Skip to navigation

The Employee object

Beta

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.
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.
employee_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the employee.
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