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_idString
remote_dataArray
run_stateEnum
Access EmployeePayrollRun information
EmployeePayrollRun fields
net_payNumber
remote_dataArray
payroll_runUUID
employeeUUID
Access Earning information
Earning fields
remote_dataArray
employee_payroll_runUUID
amountNumber
Access Tax information
Tax fields
remote_dataArray
employee_payroll_runUUID
amountNumber
GET/v1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_idString
remote_dataArray
nameString
GET/v1/company
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_idString
remote_dataArray
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
remote_dataArray
amountNumber
statusEnum
remote_idString
start_timeDateTime (ISO 8601)
end_timeDateTime (ISO 8601)
employee_noteString
employeeUUID
request_typeEnum
GET/v1/engagements
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString
remote_dataArray
provider_nameString
employeeUUID
Access Location information
Location fields
zip_codeString
remote_dataArray
street_1String
stateString
cityString
countryEnum
street_2String
remote_idString
Access Employment information
Employment fields
employment_typeEnum
remote_dataArray
job_titleString
pay_rateNumber
pay_currencyEnum
employeeUUID
Access Employee information
Employee fields
date_of_birthDateTime (ISO 8601)
remote_dataArray
work_emailString
mobile_phone_numberString
remote_idString
employment_statusEnum
start_dateDateTime (ISO 8601)
display_full_nameString
last_nameString
first_nameString