The Customer object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Customers endpoint, you can retrieve a list of all customers for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the customer, unique for the business in the accounting service. |
| customerName sortable, filterable | string | Name of the customer as recorded in the accounting service, typically the company name. |
| contactName | string | Full name of the primary contact of the customer. |
| contactFirstName | string | First name of the primary contact of the customer. |
| contactLastName | string | Last name of the primary contact of the customer. |
| emailAddress | string | Email of the customer. |
| website | string | Website of the customer. |
| parentRef | Reference Types | Reference to parent customer if this represents a sub-customer. |
| currency | string | ISO-4217 currency code of the customer's default currency. |
| phone | string | Phone number of the customer. |
| billingAddress | Reference Types | Billing address of the customer. |
| shippingAddress | Reference Types | Shipping address of the customer. |
| contacts | array | An array of Contacts information associated with the customer. |
| taxNumber | string | Customer's tax number. |
| balance sortable, filterable | decimal | Customer outstanding balance. |
| isPerson sortable, filterable | boolean | Specifies whether the customer is an individual person or a company. |
| status sortable, filterable | string | Customer status of the customer. |
| sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting system. |
The Customer Reference Object
Data types that reference a customer, for example, invoice and invoice credit notes, use a customerRef that includes the id and name of the linked customer.
Using Currency Reference in Push
For convenience, when pushing data
customerRefcan be used alone with theidas a value instead of nesting it within.