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.|
|string||Name of the customer as recorded in the accounting service provider, typically the company name.|
|string||Name of the main contact for the customer.|
|emailAddress||string||Customer's primary email address.|
|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.|
|decimal||Customer's current balance.|
|string||Customer current status, either:|
|subsidiaryRefs||Reference Types||An array of subsidiaries the customer refers to.|
|Date the record was last changed in the accounting service provider.|
Data types that reference a customer, for example, invoice and invoice credit notes, use a customerRef that includes the
name of the linked customer.
Using Currency Reference in Push
For convenience, when pushing data
customerRefcan be used alone with the
idas a value instead of nesting it within.