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