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
Employeeis a contractor ifis_contractorproperty isTrue - An
Employeeis a full time employee ifis_contractorproperty isFalse
Properties
statusEnumThe 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.idUUIDremote_idStringThe 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_nameStringThe employee's first name.
last_nameStringThe employee's last name.
is_contractorBooleanTrue if the employee is a contractor, False if not.employee_numberStringThe employee's internal identification number.
email_addressStringThe employee's email address.
companyUUIDThe subsidiary that the employee belongs to.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/employees
Betahttps://api.merge.dev/api/accounting/v1/employees
US
EU
APAC
Returns a list of Employee objects.
Query & path parameters
company_idStringOptional
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.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
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_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
first_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum
FreeAgent
GET
/employees/{id}
Betahttps://api.merge.dev/api/accounting/v1/employees/{id}
US
EU
APAC
Returns an Employee object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
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
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
email_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDemail_addressStringemployee_numberStringfirst_nameStringis_contractorBooleanlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
first_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumFreeAgent