
UKG Pro
Third-Party Data Provider Interactions
Merge interacts with UKG Pro API endpoints to access certain information as detailed belowAPI Endpoints
GET/personnel/v1/companies/{companyId}/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_id
Stringcountry
Enumcity
Stringzip_code
Stringstreet_2
Stringstate
Stringphone_number
Stringstreet_1
StringAccess Employee information
Employee fields
remote_id
Stringgender
Enumdisplay_full_name
Stringwork_email
Stringdate_of_birth
DateTime (ISO 8601)ssn
Stringfirst_name
Stringremote_created_at
DateTime (ISO 8601)last_name
Stringhome_location
UUIDAccess Employment information
Employment fields
employee
UUIDGET/personnel/v1/employment-details
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
remote_id
Stringremote_data
Arraymanager
UUIDemployee_number
Stringtermination_date
DateTime (ISO 8601)employment_status
Enumpay_group
UUIDwork_location
UUIDteam
UUIDstart_date
DateTime (ISO 8601)Access Employment information
Employment fields
job_title
Stringremote_id
Stringeffective_date
DateTime (ISO 8601)remote_data
Arraypay_currency
Enumemployee
UUIDemployment_type
EnumGET/configuration/v1/org-levels
Merge interacts with this API endpoint to...
Access Group information
Group fields
type
Enumremote_data
Arrayname
Stringremote_id
StringAccess Team information
Team fields
remote_id
Stringremote_data
Arrayname
StringGET/personnel/v1/person-details
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_id
Stringcountry
Enumcity
Stringremote_data
Arrayzip_code
Stringstreet_2
Stringstate
Stringphone_number
Stringstreet_1
StringAccess Employee information
Employee fields
remote_id
Stringgender
Enumremote_data
Arraymarital_status
Enumdisplay_full_name
Stringwork_email
Stringdate_of_birth
DateTime (ISO 8601)personal_email
Stringssn
Stringfirst_name
Stringcompany
UUIDmobile_phone_number
Stringethnicity
Enumlast_name
Stringpreferred_name
StringGET/personnel/v1/pto-plans
Merge interacts with this API endpoint to...
Access TimeOffBalance information
TimeOffBalance fields
remote_data
Arraybalance
Numberemployee
UUIDused
Numberpolicy_type
EnumGETpayroll/v1/direct-deposit
Merge interacts with this API endpoint to...
Access BankInfo information
BankInfo fields
remote_id
Stringrouting_number
Stringremote_data
Arrayaccount_type
Enumbank_name
Stringaccount_number
Stringemployee
UUIDGETpersonnel/v1/open-enrollment-emp-deductions
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
employee_contribution
Numbercompany_contribution
Numberend_date
DateTime (ISO 8601)employee
UUIDstart_date
DateTime (ISO 8601)Access PayrollRun information
PayrollRun fields
remote_id
Stringcheck_date
DateTime (ISO 8601)end_date
DateTime (ISO 8601)start_date
DateTime (ISO 8601)run_type
EnumAccess EmployeePayrollRun information
EmployeePayrollRun fields
remote_id
Stringremote_data
Arraypayroll_run
UUIDcheck_date
DateTime (ISO 8601)gross_pay
Numberend_date
DateTime (ISO 8601)employee
UUIDstart_date
DateTime (ISO 8601)net_pay
NumberAccess 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
benefit_plan_type
Stringremote_id
Stringremote_data
Arrayprovider_name
StringGET/personnel/v1/employee-job-history-details
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_period
Enumpay_rate
Numberpay_frequency
Enumflsa_status
EnumGET/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_id
Stringremote_data
Arraypay_currency
EnumGET/payroll/v1/employees/pay-statement/{pay_statement_id}
Merge interacts with this API endpoint to...
Access Deduction information
Deduction fields
remote_id
Stringremote_data
Arrayname
Stringemployee_deduction
Numbercompany_deduction
NumberAccess Tax information
Tax fields
amount
Numberremote_data
Arrayname
Stringremote_id
StringGET/configuration/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_id
Stringcountry
Enumcity
Stringname
Stringremote_data
Arrayzip_code
Stringstreet_2
Stringstate
Stringstreet_1
StringGET/configuration/v1/company-details
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_id
Stringremote_data
Arraydisplay_name
Stringlegal_name
String