Common ModelsEmployees

The Employee object

The Employee object is used to represent any person who has been employed by a company. By default, it returns all employees. To filter for only active employees, set the employment_status query parameter to ACTIVE.

statusenumRequired

The employee’s status in the accounting system.

  • ACTIVE - ACTIVE
  • INACTIVE - INACTIVE
Allowed values:
idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
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_deletedbooleanOptional

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 nullOptional
remote_datalist of objects or nullOptional