Contacts

The Contact object is used to represent a Contact. This can be either a supplier or a customer.

The Contact object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

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, or - in cases where there is no clear mapping - the original value passed through.

currencyString
Optional
The currency the contact's transactions are in.

remote_updated_atString
Optional
When the third party's contact was updated.

addressesArray
Optional
Address object IDs for the given Contacts object.

phone_numbersAccountingPhoneNumber[]
Optional
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.
{
  "number": "+3198675309",
  "type": "Mobile"
}

Properties


numberString
Optional
The phone number.

typeString
Optional
The phone number's type.

The Contact 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": "pickleball@merge.dev",
  "tax_number": "12-3456789",
  "status": "ACTIVE",
  "currency": "USD",
  "remote_updated_at": "2020-03-31T00:00:00Z",
  "addresses": [
    "2f2702aa-8948-492b-a412-2acdf6d2c499",
    "d98c7428-8dda-48a8-a1da-c570f65e2375"
  ],
  "phone_numbers": [
    {
      "number": "+3198675309",
      "type": "Mobile"
    }
  ]
}

GET

/contacts

Returns a list of Contact objects.


Query & Path Parameters


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

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

cursorString
Optional
The pagination cursor value.

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "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": "pickleball@merge.dev",
      "tax_number": "12-3456789",
      "status": "ACTIVE",
      "currency": "USD",
      "remote_updated_at": "2020-03-31T00:00:00Z",
      "addresses": [
        "2f2702aa-8948-492b-a412-2acdf6d2c499",
        "d98c7428-8dda-48a8-a1da-c570f65e2375"
      ],
      "phone_numbers": [
        {
          "number": "+3198675309",
          "type": "Mobile"
        }
      ]
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_supplierBoolean

remote_updated_atString

remote_dataRemoteData[]

tax_numberString

is_customerBoolean

email_addressString

statusEnum

currencyString

nameString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_supplierBoolean

remote_updated_atString

remote_dataRemoteData[]

tax_numberString

is_customerBoolean

email_addressString

currencyString

nameString

remote_idString
GET

/contacts/{id}

Returns a Contact object with the given id.


Query & Path Parameters


idString
Required

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

Response

{
  "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": "pickleball@merge.dev",
  "tax_number": "12-3456789",
  "status": "ACTIVE",
  "currency": "USD",
  "remote_updated_at": "2020-03-31T00:00:00Z",
  "addresses": [
    "2f2702aa-8948-492b-a412-2acdf6d2c499",
    "d98c7428-8dda-48a8-a1da-c570f65e2375"
  ],
  "phone_numbers": [
    {
      "number": "+3198675309",
      "type": "Mobile"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_supplierBoolean

remote_updated_atString

remote_dataRemoteData[]

tax_numberString

is_customerBoolean

email_addressString

statusEnum

currencyString

nameString

remote_idString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_supplierBoolean

remote_updated_atString

remote_dataRemoteData[]

tax_numberString

is_customerBoolean

email_addressString

currencyString

nameString

remote_idString