ReportResponse[AttachmentOrder]

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
If the type is application.json then this will contain a JSON representation of the relevant model
AttachmentOrder {AttachmentOrder}
{
  "type": "string",
  "content": "string",
  "model": {
    "type": "AeoP",
    "carryForwardShortfall": true,
    "allowProtectedEarnings": true,
    "autoDeduction": true,
    "reference": "string",
    "issueDate": "2019-11-18T18:25:41",
    "applyFrom": "2019-11-18T18:25:41",
    "applyUntil": "2019-11-18T18:25:41",
    "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",
    "payments": [
      {
        "attachmentOrder": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "taxYear": "Year2017",
        "payPeriod": "Monthly",
        "date": "2019-11-18T18:25:41",
        "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"
      }
    ],
    "employee": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "id": "string"
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
AEO Statement