Release Notes

2023 | 2022 | 2021 | 2024


9 July 2024 - 2.5.5

Maintenance release to apply security updates.

25 June 2024 - 2.5.4

Maintenance release to apply security updates.

4 June 2024 - 2.5.3

Maintenance release to apply security updates.

14 May 2024 - 2.5.2

Maintenance release to apply security updates.

30 April 2024 - 2.5.1

Maintenance release to retired HR API version 1.

16 April 2024 - 2.5

Working Patterns

As part of this release, we plan to deliver a Working Pattern Components and Working Patterns service.

Working Pattern Components enable you to drill down and understand how the individual components that make up a working pattern are built, including Working Days, the periods, and sequences used i.e. fixed or non-fixed (opens in a new window).

Working Patterns enable you to collect this information and build a view of working and non-working days for a given date range (opens in a new window).

Refer to the Working Pattern topic for more information.

5 March 2024 - 2.4.11

Releasing the 'Delete' method to the Absence and AbsenceDays endpoints.

Exposing the Absence reasons properties through the API, this will help to understand which properties we support currently in the API

  • Holiday

  • Absent

  • Sick

  • StatutoryMaternityPayApplicable

  • StudyExam

  • FlexiLeave

Exposing detailed error messages through the API

13 February 2024 - 2.4.10

Maintenance release to improve our sandbox environments

23 January 2024 - 2.4.9

In this release, we are continuing our work to add SourceSystemCreatedDate and SourceSystemLastModifiedDate to the following endpoints:

  • Bank Details

  • Entitlement

  • Hierarchy

This will allow customers who utilise the Database Download service to accurately check and manage updates to records.

A new Hierarchy Path endpoint added to the Hierarchy service, which will allow you to request the hierarchy path based on a node Id. The path is all of the hierarchy nodes from the root of the hierarchy to the node Id requested. Calling GET v2/hr/hierarchy/{id}/path will return an array of hierarchy nodes with the root node at the top.


6 December 2023 - 2.4.8

Continuing our work on SourceSystemID's, in this release, we will be adding fields to the following endpoints:

  • Absence

  • AbsenceDays

We will also add two new fields called "SourceSystemCreatedDate" & "SourceSystemLastModifiedDate" to the following endpoints:

  • Employee

  • Jobs

This will allow customers who utilise the Database Download service to check and manage updates to records.

15 November 2023 - 2.4.7

As part of this release (and subsequent ones), we will be adding a new field to the various services called Source System ID, this is an internal ID associated to IRIS Cascade records. In this release we are including:

  • Hierarchy

  • Bank Details

  • Entitlement

Beta Flag in Swagger for Updatable Absence methods.

In this release, we will be publishing the updatable absence methods in our Swagger (opens in new window or tab) documentation. This is still in beta testing phase. As such, if you would like access to these methods, contact

31 October 2023 - 2.4.6

Additional Job Fields

We have extended the fields on the Job endpoint (GET/POST/PUT) to now include the following:

Field on Job Screen

API Field






Post must exist (read only)




Bank Holidays



Holiday location must exist (read only)





Spinal Point




Next Increment



Timesheet Location



Timesheet Ruleset




Timesheet Lunch Duration



Auto Enrolment Profile




Expense Submission Frequency



Cost Centre



Job Family



Apprentice Under 25 (fx)



Apprenticeship End Date (fx)



Contract End Date (fx)



Reports To







RTI Irregular Frequency



Notice Period



3 October 2023 - 2.4.5

Phone Number Validation

Date Validation Job API (x2)
  • Job start dates cannot be before the continuous service date.

  • Employees with 2 or more jobs cannot have a Job start date on the same day (time is ignored).

Public Holiday Endpoint (GET)
  • A new (READ ONLY) endpoint for Public Holidays (bank holidays as they are known in Cascade). Please see Swagger for full definition of fields, which will be updated on release day.

Source System ID (Employee & Job)
  • As part of this release (and subsequent ones), we will be adding a new field to the various services called Source System ID, this is an internal ID associated to Cascade records. The field will be added to the Employee and Job endpoints ONLY for this release and is not updatable.

13 September 2023 - 2.4.4

Phone Number Validation

The API will only allow one phone number per Ownership and Type. i.e

  • Ownership of 'Organization' and Type of 'Landline'.

  • Ownership of 'Organization' and Type of 'Mobile'.

  • Ownership of 'Personal' and Type of 'Landline'.

  • Ownership of 'Personal' and Type of 'Mobile'.

Employee Benefits Endpoint (GET)
  • Added a new (READ ONLY) endpoint for employee Benefits. Please see Swagger for full definition of fields.

8 August 2023 - 2.4.3

Employee Validation
  • Display Id must be unique and not empty. A null value will auto-generate the next numeric Display Id.

25 June 2023 - 2.4.2

Absence Reason Service
  • Added new endpoint to get an absence reason for an employee, returning whether the duration is recorded in days, or not. See Swagger for details.

