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