Customers
Contains all customer profiles in QuickBooks Online, enabling you to create, update, delete, and retrieve customer contact information, billing preferences, and tax settings.
Table Specific Information
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
The driver processes other filters client-side within the driver.
Delete
Hard deletes are not supported for this table. A soft delete can be executed by setting the customer as active or inactive.Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Id [KEY] | String | True | True | True |
Specifies the unique identifier (Id) of the customer. | |
| SyncToken | String | True | False | False |
Specifies the version number that is used to lock the customer object for use by one application at a time. When an application modifies an object, its SyncToken is incremented. Attempts to modify an object with an older sync token fail. | |
| MetaData_CreateTime | Datetime | True | True | True |
Specifies the date and time when the customer record was created in the source domain. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
Specifies the date and time when the customer record was last updated in the source domain. | |
| Title | String | False | False | False |
Specifies the title of the customer. This field supports all international locales. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName. | |
| GivenName | String | False | True | True |
Specifies 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 |
Specifies the middle name of the customer. A 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 |
Specifies the family name or last name of the customer. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName. | |
| Suffix | String | False | False | False |
Specifies the suffix of the customer's name. | |
| FullyQualifiedName | String | True | True | True |
Specifies the fully qualified name of the customer. The fully qualified name consists of the topmost parent element followed by each subelement separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2. | |
| CompanyName | String | False | True | True |
Specifies the name of the company associated with the customer. | |
| DisplayName | String | False | True | True |
Specifies the name of the customer to be displayed. This value must be unique. | |
| PrintOnCheckName | String | False | True | True |
Specifies the name of the customer as printed on a check. If this field is not provided, it is populated from the DisplayName attribute. | |
| Active | Boolean | False | True | False |
Indicates whether the customer is currently enabled for use by QuickBooks Online. | |
| IsProject | Boolean | True | False | False |
Indicates whether the customer record is a project. | |
| PrimaryPhone_FreeFormNumber | String | False | False | False |
Specifies the primary phone number of the customer. | |
| AlternatePhone_FreeFormNumber | String | False | False | False |
Specifies the alternate phone number of the customer. | |
| Mobile_FreeFormNumber | String | False | False | False |
Specifies the mobile phone number of the customer. | |
| Fax_FreeFormNumber | String | False | False | False |
Specifies the fax number of the customer. | |
| PrimaryEmailAddr_Address | String | False | False | False |
Specifies the primary email address of the customer. | |
| WebAddr_URI | String | False | False | False |
Specifies the website address of the customer. | |
| DefaultTaxCodeRef | String | False |
TaxCodes.Id | False | False |
Specifies the tax code that is assigned to the customer. |
| Taxable | Boolean | False | False | False |
Indicates whether the customer is taxable. | |
| CustomerTypeRef | String | False | False | False |
Specifies the unique Id of the customer type. | |
| BillAddr_Id | String | True | False | False |
Specifies the unique Id of the entity for the billing address, mainly used for modifying the address. | |
| BillAddr_Line1 | String | False | False | False |
Specifies the first line of the billing address. | |
| BillAddr_Line2 | String | False | False | False |
Specifies the second line of the billing address. | |
| BillAddr_Line3 | String | False | False | False |
Specifies the third line of the billing address. | |
| BillAddr_Line4 | String | False | False | False |
Specifies the fourth line of the billing address. | |
| BillAddr_Line5 | String | False | False | False |
Specifies the fifth line of the billing address. | |
| BillAddr_City | String | False | False | False |
Specifies the city name in the billing address. | |
| BillAddr_Country | String | False | False | False |
Specifies the country name in the billing address. | |
| BillAddr_CountrySubDivisionCode | String | False | False | False |
Specifies the region within the country in the billing address. This field represents the state name for the USA or the province name for Canada. | |
| BillAddr_PostalCode | String | False | False | False |
Specifies the postal code in the billing address. This field represents the ZIP code for the USA and Canada. | |
| BillAddr_Lat | String | True | False | False |
Specifies the latitude coordinate of the geocoded billing address. | |
| BillAddr_Long | String | True | False | False |
Specifies the longitude coordinate of the geocoded billing address. | |
| ShipAddr_Id | String | True | False | False |
Specifies the unique Id of the entity for the shipping address, mainly used for modifying the address. | |
| ShipAddr_Line1 | String | False | False | False |
Specifies the first line of the shipping address. | |
| ShipAddr_Line2 | String | False | False | False |
Specifies the second line of the shipping address. | |
| ShipAddr_Line3 | String | False | False | False |
Specifies the third line of the shipping address. | |
| ShipAddr_Line4 | String | False | False | False |
Specifies the fourth line of the shipping address. | |
| ShipAddr_Line5 | String | False | False | False |
Specifies the fifth line of the shipping address. | |
| ShipAddr_City | String | False | False | False |
Specifies the city name in the shipping address. | |
| ShipAddr_Country | String | False | False | False |
Specifies the country name in the shipping address. | |
| ShipAddr_CountrySubDivisionCode | String | False | False | False |
Specifies the region within the country in the shipping address. This field represents the state name for the USA or the province name for Canada. | |
| ShipAddr_PostalCode | String | False | False | False |
Specifies the postal code in the shipping address. This field represents the ZIP code for the USA and Canada. | |
| ShipAddr_Lat | String | True | False | False |
Specifies the latitude coordinate of the geocoded shipping address. | |
| ShipAddr_Long | String | True | False | False |
Specifies the longitude coordinate of the geocoded shipping address. | |
| Notes | String | False | False | False |
Specifies any notes about the customer. | |
| Job | Boolean | False | True | False |
Indicates whether the customer is a job or subcustomer. If this flag is false or null, this record is a top-level customer. | |
| BillWithParent | Boolean | False | False | False |
Specifies whether the customer is to be billed together with its parent entity. This field is valid only when the customer is a job or subcustomer. | |
| ParentRef | String | False |
Customers.Id | False | False |
Specifies the unique Id of 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 |
Specifies the name of the immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list. |
| Level | Integer | True | False | False |
Specifies the level of the hierarchy where the customer record is located. 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 |
Specifies the unique Id of the sales term that is associated with the customer. |
| SalesTermRef_Name | String | True |
Terms.Name | False | False |
Specifies the name of the sales term that is associated with the customer. |
| PaymentMethodRef | String | False | False | False |
Specifies the unique Id of the payment method that is associated with the customer. | |
| PaymentMethodRef_Name | String | True |
PaymentMethods.Name | False | False |
Specifies the name of the payment method that isassociated with the customer. |
| Balance | Decimal | False | True | True |
Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When this balance is returned in a query response, it represents the current open balance for that customer. | |
| OpenBalanceDate | Date | False | False | False |
Specifies the date of the open balance. This field is used in the create operation. | |
| BalanceWithJobs | Decimal | True | False | False |
Specifies the cumulative open-balance amount for the customer and all its subcustomers. | |
| PreferredDeliveryMethod | String | False | False | False |
Specifies the preferred delivery method for the customer. The allowed values are Print, Email, None. | |
| ResaleNum | String | False | False | False |
Specifies the resale number or additional information about the customer. | |
| CurrencyRef | String | False | False | False |
Specifies the unique Id of the currency used for transactions with the customer. | |
| CurrencyRef_Name | String | True | False | False |
Specifies the name of the currency that is used for transactions with the customer. | |
| TaxExemptionReasonId | Integer | False | False | False |
Specifies the tax-exemption-reason Id that is associated with the customer object. | |
| GSTIN | String | False | False | False |
Specifies the Goods and Services tax identification number (GSTIN) that is assigned to every GST-registered business. This field is applicable only for the India region. | |
| BusinessNumber | String | False | False | False |
Specifies the Permanent Account Number (PAN) code (in India) that acts as an identification for individuals, families, and corporates, especially for those who pay taxes on their income. | |
| Source | String | False | False | False |
Specifies the source type of the transactions created by QuickBooks Commerce. The allowed values are QBCommerce. | |
| GSTRegistrationType | String | False | False | False |
Specifies the GST registration type used for filing Goods and Services tax returns (GSTR), classifying the type of customer to whom the sale is done. The allowed values are GST_REG_REG, GST_REG_COMP, GST_UNREG, CONSUMER, OVERSEAS, SEZ, DEEMED. |