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
Contains the filename for application/octet-stream, HTML or other text content depending on Type.
For the deprecated application/pdf type, this contains a link to the PDF file; its end-of-life date is 1st February 2027. |
string
|
"string"
|
|
model
|
SpinePointReport
|
{SpinePointReport}
|
|
stream
Contains PDF bytes when Type is application/octet-stream.
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"lines": [
{
"spineName": "string",
"spinePointName": "string",
"number": 0,
"effectiveDate": "2026-10-31",
"annualValue": 0.0,
"annualValueAltMax": 0.0,
"annualValueLAInner": 0.0,
"annualValueLAInnerAltMax": 0.0,
"annualValueLAOuter": 0.0,
"annualValueLAOuterAltMax": 0.0,
"annualValueLAFringe": 0.0,
"annualValueLAFringeAltMax": 0.0,
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payrollCode": "string",
"department": "string"
}
],
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}