Customers

Columns

Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		true	true	The Id of the customer.
SyncToken	String	True		false	false	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.
MetaData_CreateTime	Datetime	True		true	true	The time the record was created.
MetaData_LastUpdatedTime	Datetime	True		true	true	The time the record was last updated.
Title	String	False		false	false	The title of the person. This field supports all i18n locales. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName.
GivenName	String	False		true	true	The given name or first name of the customer. At least one of the following elements is required: Title, GivenName, MiddleName, or FamilyName.
MiddleName	String	False		true	true	The middle name of the customer. The customer can have zero or more middle names. At least one of the elements is required: Title, GivenName, MiddleName, or FamilyName.
FamilyName	String	False		true	true	The family name or the last name of the customer. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName.
Suffix	String	False		true	true	The suffix of the name.
FullyQualifiedName	String	True		true	true	The fully qualified name of the customer. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2.
CompanyName	String	False		true	true	The name of the company associated with the customer.
DisplayName	String	False		true	true	The name of the customer to be displayed. This value must be unique.
PrintOnCheckName	String	False		true	true	The name of the customer as printed on a check. If this is not provided, it is populated from DisplayName.
Active	Boolean	False		true	true	This field indicates whether the customer is currently enabled for use by QuickBooks.
IsProject	Boolean	False		true	true	If true, indicates this is a Project.
PrimaryPhone_FreeFormNumber	String	False		false	false	The primary phone number.
AlternatePhone_FreeFormNumber	String	False		false	false	The alternate phone number.
Mobile_FreeFormNumber	String	False		false	false	The mobile phone number.
Fax_FreeFormNumber	String	False		false	false	The fax number.
PrimaryEmailAddr_Address	String	False		false	false	The first line of the address.
WebAddr_URI	String	False		false	false	The website address.
DefaultTaxCodeRef	String	False	TaxCodes.Id	false	false	The tax code for the customer.
Taxable	Boolean	False		false	false	This field indicates whether this customer is taxable.
CustomerTypeRef	String	False	CustomerTypes.Id	false	false	The Id of the type of this customer.
BillAddr_Id	String	False		false	false	The Id of the entity for the billing address, mainly used for modifying the address. This value is assigned by the data service.
BillAddr_Line1	String	False		false	false	The first line of the address.
BillAddr_Line2	String	False		false	false	The second line of the address.
BillAddr_Line3	String	False		false	false	The third line of the address.
BillAddr_Line4	String	False		false	false	The fourth line of the address.
BillAddr_Line5	String	False		false	false	The fifth line of the address.
BillAddr_City	String	False		false	false	The city name.
BillAddr_Country	String	False		false	false	The country name.
BillAddr_CountrySubDivisionCode	String	False		false	false	The country region. The state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		false	false	The postal code. The zip code for the USA and Canada.
BillAddr_Lat	String	False		false	false	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		false	false	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		false	false	The Id of the entity for the shipping address, mainly used for modifying the address. This field is assigned by the data service.
ShipAddr_Line1	String	False		false	false	First line of the address.
ShipAddr_Line2	String	False		false	false	Second line of the address.
ShipAddr_Line3	String	False		false	false	Third line of the address.
ShipAddr_Line4	String	False		false	false	Fourth line of the address.
ShipAddr_Line5	String	False		false	false	Fifth line of the address.
ShipAddr_City	String	False		false	false	City name.
ShipAddr_Country	String	False		false	false	Country name.
ShipAddr_CountrySubDivisionCode	String	False		false	false	Region within a country. For example, state name for the USA or the province name for Canada.
ShipAddr_PostalCode	String	False		false	false	Postal code. For example, the zip code for the USA and Canada.
ShipAddr_Note	String	False		false	false	Note for the customer.
ShipAddr_Lat	String	False		false	false	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		false	false	The longitude coordinate of the geocoded shipping address.
Notes	String	False		false	false	Notes on the customer.
Job	Boolean	False		true	false	This field indicates whether the customer is a job or subcustomer. If false or null, this is a top-level customer.
BillWithParent	Boolean	False		false	false	This field sets whether the customer is to be billed together with its parent entity. This field is valid only if this entity is a job or subcustomer.
ParentRef	String	False	Customers.Id	false	false	The immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list. This field is required for the create operation if the customer is a subcustomer or a job.
ParentRef_Name	String	True	Customers.DisplayName	false	false	The name of the immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list.
Level	Integer	False		false	false	This field shows the level of the hierarchy the customer record is located in. A value of 0 specifies the top level of the hierarchy. The hierarchy is implicit when the parent is specified in an insert command.
SalesTermRef	String	False	Terms.Id	false	false	The Id of the sales term associated with the customer.
SalesTermRef_Name	String	True	Terms.Name	false	false	The name of the sales term associated with the customer.
PaymentMethodRef	String	False	PaymentMethods.Id	false	false	The Id of the payment method associated with the customer.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	false	false	The name of the payment method associated with the customer.
Balance	Decimal	False		true	true	The open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance for that customer.
OpenBalanceDate	Date	False		false	false	The date of the open balance. This field is used in the create operation.
BalanceWithJobs	Decimal	True		false	false	The cumulative open balance amount for the customer and all its subcustomers.
PreferredDeliveryMethod	String	False		false	false	The preferred delivery method. The allowed values are Print, Email, None.
ResaleNum	String	False		false	false	The resale number or additional info about the customer.
CurrencyRef	String	False		false	false	The Id of the currency used in the transaction.
CurrencyRef_Name	String	True		false	false	The name of the currency used in the transaction.