Employment Hero
Beta
Merge interacts with Employment Hero API endpoints to access certain information as detailed below.
API Endpoints
GET/organisations
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_dataArrayremote_idStringdisplay_nameStringAccess Employee information
Employee fields
companyUUIDGET/organisations/{organisation_id}/teams
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArrayremote_idStringnameStringGET/organisations/{organisation_id}/employees
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnumnameStringAccess Employee information
Employee fields
last_nameStringremote_dataArraymanagerUUIDstart_dateDateTime (ISO 8601)work_emailStringpreferred_nameStringmobile_phone_numberStringremote_idStringdate_of_birthDateTime (ISO 8601)personal_emailStringfirst_nameStringavatarStringtermination_dateDateTime (ISO 8601)marital_statusEnumwork_locationUUIDdisplay_full_nameStringgenderEnumAccess Employment information
Employment fields
employeeUUIDAccess EmployeePayrollRun information
EmployeePayrollRun fields
employeeUUIDGET/organisations/{organisation_id}/employees/{employee_id}/employment_histories
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArrayremote_idStringjob_titleStringeffective_dateDateTime (ISO 8601)employment_typeEnumGET/organisations/{organisation_id}/employees/{employee_id}/payslips
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArraystart_dateDateTime (ISO 8601)remote_idStringend_dateDateTime (ISO 8601)net_payNumber