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
If the type is application/json then this will contain a JSON representation of the relevant model.
|
CisSubContractorSummary[]
|
{CisSubContractorSummary}
|
|
stream
Contains PDF bytes when Type is application/octet-stream.
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": [
{
"payrollCode": "string",
"tradingName": "string",
"firstName": "string",
"lastName": "string",
"niNumber": "string",
"type": "SoleTrader",
"utr": "string",
"taxStatus": "Gross",
"verificationNumber": "string",
"displayName": "string",
"validationMessage": [
"string"
]
}
],
"stream": "string"
}
- none -
- none -