OysterHR
Beta
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with OysterHR API endpoints to access certain information as detailed below.
API Endpoints
GET/v1/payroll
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
remote_dataArray
remote_idString
run_stateEnum
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray
net_payNumber
employeeUUID
payroll_runUUID
Access Earning information
Earning fields
amountNumber
remote_dataArray
employee_payroll_runUUID
Access Tax information
Tax fields
amountNumber
remote_dataArray
employee_payroll_runUUID
GET/v1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
nameString
remote_dataArray
remote_idString
GET/v1/company
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_dataArray
remote_idString
display_nameString
Access Employee information
Employee fields
companyUUID
GET/v1/time_off/requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
amountNumber
employee_noteString
start_timeDateTime (ISO 8601)
remote_idString
remote_dataArray
employeeUUID
end_timeDateTime (ISO 8601)
request_typeEnum
statusEnum
GET/v1/engagements
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_dataArray
remote_idString
employeeUUID
provider_nameString
Access Location information
Location fields
remote_idString
zip_codeString
remote_dataArray
street_2String
stateString
cityString
street_1String
countryEnum
Access Employment information
Employment fields
job_titleString
remote_dataArray
employeeUUID
employment_typeEnum
pay_rateNumber
pay_currencyEnum
Access Employee information
Employee fields
mobile_phone_numberString
date_of_birthDateTime (ISO 8601)
remote_idString
remote_dataArray
employment_statusEnum
last_nameString
start_dateDateTime (ISO 8601)
first_nameString
work_emailString
display_full_nameString