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