Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details
| Name / Description | Type / Format | Example | |
|---|---|---|---|
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
|
string
|
"string"
|
|
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
|
string
|
"string"
|
|
model
Used to represent an Attachment of Earnings Order (AEO)
|
AttachmentOrder
|
{AttachmentOrder}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"type": "AeoP",
"carryForwardShortfall": true,
"allowProtectedEarnings": true,
"autoDeduction": true,
"reference": "string",
"issueDate": "2024-12-22",
"applyFrom": "2024-12-22",
"applyUntil": "2024-12-22",
"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-22",
"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"
},
"stream": "string"
}