OysterHR
Human Resource Information System (HRIS)
Third-Party Data Provider Interactions
Common Model Sync Frequencies
Third-Party Data Provider Interactions
Merge interacts with OysterHR API endpoints to access certain information as detailed below
API Endpoints
GET/v0.1/time_off_requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
end_timeDateTime (ISO 8601)
remote_idString
start_timeDateTime (ISO 8601)
remote_dataArray
request_typeEnum
employeeUUID
statusEnum
employee_noteString
amountNumber
GET/v0.1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_idString
remote_dataArray
nameString
GET/v0.1/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/v0.1/engagements
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString
remote_dataArray
benefit_plan_typeString
employeeUUID
provider_nameString
Access Location information
Location fields
remote_idString
countryEnum
cityString
remote_dataArray
zip_codeString
street_2String
stateString
street_1String
Access Employment information
Employment fields
job_titleString
pay_rateNumber
remote_dataArray
pay_currencyEnum
employeeUUID
employment_typeEnum
Access Employee information
Employee fields
remote_idString
remote_dataArray
display_full_nameString
work_emailString
date_of_birthDateTime (ISO 8601)
employment_statusEnum
first_nameString
mobile_phone_numberString
start_dateDateTime (ISO 8601)
last_nameString
GET/v0.1/payroll
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
run_stateEnum
remote_idString
remote_dataArray
Access EmployeePayrollRun information
EmployeePayrollRun fields
employeeUUID
remote_dataArray
net_payNumber
payroll_runUUID
Access Earning information
Earning fields
employee_payroll_runUUID
amountNumber
remote_dataArray
Access Tax information
Tax fields
employee_payroll_runUUID
amountNumber
remote_dataArray