Used to represent an Attachment of Earnings Order (AEO)
| Name / Description | Type / Format | Example | |
|---|---|---|---|
type
|
string
|
"AeoP"
"Aeo"
"Csa"
"Csa2012"
"Deo"
"AeoNp"
"CcPre92"
"CcPost92"
"Ctaeo"
"Mcaeo"
"Ea"
"Cma"
"Cao"
"Isd"
"Ea2006"
"Caps"
"Dea"
"DeaHigher"
"DeaFixed"
"CtaeoWales"
|
|
carryForwardShortfall
[ReadOnly] Whether or not shortfalls should be carried forward
|
boolean
|
true
|
|
allowProtectedEarnings
[ReadOnly] Whether or not shortfalls should be carried forward
|
boolean
|
true
|
|
autoDeduction
Whether or not the amount to be deducted is automatically calculated
|
boolean
|
true
|
|
reference
The reference which appeared on the court paperwork
|
string
|
"string"
|
|
issueDate
The date of issue for this Order
|
string
date
|
"2024-12-31"
|
|
applyFrom
The date from which to apply this Order
|
string
date
|
"2024-12-31"
|
|
applyUntil
An optional date on which to stop applying this order
|
string
date
|
"2024-12-31"
|
|
deductionIsPercentage
Whether or not the amount given for Deduction is a percentage rather than a fixed amount
|
boolean
|
true
|
|
deduction
The percentage or amount (depending on DeductionIsPercentage) to deduct
|
number
double
|
0.0
|
|
protectedEarningsIsPercentage
Whether or not the amount for ProtectedEarnings is a percentage rather than a fixed amount.
|
boolean
|
true
|
|
protectedEarnings
The percentage or amount or percentage (depending on ProtectedEarningsIsPercentage) to protect
|
number
double
|
0.0
|
|
chargeAdminFee
Whether or not a £1 admin fee should be deducted for this order
|
boolean
|
true
|
|
shortfall
Any shortfall that is being carried forward
|
number
double
|
0.0
|
|
stopWhenTotalPaid
Whether or not this order should be stopped once a total amount has been paid
|
boolean
|
true
|
|
totalAmountToPay
The Total amount that needs to be paid for this Order
|
number
double
|
0.0
|
|
amountPreviouslyPaid
Any amount that has previously been paid towards this Order
|
number
double
|
0.0
|
|
stopped
Whether or not this Order has been stopped.
This is set automatically when either it's paid in full or the ApplyUntil date has been reached. |
boolean
|
true
|
|
notes
A free-form text field to record any comments
|
string
|
"string"
|
|
includeBankDetails
|
boolean
|
true
|
|
bankDetails
|
BankDetails
|
{BankDetails}
|
|
payments
Payments made towards this order. Only populated when viewed as a report.
|
AttachmentOrderPayment[]
|
{AttachmentOrderPayment}
|
|
payee
The Id of the Payee, if any, that deductions are to be paid to.
|
string
uuid
|
"string"
|
|
payeeName
The name of the Payee, if any, that deductions are to be paid to.
|
string
|
"string"
|
|
documentCount
The number of attachments associated with this model
|
integer
int32
|
0
|
|
documents
The attachments associated with this model
|
Item[]
|
{Item}
|
|
employee
|
Item
|
{Item}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"type": "AeoP",
"carryForwardShortfall": true,
"allowProtectedEarnings": true,
"autoDeduction": true,
"reference": "string",
"issueDate": "2024-12-31",
"applyFrom": "2024-12-31",
"applyUntil": "2024-12-31",
"deductionIsPercentage": true,
"deduction": 0.0,
"protectedEarningsIsPercentage": true,
"protectedEarnings": 0.0,
"chargeAdminFee": true,
"shortfall": 0.0,
"stopWhenTotalPaid": true,
"totalAmountToPay": 0.0,
"amountPreviouslyPaid": 0.0,
"stopped": true,
"notes": "string",
"includeBankDetails": true,
"bankDetails": {
"bankName": "string",
"bankBranch": "string",
"bankReference": "string",
"accountName": "string",
"accountNumber": "string",
"sortCode": "string",
"note": "string",
"buildingSocietyRollNumber": "string"
},
"payments": [
{
"attachmentOrder": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"taxYear": "Year2017",
"payPeriod": "Custom",
"date": "2024-12-31",
"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"
}
],
"payee": "string",
"payeeName": "string",
"documentCount": 0,
"documents": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"id": "string"
}