For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Contact object
          • GET/contacts
          • POST/contacts
          • GET/contacts/{id}
          • PATCH/contacts/{id}
          • GET/contacts/meta/patch/{id}
          • GET/contacts/meta/post
          • GET/contacts/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsContacts

The Contact object

The Contact Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "is_supplier": true,
8  "is_customer": true,
9  "email_address": "string",
10  "tax_number": "string",
11  "status": "ACTIVE",
12  "currency": "string",
13  "remote_updated_at": "2023-01-01T00:00:00Z",
14  "company": "string",
15  "addresses": [
16    {
17      "created_at": "2023-01-01T00:00:00Z",
18      "modified_at": "2023-01-01T00:00:00Z",
19      "type": "BILLING",
20      "street_1": "string",
21      "street_2": "string",
22      "city": "string",
23      "state": {},
24      "country_subdivision": "string",
25      "country": "AF",
26      "zip_code": "string"
27    }
28  ],
29  "phone_numbers": [
30    {
31      "created_at": "2023-01-01T00:00:00Z",
32      "modified_at": "2023-01-01T00:00:00Z",
33      "number": "string",
34      "type": "string"
35    }
36  ],
37  "remote_was_deleted": true,
38  "field_mappings": {},
39  "remote_data": [
40    {
41      "path": "string",
42      "data": {}
43    }
44  ],
45  "remote_fields": [
46    {
47      "remote_field_class": {
48        "id": "string",
49        "display_name": "string",
50        "remote_key_name": "string",
51        "description": "string",
52        "is_custom": true,
53        "is_common_model_field": true,
54        "is_required": true,
55        "field_type": "string",
56        "field_format": "string",
57        "field_choices": [
58          "string"
59        ],
60        "item_schema": {
61          "item_type": "string",
62          "item_format": "string",
63          "item_choices": [
64            "string"
65          ]
66        }
67      },
68      "value": {
69        "string": {}
70      }
71    }
72  ]
73}
Was this page helpful?
Previous

/company-info/{id}

Next

/contacts

Built with

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.
idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The contact's name.
is_supplierboolean or nullOptional
Whether the contact is a supplier.
is_customerboolean or nullOptional
Whether the contact is a customer.
email_addressstring or nullOptional
The contact's email address.
tax_numberstring or nullOptional
The contact's tax number.
statusenum or nullOptional

The contact's status

  • ACTIVE - ACTIVE
  • ARCHIVED - ARCHIVED
Allowed values:
currencystring or nullOptional
The currency the contact's transactions are in.
remote_updated_atdatetime or nullOptional
When the third party's contact was updated.
companystring or nullOptionalformat: "uuid"
The company the contact belongs to.
addresseslist of objectsOptional

Address object IDs for the given Contacts object.

phone_numberslist of objectsOptional

AccountingPhoneNumber object for the given Contacts object.

remote_was_deletedbooleanOptionalRead-only

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 or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only