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