AbsenceDays5

AbsenceReasons6

Absences7

Adoptions2

BankDetails5

Benefits6

Calendar1

EmergencyContacts5

Employees13

Entitlements2

Hierarchy4

Jobs5

Maternities2

Paternities2

Positions4

PublicHolidays3

UserDefinedFields3

UserDefinedFieldSchemas2

WorkingPatternComponents3

WorkingPatternOverride1

WorkingPatternOverrideComponents5

WorkingPatterns2

Benefits

Gets a single Benefit referenced by ID.

Changed on Nov 10, 2026

get/benefits/{id}

Request

Base URL
https://api.iris.co.uk/hr/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.iris.co.uk/oauth2/v1/token
TypeScript
https://skmtc.dev/hrapi/apis/hr-api/docs/benefits/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Benefit ID.

Response

EmployeeIdstring required

The EmployeeId.

Cascade Source: [EmployeeBenefits].[EmployeeId]

Typestring nullable

The Type.

Cascade Source: [EmployeeBenefits].[Code]

Descriptionstring nullable

The Description.

Cascade Source: [EmployeeBenefits].[Notes]

Valuenumber double nullable

The Value of the Benefit.

Cascade Source: [EmployeeBenefits].[Value]

StartDatestring date-time nullable

The Start Date.

Cascade Source: [EmployeeBenefits].[StartDate]

EndDatestring date-time nullable

The End Date.

Cascade Source: [EmployeeBenefits].[EndDate]

P11DValuenumber double nullable

The P11DValue of the Benefit.

Cascade Source: [EmployeeBenefits].[P11DValue]

Suspendedboolean

The Suspended value.

Cascade Source: [EmployeeBenefits].[Suspended]

SourceSystemIdstring nullable

Source HR System Id.

Cascade Source: [EmployeeBenefits].[Ruid]

SourceSystemCreatedOnstring date-time nullable

The date when the Benefit was created in the Source HR System. Cascade Source: [EmployeeBenefits].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The date when the Absence was created or last updated in the Source HR System. Cascade Source: [EmployeeBenefits].[SYS_ModifiedDate]

Idstring nullable

The ID of the Benefit.

This field is generated by Iris HR platform and not related to the Cascade ID.

CreatedOnstring date-time

The date time when the Benefit was created in the Iris HR platform.

CreatedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

LastModifiedOnstring date-time nullable

Not used as the Iris HR platform has no concept of users at the moment.

LastModifiedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

Changes

Nov 10, 2026638d402d3872 Revision changes
- breaking
  added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id
- warning
  for the path request parameter id, the maxLength was set to 36
Oct 6, 20267a4734dbe370 Revision changes
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status

Operation history (4 revisions)

Gets a single Benefit referenced by ID.

Request

Path parameters

Response 200OK

Changes

Response