GrossToNetReportReportResponse

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 GrossToNetReport {GrossToNetReport}
stream
byte array
string byte "string"
{
  "type": "string",
  "content": "string",
  "model": {
    "forCis": true,
    "lines": [
      {
        "niNumber": "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,
        "lastName": "string",
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "department": "string"
      }
    ],
    "cisLines": [
      {
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "payrollCode": "string",
        "department": "string",
        "totalGross": 0.0,
        "labour": 0.0,
        "materials": 0.0,
        "taxableGross": 0.0,
        "cisDeduction": 0.0,
        "umbrellaFee": 0.0,
        "vat": 0.0,
        "payment": 0.0,
        "lastName": "string"
      }
    ],
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "payPeriod": "Custom",
    "ordinal": 0,
    "period": 0,
    "periodTo": 0,
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2024-03-19",
    "endDate": "2024-03-19",
    "report": "GrossToNet",
    "taxYear": "Year2017",
    "title": "string",
    "isDraft": true
  },
  "stream": "string"
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Gross To Net