Supported Methods

Supported Parameters

GET, POST, PATCH

Id, name, page, pageSize, modTimeStart, modTimeEnd, isActive, isDeleted, includeShippingAddress

{
    "ID": "",
    "Name": "",
    "FullName": "",
    "Parent": {
        "ID": "",
        "FullName": ""
    },
    "Terms": {
        "ID": "",
        "FullName": ""
    },
    "CompanyName": "",
    "FirstName": "",
    "MiddleName": "",
    "LastName": "",
    "ItemSalesTax": {
        "ID": "",
        "FullName": ""
    },
    "BillingAddress": {
        "Line1": "",
        "Line2": "",
        "Line3": "",
        "Line4": "",
        "Line5": "",
        "City": "",
        "State": "",
        "PostalCode": "",
        "Country": "",
        "Notes": ""
    },
    "ShippingAddress": {
        "Line1": "",
        "Line2": "",
        "Line3": "",
        "Line4": "",
        "Line5": "",
        "City": "",
        "State": "",
        "PostalCode": "",
        "Country": "",
        "Notes": ""
    },
    "Phone": "",
    "Mobile": "",
    "Other": "",
    "Email": "",
    "Balance": 0.0,
    "IsActive": true,
    "LastModifiedDate": "2021-07-12T16:21:46Z",
    "CreatedDate": "2021-07-12T16:21:46Z",
    "Salutation": "",
    "AlternatePhone": "",
    "Contact": {
        "Name": ""
    },
    "AlternateContact": "",
    "Number": "",
    "TaxCode": {
        "FullName": "",
        "ID": ""
    },
    "JobDescription": "",
    "JobType": {
        "FullName": "",
        "ID": ""
    },
    "JobStatus": "",
    "DeletedDate": "2021-07-12T16:21:46Z",
    "CustomFields": [{
        "FullName": "",
        "Value": ""
    }],
    "ShippingAddressList": [{
        "Name": "",
        "Line1": "",
        "Line2": "",
        "Line3": "",
        "City": "",
        "State": "",
        "PostalCode": "",
        "Country": "",
        "Notes": "",
        "IsDefault": true
    }],
    "TypeID": "",
    "Type": "",
    "SalesRep": {
        "ID": "",
        "FullName": ""
    },
    "PreferredDeliveryMethod": {
        "FullName": ""
    },
    "PreferredPaymentMethod": {
        "ID": "",
        "FullName": ""
    },
    "CreditLimit": 0.0,
    "CCEmail": "",
    "JobTitle": "",
    "Currency": {
        "ID": "",
        "FullName": ""
    },
    "PriceLevel": {
        "Id": "",
        "FullName": ""
    },
    "Contacts": [{
        "Salutation": "",
        "FirstName": "",
        "MiddleName": "",
        "LastName": "",
        "JobTitle": "",
        "AdditionalContact": [{
            "Name": "",
            "Value": ""
        }],
        "ID": ""
    }],
    "AdditionalContact": [{
        "Name": "",
        "Value": ""
    }],
    "Note": "",
    "Notes": [{
        "ID": "",
        "Date": "2021-07-12T16:21:46Z",
        "Note": ""
    }],
    "HomePhone": "",
    "WorkPhone": "",
    "DateOfBirth": "",
    "TaxID": ""
}

Important Notes

  • available parameter: IncludeShippingAddress
    • excludes the Shipping Address fields on a GET request
    • available only for QuickBooks Desktop Customer GET request
    • default value is true
  • PATCH and POST are not supported for Note or Notes[]

Did this page help you?