chargeDetails

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "chargeDetails",
  "required": [
    "etag",
    "status",
    "classification",
    "charge_number",
    "id"
  ],
  "properties": {
    "etag": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "The id of the charge"
    },
    "charge_code": {
      "type": "string",
      "description": "The charge code is a replacement of the mortgage description"
    },
    "classification": {
      "type": "array",
      "description": "Classification information",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/classificationDesc"
      }
    },
    "charge_number": {
      "type": "integer",
      "description": "The charge number is used to reference an individual charge"
    },
    "status": {
      "enum": [
        "outstanding",
        "fully-satisfied",
        "part-satisfied",
        "satisfied"
      ],
      "type": "string",
      "description": "The status of the charge.\n For enumeration descriptions see `status` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
    },
    "assests_ceased_released": {
      "enum": [
        "property-ceased-to-belong",
        "part-property-release-and-ceased-to-belong",
        "part-property-released",
        "part-property-ceased-to-belong",
        "whole-property-released",
        "multiple-filings",
        "whole-property-released-and-ceased-to-belong"
      ],
      "type": "string",
      "description": "Cease/release information about the charge.\n For enumeration descriptions see `assets-ceased-released` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
    },
    "acquired_on": {
      "type": "string",
      "format": "date",
      "description": "The date the property or undertaking was acquired on"
    },
    "delivered_on": {
      "type": "string",
      "format": "date",
      "description": "The date the charge was submitted to Companies House"
    },
    "resolved_on": {
      "type": "string",
      "format": "date",
      "description": "The date the issue was resolved on"
    },
    "covering_instrument_date": {
      "type": "string",
      "format": "date",
      "description": "The date by which the series of debentures were created"
    },
    "created_on": {
      "type": "string",
      "format": "date",
      "description": "The date the charge was created"
    },
    "satisfied_on": {
      "type": "string",
      "format": "date",
      "description": "The date the charge was satisfied"
    },
    "particulars": {
      "type": "array",
      "description": "Details of charge or undertaking",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/particularDesc"
      }
    },
    "secured_details": {
      "type": "array",
      "description": "Information about what is secured against this charge",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/securedDetailsDesc"
      }
    },
    "scottish_alterations": {
      "type": "array",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/alterationsDesc"
      },
      "description": "Information about alterations for Scottish companies"
    },
    "more_than_four_persons_entitled": {
      "type": "boolean",
      "description": "Charge has more than four person entitled"
    },
    "persons_entitled": {
      "type": "array",
      "description": "People that are entitled to the charge",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/persons_entitled"
      }
    },
    "transactions": {
      "type": "array",
      "description": "Transactions that have been filed for the charge.",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/transactions"
      }
    },
    "insolvency_cases": {
      "type": "array",
      "description": "Transactions that have been filed for the charge.",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/insolvency_cases"
      }
    },
    "links": {
      "type": "array",
      "description": "The resources related to this charge",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/definitions/charge_links"
      }
    }
  }
}