WFM API - Release Notes & highlights

[#1]

• 29-04-2025: new entity Work pattern
• 31-03-2025: backupManager and backupManagerPersonId added to endpoint OrganizationUnits
• 22-03-2023: property employmentIndicator added to Employments endpoint
• 23-01-2023: property Identity added to Persons endpoint
• 3-10-2022: new endpoint LeaveBalances
• 23-8-2022: change fields PersonId/Personcode
• 19-07-2022: change of description of leaveBalancesPayroll endpoint
• 13-07-2022: Leaves endpoint
• 13-05-2022: managerPersonCode removed from endpoint OrganizationUnits

 

29-04-2025: new entity Work pattern

Today we have added the work pattern data to the WFM API.

Defined in HR Core, the work pattern specifies the regular days an employee is available for scheduling. This update includes:

• New properties in the Employments endpoint: 
  • A reference to the work pattern
  • The work pattern method
  • The date when the work pattern starts
• New endpoint Workpatterns

This new functionality is now accessible to all WFM API users. To utilize the work pattern data, a reload of your employment data is necessary. If this is required, please reach out to the service desk to initiate the data reload.

For detailed information about the new functionality, please refer to our knowledge base:

• Employments endpoint
• Workpatterns endpoint

31-03-2025: backupManager and backupManagerPersonId added to endpoint OrganizationUnits

The properties backupmanager and backupMangerPersonId are added to the endpoint OrganizationUnits. To use the new properties, we have to reload your data from HR Core to our API platform. Please use a support request in Xurrent/4me to reload your data. 

Description of endpoint: OrganizationUnits

22-03-2023: property employmentIndicator added to Employments endpoint

Persons endpoint - The property employmentIndicator is added to the Employments endpoint. 

Endpoint documentation is updated.

23-01-2023: property Identity added to Persons endpoint

Persons endpoint - The property Identity is added to the Persons endpoint. 

Endpoint documentation is updated.

3-10-2022: new endpoint LeaveBalances

We have added 1 more endpoint to the WFM API: LeaveBalances. This new endpoint is available for all WFM API consumers. The LeaveBalances endpoint delivers information about  leave entitlement and the leave taken. Learn more about this endpoint in our knowledge base.

23-8-2022: change fields PersonId/Personcode

The properties PersonId and Personcode did not refer to the same source in HR Core Business throughout the WFM API. Sometimes the property PersonId refered to the UPI, sometimes to the Personcode. Same for the property Personcode.

To have a logical and more intuitive explanation of the properies, we have synchronized the mapping throughout the WFM API.

The PersonId and Personcode is synchronized for all endpoint in WFM API:

• PersonId - refers to the UPI (NL: Uniek Persoonlijk Id) in HR Core Business
• PersonCode  - refers to the Person code (NL: Persoonscode) in HR Core Business

This change has no impact for consumers of the WFM API. When the Person layer is enabled in HR Core Business (requirement for normal usage of WFM API), these values are the same. Therefore, switching the mapping in the WFM API has no impact for WFM API consumers. 

19-07-2022: change of description of leaveBalancesPayroll endpoint

LeaveBalancesPayroll endpoint - The HR Core Business example of Id property has changed.

Old text:

• id - Combined field of: [PersonId] +  [Payroll year] + [Payroll period] ...

New:

• id - Combined field of: [EmployeeId] +  [Payroll year] + [Payroll period] ...

The description of the user endpoint : WFM LeaveBalancesPayroll endpoint.

13-07-2022: Leaves endpoint

Three more endpoints are added to the WFM API: Leaves, LeaveTypes, LeaveReasons. Learn more about these endpoints in our knowledge base.

13-05-2022: managerPersonCode removed from endpoint OrganizationUnits

The property managerPersonCode is removed from endpoint OrganizationUnits. Although described in the documentation and swagger, the property was never supported and has the same value as managerPersonId. Documentation and swagger page are adjusted.

To Identify the manager of a organizationalUnit, the property managerPersonId can be used. Description of endpoint: OrganizationUnits