Used to represent a payment towards an Attachment of Earnings Order (AEO)
| Name / Description | Type / Format | Example | |
|---|---|---|---|
attachmentOrder
|
Item
|
{Item}
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
payPeriod
|
string
|
"Custom"
"Monthly"
"FourWeekly"
"Fortnightly"
"Weekly"
"Daily"
|
|
date
The date this deduction was made
|
string
date
|
"2024-11-21"
|
|
description
Description of deduction, usually the reference from the AttachmentOrder
|
string
|
"string"
|
|
attachablePay
The total Attachable pay for the Employee on this PayRun
|
number
double
|
0.0
|
|
protectedPay
The amount of the Attachable Pay that must be protected
|
number
double
|
0.0
|
|
otherAttachmentOrderDeductions
Deductions made on this PayRun for this employee due to other higher priority AttachmentOrders
|
number
double
|
0.0
|
|
desiredDeduction
The amount that should be deducted, if arrestable pay is available.
Not including any shortfall |
number
double
|
0.0
|
|
shortfall
Any shortfall (ie arrears) that existed before this PayRun.
|
number
double
|
0.0
|
|
totalPaid
Total amount paid to date, including this deduction.
|
number
double
|
0.0
|
|
resultingDeduction
The actual amount deducted
|
number
double
|
0.0
|
|
resultingShortfall
The resulting shortfall (including any shortfall from previous periods
|
number
double
|
0.0
|
|
adminFee
Any admin fee charged
|
number
double
|
0.0
|
|
employee
|
Item
|
{Item}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"attachmentOrder": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"taxYear": "Year2017",
"payPeriod": "Custom",
"date": "2024-11-21",
"description": "string",
"attachablePay": 0.0,
"protectedPay": 0.0,
"otherAttachmentOrderDeductions": 0.0,
"desiredDeduction": 0.0,
"shortfall": 0.0,
"totalPaid": 0.0,
"resultingDeduction": 0.0,
"resultingShortfall": 0.0,
"adminFee": 0.0,
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"id": "string"
}