Intuit · Schema
QuickBooks Online Customer
A Customer represents a consumer of the service or product that the business offers. The Customer entity supports a hierarchy where customers can have sub-customers (jobs) organized under a parent customer. DisplayName must be unique across all Customer, Employee, and Vendor objects within a QuickBooks Online company.
AccountingCustom FieldsFinancialFinancial ServicesInvoicingPaymentsPayrollProject ManagementSales TaxSmall BusinessTaxTax PreparationTaxesTime Tracking
Properties
| Name | Type | Description |
|---|---|---|
| Id | string | Unique identifier for the customer, assigned by QuickBooks Online. |
| SyncToken | string | Version number of the entity used for optimistic concurrency control. Required for update operations. |
| MetaData | object | |
| Title | string | Title of the person (e.g., Mr., Mrs., Ms., Dr.). |
| GivenName | string | Given (first) name of the customer. |
| MiddleName | string | Middle name of the customer. |
| FamilyName | string | Family (last) name of the customer. |
| Suffix | string | Suffix of the person (e.g., Jr., Sr., III). |
| DisplayName | string | The name displayed to identify the customer in the QuickBooks UI and on transaction forms. Must be unique across all Customer, Employee, and Vendor objects. |
| CompanyName | string | The company name associated with the customer. |
| PrintOnCheckName | string | Name to print on checks issued to this customer. |
| Active | boolean | Whether the customer is currently active. Inactive customers do not appear in transaction drop-downs but their data is retained. |
| Taxable | boolean | Whether transactions for this customer are taxable. |
| PrimaryEmailAddr | object | Primary email address for the customer. |
| PrimaryPhone | object | Primary phone number. |
| Mobile | object | Mobile phone number. |
| Fax | object | Fax number. |
| AlternatePhone | object | Alternate phone number. |
| BillAddr | object | Default billing address for the customer. |
| ShipAddr | object | Default shipping address for the customer. |
| Notes | string | Free-form text notes about the customer. |
| Job | boolean | Whether this customer represents a job (sub-customer) rather than a top-level customer. |
| ParentRef | object | Reference to the parent customer if this is a sub-customer (job). |
| Level | integer | Depth level in the customer hierarchy. 0 indicates a top-level customer. |
| FullyQualifiedName | string | Fully qualified name of the customer including all parent names separated by colons (e.g., 'ParentCustomer:SubCustomer'). |
| CurrencyRef | object | Reference to the currency used by this customer. Only applicable for companies with multicurrency enabled. |
| PreferredDeliveryMethod | string | Preferred method for delivering communications to this customer. |
| Balance | number | Open balance amount for the customer (sum of all open invoices minus payments). |
| BalanceWithJobs | number | Open balance amount including balances of all sub-customers (jobs). |
| SalesTermRef | object | Default sales terms for transactions with this customer. |
| PaymentMethodRef | object | Default payment method for this customer. |
| TaxExemptionReasonId | string | The tax exemption reason identifier if the customer is tax-exempt. |
| WebAddr | object | The customer's website address. |
| IsProject | boolean | Whether this customer is a project (QuickBooks Online Plus and Advanced only). |
| Source | string | Source of the customer record. |
| PrimaryTaxIdentifier | string | Primary tax identifier for the customer (e.g., ABN in Australia, GSTIN in India). |
| GSTRegistrationType | string | GST registration type (applicable for India and Australia editions). |
| BusinessNumber | string | Business number of the customer (used in certain international editions). |
| GSTIN | string | GST Identification Number (India edition). |
| domain | string | Domain of the entity (e.g., QBO). |
| sparse | boolean | Indicates whether this is a sparse (partial) representation of the entity. |