UKG Pro
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with UKG Pro API endpoints to access certain information as detailed below.
API Endpoints
GETpersonnel/v1/open-enrollment-emp-deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
start_dateDateTime (ISO 8601)
company_contributionNumber
employee_contributionNumber
end_dateDateTime (ISO 8601)
employeeUUID
GET/configuration/v1/deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
benefit_plan_typeString
remote_dataArray
remote_idString
provider_nameString
GET/configuration/v1/org-levels
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArray
remote_idString
nameString
typeEnum
Access Team information
Team fields
remote_dataArray
remote_idString
nameString
GET/personnel/v1/employee-job-history-details
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArray
remote_idString
effective_dateDateTime (ISO 8601)
employment_typeEnum
pay_frequencyEnum
flsa_statusEnum
pay_periodEnum
GET/personnel/v1/compensation-details
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_idString
pay_group_nameString
Access Employment information
Employment fields
remote_dataArray
pay_currencyEnum
GET/payroll/v1/pay-register
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
start_dateDateTime (ISO 8601)
remote_idString
end_dateDateTime (ISO 8601)
run_typeEnum
check_dateDateTime (ISO 8601)
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray
start_dateDateTime (ISO 8601)
payroll_runUUID
remote_idString
gross_payNumber
end_dateDateTime (ISO 8601)
employeeUUID
check_dateDateTime (ISO 8601)
net_payNumber
Access Earning information
Earning fields
employee_payroll_runUUID
Access Deduction information
Deduction fields
employee_payroll_runUUID
Access Tax information
Tax fields
employee_payroll_runUUID
GET/payroll/v1/employees/pay-statement/{pay_statement_id}
Merge interacts with this API endpoint to...
Access Earning information
Earning fields
remote_dataArray
amountNumber
remote_idString
typeEnum
Access Deduction information
Deduction fields
remote_dataArray
company_deductionNumber
employee_deductionNumber
remote_idString
nameString
Access Tax information
Tax fields
remote_dataArray
amountNumber
nameString
remote_idString
GETpayroll/v1/direct-deposit
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
remote_dataArray
remote_idString
bank_nameString
account_typeEnum
routing_numberString
employeeUUID
account_numberString
GET/configuration/v1/company-details
Merge interacts with this API endpoint to...
Access Company information
Company fields
legal_nameString
remote_idString
display_nameString
remote_dataArray
GET/personnel/v1/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
cityString
street_1String
remote_idString
countryEnum
phone_numberString
stateString
zip_codeString
street_2String
Access Employee information
Employee fields
last_nameString
remote_dataArray
preferred_nameString
ssnString
work_emailString
mobile_phone_numberString
companyUUID
remote_idString
date_of_birthDateTime (ISO 8601)
personal_emailString
first_nameString
marital_statusEnum
display_full_nameString
genderEnum
ethnicityEnum
GET/personnel/v1/employment-details
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
managerUUID
start_dateDateTime (ISO 8601)
employee_numberString
remote_idString
employment_statusEnum
work_locationUUID
pay_groupUUID
Access Employment information
Employment fields
effective_dateDateTime (ISO 8601)
GET/personnel/v1/companies/{companyId}/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
cityString
street_1String
remote_idString
countryEnum
phone_numberString
stateString
zip_codeString
street_2String
Access Employee information
Employee fields
last_nameString
ssnString
work_emailString
remote_created_atDateTime (ISO 8601)
remote_idString
date_of_birthDateTime (ISO 8601)
first_nameString
display_full_nameString
genderEnum
home_locationUUID
Access Employment information
Employment fields
employeeUUID
GET/personnel/v1/pto-plans
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
remote_dataArray
usedNumber
policy_typeEnum
balanceNumber
employeeUUID
GET/configuration/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_dataArray
cityString
street_1String
street_2String
remote_idString
countryEnum
stateString
zip_codeString
nameString