Customers

Create, Update, Query, and Delete QuickBooks Customers.

Table Specific Information

In order to add a Customer, you must specify the Name.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or '=' comparison. The available columns for Customers are Id, Name, and IsActive. In addition, the pseudo-columns ActiveStatus, MinBalance, MaxBalance, StartModifiedDate and EndModifiedDate may also be specified.

QuickBooks Online

Several columns are not supported in the QuickBooks Online API including IsActive, Contact, AlternateContact, SalesRep columns, and TaxCode columns.

Columns


Name	Type	Description	ReadOnly
ID [KEY]	String	The unique identifier of the Customer.	True
Name	String	The name of the customer. This is required to have a value when inserting.	False
Salutation	String	A salutation, such as Mr., Mrs., etc.	False
FirstName	String	The first name of the customer as stated in the address info.	False
MiddleInitial	String	A middle name or middle initial of the customer.	False
LastName	String	The last name of the customer as stated in the address info.	False
FullName	String	The full name of the customer, including parents in the format Parent:Customer.	True
AccountNumber	String	The account number for the customer.	False
Company	String	The name of the customer's company.	False
Balance	Double	The balance owned by this customer including sub-customers.	True
CustomerBalance	Double	The balance owned by only this customer not including sub-customers.	True
Contact	String	The name of the main contact person for the customer.	False
Type	String	A predefined customer type within QuickBooks. Typical customer types, if defined, might be Commercial, Residential, etc.	False
TypeId	String	A predefined customer type within QuickBooks.	False
Phone	String	The main telephone number for the customer.	False
Fax	String	The Fax number number for the customer.	False
AlternateContact	String	The name of an alternate contact person for the customer.	False
AlternatePhone	String	The alternate telephone number for the customer.	False
Email	String	The email address for communicating with the customer. If using QuickBooks Online, this is required to have a value when inserting.	False
Notes	String	Notes on this customer.	False
ParentName	String	The parent name of the job.	False
ParentId	String	The parent id of the job.	False
Sublevel	String	The number of ancestors this Customer has.	False
JobStatus	String	The current status of the job.	False
JobStartDate	Date	The start date of the job.	False
JobProjectedEndDate	Date	The expected end date for the job.	False
JobEndDate	Date	The actual end date for the job.	False
JobDescription	String	A description of the job.	False
JobTypeId	String	A job type reference ID.	True
JobType	String	The name of the job type.	True
CreditCardAddress	String	The address associated with the CreditCard.	False
CreditCardExpMonth	String	The expiration month associated with the CreditCard.	False
CreditCardExpYear	String	The expiration year associated with the CreditCard.	False
CreditCardNameOnCard	String	The name as it appears on the customer's CreditCard.	False
CreditCardNumber	String	The credit card number on file for this customer.	False
CreditCardPostalCode	String	The postal code associated with the Address and Number on file for this customer.	False
CreditLimit	Double	The credit limit for this customer. If it is equal to 0, there is no credit limit. This field can be set in Inserts but not in Updates.	False
BillingAddress	String	Full billing address returned by QuickBooks.	True
BillingLine1	String	First line of the billing address.	False
BillingLine2	String	Second line of the billing address.	False
BillingLine3	String	Third line of the billing address.	False
BillingLine4	String	Forth line of the billing address.	False
BillingLine5	String	Fifth line of the billing address.	False
BillingCity	String	City name for the billing address of the customer.	False
BillingState	String	State name for the billing address of the customer.	False
BillingPostalCode	String	Postal code for the billing address of the customer.	False
BillingCountry	String	Country for the billing address of the customer.	False
ShippingAddress	String	Full shipping address returned by QuickBooks.	True
ShippingLine1	String	First line of the shipping address.	False
ShippingLine2	String	Second line of the shipping address.	False
ShippingLine3	String	Third line of the shipping address.	False
ShippingLine4	String	Forth line of the shipping address.	False
ShippingLine5	String	Fifth line of the shipping address.	False
ShippingCity	String	City name for the shipping address of the customer.	False
ShippingState	String	State name for the shipping address of the customer.	False
ShippingPostalCode	String	Postal code for the shipping address of the customer.	False
ShippingCountry	String	Country for the shipping address of the customer.	False
ResaleNumber	String	The resale number of the Customer, if he/she has one. This field can be set in Inserts but not in Updates.	False
SalesRep	String	A reference to a sales rep for the Customer.	False
SalesRepId	String	A reference to a sales rep for the Customer.	False
Terms	String	A reference to terms of payment for this Customer. A typical example might be '2% 10 Net 60'. This field can be set in Inserts but not in Updates.	False
TermsId	String	A reference to terms of payment for this Customer.	False
CurrencyName	String	The name of the currency for this customer. A minimum QBXML Version of 8.0 is required for this feature.	False
CurrencyId	String	The unique id of the currency for this customer. A minimum QBXML Version of 8.0 is required for this feature.	False
TaxCode	String	This is a reference to a sales tax code predefined within QuickBooks. This field can be set in Inserts but not in Updates.	False
TaxCodeId	String	This is a reference to a sales tax code predefined within QuickBooks. This field can be set in Inserts but not in Updates.	False
TaxItem	String	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.	False
TaxItemId	String	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.	False
PriceLevel	String	Reference to a price level for the customer.	False
PriceLevelId	String	Reference to a price level for the customer.	False
PreferredPaymentMethodName	String	The preferred method of payment.	False
PreferredPaymentMethodId	String	The preferred method of payment.	False
PrintAs	String	A QuickBooks Online field describing how to print the name on checks.	False
IsActive	Boolean	Whether or not the customer is active.	False
CustomFields	String	Custom fields returned from QuickBooks formatted into XML.	False
EditSequence	String	An identifier for this copy of the object, used for versioning.	True
TimeModified	Datetime	When the Customer was last modified.	True
TimeCreated	Datetime	When the Customer was created.	True

Pseudo-Columns

Pseudo-Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
NameMatchType	String	Type of match to perform on SearchName. The allowed values are CONTAINS, EXACT, STARTSWITH, ENDSWITH. The default value is CONTAINS.
IncludeJobs	String	Whether or not to include job information in the results. The allowed values are TRUE, FALSE. The default value is TRUE.
ActiveStatus	String	The status of the customers included in the results. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is ALL.
StartModifiedDate	String	Earliest modified date to search for.
EndModifiedDate	String	Latest modified date to search for.
MinBalance	String	A minimum balance which returned records should have. Limits the search to records with balances greater than or equal to MinBalance.
MaxBalance	String	A maximum balance which returned records should have. Limits the search to records with balances less than or equal to MaxBalance.