Cis300

Schema

Name / Description Type / Format Example
taxMonth integer int32 0
employeeCount integer int32 0
employmentStatusDeclaration boolean true
verificationDeclaration boolean true
informationCorrectDeclaration boolean true
inactivityDeclaration boolean true
cisReturn CisReturn {CisReturn}
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"

JSON Example 

{
  "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": {
          "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"
      }
    ],
    "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-12-22T03:20:42",
    "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-22T03:20:42",
    "id": "string"
  },
  "id": "string"
}

References

Contained in Models
Cis300ReportResponse
Consumed by Operations
Create Cis300
Update Cis300
Returned by Operations
Create Cis300
Update Cis300
Get Cis300
Submit Cis300
Mark as Sent