The Customer Object

From the Customers endpoint, you can retrieve a list of all customers for a specified business.

id string Identifier for the customer, unique to the business in the accounting service provider.
sortable, filterable
stringName of the customer as recorded in the accounting service provider, typically the company name.
sortable, filterable
stringName of the main contact for the customer.
emailAddress stringCustomer's primary email address.
website stringCustomer's website
defaultCurrency Reference TypesCustomer'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 stringCustomer's phone number.
addresses arrayAn array of Addresses.
contacts arrayAn array of Contacts.
taxNumber stringCustomer's tax number.
sortable, filterable
decimalCustomer's current balance.
sortable, filterable
stringCustomer current status, either:
subsidiaryRefsReference TypesAn array of subsidiaries the customer refers to.
sortable, filterable
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 the id as a value instead of nesting it within.