Version History
The Version history catalogues the API resources and operations added in each release.
August 2022
The following operations were added to the API in August 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Employee Security User Details | Retrieve Employee Security User Details | GET | /personnel/v1/employee-security-user-details |
| Personnel | Employee Extended Elements | Retrieve Employee Extended Elements | GET | /personnel/v1/employee-extended-elements |
| Payroll | Earnings History Base Elements | Retrieve Earnings History Base Elements | GET | /payroll/v1/earnings-history-base-elements |
July 2022
The following operations were added to the API in July 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Configuration | Benefits Reductions | Retrieve Benefit Reductions | GET | /configuration/v1/benefit-reduction |
| Configuration | Insurance Rate | Retrieve Insurance Rate | GET | /configuration/v1/insurance-rate |
| Configuration | Option Rate | Retrieve Option Rate | GET | /configuration/v1/option-rate |
| Configuration | Positions | Retrieve Positions | GET | /configuration/v1/positions |
| Configuration | Roles | Retrieve Roles | GET | /configuration/v1/roles |
| Configuration | Shift Codes | Retrieve Shift Codes | GET | /configuration/v1/shift-codes |
| Payroll | Earnings History Base Elements | Retrieve Earnings History Base Elements | GET | /payroll/v1/earnings-history-base-elements |
| Payroll | Pay Group Pay Periods | Retrieve Pay Groups And Pay Periods | GET | /payroll/v1/paygroup-payperiods |
| Personnel | Audit Details | Retrieve Audit Detail | GET | /personnel/v1/audit-details |
| Personnel | Dependent Deductions | Retrieve Dependent Deduction | GET | /personnel/v1/dep-deductions |
| Personnel | Employee Cobra Details | Retrieve Employee Cobra Detail | GET | /personnel/v1/employee-cobra-details |
| Personnel | Employee Deduction Benefit Option Change Date | Retrieve Employee Deduction Benefit Option Change Date | GET | /personnel/v1/emp-deductions-benefit-option-change-date |
| Personnel | Integration Audit Configuration | Retrieve Integration Audit Configuration | GET | /personnel/v1/integration-audit-configuration |
| Personnel | Business Structure Status | Retrieve Business Structure Status | GET | /personnel/v1/integration/kronos/business-structure-status |
| Personnel | Employee Status | Retrieve Employee Status | GET | /personnel/v1/integration/kronos/employee-status |
| Personnel | Employee Profiles | Retrieve Employee | GET | /personnel/v1/integration/kronos/employee-profiles |
| Payroll | Employee Pay Statement > CompanyPayStatement | Retrieve Employee(s) Pay Statement Summaries | POST | /payroll/v1/companies/pay-statements-summary |
| Payroll | Employee Pay Statement > CompanyPayStatement | Retrieve Employee(s) Pay Statements | POST | /payroll/v1/companies/pay-statements |
| Payroll | Employee Pay Statement > EmployeePayStatement | Retrieve Employee Pay Statements By Employee ID | POST | /payroll/v1/employees/pay-statements |
| Payroll | Employee Pay Statement > EmployeePayStatement | Retrieve Last Pay Statement By Employee ID | POST | /payroll/v1/employees/pay-statement/last |
| Payroll | Employee Pay Statement > EmployeePayStatement | Retrieve Employee Pay Statement by Pay ID | GET | /payroll/v1/pay-statement/{PayIdentifier} |
| Configuration | Earnings Code > Earnings | Retrieve All Earnings Configurations | GET | /configuration/v1/earnings |
| Configuration | Earnings Code > Earnings | Retrieve Earnings Configurations By Parameter | GET | /configuration/v1/earnings/{CalculationRule}/{TaxCategory}/{UseDeductionOffset}/{CountryCode}/{IncludeInShiftDifferential}/{IncludeInManualCheck} |
| Configuration | Earnings Code > Earnings | Retrieve Specific Earning Configuration | GET | /configuration/v1/earnings/{EarningCode} |
June 2022
The following operations were added to the API in June 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Payroll | Payroll Deductions History | Retrieve Payroll Deduction History | GET | /payroll/v1/payroll-deductions-history) |
| Payroll | Pay Register | Retrieve Pay Register | GET | /payroll/v1/pay-register |
| Personnel | Employee Deduction History Effective Change Date | Retrieve Employee Deduction History Effective Change Date | GET | /personnel/v1/deduction-history-effective-change-dates |
| Personnel | Open Enrollment Dependent Deductions | Retrieve Open Enrollment Dependent Deduction | GET | /personnel/v1/open-enrollment-dep-deductions |
| Personnel | Position Report | Retrieve Position Report | GET | /personnel/v1/position-report |
| Personnel | User Preferences | Retrieve User Preferences | GET | /personnel/v1/user-preferences |
| Personnel | User Profile | Retrieve User Profile | GET | /personnel/v1/user-profile-details |
The following operations were enhanced in the API in June 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Configuration | Code Tables | Retrieve Code Table | GET | /configuration/v1/code-tables |
| Configuration | Code Tables | Update Code Table | POST | /configuration/v1/code-tables |
May 2022
The following operations were added to the API in May 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Configuration | Tax Group Details | Retrieve Tax Group | GET | /configuration/v1/tax-groups |
| Personnel | User Details | Retrieve User Details | GET | /personnel/v1/user-details |
| Configuration | Organization Reporting Category | Retrieve Organizational Reporting Category From Org Level Codes | GET | /configuration/v1/organization-reporting-category |
| Personnel | Employee Supervisor Details | Retrieve Employee Supervisor Details | GET | /personnel/v1/employee-supervisor-details |
| Personnel | Employee Multiple Positions | Retrieve Multiple Position Employees | GET | /personnel/v1/empl-multiple-positions |
| Personnel | Open Enrollment Employee Deductions | Retrieve Open Enrollment Deductions | GET | /personnel/v1/open-enrollment-emp-deductions |
| Personnel | Employee Multiple Phone Numbers | Retrieve Multiple Phone Number Employees | GET | /personnel/v1/employee-multi-phone-numbers |
| Personnel | Employee Multiple Jobs | Retrieve Multiple Job Employees | GET | /personnel/v1/empl-multiple-jobs |
| Personnel | Employee Deductions | Retrieve Employee Deductions From Benefits | GET | /personnel/v1/empl-deductions |
| Configuration | Job Groups | Retrieve Job Groups Using Job Group Codes | GET | /configuration/v1/jobgroup |
| Personnel | Employee Demographic Details | Retrieve Employee Demographic Details | GET | /personnel/v1/employee-demographics-details |
| Configuration | Deduction Code | Retrieve Deduction Configuration For Benefit Setup | GET | /configuration/v1/deductions |
April 2022
The following operations were added to the API in April 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | User-Defined Fields | Retrieve User Designed Fields | GET | /personnel/v1/user-defined-fields |
| Personnel | User-Defined Fields | Retrieve Single Company User Defined Fields | GET | /personnel/v1/{companyId}/user-defined-fields |
| Personnel | User-Defined Fields | Retrieve Single Employee In Single Company User Defined Fields | GET | /personnel/v1/{companyId}/employees/{employeeId}/user-defined-fields |
March 2022
The following operation was added to the API in March 2022:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Employee Employement Details | Retrieve Employee Employment Details | GET | /personnel/v1/employee-employment-details |
July 2020
The following operations were added to the API in July 2020:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Platform Configuration Custom Fields Data | Retrieve Platform Configuration Custom Fields and Values | GET | /personnel/v1/platform-configuration-fields/class-name/{className} |
| Personnel | Platform Configuration Custom Fields Data | Retrieve Platform Configuration Custom Fields and Values | GET | /personnel/v2/platform-configuration-fields/class-name/{className} |
December 2019
The following operations were added to the API in December 2019:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | General Ledger Run Details | Retrieve General Ledger Run Details Filterable by runId and blockId | GET | /personnel/v2/general-ledger |
| Personnel | General Ledger Run Details | Retrieve Specific Ledger Run Details | GET | /personnel/v2/general-ledger/{runId} |
The following operations were enhanced in the API in December 2019:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Employee Job History | Retrieve Employee Job History Detail Records | GET | /personnel/v1/employee-job-history-details |
| Personnel | Employee Job History | Retrieve Specific Job History Detail Record | GET | /personnel/v1/employee-job-history-details/{systemId} |
| Payroll | Employee Direct Deposit Details | Retrieve List Of Direct Deposit Information All US And Canada Employees | GET | /payroll/v1/direct-deposit |
| Payroll | Employee Direct Deposit Details | Retrieve List Of Direct Deposit Information For US And Canada Employees By Company | GET | /payroll/v1/{companyId}/direct-deposit |
| Personnel | Employee Contact Details | Retrieve All Details For Persons Assigned To An Employee As Contacts | GET | /personnel/v1/contacts |
| Personnel | Employee Contact Details | Retrieve All Details For A Single Person Assigned To An Employee As A Contact | GET | /personnel/v1/contacts/{contactId} |
| Personnel | Global Employee Direct Deposit | Retrieve Direct Deposit Information For All US And Canada Employees | GET | /personnel/v1/employee-global-banks |
| Personnel | Global Employee Direct Deposit | Retrieve Direct Deposit Information For All US And Canada Employees By Company | GET | /personnel/v1/employee-global-banks |
| Personnel | Global Employee Localization | Retrieve Employee Specific Localization Information From Platform Configuration | GET | /personnel/v1/employee-global-localization-elements |
| Personnel | Global Employee Payments And Deductions | Retrieve Payment And Deduction Information Assigned To Global Pay Group and Pay Schedules | GET | /personnel/v1/employee-pay-deduction-elements |
| Personnel | Employee Contracts | Retrieve Contract Data Assigned To Employees | GET | /personnel/v1/employee-contract-details |
| Personnel | Compensation Details | Retrieve Compensation And Pay Informatiom | GET | /personnel/v1/compensation-details |
| Personnel | Compensation Details | Retrieve Compensation And Pay Informatiom By Company | GET | /personnel/v1/companies/{companyId}/compensation-details |
| Personnel | Compensation Details | Retrieve Compensation And Pay Informatiom By Company And Employee | GET | /personnel/v1/companies/{companyId}/employees/{employeeId}/compensation-details |
| Personnel | Compensation Details | Retrieve Compensation And Pay Informatiom By Employee | GET | /personnel/v1/compensation-details/{employeeId} |
| Personnel | Employment Details | Retrieve Employment Data | GET | /personnel/v1/employment-details |
| Personnel | Employment Details | Retrieve Employment Data By Company | GET | /personnel/v1/companies/{companyId}/employment-details |
| Personnel | Employment Details | Retrieve Employment Data By Company And Employee | GET | /personnel/v1/companies/{companyId)/employees/{employeeId}/employment-details |
| Personnel | Person Details | Retrieve Details On A Person Shared Across Companies | GET | /personnel/v1/person-details |
| Personnel | Person Details | Retrieve Person Details By Company | GET | /personnel/v1/companies/{companyId}/person-details |
| Personnel | Person Details | Retrieve Person Details By Company And Employee | GET | /personnel/v1/companies/{companyId}/employees/{employeeId}/person-details |
| Personnel | Person Details | Retrieve Person Details By Employee | GET | /personnel/v1/person-details/{employeeId} |
March 2019
The following operations were added to the API in March 2019:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Employee File Management | Retrieve | GET | /personnel/v1/person-details |
| Personnel | Employee Case Management | Retrieve | GET | /personnel/v1/person-details |
October 2018
The following operations were added to the API in October 2018:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | International Employees | Retrieve All International Employee Details | GET | /personnel/v1/international-employees |
| Personnel | Internalional Employees | Retrieve Details For A Specific International Employee | GET | /personnel/v1/international-employees/{employeeId} |
| Personnel | Global Employee Direct Deposit Details | Retrieve Direct Deposit Details For Global Employees | GET | /personnel/v1/employee-global-banks |
| Personnel | Employee Case Localization | Retrieve Global Employee Localization Fields Added To UKG Pro | GET | /personnel/v1/employee-global-localization-elements |
| Personnel | Employee Education | Retrieve | GET | /personnel/v1/employee-education |
| Personnel | Employee Job History | Retrieve Employee Job History | GET | /personnel/v1/employee-job-history-details |
| Personnel | Employee National Documents | Retrieve National Documents Assigned To Employees Or Contacts | GET | /personnel/v1/national-documents |
| Personnel | Employee Case Management | Retrieve Contract Data Assigned Employees | GET | /personnel/v1/employee-contract-details |
The following operations were enhanced in the API in October 2018:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Compensation Details | Retrieve Compensation And Pay Group Details | GET | /personnel/v1/compensation-details |
| Personnel | Employment Details | Retrieve Employement Data | GET | /personnel/v1/employment-details |
| Personnel | Person Details | Retrieve Details On A Person Shared Across Companies | GET | /personnel/v1/person=details |
September 2017
The following operations were added to the API in September 2017:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Personnel | Employee ID Lookup | Retrieve Employee ID and Company ID | POST | /personnel/v1/employee-ids |
| Personnel | Employee Changes > Change By Date | Retrieve Employee Attribute Changes | GET | /personnel/v1/employee-changes |
| Personnel | Employee Changes | Retrieve Attribute Changes For Specific Employee | GET | /personnel/v1/employee-changes/{employeeId} |
| Configuration | Organizational Levels | Retrieve All Org Levels | GET | /configuration/v1/org-levels |
| Configuration | Organizational Levels | Create Org Level Configuration | POST | /configuration/v1/org-levels |
| Configuration | Organizational Levels | Retrieve Single Org Level | GET | /configuration/v1/org-levels/{level}/{code} |
| Configuration | Organizational Levels | Patch One Org Level | PATCH | /configuration/v1/org-levels/{level}/{code} |
| Configuration | Organizational Levels | Update One Org Level | PUT | /configuration/v1/org-levels/{level}/{code} |
| Configuration | Code Tables | Retrieve Code Tables And Codes in UKG Pro Used To Populate Drop Downs | GET | /configuration/v1/code-tables |
| Configuration | Code Tables | Update Code Tables And Codes in UKG Pro Used To Populate Drop Downs | POST | /configuration/v1/code-tables |
Updated about 2 months ago