Holiday Scheme Pay Instruction



HolidaySchemePayInstruction [Schema]

Name Type Required Description
AnnualEntitlementDays xsd:double ( min: 0 max: 365) no [Optional] The total number of holiday entitled days annually. If omitted; use value defined in holiday scheme.
MaxCarryOverDays xsd:double ( min: 0 max: 365) no [Optional] The maximum number of unused days that can be carried into the next holiday scheme annual period. If omitted; use value defined in holiday scheme.
AllowNegativeBalance xsd:boolean no [Optional] Determines if holiday may be used before it is accrued. If omitted; use value defined in holiday scheme.
SchemeJoinDate xsd:date ( min: 1970-01-01) yes Indicates the date when the employee joined the holiday scheme.
SchemeExitDate xsd:date ( min: 1970-01-01) no [Optional] Used to specify the date when the employee left the holiday scheme. If omitted; employee considered to be continously within scheme.
AccrualType xsd:string (enumeration)
  • DaysWorkedPerWeek
  • HoursWorkedPerWeek
  • CasualOrIrregularHours
yes Determines the type of holiday accrual.
HolidayScheme Link yes A link to the related holiday scheme.

Interits from: PayInstruction[Schema]

See Understanding Pay Instructions for more information on how pay instructions can be used.

Name Type Required Description
StartDate xsd:date yes The date the instruction will come into effect.
EndDate xsd:date no The date the instruction will end, open ended instructions will run forever.
Description xsd:string ( max: 200) no The pay line descripton override; this description will override the default description from the pay code. See Customising the Payslip for more information on customising the payslip output and using runtime variables.
PayLineTag xsd:string ( max: 100) no If specified, the PayLineTag value is used to decorate all child pay lines generated by the instruction.

Example

<?xml version="1.0"?>
<HolidaySchemePayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-04-16</StartDate>
  <EndDate>2019-04-16</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AnnualEntitlementDays>123.99</AnnualEntitlementDays>
  <MaxCarryOverDays>123.99</MaxCarryOverDays>
  <AllowNegativeBalance>true</AllowNegativeBalance>
  <SchemeJoinDate>2019-04-16</SchemeJoinDate>
  <SchemeExitDate>2019-04-16</SchemeExitDate>
  <AccrualType>DaysWorkedPerWeek</AccrualType>
  <HolidayScheme title="string" href="string" rel="string" />
</HolidaySchemePayInstruction>
{
  "HolidaySchemePayInstruction": {
    "StartDate": "2019-04-16",
    "EndDate": "2019-04-16",
    "Description": "string",
    "PayLineTag": "string",
    "AnnualEntitlementDays": "123.99",
    "MaxCarryOverDays": "123.99",
    "AllowNegativeBalance": "true",
    "SchemeJoinDate": "2019-04-16",
    "SchemeExitDate": "2019-04-16",
    "AccrualType": "DaysWorkedPerWeek",
    "HolidayScheme": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    }
  }
}