The Customer object
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. |
| paymentMethodRef | Reference Types | Preferred payment method used by the customer |
| 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 Bank Account Object
From the Customer Bank Accounts endpoint, you can retrieve a list of bank accounts for a specified customer of a business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the customer bank account, unique for the business in the accounting service. |
| name sortable, filterable | string | Name of the account as recorded in the accounting service. |
| contactName | string | Full name of the primary contact of the customer. |
| type sortable, filterable | string | The bank account type. Valid values:checkingsavingcreditCardloaninvestmentunknown |
| customerRef | Reference Types | Reference to the customer against which the payment is created. |
| accountNumber sortable, filterable | string | Account number for the bank account. |
| routingNumber sortable, filterable | string | Routing number for the bank associated with the account. |
| bankName sortable, filterable | string | Name of the bank. |
| supportsAch sortable, filterable | boolean | Does the account support ACH payments |
| supportsWire sortable, filterable | boolean | Does the account support wire transfers |
| supportsCheck sortable, filterable | boolean | Does the account support check payments |
| address | Reference Types | Address of the bank. |
| currency | string | ISO-4217 currency code of the customer's default currency. |
| 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.