Employees

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
Properties

statusEnum
The employee's status in the accounting system. Possible values include: ACTIVE, INACTIVE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

idUUID

remote_idString
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.

first_nameString
The employee's first name.

last_nameString
The employee's last name.

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

employee_numberString
The employee's internal identification number.

email_addressString
The employee's email address.

companyUUID
The subsidiary that the employee belongs to.

remote_was_deletedBoolean
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

remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties

pathString
The third-party API path that is being called.

dataAny
The data returned from the third-party for this object in its original, unnormalized format.


GET
/employees
Beta

https://api.merge.dev/api/accounting/v1/employees

US
EU
APAC

Returns a list of Employee objects.


Query & path parameters

company_idString
Optional
If provided, will only return employees for this company.

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
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.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
FreeAgent
FreeAgent
Unsupported by API provider
GET
/employees/{id}
Beta

https://api.merge.dev/api/accounting/v1/employees/{id}

US
EU
APAC

Returns an Employee object with the given id.


Query & path parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Sage Intacct
Sage Intacct
Xero
Xero
FreeAgent
FreeAgent
Unsupported by API provider