Contacts
TheContact object refers to 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.
companyStringOptional
The company the contact belongs to.
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.
field_mappingsObjectOptional
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","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
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
company_idStringOptional
If provided, will only return contacts for this company.
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
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
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","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_updated_atStringtax_numberString
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtax_numberString
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberString
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberString
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberString
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_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[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberString
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_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.
POST
/contacts
Creates a Contact object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
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 Must pass in one of the following choices:
ACTIVE, ARCHIVED.currencyStringOptional
The currency the contact's transactions are in.
companyStringOptional
The company the contact belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Company table.addressesArrayRequired
Address object IDs for the given Contacts object.phone_numbersArrayRequired
AccountingPhoneNumber object for the given Contacts object.integration_paramsObjectOptional
linked_account_paramsObjectOptional
POST v1/contacts
JSON
{"model": {"name": "Gil Feig's Pickleball Team","is_supplier": true,"is_customer": true,"email_address": "[email protected]","tax_number": "12-3456789","status": "ACTIVE","currency": "USD","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}]}}
Response
JSON
{"model": {"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","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}
Field support by platform
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
companyStringRequired
currencyStringOptional
email_addressStringOptional
is_customerBooleanRequired
is_supplierBooleanRequired
nameStringRequired
remote_idStringOptional
remote_updated_atStringOptional
tax_numberStringOptional
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
companyStringRequired
email_addressStringOptional
is_customerBooleanRequired
is_supplierBooleanRequired
nameStringRequired
remote_idStringOptional
remote_updated_atStringOptional
statusEnumOptional
Additional POST Parameters
integration_paramsObjectRequired
is_personStringRequired
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
currencyStringOptional
email_addressStringOptional
is_customerBooleanOptional
is_supplierBooleanOptional
nameStringRequired
remote_idStringOptional
remote_updated_atStringOptional
statusEnumOptional
tax_numberStringOptional
Xero
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
currencyStringOptional
email_addressStringOptional
is_customerBooleanOptional
is_supplierBooleanOptional
nameStringRequired
remote_idStringOptional
statusEnumOptional
tax_numberStringOptional
Hint: 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
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
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","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","addresses": ["2f2702aa-8948-492b-a412-2acdf6d2c499","d98c7428-8dda-48a8-a1da-c570f65e2375"],"phone_numbers": [{"number": "+3198675309","type": "Mobile"}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_updated_atStringtax_numberStringFreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtax_numberStringFreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringMoneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtax_numberStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringWave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_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.
GET
/contacts/meta/post
Returns metadata for Contact POSTs.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Response
JSON
{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
Field support by platform
Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_updated_atStringtax_numberStringFreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtax_numberStringFreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringMoneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addressStringnameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringcurrencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumtax_numberStringSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringtax_numberStringWave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currencyStringemail_addressStringis_customerBooleanis_supplierBooleannameStringremote_dataRemoteData[]pathstringdataobjectremote_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.