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