ReportResponse[GrossToNetReport]

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
GrossToNetReport {GrossToNetReport}
{
  "type": "string",
  "content": "string",
  "model": {
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "taxYear": "Year2017",
    "payPeriod": "Monthly",
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2019-11-13T23:32:43",
    "endDate": "2019-11-13T23:32:43",
    "lines": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "totalGross": 0.0,
        "taxableGross": 0.0,
        "netPay": 0.0,
        "tax": 0.0,
        "employeeNi": 0.0,
        "employerNi": 0.0,
        "employeePension": 0.0,
        "employerPension": 0.0,
        "studentOrPgLoan": 0.0,
        "statutoryPayments": 0.0,
        "attachments": 0.0,
        "otherDeductions": 0.0
      }
    ]
  }
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Gross To Net