FullSummaryOfPayReportReportResponse

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

Schema

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 FullSummaryOfPayReport {FullSummaryOfPayReport}
stream
byte array
 string byte "string"

JSON Example 

{
  "type": "string",
  "content": "string",
  "model": {
    "lines": [
      {
        "payCode": {
          "title": "string",
          "code": "string",
          "defaultValue": 0.0,
          "isDeduction": true,
          "isNiable": true,
          "isTaxable": true,
          "isPensionable": true,
          "isAttachable": true,
          "isRealTimeClass1aNiable": true,
          "isNotContributingToHolidayPay": true,
          "isQualifyingEarningsForAe": true,
          "isNotTierable": true,
          "isTcp_Tcls": true,
          "isTcp_Pp": true,
          "isTcp_Op": true,
          "flexibleDrawdown": "None",
          "isAutoAdjust": true,
          "calculationType": "FixedAmount",
          "multiplierType": "None",
          "dailyRateMultiplier": 0.0,
          "hourlyRateMultiplier": 0.0,
          "isSystemCode": true,
          "isControlCode": true,
          "isNotional": true,
          "payee": "string"
        },
        "value": 0.0,
        "erValue": 0.0,
        "qty": 0.0,
        "headCount": 0
      }
    ],
    "deductionLines": [
      {
        "payCode": {
          "title": "string",
          "code": "string",
          "defaultValue": 0.0,
          "isDeduction": true,
          "isNiable": true,
          "isTaxable": true,
          "isPensionable": true,
          "isAttachable": true,
          "isRealTimeClass1aNiable": true,
          "isNotContributingToHolidayPay": true,
          "isQualifyingEarningsForAe": true,
          "isNotTierable": true,
          "isTcp_Tcls": true,
          "isTcp_Pp": true,
          "isTcp_Op": true,
          "flexibleDrawdown": "None",
          "isAutoAdjust": true,
          "calculationType": "FixedAmount",
          "multiplierType": "None",
          "dailyRateMultiplier": 0.0,
          "hourlyRateMultiplier": 0.0,
          "isSystemCode": true,
          "isControlCode": true,
          "isNotional": true,
          "payee": "string"
        },
        "value": 0.0,
        "erValue": 0.0,
        "qty": 0.0,
        "headCount": 0
      }
    ],
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "payPeriod": "Custom",
    "ordinal": 0,
    "period": 0,
    "periodTo": 0,
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2024-11-21",
    "endDate": "2024-11-21",
    "report": "GrossToNet",
    "taxYear": "Year2017",
    "title": "string",
    "isDraft": true
  },
  "stream": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Cost Of Employment