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
|
RightToWorkReport
|
{RightToWorkReport}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"employer": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"lines": [
{
"employee": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"payrollCode": "string",
"department": "string",
"rightToWork": {
"checked": true,
"documentType": "Other",
"documentRef": "string",
"documentExpiry": "2024-12-22",
"note": "string"
}
}
],
"report": "GrossToNet",
"taxYear": "Year2017",
"title": "string",
"isDraft": true
},
"stream": "string"
}