AOE YTD Pay Instruction

AoeYtdPayInstruction [Schema]

Name	Type	Required	Description
Value	Money	yes	The value to apply to the generated line. Used to represent the amount already repaid against the attachment.
CaseNumber	xsd:string ( min: 1 max: 250)	yes	The attachment of earnings case number. Used to uniquely identify the attachment order.
AoeType	AoeType	yes	The attachment of earnings type.
Arrears	Money	yes	The attachment of earnings arrears amount. The arrears indicates the amount of money owed that could not be repaid in time due to insufficient earnings.
ArrestablePay	Money	no	The year to date arrestable pay amount.
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"?>
<AoeYtdPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2020-07-05</StartDate>
  <EndDate>2020-07-05</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Value>123.99</Value>
  <CaseNumber>string</CaseNumber>
  <AoeType>string</AoeType>
  <Arrears>123.99</Arrears>
  <ArrestablePay>123.99</ArrestablePay>
  <IsAdjustment>true</IsAdjustment>
</AoeYtdPayInstruction>

{
  "AoeYtdPayInstruction": {
    "StartDate": "2020-07-05",
    "EndDate": "2020-07-05",
    "Description": "string",
    "PayLineTag": "string",
    "Value": "123.99",
    "CaseNumber": "string",
    "AoeType": "string",
    "Arrears": "123.99",
    "ArrestablePay": "123.99",
    "IsAdjustment": "true"
  }
}