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