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