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