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
account_numberString

bank_nameString

remote_dataArray

routing_numberString

account_typeEnum
GET/lookup/benefit-plans
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
nameString

descriptionString

remote_idString

remote_dataArray
GET/employees/{employee_id}
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_1String

zip_codeString

remote_dataArray

phone_numberString

street_2String

stateString

cityString

countryEnum
Access Employee information
Employee fields
employment_statusEnum

work_emailString

avatarString

date_of_birthDateTime (ISO 8601)

companyUUID

remote_idString

first_nameString

start_dateDateTime (ISO 8601)

last_nameString

home_locationUUID

preferred_nameString

termination_dateDateTime (ISO 8601)

ssnString

employee_numberString

mobile_phone_numberString

teamUUID

managerUUID

personal_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
start_timeDateTime (ISO 8601)

remote_idString

statusEnum

employeeUUID

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_idString

balanceNumber

remote_dataArray
GET/lookup/eins
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_nameString

remote_idString

remote_dataArray

legal_nameString

einsArray
GET/employees/{id}/pay-info
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
job_titleString

remote_dataArray
GET/compensation/history
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
effective_dateDateTime (ISO 8601)

remote_idString

remote_dataArray

employeeUUID

pay_rateNumber

pay_periodEnum

pay_currencyEnum
GET/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
end_dateDateTime (ISO 8601)

remote_idString

start_dateDateTime (ISO 8601)

check_dateDateTime (ISO 8601)

run_typeEnum

run_stateEnum
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

start_dateDateTime (ISO 8601)

check_dateDateTime (ISO 8601)
Access Deduction information
Deduction fields
employee_payroll_runUUID

nameString

remote_dataArray
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
nameString

parent_teamUUID

remote_idString

remote_dataArray
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
start_timeDateTime (ISO 8601)

remote_idString

remote_dataArray

end_timeDateTime (ISO 8601)

hours_workedNumber
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
end_dateDateTime (ISO 8601)

remote_idString

remote_dataArray

employeeUUID

start_dateDateTime (ISO 8601)

employer_benefitUUID
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
relationshipEnum

date_of_birthDateTime (ISO 8601)

remote_idString

first_nameString

last_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
GET/employees/{employee_id}/profiles
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_groupUUID