UKG Ready
Human Resource Information System (HRIS)
Third-Party Data Provider Interactions
Common Model Sync Frequencies
Third-Party Data Provider Interactions
Merge interacts with UKG Ready API endpoints to access certain information as detailed below
API Endpoints
GET/employees
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
employeeUUID
Access TimeOffBalance information
TimeOffBalance fields
employeeUUID
Access Employee information
Employee fields
remote_idString
GET/employees/{employee_account_id}/direct-deposits
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
routing_numberString
remote_dataArray
account_typeEnum
bank_nameString
account_numberString
GET/lookup/benefit-plans
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
remote_idString
remote_dataArray
nameString
descriptionString
GET/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
run_stateEnum
remote_idString
check_dateDateTime (ISO 8601)
end_dateDateTime (ISO 8601)
start_dateDateTime (ISO 8601)
run_typeEnum
Access EmployeePayrollRun information
EmployeePayrollRun fields
payroll_runUUID
GETpay-periods
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
remote_dataArray
GET/payrolls/{payroll_id}/pay-statements/{pay_statement_id}
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_idString
remote_dataArray
check_dateDateTime (ISO 8601)
end_dateDateTime (ISO 8601)
employeeUUID
start_dateDateTime (ISO 8601)
Access Deduction information
Deduction fields
employee_payroll_runUUID
remote_dataArray
nameString
Access Earning information
Earning fields
amountNumber
typeEnum
employee_payroll_runUUID
GET/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString
remote_dataArray
employer_benefitUUID
end_dateDateTime (ISO 8601)
employeeUUID
start_dateDateTime (ISO 8601)
Access Dependent information
Dependent fields
employeeUUID
remote_dataArray
GET/benefits/{benefit_id}
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
company_contributionNumber
employee_contributionNumber
Access Dependent information
Dependent fields
remote_idString
date_of_birthDateTime (ISO 8601)
first_nameString
last_nameString
relationshipEnum
GET/compensation/history
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_rateNumber
remote_idString
remote_dataArray
effective_dateDateTime (ISO 8601)
pay_currencyEnum
employeeUUID
pay_periodEnum
GET/employees/{employee_id}/profiles
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_groupUUID
GET/employees/{id}/pay-info
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
job_titleString
remote_dataArray
GET/config/cost-centers
Merge interacts with this API endpoint to...
Access Team information
Team fields
remote_idString
parent_teamUUID
nameString
remote_dataArray
Access Group information
Group fields
remote_idString
nameString
parent_groupUUID
GET/config/cost-centers/{cost_center_id}
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArray
GET/employees/{employee_id}/loa/requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
end_timeDateTime (ISO 8601)
approverUUID
remote_idString
start_timeDateTime (ISO 8601)
employeeUUID
statusEnum
GET/employees/{employee_id}/loa/counters
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
remote_idString
usedNumber
remote_dataArray
balanceNumber
GET/lookup/eins
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_idString
remote_dataArray
display_nameString
einsArray
legal_nameString
GET/employees/{employee_id}/demographics
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
ethnicityEnum
genderEnum
remote_dataArray
GET/lookup/pay-period-profiles
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_idString
pay_group_nameString
remote_dataArray
GET/employees/{employee_id}
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnum
cityString
remote_dataArray
zip_codeString
street_2String
stateString
phone_numberString
street_1String
Access Employee information
Employee fields
remote_idString
avatarString
work_emailString
preferred_nameString
employee_numberString
termination_dateDateTime (ISO 8601)
managerUUID
date_of_birthDateTime (ISO 8601)
personal_emailString
employment_statusEnum
first_nameString
teamUUID
ssnString
companyUUID
mobile_phone_numberString
start_dateDateTime (ISO 8601)
last_nameString
home_locationUUID
GET/employees/{employee_id}/hr-custom-fields
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
remote_dataArray