Merge · Schema

Employee

# The Employee Object ### Description An `Employee` is an individual who works for the company of the linked account. The `Employee` model contains both contractors and full time employees. * An `Employee` is a contractor if `is_contractor` property is `True` * An `Employee` is a full time employee if `is_contractor` property is `False` ### Usage Example Fetch from the `LIST Employees` endpoint and view a company's employees.

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.
first_name	stringnull	The employee's first name.
last_name	stringnull	The employee's last name.
is_contractor	booleannull	`True` if the employee is a contractor, `False` if not.
employee_number	stringnull	The employee's internal identification number.
email_address	stringnull	The employee's email address.
company	stringnull	The subsidiary that the employee belongs to.
status	object	The employee's status in the accounting system.
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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Employee",
  "title": "Employee",
  "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."
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employee's first name."
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employee's last name."
    },
    "is_contractor": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "`True` if the employee is a contractor, `False` if not."
    },
    "employee_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employee's internal identification number."
    },
    "email_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "The employee's email address."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The subsidiary that the employee belongs to."
    },
    "status": {
      "$ref": "#/components/schemas/Status895Enum",
      "description": "The employee's status in the accounting system."
    },
    "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/EmployeeFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "required": [
    "status"
  ],
  "description": "# The Employee Object\n### Description\nAn `Employee` is an individual who works for the company of the linked account. The `Employee` model contains both contractors and full time employees.\n* An `Employee` is a contractor if `is_contractor` property is `True`\n* An `Employee` is a full time employee if `is_contractor` property is `False`\n\n### Usage Example\nFetch from the `LIST Employees` endpoint and view a company's employees."
}