Contacts
TheContact
object refers to either a supplier or a customer.The Contact object
Properties
id
Stringremote_id
Stringremote_data
RemoteData[]name
Stringis_supplier
Booleanis_customer
Booleanemail_address
Stringtax_number
Stringstatus
EnumACTIVE
, ARCHIVED
, or - in cases where there is no clear mapping - the original value passed through.currency
Stringremote_updated_at
Stringcompany
Stringaddresses
ArrayAddress
object IDs for the given Contacts
object.phone_numbers
AccountingPhoneNumber[]AccountingPhoneNumber
object for the given Contacts
object.The AccountingPhoneNumber object
AccountingPhoneNumber
object is used to represent a contact's or company's phone number.{"number": "+3198675309","type": "Mobile"}
Properties
number
Stringtype
Stringremote_was_deleted
Booleanfield_mappings
Object{"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"}}}
/contacts
Returns a list of Contact
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
company_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
String{"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"}}}]}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_updated_at
Stringtax_number
String
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringstatus
Enum/contacts
Creates a Contact
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
name
Stringis_supplier
Booleanis_customer
Booleanemail_address
Stringtax_number
Stringstatus
EnumACTIVE
, ARCHIVED
.currency
Stringcompany
Stringid
field in the Company table.addresses
ArrayAddress
object IDs for the given Contacts
object.phone_numbers
ArrayAccountingPhoneNumber
object for the given Contacts
object.integration_params
Objectlinked_account_params
Object{"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"}]}}
{"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}}]}

Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringtax_number
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
company
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringstatus
EnumAdditional POST Parameters
integration_params
Objectis_person
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringstatus
Enumtax_number
String/contacts/{id}
Returns a Contact
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"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"}}}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_updated_at
Stringtax_number
String
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringstatus
Enum/contacts/meta/post
Returns metadata for Contact
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_updated_at
Stringtax_number
String
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringcurrency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtax_number
String
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumtax_number
String
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
currency
Stringemail_address
Stringis_customer
Booleanis_supplier
Booleanname
Stringremote_id
Stringremote_updated_at
Stringstatus
Enum