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
|
Cis300
|
{Cis300}
|
|
stream
byte array
|
string
byte
|
"string"
|
{
"type": "string",
"content": "string",
"model": {
"taxMonth": 0,
"employeeCount": 0,
"employmentStatusDeclaration": true,
"verificationDeclaration": true,
"informationCorrectDeclaration": true,
"inactivityDeclaration": true,
"cisReturn": {
"contractor": {
"utr": "string",
"aOref": "string"
},
"subcontractor": [
{
"employeeUniqueId": "string",
"emailStatementTo": "string",
"numberOfPayments": 0,
"item": "error too many levels",
"displayName": "string",
"action": "string",
"type": "string",
"name": "error too many levels",
"tradingName": "string",
"worksRef": "string",
"unmatchedRate": "string",
"utr": "string",
"crn": "string",
"nino": "string",
"partnership": "error too many levels",
"address": "error too many levels",
"telephone": "string",
"totalPaymentsUnrounded": "string",
"costOfMaterialsUnrounded": "string",
"umbrellaFee": "string",
"validationMsg": "string",
"verificationNumber": "string",
"totalPayments": "string",
"costOfMaterials": "string",
"totalDeducted": "string",
"matched": "string",
"taxTreatment": "string",
"netPayment": "string",
"vatAmount": "string"
}
],
"nilReturn": "string",
"declarations": {
"employmentStatus": "string",
"verification": "string",
"informationCorrect": "string",
"inactivity": "string"
}
},
"iRmark": "string",
"xml": "string",
"taxYear": "Year2017",
"employerReferences": {
"officeNo": "string",
"payeRef": "string",
"aoRef": "string",
"econ": "string",
"cotaxRef": "string",
"sautr": "string"
},
"govTalkSubmission": {
"rawResponse": "string",
"messageClass": "string",
"pollInterval": 0,
"lastPoll": "2024-11-21T14:18:25",
"correlationId": "string",
"url": "string",
"status": "NotSubmitted",
"message": "string",
"iRmark": "string",
"errorsJson": "string",
"errors": [
{
"raisedBy": "string",
"number": "string",
"type": "string",
"text": "string",
"location": "string"
}
],
"submittedAt": "2024-11-21T14:18:25",
"id": "string"
},
"id": "string"
},
"stream": "string"
}