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_2String

phone_numberString

street_1String

zip_codeString

remote_idString

cityString

countryEnum

stateString
Access Employee information
Employee fields
first_nameString

last_nameString

ssnString

remote_created_atDateTime (ISO 8601)

home_locationUUID

date_of_birthDateTime (ISO 8601)

remote_idString

display_full_nameString

work_emailString

genderEnum
Access Employment information
Employment fields
employeeUUID
GET/personnel/v1/employment-details
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
work_locationUUID

termination_dateDateTime (ISO 8601)

pay_groupUUID

start_dateDateTime (ISO 8601)

employee_numberString

remote_idString

remote_dataArray

teamUUID

employment_statusEnum

managerUUID
Access Employment information
Employment fields
pay_currencyEnum

job_titleString

effective_dateDateTime (ISO 8601)

remote_idString

remote_dataArray

employeeUUID
GET/configuration/v1/company-details
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_nameString

legal_nameString

remote_idString

remote_dataArray
GET/personnel/v1/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2String

phone_numberString

street_1String

zip_codeString

remote_idString

cityString

remote_dataArray

countryEnum

stateString
Access Employee information
Employee fields
first_nameString

last_nameString

ssnString

companyUUID

marital_statusEnum

mobile_phone_numberString

personal_emailString

date_of_birthDateTime (ISO 8601)

remote_idString

display_full_nameString

remote_dataArray

preferred_nameString

work_emailString

ethnicityEnum

genderEnum
GETpersonnel/v1/open-enrollment-emp-deductions
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
start_dateDateTime (ISO 8601)

run_typeEnum

check_dateDateTime (ISO 8601)

remote_idString

end_dateDateTime (ISO 8601)
Access EmployeePayrollRun information
EmployeePayrollRun fields
gross_payNumber

start_dateDateTime (ISO 8601)

check_dateDateTime (ISO 8601)

payroll_runUUID

remote_idString

remote_dataArray

end_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
Access Benefit information
Benefit fields
start_dateDateTime (ISO 8601)

end_dateDateTime (ISO 8601)

employee_contributionNumber

company_contributionNumber

employeeUUID
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
company_deductionNumber

remote_idString

remote_dataArray

nameString

employee_deductionNumber
Access Tax information
Tax fields
remote_dataArray

remote_idString

nameString

amountNumber
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_idString

remote_dataArray
GETpayroll/v1/direct-deposit
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
routing_numberString

remote_idString

remote_dataArray

account_numberString

bank_nameString

account_typeEnum

employeeUUID
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/personnel/v1/employee-job-history-details
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_frequencyEnum

flsa_statusEnum

employment_typeEnum

pay_periodEnum

pay_rateNumber
GET/personnel/v1/pto-plans
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
usedNumber

policy_typeEnum

balanceNumber

remote_dataArray

employeeUUID
GET/configuration/v1/org-levels
Merge interacts with this API endpoint to...
Access Group information
Group fields
typeEnum

remote_idString

nameString

remote_dataArray
Access Team information
Team fields
remote_idString

nameString

remote_dataArray
GET/configuration/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2String

street_1String

zip_codeString

remote_idString

cityString

remote_dataArray

nameString

countryEnum

stateString