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 Employee information
Employee fields
remote_idString
Access TimeOffBalance information
TimeOffBalance fields
employeeUUID
GET/employees/{employee_account_id}/direct-deposits
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
bank_nameString
routing_numberString
account_typeEnum
remote_dataArray
account_numberString
GET/lookup/benefit-plans
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
nameString
remote_dataArray
remote_idString
descriptionString
GET/config/cost-centers
Merge interacts with this API endpoint to...
Access Team information
Team fields
nameString
remote_dataArray
remote_idString
parent_teamUUID
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
GET/employees/{employee_id}/demographics
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
remote_dataArray
ethnicityEnum
genderEnum
GET/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
end_dateDateTime (ISO 8601)
remote_dataArray
remote_idString
employeeUUID
employer_benefitUUID
start_dateDateTime (ISO 8601)
Access Dependent information
Dependent fields
remote_dataArray
employeeUUID
GET/benefits/{benefit_id}
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
employee_contributionNumber
company_contributionNumber
Access Dependent information
Dependent fields
date_of_birthDateTime (ISO 8601)
remote_idString
last_nameString
relationshipEnum
first_nameString
GET/lookup/pay-period-profiles
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_dataArray
remote_idString
pay_group_nameString
GET/compensation/history
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
effective_dateDateTime (ISO 8601)
job_titleString
remote_idString
remote_dataArray
employeeUUID
pay_rateNumber
pay_currencyEnum
pay_periodEnum
remote_data_pathUnknown
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
remote_dataArray
zip_codeString
street_2String
stateString
cityString
street_1String
phone_numberString
countryEnum
Access Employee information
Employee fields
teamUUID
personal_emailString
date_of_birthDateTime (ISO 8601)
mobile_phone_numberString
preferred_nameString
employment_statusEnum
home_locationUUID
last_nameString
termination_dateDateTime (ISO 8601)
work_emailString
managerUUID
start_dateDateTime (ISO 8601)
first_nameString
companyUUID
avatarString
employee_numberString
GET/employees/{employee_id}/hr-custom-fields
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
remote_dataArray
GET/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
run_stateEnum
end_dateDateTime (ISO 8601)
remote_idString
run_typeEnum
check_dateDateTime (ISO 8601)
start_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
end_dateDateTime (ISO 8601)
remote_idString
remote_dataArray
employeeUUID
check_dateDateTime (ISO 8601)
start_dateDateTime (ISO 8601)
Access Deduction information
Deduction fields
company_deductionNumber
remote_dataArray
remote_idString
employee_payroll_runUUID
nameString
employee_deductionNumber
Access Earning information
Earning fields
amountNumber
typeEnum
remote_idString
remote_dataArray
employee_payroll_runUUID
Access Tax information
Tax fields
amountNumber
remote_idString
remote_dataArray
employee_payroll_runUUID
nameString
GET/time-entries
Merge interacts with this API endpoint to...
Access TimesheetEntry information
TimesheetEntry fields
start_timeDateTime (ISO 8601)
remote_idString
remote_dataArray
employeeUUID
hours_workedNumber
end_timeDateTime (ISO 8601)
GET/employees/{employee_id}/loa/requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
start_timeDateTime (ISO 8601)
remote_idString
employeeUUID
statusEnum
end_timeDateTime (ISO 8601)
approverUUID
GET/employees/{employee_id}/loa/counters
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
usedNumber
remote_dataArray
remote_idString
balanceNumber
GET/lookup/eins
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_dataArray
remote_idString
display_nameString
einsArray
legal_nameString