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