Attachment of Earning Pay Instruction

See Attachment of Earnings for more information.



AoePayInstruction [Schema]

Name Type Required Description
Code SystemCode no Optional alternative pay component code. If omitted; defaults to 'AOE' pay code.
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.
IssueDate xsd:date yes The issue date. The date when the attachment comes into affect.
StopDate xsd:date no The stop date. The optional date when the attachment ends.
TotalToPay Money no The total amount to be paid.
PreviousPayments Money no The starting amount already paid. Used when the instruction started partway through the attachment. For example: when an employee starts a new job part way through the attachment period and has already made historic payments.
PreviousArrears Money no The starting amount owed in arrears. Used when the instruction started partway through the attachment. For example: when an employee starts a new job part way through the attachment period and has arrears to be settled.
ClaimAdminFee xsd:boolean yes The claim admin fee option. Determines if the admin fee should be collected.
ProtectedEarningsAmount Money no The protected earnings amount. Indicates the amount of earnings that cannot be collected in repayment of the attachment.
DeductionAmount Money no The deduction amount. Indicates the fixed amount to be collected in repayment of attachment.
ProtectedEarningsPercentage Percentage no The protected earnings percentage. Indicates the percentage of earnings that cannot be collected in repayment of attachment.
DeductionPercentage Percentage no The deduction percentage. Indicates the percentage amount to be collected in repayment of the attachment.
BeneficiaryBankAccount BankAccount no The beneficiary bank account details; this is usually the court that issued the order.

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"?>
<AoePayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2022-01-25</StartDate>
  <EndDate>2022-01-25</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Code>string</Code>
  <CaseNumber>string</CaseNumber>
  <AoeType>string</AoeType>
  <IssueDate>2022-01-25</IssueDate>
  <StopDate>2022-01-25</StopDate>
  <TotalToPay>123.99</TotalToPay>
  <PreviousPayments>123.99</PreviousPayments>
  <PreviousArrears>123.99</PreviousArrears>
  <ClaimAdminFee>true</ClaimAdminFee>
  <ProtectedEarningsAmount>123.99</ProtectedEarningsAmount>
  <DeductionAmount>123.99</DeductionAmount>
  <ProtectedEarningsPercentage>123.99</ProtectedEarningsPercentage>
  <DeductionPercentage>123.99</DeductionPercentage>
  <BeneficiaryBankAccount>
    <AccountName>string</AccountName>
    <AccountNumber>string</AccountNumber>
    <SortCode>string</SortCode>
    <Reference>string</Reference>
  </BeneficiaryBankAccount>
</AoePayInstruction>

{
  "AoePayInstruction": {
    "StartDate": "2022-01-25",
    "EndDate": "2022-01-25",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "CaseNumber": "string",
    "AoeType": "string",
    "IssueDate": "2022-01-25",
    "StopDate": "2022-01-25",
    "TotalToPay": "123.99",
    "PreviousPayments": "123.99",
    "PreviousArrears": "123.99",
    "ClaimAdminFee": "true",
    "ProtectedEarningsAmount": "123.99",
    "DeductionAmount": "123.99",
    "ProtectedEarningsPercentage": "123.99",
    "DeductionPercentage": "123.99",
    "BeneficiaryBankAccount": {
      "AccountName": "string",
      "AccountNumber": "string",
      "SortCode": "string",
      "Reference": "string"
    }
  }
}