
UKG Pro
Merge interacts with UKG Pro API endpoints to access certain information as detailed below.
API Endpoints
GET/personnel/v1/employment-details
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
work_location
UUIDteam
UUIDemployee_number
Stringpay_group
UUIDemployment_status
Enumremote_id
Stringmanager
UUIDtermination_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)remote_data
ArrayAccess Employment information
Employment fields
effective_date
DateTime (ISO 8601)GETpersonnel/v1/open-enrollment-emp-deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
end_date
DateTime (ISO 8601)company_contribution
Numberstart_date
DateTime (ISO 8601)employee
UUIDemployee_contribution
NumberAccess PayrollRun information
PayrollRun fields
run_type
Enumcheck_date
DateTime (ISO 8601)remote_id
Stringend_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)Access EmployeePayrollRun information
EmployeePayrollRun fields
payroll_run
UUIDremote_id
Stringgross_pay
Numbernet_pay
Numberend_date
DateTime (ISO 8601)check_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)remote_data
Arrayemployee
UUIDAccess Earning information
Earning fields
employee_payroll_run
UUIDAccess Deduction information
Deduction fields
employee_payroll_run
UUIDAccess Tax information
Tax fields
employee_payroll_run
UUIDGET/configuration/v1/deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_data
Arrayremote_id
Stringprovider_name
Stringbenefit_plan_type
StringGET/personnel/v1/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
phone_number
Stringcountry
Enumcity
Stringremote_id
Stringzip_code
Stringstreet_2
Stringstate
Stringstreet_1
StringAccess Employee information
Employee fields
work_email
Stringcompany
UUIDdate_of_birth
DateTime (ISO 8601)display_full_name
Stringremote_id
Stringfirst_name
Stringremote_data
Arraypersonal_email
Stringpreferred_name
Stringmobile_phone_number
Stringssn
Stringethnicity
Enumlast_name
Stringgender
Enummarital_status
EnumGET/payroll/v1/employees/pay-statement/{pay_statement_id}
Merge interacts with this API endpoint to...
Access Earning information
Earning fields
remote_data
Arrayamount
Numbertype
Enumremote_id
StringAccess Deduction information
Deduction fields
remote_id
Stringname
Stringcompany_deduction
Numberremote_data
Arrayemployee_deduction
NumberAccess Tax information
Tax fields
remote_data
Arrayname
Stringamount
Numberremote_id
StringGET/personnel/v1/companies/{companyId}/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
phone_number
Stringcountry
Enumcity
Stringremote_id
Stringzip_code
Stringstreet_2
Stringstate
Stringstreet_1
StringAccess Employee information
Employee fields
work_email
Stringdate_of_birth
DateTime (ISO 8601)display_full_name
Stringremote_created_at
DateTime (ISO 8601)first_name
Stringremote_id
Stringssn
Stringlast_name
Stringgender
Enumhome_location
UUIDAccess Employment information
Employment fields
employee
UUIDGET/configuration/v1/company-details
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_data
Arrayremote_id
Stringdisplay_name
Stringlegal_name
StringGET/personnel/v1/pto-plans
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
policy_type
Enumbalance
Numberused
Numberremote_data
Arrayemployee
UUIDGET/configuration/v1/org-levels
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_data
Arrayname
Stringtype
Enumremote_id
StringAccess Team information
Team fields
remote_data
Arrayname
Stringremote_id
StringGET/configuration/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
country
Enumcity
Stringremote_id
Stringzip_code
Stringname
Stringstreet_2
Stringstate
Stringremote_data
Arraystreet_1
StringGET/personnel/v1/employee-job-history-details
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
employment_type
Enumpay_period
Enumpay_frequency
Enumremote_id
Stringflsa_status
Enumremote_data
Arrayeffective_date
DateTime (ISO 8601)GET/personnel/v1/compensation-details
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_id
Stringpay_group_name
StringAccess Employment information
Employment fields
remote_data
Arraypay_currency
EnumGETpayroll/v1/direct-deposit
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
bank_name
Stringaccount_type
Enumaccount_number
Stringremote_id
Stringremote_data
Arrayrouting_number
Stringemployee
UUID