Contract.LeaveSettingsResponse

Name / Description Type / Format Example
allowanceUsed
The number of days used from the allowance since last reset
number double 0.0
allowanceUsedPreviousPeriod
The number of days used in the 12 months prior to the last reset
number double 0.0
allowanceRemaining
The number of days remaining of the allowance until next reset
number double 0.0
accruedPaymentLiability
The total accrued payments for this employee over the lifetime of their employment so far
number double 0.0
accruedPaymentPaid
The Total amount paid to this employee in lieu of holidays
number double 0.0
accruedPaymentBalance
The balance of what is owed to this employee in lieu of holidays
number double 0.0
accruedHoursAmount
The total accrued hours for this employee over the lifetime of their employment so far
number double 0.0
accruedHoursPaid
The Total amount of hours paid to this employee in lieu of holidays
number double 0.0
accruedHoursBalance
The balance of hours owed to this employee in lieu of holidays
number double 0.0
useDefaultHolidayType
If true then the value for HolidayType comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAllowanceResetDate
If true then the value for the AllowanceResetDate comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAllowance
If true then the value for the Allowance comes from the Employer record.
This property only appears if the LeaveSettings if a child of an Employee (not of an Employer)
boolean true
useDefaultAccruePaymentInLieu
If true then the value for AccruePaymentInLieu comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAccruePaymentInLieuRate
If true then the value for AccruePaymentInLieuRate comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAccruePaymentInLieuAllGrossPay
[Deprecated] Please use UseUseDefaultHolidayAccrualBasis instead.
This filed will be removed in a later release.
boolean true
useDefaultHolidayAccrualBasis
If true then the value for HolidayAccrualBasis comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAccruePaymentInLieuPayAutomatically
If true then the value for AccruePaymentInLieu comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultAccrueHoursPerDay
If true then the value for AccrueHoursPerDay comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
useDefaultMaximumAccruePeriod
If true then the value for MaximumAccruePeriod comes from the Employer record.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
boolean true
allowanceResetDate
The date that the holiday allowance resets. Only the day/month part of the value is relevant.
string date "2024-06-24"
allowance
The number of days holiday an employee can take per year if HolidayType is Days.
Otherwise this is readonly and gives you the number of days accrued since the last reset
number double 0.0
adjustment
Adjustment to number of hours/days/weeks holiday this employee can take per year.
Will reset to 0 when the Allowance resets.
This property only appears if the LeaveSettings is a child of an Employee (not of an Employer)
number double 0.0
holidayType string "Days" "Accrual_Money" "Accrual_Days" "Accrual_Hours"
accrueSetAmount
If true and HolidayType is Accrual_Days then the AccruePaymentInLieuRate will be treated as the set amount to accrue per period worked.
boolean true
accrueHoursPerDay
If HolidayType is Accrual_Days then this value is used to help convert hours worked into days accrued
number double 0.0
showAllowanceOnPayslip
If true then the remaining Allowance will be shown on the employees payslip.
boolean true
showAhpOnPayslip
If true then the AHP balance will be shown on the employees payslip.
boolean true
accruePaymentInLieuRate
The rate at which Payments in Lieu acrrue. Typically this should be 12.07%.
number double 0.0
accruePaymentInLieuAllGrossPay
[Deprecated] Please use HolidayAccrualBasis instead.
This filed will be removed in a later release.
boolean true
accruePaymentInLieuPayAutomatically
Set to true if you want employees to be automatically paid any outstanding holiday pay
boolean true
occupationalSicknessUniqueId string uuid "string"
accruedPaymentAdjustment
Any manual adjustment to the total accrued
number double 0.0
accruedHoursAdjustment
Any manual adjustment to the total hours accrued
number double 0.0
holidayAccrualBasis string "RegularPayOnly" "AllGrossPay" "PaycodeSet" "WorkingPatternHours"
holidayAccrualDefaultRateType string "HourlyRate" "AverageHolidayRate" "FixedPeriodAmount"
aggregatedServiceDate string date "2024-06-24"
useAggregatedServiceDate boolean true
accruePayCodeSetUniqueId
Pay code set to use for accruing holiday pay
string uuid "string"
maximumAccruePeriod
The maximum number of hours capable of being accrued in a single period
number double 0.0
holidayLeaveAccrualCustomRateType string "HourlyRate" "AverageHolidayRate" "FixedPeriodAmount"
useDefaultHolidayAccrualDefaultRateType
If true then the value for HolidayAccrualDefaultRateType comes from the Employer record.
boolean true
{
  "allowanceUsed": 0.0,
  "allowanceUsedPreviousPeriod": 0.0,
  "allowanceRemaining": 0.0,
  "accruedPaymentLiability": 0.0,
  "accruedPaymentPaid": 0.0,
  "accruedPaymentBalance": 0.0,
  "accruedHoursAmount": 0.0,
  "accruedHoursPaid": 0.0,
  "accruedHoursBalance": 0.0,
  "useDefaultHolidayType": true,
  "useDefaultAllowanceResetDate": true,
  "useDefaultAllowance": true,
  "useDefaultAccruePaymentInLieu": true,
  "useDefaultAccruePaymentInLieuRate": true,
  "useDefaultAccruePaymentInLieuAllGrossPay": true,
  "useDefaultHolidayAccrualBasis": true,
  "useDefaultAccruePaymentInLieuPayAutomatically": true,
  "useDefaultAccrueHoursPerDay": true,
  "useDefaultMaximumAccruePeriod": true,
  "allowanceResetDate": "2024-06-24",
  "allowance": 0.0,
  "adjustment": 0.0,
  "holidayType": "Days",
  "accrueSetAmount": true,
  "accrueHoursPerDay": 0.0,
  "showAllowanceOnPayslip": true,
  "showAhpOnPayslip": true,
  "accruePaymentInLieuRate": 0.0,
  "accruePaymentInLieuAllGrossPay": true,
  "accruePaymentInLieuPayAutomatically": true,
  "occupationalSicknessUniqueId": "string",
  "accruedPaymentAdjustment": 0.0,
  "accruedHoursAdjustment": 0.0,
  "holidayAccrualBasis": "RegularPayOnly",
  "holidayAccrualDefaultRateType": "HourlyRate",
  "aggregatedServiceDate": "2024-06-24",
  "useAggregatedServiceDate": true,
  "accruePayCodeSetUniqueId": "string",
  "maximumAccruePeriod": 0.0,
  "holidayLeaveAccrualCustomRateType": "HourlyRate",
  "useDefaultHolidayAccrualDefaultRateType": true
}
Contained in Models
Contract.EmployeeResponse
Consumed by Operations

- none -

Returned by Operations

- none -