Used to represent an Attachment of Earnings Order (AEO)
Name / Description | Type / Format | Example | |
---|---|---|---|
issueDate
The date the Loan was made
|
string
date
|
"2024-12-05"
|
|
reference
An optional reference for this Loan
|
string
|
"string"
|
|
payCode
The Code of the PayCode used for recording payments.
The PayCode must have a CalculationType of FixedAmount and not be a multiplier code |
string
|
"string"
|
|
loanAmount
The initial amount that the loan was for
|
number
double
|
0.0
|
|
periodAmount
The amount to deduct per PayPeriod
|
number
double
|
0.0
|
|
amountRepaid
The amount repaid so far due to deductions in Payruns
|
number
double
|
0.0
|
|
previouslyPaid
Any amount by which to adjust the Balance, perhaps due to repayments made elsewhere
|
number
double
|
0.0
|
|
balance
The Balance of the Loan
|
number
double
|
0.0
|
|
isSettled
|
boolean
|
true
|
|
isPaused
If set to true then deductions will not be made
|
boolean
|
true
|
|
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"
|
{
"issueDate": "2024-12-05",
"reference": "string",
"payCode": "string",
"loanAmount": 0.0,
"periodAmount": 0.0,
"amountRepaid": 0.0,
"previouslyPaid": 0.0,
"balance": 0.0,
"isSettled": true,
"isPaused": true,
"documentCount": 0,
"documents": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"id": "string"
}
- none -