Release notes
The Release notes contain announcements, corrections, enhancements, and updates of note to the conceptual and reference documentation. New API resources and operations are listed in the version history.
September 2024 Pro API updates
The following operations were added to the API documentation in September 2024:
| Domain | Resource | Operation | Method | URL endpoint |
|---|---|---|---|---|
| Recruiting | Opportunities | Retrieve Recruiters and Opportunity is Shared With | GET | {tenantalias}/api/opportunities/{opportunityId}/shared-with |
| Recruiting | Opportunities | Share Opportunity with Recruiter | POST | {tenantalias}/api/opportunities/{opportunityId}/shared-with |
The following new fields were added to the API documentation in 2024.R2:
| Domain | Resource | Operation | Method | URL endpoint | New Field |
|---|---|---|---|---|---|
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | flsa_status |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | secondary_recruiter |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | short_term_plan_name |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | short_term_incentive_percentage |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | short_term_incentive_amount |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | long_term_plan_name |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | long_term_incentive_percentage |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | long_term_incentive_amount |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | alternate_tracking_number |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | fringe_incentive |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | bonus_plan |
| Recruiting | Opportunities | Retreive Opportunities | Get | /{tenantalias}/api/opportunities | equity_plan |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | job_location_type |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | relocation_assistance |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | personal_time_off |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | sign_on_equity_amount |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | sign_on_bonus_amount |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | sign_on_options_amount |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | flsa_status |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | short_term_incentive_percentage |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | short_term_incentive_amount |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | long_term_incentive_percentage |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | long_term_incentive_amount |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | fringe_incentive |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | bonus_plan |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | equity_plan |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | offer_letter_date_format |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | offer_letter_extended_date_format |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | default_date_format |
| Recruiting | Offers | Retreive Offers | Get | /{tenantalias}/api/offers | is_allow_override_recruiter_setting |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | defaultdate_format_extended |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | job_location_type |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | relocation_assistance |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | personal_time_off |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | sign_on_equity_amount |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | sign_on_bonus_amount |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | sign_on_options_amount |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | flsa_status |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | short_term_incentive_percentage |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | short_term_incentive_amount |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | long_term_incentive_percentage |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | long_term_incentive_amount |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | fringe_incentive |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | bonus_plan |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | equity_plan |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | offer_letter_date_format |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | offer_letter_extended_date_format |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | default_date_format |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | is_allow_override_recruiter_setting |
| Recruiting | Offers | Create Offers | Post | /{tenantalias}/api/offers | defaultdate_format_extended |
| Locations Configuration | Locations | Retrieve Locations | Get | /{tenantalias}/api/offers | addressLine1 |
| Locations Configuration | Locations | Retrieve Locations | Get | /{tenantalias}/api/offers | addressLine2 |
| Locations Configuration | Locations | Retrieve Locations | Get | /{tenantalias}/api/offers | locationGLSegment |
The following Tutorials have been updated to match the latest documentation formerly available on the Library (Documentation > Tutorials > UKG Pro SOAP Services):
- Reports As A Service
- Employee Employee Employment Information Service
- Employee Job Service
- Employee New Hire Service
- Employee Contacts Service
- Employee User-Defined Fields Service
- Federated Single Sign-on User Service
- Development Opportunity Service
- Employee Compensation Service
- Global Employee New Hire Service
- Employee Address SOAP Service
- Employee Termination Service
- Employee Phone Service
- Third Party Pay Service
- Development Opportunity Participation Service
- Time Management Web Service
- Employee Person Service
🆕 2024.R1 Pro API updates
- 🚀 Check out the What's New section for important news going forward! The Release Notes will be deprecated in favor of the What's New section in a future release of the Developer Hub.
- New: Added a full suite of Recruiting API resources and operations, over 100 in total. Be sure to check out the new Recruiting content in the Pro API specification.
- Enhancement: Completely rewrote, updated, and enhanced the Payroll Earnings Import resource.
- Enhancement: The Employee New Hire API has been updated to include these fields:
ResidentStateTotalAllowancesClaimedCurrencyAmountandWorkStateTotalAllowancesClaimedCurrencyAmount. These fields each have a 10-digit maximum and can only include whole dollar amounts (decimals are not supported). Note: These fields are only to be used by Iowa locations. The Developer Hub entry for the Employee New Hire Service as well as the Employee New Hire Service API Guide, available in the UKG Community Library, have been updated to include these new field-level details.
Updated 2 months ago