Pay Line Attachment of Earning

The attachment of earning pay line. Generated in response to court orders. See Attachment of Earnings for more information.

PayLineAoe [Schema]

This type is readonly.

Name Type Description
CaseNumber xsd:string The attachment of earning case number. Used to identify the attachment order associated with the pay line.
Arrears Money The attachment of earning arrears. Represents the cumulative balance of arrears on the attachment order. A positive number indicates arrears have increased; a negative number indicates arrears have decreased.
ArrestablePay Money The amount of pay considered during the arrestment calculation.

Interits from: PayLine[Schema]

Name Type Description
PayLine PayLine
Description xsd:string ( max: 100) The description of the pay line displayed in the payslip report.
Calculator xsd:string ( max: 300) The name of a Calculator responsible for generating the pay line.
Generated xsd:dateTime The date and time the pay line was generated.
PayCode xsd:string ( max: 35) A loose linkage to the type of pay line and it's calculator treatment.
PayCodeType SystemCodeType The category of pay line.
Value Money The monetary value of the pay line; used in the net pay sum. Typically positive for payments and negative for deductions.
PaymentDate xsd:date The date the employees were paid in the pay run. Not applicable for year to date generated lines.
TaxYear xsd:integer The tax year the pay run was in.
TaxPeriod xsd:integer The tax period the pay run was in.
PayRunSequence xsd:integer The sequence number of the owning pay run.


<?xml version="1.0"?>
<PayLineAoe xmlns:xsi="" xmlns:xsd="">
  "PayLineAoe": {
    "Description": "string",
    "Calculator": "string",
    "Generated": "2022-01-25T00:00:00+00:00",
    "PayCode": "string",
    "PayCodeType": "NotSet",
    "Value": "123.99",
    "PaymentDate": "2022-01-25",
    "TaxYear": "123",
    "TaxPeriod": "123",
    "PayRunSequence": "123",
    "CaseNumber": "string",
    "Arrears": "123.99",
    "ArrestablePay": "123.99"