Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Name / Description Type / Format Example
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model StatutoryPayReport {StatutoryPayReport}
byte array
string byte "string"
  "type": "string",
  "content": "string",
  "model": {
    "lines": [
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        "payrollCode": "string",
        "department": "string",
        "ssp": 0.0,
        "smp": 0.0,
        "spp": 0.0,
        "sap": 0.0,
        "shpp": 0.0,
        "spbp": 0.0,
        "hasStatPay": true,
        "totalStatPay": 0.0
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    "payPeriod": "Custom",
    "ordinal": 0,
    "period": 0,
    "periodTo": 0,
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2024-06-24",
    "endDate": "2024-06-24",
    "report": "GrossToNet",
    "taxYear": "Year2017",
    "title": "string",
    "isDraft": true
  "stream": "string"
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Statutory Pay