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