The Contact 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 Contact endpoint, you can retrieve a list of all contacts (Customers and vendors) for a specified business.
| Field | Type | Description |
|---|---|---|
| id | string | Identifier for the contact, unique for the business in the accounting service. |
| contactName | string | Full name of the primary contact |
| contactFirstName sortable, filterable | string | First name of the primary contact |
| contactLastName sortable, filterable | string | The last name of the primary contact |
| emailAddress | string | Email of the contact. |
| bankAccountRef | Reference Types | Reference to the account the transaction is recorded against. Query the Chart of Accounts endpoint to determine the appropriate Account object for this reference, where isBankAccount is true. |
| website | string | Website of the contact. |
| currency sortable, filterable | string | ISO-4217 currency code of the contact's default currency. |
| phone | string | Phone number of the contact. |
| shippingAddress | Reference Types | Shipping address of the customer. |
| billingAddress | Reference Types | Billing address of the contact. |
| contacts | Reference Types | An array of contact information associated with the contact. |
| taxNumber | string | Contact tax number. |
| status sortable, filterable | string | Contact status. |
| balance sortable, filterable | decimal | Contact outstanding balance. |
| contactType sortable, filterable | string | Specifies whether the contact is a customer or a vendor |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |