Merge · Schema

Contact

# The Contact Object ### Description 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. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company's contacts.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
name	stringnull	The contact's name.
is_supplier	booleannull	Whether the contact is a supplier.
is_customer	booleannull	Whether the contact is a customer.
email_address	stringnull	The contact's email address.
tax_number	stringnull	The contact's tax number.
status	object	The contact's status
currency	stringnull	The currency the contact's transactions are in.
remote_updated_at	stringnull	When the third party's contact was updated.
company	stringnull	The company the contact belongs to.
addresses	array	`Address` object IDs for the given `Contacts` object.
phone_numbers	array	`AccountingPhoneNumber` object for the given `Contacts` object.
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Contact",
  "title": "Contact",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's name."
    },
    "is_supplier": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the contact is a supplier."
    },
    "is_customer": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the contact is a customer."
    },
    "email_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's email address."
    },
    "tax_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The contact's tax number."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Status7d1Enum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The contact's status"
    },
    "currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "The currency the contact's transactions are in."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's contact was updated."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the contact belongs to."
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Address"
      },
      "description": "`Address` object IDs for the given `Contacts` object."
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountingPhoneNumber"
      },
      "description": "`AccountingPhoneNumber` object for the given `Contacts` object."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ContactFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "description": "# The Contact Object\n### Description\nA `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.\n* A `Contact` is a Vendor/Supplier if the `is_supplier` property is true.\n* A `Contact` is a customer if the `is_customer` property is true.\n\n### Usage Example\nFetch from the `LIST Contacts` endpoint and view a company's contacts."
}