CisDetails

If an Employee is marked as a CIS Subcontractor then this model provides further details specifically related to the CIS details of the Employee.

Schema

Name / Description Type / Format Example
type string "SoleTrader" "Partnership" "Company" "Trust"
utr string "string"
tradingName string "string"
companyUtr string "string"
companyNumber string "string"
vatRegistered boolean true
vatNumber string "string"
vatRate number double 0.0
reverseChargeVAT boolean true
verification CisVerificationDetails {CisVerificationDetails}

JSON Example 

{
  "type": "SoleTrader",
  "utr": "string",
  "tradingName": "string",
  "companyUtr": "string",
  "companyNumber": "string",
  "vatRegistered": true,
  "vatNumber": "string",
  "vatRate": 0.0,
  "reverseChargeVAT": true,
  "verification": {
    "manuallyEntered": true,
    "matchInsteadOfVerify": true,
    "number": "string",
    "date": "2024-12-22",
    "taxStatus": "Gross",
    "verificationRequest": "string",
    "verificationResponse": {
      "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"
    }
  }
}

References

Contained in Models
EmploymentDetails
Consumed by Operations

- none -

Returned by Operations

- none -