| Name | Description | Type | Additional information |
|---|---|---|---|
| SchemeName | string |
Required |
|
| RolledOverDays |
Top Up Schemes: Annual Entitlement. All others: Carried Forward (Hours or Days based on scheme) |
decimal number |
None. |
| EffectiveDate | date |
Required |
|
| AccrueDaysOverride | decimal number |
None. |
|
| AccruedYTD | decimal number |
None. |
|
| TakenYTD | decimal number |
None. |
|
| AverageRate | decimal number |
None. |
|
| AllowNegative |
(Not settable via REST) Indicates whether the holiday scheme is allow to go negative. |
boolean |
None. |
| EndDate | date |
None. |
|
| AverageRateOverride | decimal number |
None. |
|
| EnhancedScheme |
Applicable for hourly/daily schemes. |
boolean |
Nullable |
| EnhancedThreshold |
Threshold value for the enhanced holiday scheme (if applicable) |
decimal number |
None. |
| EnhancedThresholdOverride |
Threshold value override for the enhanced holiday scheme (if applicable) |
decimal number |
None. |
| TakenToDate |
For enhanced holiday schemes only. How many enhanced holiday days have already been used up out of the threshold. |
decimal number |
None. |
| EnhancedAverageRate |
Average rate for the enhanced holiday scheme (if applicable) |
decimal number |
None. |
| EnhancedAverageRateOverride |
Average rate override for the enhanced holiday scheme (if applicable) |
decimal number |
None. |