💡 Be sure to check out the Version History for the Pro WFM API below, which outline the new API operations in this release:

• Pro WFM Version History

🆕 Pro WFM API updates

🚩 Expand and Collapse feature

The Developer Hub for Pro WFM now allows you to expand and collapse each top-level domain in the left-side panel, greatly enhancing the navigation experience. The top-level domains now default to a collapsed format, significantly reducing the scrolling required to reach your destination.

🔦 Spotlight: Combined Paycodes for Timekeeping

The Combined Paycodes for Timekeeping API resource allows you to retrieve and modify combined paycodes, which are GDAP-filtered, selected paycodes for the logged-in user.

🔦 Spotlight: Publish and Run Reports

The Publish and Run Reports API resource allows you to publish report designs, run reports, and retrieve details about required report parameters and metadata, including name, description, category, and default output type.

🚀 Enhancements to existing operations

This release includes over 50 corrections and enhancements to the Pro WFM API. See the Release Notes for more details. Among many other enhancements, the following were implemented this release:

• Enhanced the Retrieve Timecard Data for Multiple Employees (POST /v1/timekeeping/timecard_metrics/multi_read) API operation's response body to include the following new properties: (PS-310099)
  • vestedDurationInSeconds
  • probationDurationInSeconds
  • takingToDateInSeconds
  • availableBalanceInSeconds
  • secondsAmount
  • probationSecondsAmount
• Enhanced the Retrieve Timecard Data for Multiple Employees (POST /v1/timekeeping/timecard_metrics/multi_read) API operation to allow filtering based on the payCodeType specified in the request payload. When COMBINED is specified, all combined paycodes totals are returned, and when REGULAR is specified, all regular paycodes totals are returned. (PS-291411)
• Enhanced the following API operations with the optional Boolean query parameter validation_only, which allows users to preview and validate labor categories or labor category entries before performing insertions or updates: (PS-319461, PS-319462)
  • Create Labor Category Entries (POST /v1/commons/labor_entries/multi_create)
  • Update Labor Category Entries (POST /v1/commons/labor_entries/multi_update)
  • Create Labor Categories (POST /v1/commons/labor_categories/multi_create)
  • Update Labor Categories (POST /v1/commons/labor_categories/multi_update)

🆕 September 2024 Pro API updates

💡 Be sure to check out the Version History for the Pro API below, which outline the new API operations in this release:

• Pro Version History

🚀 SOAP Services Documentation

All of the SOAP Services documentation available on the Developer Hub has been updated to match the latest documentation formerly available on the Library (Documentation > Tutorials > UKG Pro SOAP Services).

🔦 Spotlight: New API Operations

A number of new API operations are now documented on the Developer Hub, including:

• Retrieve Recruiters and Opportunity is Shared With and Share Opportunity with Recruiter in the Recruiting > Opportunities API resource
• A new API area, Payroll Pending Items, featuring 8 new operations within the Deductions and Earnings API resources

🚀 Enhancements to existing operations

This release includes many corrections and enhancements to the Pro API. See the Release Notes for more details. Among many other enhancements, the following were implemented this release:

• New request and response properties and other updates to the Locations Configuration > Locations API resource
• New request and response properties and other updates to the Recruiting > Opportunities and Recruiting > Offers API resources

The new UKG Webhooks application allows you to subscribe to specific events and implement Hash-Based Message Authentication Codes (HMAC) that ensure the security of the messages. Subscriptions can be tested, deactivated, and reactivated at any time.

When an event is triggered in your UKG Pro® solution, the UKG Webhooks application enables you to pass that event’s information to an endpoint of your choosing in near real-time.

For more information about UKG Webhooks, refer to the following topics:

• UKG Webhooks User Guide
• UKG Webhooks Event Catalog

💡 Be sure to check out the Version History for each of our Pro APIs below, which outline the new APIs in this release:

• Pro Version History
• Pro WFM Version History

🆕 Pro API updates

• 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.
  • You can see the new operations beginning with Import Earnings for Payroll.
• Enhancement: The Employee New Hire API has been updated to include these fields: ResidentStateTotalAllowancesClaimedCurrencyAmount and WorkStateTotalAllowancesClaimedCurrencyAmount. 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.

Many other corrections and enhancements have been made to the Pro API. See the Release Notes for more details.

🆕 Pro WFM API updates

New Top-Level Domain: Universal Device Manager

A new top-level domain is now available covering the Universal Device Manager API resources and operations, beginning with UDM Devices and UDM Device Groups.

🔒 No longer supported: accountLocked boolean

The following API operations will no longer process the accountLocked boolean property in the request payload. If accountLocked is specified, it will be ignored by the system.

• Create Person (POST /v1/commons/persons)
• Create Multiple Persons (POST /v1/commons/persons/multi_create)
• Update Multiple Persons (POST /v1/commons/persons/multi_update)
• Create or Update Persons (POST /v1/commons/persons/multi_upsert)
• Retrieve Persons (POST /v1/commons/persons/extensions/multi_read)
• Update Person by ID (PUT /v1/commons/persons/{personId})

🚀 Enhancements to existing operations

• Enhanced the request payload of the Stage Payroll Asynchronously (POST /v1/commons/payroll/staging/async) API operation with the customFields array, which allows you to specify custom fields to return in the response. (PS-179659)
• Enhanced the Create Rule Set (POST /v1/scheduling/schedule_rule_sets) and Update Rule Set by ID (PUT /v1/scheduling/schedule_rule_sets/{ruleSetId}) API operations to support Employee Rule Sets. (PS-175466)

Many other corrections and enhancements have been made to the Pro WFM API. See the Release Notes for more details.

2023.R2.1

AppKey retired

You no longer need an AppKey to call API operations. If one is defined, it is ignored.

We've consolidated our separate methods of communicating our most important news into the What's New log, which provides an ongoing log of changes across the Hub. What's New contains this section covering changes to the Developer Hub as a whole and sections for each of our major APIs, like Pro and Pro WFM.

💡 What's New RSS feed

You can now subscribe to our What's New RSS feed at https://developer.ukg.com/general/changelog.rss. With this URL, you can use any RSS feed tool to input the URL. You can also generate HTML to embed the feed.

🔔 Notifications

The new notification bell icon alerts developers to API and other updates to the Developer Hub. The View all button at the bottom of the notifications box takes you to the What’s New page where you can view a chronological list of updates to Developer Hub.

🚧 UKG Pro status

The UKG Pro status link located at the top of each page will take you to the UKG Pro status page in the UKG Community. If you are experiencing issues with your API calls, you can check the status of UKG Pro services. Service disruptions impact API calls to that service.

To access the UKG Pro Status page, you must be logged in to UKG Community.

📜 Auto-expanding response schemas

API specifications now auto-expand the first HTTP status code 200-level response schema.

💡 API specifications: Authorization and URL

All API specifications now allow you to input the appropriate authorization values needed to call that API. For example, you can now enter the hostname and tenant ID in the URL for every API operation.

This enhancement makes it easier to create an example API request which can then be copied to the tool of your choice.