HRhrapi
Entitlements

Gets an Entitlement by ID.

Changed on
get/attendance/entitlements/{id}

Request

Path parameters

idstring required

Entitlement ID.

Response

OK

EmployeeIdstring nullable

The ID of the HR Employee.

Must exist in the Employee Service.

AbsenceReasonIdstring nullable

The Absence Reason ID.

Must exist in the Absence Reason Service.

EntitlementYearNamestring nullable

The Entitlement Year Name.

Cascade Source: [EmployeeAttendanceEntitlementYear].[EntitlementYearName]

Openboolean

The status of Open indicates whether the entitlement is active.

Cascade Source: [EmployeeAttendanceEntitlementYear].[Open]

StartDatestring date-time nullable

The Start Date of this Entitlement.

Cascade Source: [EmployeeAttendanceEntitlementYear].[StartDate]

EndDatestring date-time nullable

The End Date of this Entitlement.

Cascade Source: [EmployeeAttendanceEntitlementYear].[EndDate]

Narrativestring nullable

The optional description of this Entitlement.

Cascade Source: [EmployeeAttendanceEntitlementYear].[Narrative]

BaseDaysnumber double

The number of Base Entitlement Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BaseEntitlementDays]

BaseMinutesinteger nullable

The number of Base Entitlement Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BaseEntitlement]

CarryDaysnumber double

The number of Carry Days allowed.

Cascade Source: [EmployeeAttendanceEntitlementYear].[CarryDays]

CarryMinutesinteger nullable

The number of Carry Minutes allowed.

Cascade Source: [EmployeeAttendanceEntitlementYear].[Carry]

CarryUseByDatestring date-time nullable

The date when Carry Days should be used by.

Cascade Source: [EmployeeAttendanceEntitlementYear].[CarryUsebyDays]

CarryLostDaysnumber double nullable

The number of Carry Days lost.

Cascade Source: [EmployeeAttendanceEntitlementYear].[CarryLostDays]

CarryLostMinutesinteger nullable

The number of Carry Minutes lost.

Cascade Source: [EmployeeAttendanceEntitlementYear].[CarryLost]

ManualAdjustmentDaysnumber double

The number of Manual Adjustment Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[ManualAdjustmentDays]

ManualAdjustmentMinutesinteger nullable

The number of Manual Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[ManualAdjustment]

ServiceLengthAdjustmentDaysnumber double

The number of Adjustment Days due to service length.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LOSDays]

ServiceLengthAdjustmentMinutesinteger nullable

The number of Adjustment Minutes due to service length.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LOS]

NewStarterAdjustmentDaysnumber double

The number of New Starter Adjustment Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[NewStarterDays]

NewStarterAdjustmentMinutesinteger nullable

The number of New Starter Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[NewStarter]

LeaverAdjusmentDaysnumber double

The number of Leaver Adjustment Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LeaverAdjustmentDays]

LeaverAdjusmentMinutesinteger nullable

The number of Leaver Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LeaverAdjustment]

LeaverAdjustmentDaysnumber double nullable

The number of Leaver Adjustment Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LeaverAdjustmentDays]

LeaverAdjustmentMinutesinteger nullable

The number of Leaver Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[LeaverAdjustment]

PartTimeAdjustmentDaysnumber double

The number of Part Time Adjustment Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[PTProrataDays]

PartTimeAdjustmentMinutesinteger nullable

The number of Part Time Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[PTProrata]

BankHolidayAdjustmentDaysnumber double

The number of Bank Holiday Adjustment Day.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BHProrataDays]

BankHolidayAdjustmentMinutesinteger nullable

The number of Bank Holiday Adjustment Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BHProrata]

BuySellDaysnumber double

The number of Buy Sell Days.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BuySellDays]

BuySellMinutesinteger nullable

The number of Buy Sell Minutes.

Cascade Source: [EmployeeAttendanceEntitlementYear].[BuySell]

TotalEntitlementDaysnumber double nullable

The total Entitlement in days.

= BaseDays +

ServiceLengthAdjustmentDays +

NewStarterAdjustmentDays +

ManualAdjustmentDays +

CarryDays +

PartTimeAdjustmentDays +

BankHolidayAdjustmentDays +

BuySellDays -

CarryLostDays +

LeaverAdjustmentDays

TotalEntitlementMinutesinteger nullable

The total Entitlement in minutes.

= BaseMinutes +

ServiceLengthAdjustmentMinutes +

NewStarterAdjustmentMinutes +

ManualAdjustmentMinutes +

CarryMinutes +

PartTimeAdjustmentMinutes +

BankHolidayAdjustmentMinutes +

BuySellMinutes -

CarryLostMinutes +

LeaverAdjustmentMinutes

SourceSystemIdstring nullable

The Internal ID of the Source HR Product.

Cascade Source: [EmployeeAttendanceEntitlementYear].[RUID]

SourceSystemCreatedOnstring date-time nullable

The date when the Entitlement record was created in the Source HR System.

Cascade Source: [EmployeeAttendanceEntitlementYear].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The date when the Entitlement record was created or last updated in the Source HR System.

Cascade Source: [EmployeeAttendanceEntitlementYear].[SYS_ModifiedDate]

Idstring nullable

This ID is generated by the Iris HR platform and does not relate to the Cascade Employee Entitlement ID.

CreatedOnstring date-time

The date when the Entitlement 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

The date when the Entitlement was created or last updated.

LastModifiedBystring nullable

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

Changes

  • 638d402d3872Revision 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

  • 7a4734dbe370Revision 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