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
|
GenderPayGapReport
|
{GenderPayGapReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"genderPayGapLines": [
{
"payrollCode": "string",
"forename": "string",
"surname": "string",
"gender": "Male",
"fullPay": "string",
"ordinaryPay": 0.0,
"periodBonus": 0.0,
"bonusRbp": 0.0,
"weeklyHours": 0.0,
"hourlyRate": 0.0
}
],
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}