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