Supported MethodsSupported Parameters
GET, POST, PATCHId, 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": "2023-01-09T15:23:46Z",
	"CreatedDate": "2023-01-09T15:23:46Z",
	"Fax": "",
	"WebSite": "",
	"Level": 0,
	"BillWithParent": true,
	"Salutation": "",
	"AlternatePhone": "",
	"Contact": {
		"Name": ""
	},
	"AlternateContact": "",
	"Number": "",
	"TaxCode": {
		"FullName": "",
		"ID": ""
	},
	"JobDescription": "",
	"JobType": {
		"FullName": "",
		"ID": ""
	},
	"JobStatus": "",
	"DeletedDate": "2023-01-09T15:23: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": "2023-01-09T15:23:46Z",
		"Note": ""
	}],
	"ResaleNumber": "",
	"BalanceWithJobs": 0.0,
	"HomePhone": "",
	"WorkPhone": "",
	"DateOfBirth": "01/09/2023",
	"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[]