Companies House Public Data API: chargeList

Methods

get - Charges

Resource

{
    "etag": "string",
    "items": [
        {
            "acquired_on": "date",
            "assests_ceased_released": "string",
            "charge_code": "string",
            "charge_number": "integer",
            "classification": [
                {
                    "description": "string",
                    "type": "string"
                }
            ],
            "covering_instrument_date": "date",
            "created_on": "date",
            "delivered_on": "date",
            "etag": "string",
            "id": "string",
            "insolvency_cases": [
                {
                    "case_number": "string",
                    "links": [
                        {
                            "case": "string"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "self": "string"
                }
            ],
            "more_than_four_persons_entitled": "boolean",
            "particulars": [
                {
                    "chargor_acting_as_bare_trustee": "boolean",
                    "contains_fixed_charge": "boolean",
                    "contains_floating_charge": "boolean",
                    "contains_negative_pledge": "boolean",
                    "description": "string",
                    "floating_charge_covers_all": "boolean",
                    "type": "string"
                }
            ],
            "persons_entitled": [
                {
                    "name": "string"
                }
            ],
            "resolved_on": "date",
            "satisfied_on": "date",
            "scottish_alterations": [
                {
                    "has_alterations_to_order": "boolean",
                    "has_alterations_to_prohibitions": "boolean",
                    "has_alterations_to_provisions": "boolean"
                }
            ],
            "secured_details": [
                {
                    "description": "string",
                    "type": "string"
                }
            ],
            "status": "string",
            "transactions": [
                {
                    "delivered_on": "date",
                    "filing_type": "string",
                    "insolvency_case_number": "string",
                    "links": [
                        {
                            "filing": "string",
                            "insolvency_case": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "part_satisfied_count": "integer",
    "satisfied_count": "integer",
    "total_count": "integer",
    "unfiletered_count": "integer"
}

Properties

Name	Type	Description	Additional
etag	string	The ETag of the resource.
items[]	array	List of charges
items[].acquired_on	date	The date the property or undertaking was acquired on	Optional
items[].assests_ceased_released	string	Cease/release information about the charge. For enumeration descriptions see `assets-ceased-released` section in the enumeration mappings Possible values are: `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`	Optional
items[].charge_code	string	The charge code is a replacement of the mortgage description	Optional
items[].charge_number	integer	The charge number is used to reference an individual charge
items[].classification[]	array	Classification information
items[].classification[].description	string	Details of the charge classification
items[].classification[].type	string	The type of charge classication. For enumeration descriptions see `classificationDesc` section in the enumeration mappings Possible values are: `charge-description` `nature-of-charge`
items[].covering_instrument_date	date	The date by which the series of debentures were created	Optional
items[].created_on	date	The date the charge was created	Optional
items[].delivered_on	date	The date the charge was submitted to Companies House	Optional
items[].etag	string
items[].id	string	The id of the charge
items[].insolvency_cases[]	array	Transactions that have been filed for the charge.	Optional
items[].insolvency_cases[].case_number	string	The number of this insolvency case	Optional
items[].insolvency_cases[].links[]	array	The resources related to this insolvency case	Optional
items[].insolvency_cases[].links[].case	string	Link to the insolvency case data	Optional
items[].links[]	array	The resources related to this charge	Optional
items[].links[].self	string	Link to the this charge data
items[].more_than_four_persons_entitled	boolean	Charge has more than four person entitled	Optional
items[].particulars[]	array	Details of charge or undertaking	Optional
items[].particulars[].chargor_acting_as_bare_trustee	boolean	The chargor is acting as a bare trustee for the property	Optional
items[].particulars[].contains_fixed_charge	boolean	The charge contains a fixed charge	Optional
items[].particulars[].contains_floating_charge	boolean	The charge contains a floating charge	Optional
items[].particulars[].contains_negative_pledge	boolean	The charge contains a negative pledge	Optional
items[].particulars[].description	string	Details of charge particulars
items[].particulars[].floating_charge_covers_all	boolean	The floating charge covers all the property or undertaking or the company	Optional
items[].particulars[].type	string	The type of charge particulars. For enumeration descriptions see `particular-description` section in the enumeration mappings Possible values are: `short-particulars` `charged-property-description` `charged-property-or-undertaking-description` `brief-description`
items[].persons_entitled[]	array	People that are entitled to the charge	Optional
items[].persons_entitled[].name	string	The name of the person entitled.
items[].resolved_on	date	The date the issue was resolved on	Optional
items[].satisfied_on	date	The date the charge was satisfied	Optional
items[].scottish_alterations[]	array	Information about alterations for Scottish companies	Optional
items[].scottish_alterations[].has_alterations_to_order	boolean	The charge has alterations to order	Optional
items[].scottish_alterations[].has_alterations_to_prohibitions	boolean	The charge has alterations to prohibitions	Optional
items[].scottish_alterations[].has_alterations_to_provisions	boolean	The charge has provisions restricting the creation of further charges	Optional
items[].secured_details[]	array	Information about what is secured against this charge	Optional
items[].secured_details[].description	string	Details of the amount or obligation secured by the charge
items[].secured_details[].type	string	The type of secured details. For enumeration descriptions see `secured-details-description` section in the enumeration mappings Possible values are: `amount-secured` `obligations-secured`
items[].status	string	The status of the charge. For enumeration descriptions see `status` section in the enumeration mappings Possible values are: `outstanding` `fully-satisfied` `part-satisfied` `satisfied`
items[].transactions[]	array	Transactions that have been filed for the charge.	Optional
items[].transactions[].delivered_on	date	The date the filing was submitted to Companies House	Optional
items[].transactions[].filing_type	string	Filing type which created, updated or satisfied the charge	Optional
items[].transactions[].insolvency_case_number	string	The insolvency case related to this filing	Optional
items[].transactions[].links[]	array	The resources related to this filing	Optional
items[].transactions[].links[].filing	string	Link to the charge filing data	Optional
items[].transactions[].links[].insolvency_case	string	Link to the insolvency case related to this filing	Optional
part_satisfied_count	integer	Number of satisfied charges	Optional
satisfied_count	integer	Number of satisfied charges	Optional
total_count	integer	Total number of charges returned by the API (filtering applies).	Optional
unfiletered_count	integer	Number of satisfied charges	Optional

chargeList resource

Methods

Resource

Properties