If an Employee is marked as a CIS Subcontractor then this model is included ad a child of CisDetails and is used to represent the Verification details of the Subcontractor
| Name / Description | Type / Format | Example | |
|---|---|---|---|
employees
|
Item[]
|
{Item}
|
|
employeeCount
|
integer
int32
|
0
|
|
cisRequest
|
CisRequest
|
{CisRequest}
|
|
responses
|
CisSubContractor[]
|
{CisSubContractor}
|
|
iRmark
|
string
|
"string"
|
|
xml
This property will soon be removed and should not be used.
There is now a dedicated API endpoint for retrieving the XML for a submission. |
string
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
employerReferences
|
EmpRefs
|
{EmpRefs}
|
|
govTalkSubmission
|
GovTalkSubmission
|
{GovTalkSubmission}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"employees": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"employeeCount": 0,
"cisRequest": {
"contractor": {
"utr": "string",
"aOref": "string"
},
"subcontractor": [
{
"employeeUniqueId": "string",
"emailStatementTo": "string",
"numberOfPayments": 0,
"item": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"displayName": "string",
"action": "string",
"type": "string",
"name": {
"ttl": "string",
"fore": [
"string"
],
"initials": "string",
"sur": "string"
},
"tradingName": "string",
"worksRef": "string",
"unmatchedRate": "string",
"utr": "string",
"crn": "string",
"nino": "string",
"partnership": {
"name": "string",
"utr": "string"
},
"address": {
"line": [
"string"
],
"postcode": "string",
"postCode": "string",
"ukPostcode": "string",
"country": "string",
"foreignCountry": "string"
},
"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"
}
],
"declaration": "string"
},
"responses": [
{
"employeeUniqueId": "string",
"emailStatementTo": "string",
"numberOfPayments": 0,
"item": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"displayName": "string",
"action": "string",
"type": "string",
"name": {
"ttl": "string",
"fore": [
"string"
],
"initials": "string",
"sur": "string"
},
"tradingName": "string",
"worksRef": "string",
"unmatchedRate": "string",
"utr": "string",
"crn": "string",
"nino": "string",
"partnership": {
"name": "string",
"utr": "string"
},
"address": {
"line": [
"string"
],
"postcode": "string",
"postCode": "string",
"ukPostcode": "string",
"country": "string",
"foreignCountry": "string"
},
"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"
}
],
"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-12-22T02:57:44",
"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-12-22T02:57:44",
"id": "string"
},
"id": "string"
}- none -