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     "organization_defined_targets": {
40       "string": {}
41     },
42     "linked_account_defined_targets": {
43       "string": {}
44     }
45   },
46   "remote_data": [
47     {
48       "path": "string",
49       "data": {}
50     }
51   ],
52   "remote_fields": [
53     {
54       "remote_field_class": {
55         "id": "string",
56         "display_name": "string",
57         "remote_key_name": "string",
58         "description": "string",
59         "is_custom": true,
60         "is_common_model_field": true,
61         "is_required": true,
62         "field_type": "string",
63         "field_format": "string",
64         "field_choices": [
65           "string"
66         ],
67         "item_schema": {
68           "item_type": "string",
69           "item_format": "string",
70           "item_choices": [
71             "string"
72           ]
73         }
74       },
75       "value": {
76         "string": {}
77       }
78     }
79   ]
80 }

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

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

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

phone_numberslist of objectsOptional

remote_was_deletedbooleanOptionalRead-only

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only