Contacts

The Contact Object

From the Contact endpoint, you can retrieve a list of all contacts (Customers and vendors) for a specified business.

FieldTypeDescription
idstringIdentifier for the contact, unique for the business in the accounting service.
contactName stringFull name of the primary contact
contactFirstName
sortable, filterable
stringFirst name of the primary contact
contactLastName
sortable, filterable
stringThe last name of the primary contact
emailAddress stringEmail of the contact.
bankAccountRefReference TypesReference 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.
websitestringWebsite of the contact.
currency
sortable, filterable
stringISO-4217 currency code of the contact's default currency.
phonestringPhone number of the contact.
shippingAddressReference TypesShipping address of the customer.
billingAddressReference TypesBilling address of the contact.
contacts Reference TypesAn array of contact information associated with the contact.
taxNumberstringContact tax number.
status
sortable, filterable
stringContact status.
balance
sortable, filterable
decimalContact 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.