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