Contacts
TheContact object is used to represent a Contact. This can be either a supplier or a customer.The Contact object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
remote_dataRemoteData[]Optional
nameStringOptional
The contact's name.
is_supplierBooleanOptional
Whether the contact is a supplier.
is_customerBooleanOptional
Whether the contact is a customer.
email_addressStringOptional
The contact's email address.
tax_numberStringOptional
The contact's tax number.
statusEnumOptional
The contact's status Possible values include:
ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.currencyStringOptional
The currency the contact's transactions are in.
remote_updated_atStringOptional
When the third party's contact was updated.
addressesArrayRequired
Address object IDs for the given Contacts object.phone_numbersAccountingPhoneNumber[]Required
AccountingPhoneNumber object for the given Contacts object.The AccountingPhoneNumber object
The
AccountingPhoneNumber object is used to represent a contact's or company's phone number.JSON
{"number": "+3198675309","type": "Mobile"}
Properties
numberStringOptional
The phone number.
typeStringOptional
The phone number's type.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
The Contact object
JSON
{"id": "c640b80b-fac9-409f-aa19-1f9221aec445","remote_id": "11167","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "Gil Feig's Pickleball Team","is_supplier": true,"is_customer": true,"email_address": "[email protected]","tax_number": "12-3456789","status": "ACTIVE","currency": "USD","remote_updated_at": "2020-03-31T00:00:00Z","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true}
GET
/contacts
Returns a list of Contact objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Which fields should be returned in non-normalized form.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "c640b80b-fac9-409f-aa19-1f9221aec445","remote_id": "11167","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "Gil Feig's Pickleball Team","is_supplier": true,"is_customer": true,"email_address": "[email protected]","tax_number": "12-3456789","status": "ACTIVE","currency": "USD","remote_updated_at": "2020-03-31T00:00:00Z","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true}]}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_updated_atStringtax_numberString
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringnameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtax_numberString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnumtax_numberString
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtax_numberString
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnumtax_numberString
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_idStringremote_updated_atStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/{id}
Returns a Contact object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "c640b80b-fac9-409f-aa19-1f9221aec445","remote_id": "11167","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "Gil Feig's Pickleball Team","is_supplier": true,"is_customer": true,"email_address": "[email protected]","tax_number": "12-3456789","status": "ACTIVE","currency": "USD","remote_updated_at": "2020-03-31T00:00:00Z","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_updated_atStringtax_numberStringFreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringnameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtax_numberStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnumQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnumtax_numberStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringtax_numberStringXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]remote_idStringremote_updated_atStringstatusEnumtax_numberStringZoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_idStringremote_updated_atStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.