UKG Ready
Common Model Sync Frequencies
Accessed third-party endpoints
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 TimesheetEntry information
TimesheetEntry 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
bank_nameString
remote_dataArray
account_numberString
routing_numberString
account_typeEnum
GET/lookup/benefit-plans
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
nameString
remote_dataArray
descriptionString
remote_idString
GET/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString
end_dateDateTime (ISO 8601)
employer_benefitUUID
remote_dataArray
start_dateDateTime (ISO 8601)
employeeUUID
Access Dependent information
Dependent fields
remote_dataArray
employeeUUID
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
last_nameString
date_of_birthDateTime (ISO 8601)
relationshipEnum
first_nameString
GET/employees/{employee_account_id}/time-entries
Merge interacts with this API endpoint to...
Access TimesheetEntry information
TimesheetEntry fields
remote_idString
end_timeDateTime (ISO 8601)
start_timeDateTime (ISO 8601)
hours_workedNumber
remote_dataUnknown
GET/compensation/history
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
effective_dateDateTime (ISO 8601)
remote_idString
remote_dataArray
pay_rateNumber
pay_periodEnum
pay_currencyEnum
employeeUUID
GET/employees/{employee_id}/profiles
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_groupUUID
GET/employees/{employee_id}
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2String
phone_numberString
countryEnum
remote_dataArray
cityString
stateString
street_1String
zip_codeString
Access Employee information
Employee fields
remote_idString
last_nameString
managerUUID
date_of_birthDateTime (ISO 8601)
employment_statusEnum
home_locationUUID
personal_emailString
termination_dateDateTime (ISO 8601)
mobile_phone_numberString
start_dateDateTime (ISO 8601)
preferred_nameString
teamUUID
employee_numberString
companyUUID
ssnString
avatarString
first_nameString
work_emailString
GET/employees/{employee_id}/hr-custom-fields
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
remote_dataArray
GET/employees/{employee_id}/loa/requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
remote_idString
end_timeDateTime (ISO 8601)
start_timeDateTime (ISO 8601)
approverUUID
statusEnum
employeeUUID
GET/employees/{employee_id}/loa/counters
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
usedNumber
remote_dataArray
balanceNumber
remote_idString
GET/lookup/eins
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_idString
remote_dataArray
legal_nameString
einsArray
display_nameString
GET/employees/{employee_id}/demographics
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
genderEnum
ethnicityEnum
remote_dataArray
GET/employees/{id}/pay-info
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArray
job_titleString
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/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
remote_idString
run_typeEnum
end_dateDateTime (ISO 8601)
run_stateEnum
start_dateDateTime (ISO 8601)
check_dateDateTime (ISO 8601)
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
end_dateDateTime (ISO 8601)
remote_dataArray
start_dateDateTime (ISO 8601)
employeeUUID
check_dateDateTime (ISO 8601)
Access Deduction information
Deduction fields
nameString
remote_dataArray
employee_payroll_runUUID
Access Earning information
Earning fields
employee_payroll_runUUID
typeEnum
amountNumber
GET/config/cost-centers
Merge interacts with this API endpoint to...
Access Team information
Team fields
nameString
remote_dataArray
parent_teamUUID
remote_idString
Access Group information
Group fields
nameString
parent_groupUUID
remote_idString
GET/config/cost-centers/{cost_center_id}
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArray