UKG Pro
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_2
Stringphone_number
Stringstreet_1
Stringzip_code
Stringremote_id
Stringcity
Stringcountry
Enumstate
StringAccess Employee information
Employee fields
first_name
Stringlast_name
Stringssn
Stringremote_created_at
DateTime (ISO 8601)home_location
UUIDdate_of_birth
DateTime (ISO 8601)remote_id
Stringdisplay_full_name
Stringwork_email
Stringgender
EnumAccess Employment information
Employment fields
employee
UUIDGET/personnel/v1/employment-details
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
work_location
UUIDtermination_date
DateTime (ISO 8601)pay_group
UUIDstart_date
DateTime (ISO 8601)employee_number
Stringremote_id
Stringremote_data
Arrayteam
UUIDemployment_status
Enummanager
UUIDAccess Employment information
Employment fields
pay_currency
Enumjob_title
Stringeffective_date
DateTime (ISO 8601)remote_id
Stringremote_data
Arrayemployee
UUIDGET/configuration/v1/company-details
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_name
Stringlegal_name
Stringremote_id
Stringremote_data
ArrayGET/personnel/v1/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2
Stringphone_number
Stringstreet_1
Stringzip_code
Stringremote_id
Stringcity
Stringremote_data
Arraycountry
Enumstate
StringAccess Employee information
Employee fields
first_name
Stringlast_name
Stringssn
Stringcompany
UUIDmarital_status
Enummobile_phone_number
Stringpersonal_email
Stringdate_of_birth
DateTime (ISO 8601)remote_id
Stringdisplay_full_name
Stringremote_data
Arraypreferred_name
Stringwork_email
Stringethnicity
Enumgender
EnumGETpersonnel/v1/open-enrollment-emp-deductions
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
start_date
DateTime (ISO 8601)run_type
Enumcheck_date
DateTime (ISO 8601)remote_id
Stringend_date
DateTime (ISO 8601)Access EmployeePayrollRun information
EmployeePayrollRun fields
gross_pay
Numberstart_date
DateTime (ISO 8601)check_date
DateTime (ISO 8601)payroll_run
UUIDremote_id
Stringremote_data
Arrayend_date
DateTime (ISO 8601)net_pay
Numberemployee
UUIDAccess Earning information
Earning fields
employee_payroll_run
UUIDAccess Deduction information
Deduction fields
employee_payroll_run
UUIDAccess Tax information
Tax fields
employee_payroll_run
UUIDAccess Benefit information
Benefit fields
start_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)employee_contribution
Numbercompany_contribution
Numberemployee
UUIDGET/payroll/v1/employees/pay-statement/{pay_statement_id}
Merge interacts with this API endpoint to...
Access Earning information
Earning fields
type
Enumremote_data
Arrayremote_id
Stringamount
NumberAccess Deduction information
Deduction fields
company_deduction
Numberremote_id
Stringremote_data
Arrayname
Stringemployee_deduction
NumberAccess Tax information
Tax fields
remote_data
Arrayremote_id
Stringname
Stringamount
NumberGET/personnel/v1/compensation-details
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
pay_group_name
Stringremote_id
StringAccess Employment information
Employment fields
pay_currency
Enumremote_id
Stringremote_data
ArrayGETpayroll/v1/direct-deposit
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
routing_number
Stringremote_id
Stringremote_data
Arrayaccount_number
Stringbank_name
Stringaccount_type
Enumemployee
UUIDGET/configuration/v1/deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
benefit_plan_type
Stringprovider_name
Stringremote_id
Stringremote_data
ArrayGET/personnel/v1/employee-job-history-details
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_frequency
Enumflsa_status
Enumemployment_type
Enumpay_period
Enumpay_rate
NumberGET/personnel/v1/pto-plans
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
used
Numberpolicy_type
Enumbalance
Numberremote_data
Arrayemployee
UUIDGET/configuration/v1/org-levels
Merge interacts with this API endpoint to...
Access Group information
Group fields
type
Enumremote_id
Stringname
Stringremote_data
ArrayAccess Team information
Team fields
remote_id
Stringname
Stringremote_data
ArrayGET/configuration/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_2
Stringstreet_1
Stringzip_code
Stringremote_id
Stringcity
Stringremote_data
Arrayname
Stringcountry
Enumstate
String