ReportResponse[AnalysisReport]

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
AnalysisReport {AnalysisReport}
{
  "type": "string",
  "content": "string",
  "model": {
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "taxYear": "Year2017",
    "payPeriod": "Monthly",
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2020-01-18T06:47:44",
    "endDate": "2020-01-18T06:47:44",
    "lines": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "gross": 0.0,
        "net": 0.0,
        "takeHome": 0.0,
        "employerNic": 0.0,
        "employerPension": 0.0,
        "lines": [
          {
            "code": "string",
            "value": 0.0
          }
        ]
      }
    ],
    "payCodes": [
      {
        "title": "string",
        "code": "string",
        "defaultValue": 0.0,
        "isDeduction": true,
        "isNiable": true,
        "isTaxable": true,
        "isPensionable": true,
        "isAttachable": true,
        "isRealTimeClass1aNiable": true,
        "calculationType": "FixedAmount",
        "multiplierType": "None",
        "isSystemCode": true,
        "isControlCode": true
      }
    ]
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Analysis