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. |
| 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. |