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 Employee object
          • GET/employees
          • GET/employees/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEmployees

The Employee object

Beta
The Employee 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  "first_name": "string",
7  "last_name": "string",
8  "is_contractor": true,
9  "employee_number": "string",
10  "email_address": "string",
11  "company": "string",
12  "status": "ACTIVE",
13  "remote_was_deleted": true,
14  "field_mappings": {},
15  "remote_data": [
16    {
17      "path": "string",
18      "data": {}
19    }
20  ]
21}
Was this page helpful?
Previous

/credit-notes/meta/post

Next

/employees

Built with

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
statusenumRequired

The employee's status in the accounting system.

  • ACTIVE - ACTIVE
  • INACTIVE - INACTIVE
Allowed values:
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.
first_namestring or nullOptional<=255 characters
The employee's first name.
last_namestring or nullOptional<=255 characters
The employee's last name.
is_contractorboolean or nullOptional

True if the employee is a contractor, False if not.

employee_numberstring or nullOptional<=50 characters
The employee's internal identification number.
email_addressstring or nullOptional
The employee's email address.
companystring or nullOptionalformat: "uuid"
The subsidiary that the employee belongs to.
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