Furlough YTD Pay Instruction

Implemented to support the emergency furloughed employee scheme introduced in response to the COVID-19 pandemic 2020-03-01.

FurloughYtdPayInstruction [Schema]

Name	Type	Required	Description
Value	Money	yes	The value of the furlough payment.
EntitlementMonthStart	xsd:date	yes	The entitlement period month start date. E.g 2020-03-01 for 1st March 2020.
IsAdjustment	xsd:boolean	yes	Indicates if the instruction is an adjustment. Pay lines generated from adjustment YTD instructions appear on the employee pay slip.

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"?>
<FurloughYtdPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2022-01-12</StartDate>
  <EndDate>2022-01-12</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Value>123.99</Value>
  <EntitlementMonthStart>2022-01-12</EntitlementMonthStart>
  <IsAdjustment>true</IsAdjustment>
</FurloughYtdPayInstruction>

{
  "FurloughYtdPayInstruction": {
    "StartDate": "2022-01-12",
    "EndDate": "2022-01-12",
    "Description": "string",
    "PayLineTag": "string",
    "Value": "123.99",
    "EntitlementMonthStart": "2022-01-12",
    "IsAdjustment": "true"
  }
}