Merge Accounting - Contacts

Contacts

A Contact is an individual or business entity to which products and services are sold to or purchased from. The Contact model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from.

A Contact is a Vendor/Supplier if the is_supplier property is true.
A Contact is a customer if the is_customer property is true.

Properties

idUUID

Required

remote_idString

Optional

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

nameString

Optional

The contact's name.

is_supplierBoolean

Optional

Whether the contact is a supplier.

is_customerBoolean

Optional

Whether the contact is a customer.

email_addressString

Optional

The contact's email address.

tax_numberString

Optional

The contact's tax number.

statusEnum

Optional

The contact's status Possible values include: ACTIVE, ARCHIVED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

currencyString

Optional

The currency the contact's transactions are in.

remote_updated_atDateTime (ISO 8601)

Optional

When the third party's contact was updated.

companyUUID

Optional

The company the contact belongs to.

addressesAddress[]

Required

Address object IDs for the given Contacts object.

The Address object

The Address object is used to represent a contact's or company's address.

Properties

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

typeEnum

Optional

The address type. Possible values include: BILLING, SHIPPING. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

street_1String

Optional

Line 1 of the address's street.

street_2String

Optional

Line 2 of the address's street.

cityString

Optional

The address's city.

stateAny

Optional

The address's state or region.

country_subdivisionString

Optional

The address's state or region.

countryEnum

Optional

The address's country. Possible values include: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

zip_codeString

Optional

The address's zip code.

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.

Properties

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

numberString

Optional

The phone number.

typeString

Optional

The phone number's type.

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/contacts

https://api.merge.dev/api/accounting/v1/contacts

APAC

Returns a list of Contact objects.

Query & Path Parameters

company_idString

Optional

If provided, will only return contacts for this company.

created_afterDateTime (ISO 8601)

Optional

If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

email_addressString

Optional

If provided, will only return Contacts that match this email.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsBoolean

Optional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

is_customerString

Optional

If provided, will only return Contacts that are denoted as customers.

is_supplierString

Optional

If provided, will only return Contacts that are denoted as suppliers.

modified_afterDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge before this date time will be returned.

nameString

Optional

If provided, will only return Contacts that match this name.

page_sizeInteger

Optional

Number of results to return per page.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

show_enum_originsString

Optional

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Clear Books

FreeAgent

FreshBooks

Microsoft Dynamics 365 Business Central

Microsoft Dynamics Finance and Operations

Moneybird

NetSuite

QuickBooks Desktop

QuickBooks Online

Sage Business Cloud Accounting

Sage Intacct

Wave Financial

Workday

Xero

Zoho Books

POST

/contacts

https://api.merge.dev/api/accounting/v1/contacts

APAC

Creates a Contact object with the given values. To run asynchronously, see our guide.

Query & Path Parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.

nameString

The contact's name.

is_supplierBoolean

Whether the contact is a supplier.

is_customerBoolean

Whether the contact is a customer.

email_addressString

The contact's email address.

tax_numberString

The contact's tax number.

statusEnum

The contact's status Must pass in one of the following choices: ACTIVE, ARCHIVED.

currencyString

The currency the contact's transactions are in.

companyUUID

The company the contact belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Company object.

addressesArray

Address object IDs for the given Contacts object.

phone_numbersArray

AccountingPhoneNumber object for the given Contacts object.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

FreshBooks

Microsoft Dynamics 365 Business Central

NetSuite

QuickBooks Online

Sage Intacct

Xero

To include the correct model fields when making POST requests, use the GET /contacts/meta/post endpoint. Learn more in our /meta guide.

GET

/contacts/{id}

https://api.merge.dev/api/accounting/v1/contacts/{id}

APAC

Returns a Contact object with the given id.

Query & Path Parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsBoolean

Optional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Clear Books