The Customer Object
From the Customers endpoint, you can retrieve a list of all customers for a specified business.
Field | Type | Description |
---|---|---|
id | string | Identifier for the customer, unique to the business in the accounting service provider. |
customerName sortable, filterable | string | Name of the customer as recorded in the accounting service provider, typically the company name. |
contactName sortable, filterable | string | Name of the main contact for the customer. |
emailAddress | string | Customer's primary email address. |
website | string | Customer's website |
defaultCurrency | Reference Types | Customer's default currency. Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency. |
phone | string | Customer's phone number. |
addresses | array | An array of Addresses. |
contacts | array | An array of Contacts. |
taxNumber | string | Customer's tax number. |
balance sortable, filterable | decimal | Customer's current balance. |
status sortable, filterable | string | Customer current status, either:unknown active archived |
subsidiaryRefs | Reference Types | An array of subsidiaries the customer refers to. |
sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting service provider. |
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
customerRef
can be used alone with theid
as a value instead of nesting it within.