AbsenceDays5

AbsenceReasons6

Absences7

Adoptions2

BankDetails5

Benefits6

Calendar1

EmergencyContacts5

Employees13

Entitlements2

Hierarchy4

Jobs5

Maternities2

Paternities2

Positions4

PublicHolidays3

UserDefinedFields3

UserDefinedFieldSchemas2

WorkingPatternComponents3

WorkingPatternOverride1

WorkingPatternOverrideComponents5

WorkingPatterns2

Absences

Creates a new Absence.

Changed on Oct 6, 2026

<br /> This API request method is currently in beta testing. <br /> To gain access to use this method, please contact <a href='mailto:hrapi@iris.co.uk'>hrapi@iris.co.uk</a>.

post/attendance/absences

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/attendance/absences/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

autoGenerateDaysBasedOnWorkingPatternboolean

Create the Absence Days automatically based on the Employee's Working Pattern.

Request body

EmployeeIdstring nullable required

The ID of the Employee.

Must exist in the Employees Service.

Cannot be updated once Absence created.

AbsenceReasonIdstring required

The Absence Reason ID.

Must exist in the Attendance Absence Reasons Service.

When updating the Absende Reason Parent Id cannot change.

Narrativestring nullable

The Narrative relating to the Attendance.

Cascade Source:

[EmployeeAttendance].[Narrative] if Absence Reason is not Shared Parental Leave

'Shared Parental Leave - ' + [EmployeeSharedParentalLeave].[LeaveType] + ' - ' + [EmployeeSharedParentalLeave].[WhoseLeaveIsIt] if Absence Reason is Shared Parental Leave

StartDatestring date-time nullable

The Start Date of the Attendance.

Cascade Source:

[EmployeeAttendance].[StartDate] if Absence Reason is not Shared Parental Leave

[EmployeeSharedParentalLeave].[LeaveStartDate] if Absence Reason is Shared Parental Leave

EndDatestring date-time nullable

The End Date of the Attendance.

Cascade Source:

[EmployeeAttendance].[EndDate] if Absence Reason is not Shared Parental Leave

Null if Opened Ended - Cascade Source: [EmployeeAttendance].[OpenEnded]

[EmployeeSharedParentalLeave].[LeaveEndDate] if Absence Reason is Shared Parental Leave

Response

idstring nullable

Changes

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; 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; 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=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=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; 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=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=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; 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=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.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=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/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 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
- 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
Aug 6, 2026f218760c73b5 Revision changes
- breaking
  removed the media type application/*+json; version=1 from the request body
- breaking
  removed the media type application/prs.odatatestxx-odata; version=1 from the request body
- breaking
  removed the media type text/json; version=1 from the request body
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=minimal;odata.streaming=true; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=minimal;odata.streaming=false; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=minimal; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=full;odata.streaming=true; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=full;odata.streaming=false; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=full; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=none;odata.streaming=true; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=none;odata.streaming=false; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.metadata=none; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.streaming=true; version=1)
- breaking
  the request property became not nullable (media type: application/json;odata.streaming=false; version=1)
- breaking
  the request property became not nullable (media type: application/json; version=1)
- breaking
  the request property became not nullable (media type: application/xml; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none; version=1)
- breaking
  the request property became required (media type: application/json;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json; version=1)
- breaking
  the request property became required (media type: application/xml; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=minimal; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=full; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json;odata.metadata=none; version=1)
- breaking
  the request property became required (media type: application/json;odata.streaming=true; version=1)
- breaking
  the request property became required (media type: application/json;odata.streaming=false; version=1)
- breaking
  the request property became required (media type: application/json; version=1)
- breaking
  the request property became required (media type: application/xml; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=minimal;odata.streaming=true; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=minimal;odata.streaming=false; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=minimal; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=full;odata.streaming=true; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=full;odata.streaming=false; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=full; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=none;odata.streaming=true; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=none;odata.streaming=false; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.metadata=none; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.streaming=true; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json;odata.streaming=false; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json; version=1)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/xml; version=1)
- breaking
  removed the media type application/prs.odatatestxx-odata; version=1 for the response with the status
- breaking
  removed the media type text/json; version=1 for the response with the status
- info
  added the media type application/json-patch+json; version=1 to the request body
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history (3 revisions)

Creates a new Absence.

Request

Query parameters

Request body

Response 200OK

Changes

Response