Employment Hero
Beta
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with Employment Hero API endpoints to access certain information as detailed below.
API Endpoints

GET/organisations/{organisation_id}/teams
Merge interacts with this API endpoint to...
Access Group information
Group fields
nameString

remote_idString

remote_dataArray
GET/organisations/{organisation_id}/employees
Merge interacts with this API endpoint to...
Access Location information
Location fields
nameString

countryEnum
Access Employee information
Employee fields
work_emailString

remote_dataArray

remote_idString

personal_emailString

genderEnum

termination_dateDateTime (ISO 8601)

marital_statusEnum

first_nameString

work_locationUUID

display_full_nameString

employment_statusEnum

mobile_phone_numberString

date_of_birthDateTime (ISO 8601)

last_nameString

start_dateDateTime (ISO 8601)

avatarString

managerUUID

preferred_nameString
Access Employment information
Employment fields
employeeUUID
Access EmployeePayrollRun information
EmployeePayrollRun fields
employeeUUID
GET/organisations
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
companyUUID
Access Company information
Company fields
display_nameString

remote_dataArray

remote_idString
GET/organisations/{organisation_id}/employees/{employee_id}/employment_histories
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArray

effective_dateDateTime (ISO 8601)

remote_idString

job_titleString

employment_typeEnum
GET/organisations/{organisation_id}/employees/{employee_id}/payslips
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray

remote_idString

end_dateDateTime (ISO 8601)

start_dateDateTime (ISO 8601)

net_payNumber