20 June 2023 - 2.4.1

Employee Service
  • Fixed an issue where WindowsUsername was showing null in the API.

11 June 2023 - 2.4

  • Fixed an issue with handling Currency fields.

Employee Service
  • Employment Left Date time only shows midnight

  • Removed incorrect Employee Start Date On Or Before Job Start Dates validator

  • Added WindowsUsername field

  • Employee ID is no longer required when creating an Employee. The ID is generated automatically.

Entitlement Service
  • Corrected Entitlement Model to fix issue from previous release

  • Added TotalEntitlementDays to Entitlement Model

  • Added TotalEntitlementMinutes to Entitlement Model

  • Added CarryLostDays to Entitlement Model

  • Added CarryLostMinutes to Entitlement Model

11 May 2023 -

  • Employee Service: performance fix

  • Entitlement Model: corrected errors to allow new fields to be added

15 April 2023 - 2.3.7

  • Corrections to Swagger descriptions

  • Empty Bank Details Address now shows as empty address lines and not an empty object

  • Added Absence Reasons from Statutory Leave System List

  • Corrected Absence Days so Zero Duration Absence Days do not appear instead of when AM and PM are false

  • Added new Entitlement fields: Total Minutes, Total Days, Carry Lost Minutes, Carry Lost Days

Employee Validation
  • Field Length Validation to match IRIS Cascade

  • Continuous Service Date On Or Before Employment Start Date

  • Continuous Service Date On Or Before Job Start Dates

  • Last Working Date On Or Before Left Date

  • Left Date On Or After Job Start Dates

  • Left Date On Or After Start Date

  • Start Date On Or Before Job Start Dates

Job Validation
  • Job Start Date Before Employee Employment Left Date

  • Job Start Date On Or After Continuous Service Date


1 November 2022 -

Several high priority bug fixes:

  • Unexpected data changes

  • Hash code update – absence days endpoint showing no data Further tracking logs added

Further sync improvements

Improved service bus pipeline settings

17 October 2022 - 2.3.6

  • Logging improvements

  • Absence days syncing fix

  • Added proper cascade ID values

  • Added employee id to absence day model

  • Removed redundant code

  • API absence narrative length increased to 3,000 characters

14 September 2022 - 2.3.5

Minor bug fixes exposed by sync issue.

01 September 2022 - 2.3.4

Sync scalability fix.

16 August 2022 - 2.3.3

Bug fixes.

28 July 2022 - 2.3.2

Bug fixes and API sync issues fixed.

13 July 2022 - 2.3.1

  • New Absence (read-only) end points: Refer to Swagger for further details: 

  • Absence service

  • Absence Reasons / Entitlements / Absences / Absence Days endpoints

  • Addition of start and end date to Absences endpoints following feedback

  • Addition of entitlement name to entitlement endpoint following feedback

  • GET method only in this release

  • Bug fixes

  • Performance enhancements

  • Pagination increased from 50 rows to 250 rows

  • Daily call limits increased from 1,000 to 2,000

15 February 2022 - 2.3

We introduced a New Bank Details endpoint.

  • Employee ID

  • Bank account name

  • Bank account number

  • Sort code

  • Bank name

  • Bank address

  • Roll number

  • GET

  • PUT

  • POST

Access to the New Bank Details endpoint is by request only.

26 January 2022 - 2.2

Extension to Jobs V2 endpoint – Fields added:

  • Contract type

  • Pay frequency

  • Pay Basis

  • Full Time Equivalent

Minor Sync bug fixes

17 January 2022 - 2.1

Version 1 end point split into two:

  • Version 2 Employees Endpoint

  • Version 2 Jobs Endpoint

PUT and POST methods added to both V2 endpoints

Improved performance on endpoints

Additional fields added to employee endpoint:

  • Last Working Date

  • Leaver Reason

  • Cost Centre

  • Working Status

  • Is Manager

  • Marital status

  • National Insurance number

  • Payroll ID

  • Tax Code

  • Include in Payroll

First iteration of the API documentation:

As per our documentation, we will support old versions of our API for 6 months after the release of a new version. We will inform you periodically when this is due to happen so you can make the necessary adjustments to allow your integrations to continue smoothly. We will try to keep this to an absolute minimum. We will be retiring our V1 endpoint in July 2022.


28 September 2021 - 1.2

Added extra fields to Employee V1:

  • EmploymentLeftDate

  • KnownAs

  • OtherName

  • DateOfBirth

  • Gender

  • Ethnicity

  • Nationality

  • Religion

Job Salary now supports null value

Added Home Address to Employee V1

16 July 2021 - 1.1

Multi-tenancy release

8 July 2021 - 1.0

  • Minimum viable product released to Beta – HR API V1 is born!

  • Limited Employee information

  • Limited Job information Hierarchy information

  • Pagination, sorting, and filtering

  • GET method