Streaming API: chargesStream

Methods

get - Charges stream

Resource

{
    "data": {
        "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"
                    }
                ]
            }
        ]
    },
    "event": {
        "fields_changed": [
            "string"
        ],
        "published_at": "date-time",
        "timepoint": "integer",
        "type": "string"
    },
    "resource_id": "string",
    "resource_kind": "string",
    "resource_uri": "string"
}

Properties

Name	Type	Description	Additional
data	object	The company charges resource data. May be absent for 'deleted' event types.	Optional
data.acquired_on	date	The date the property or undertaking was acquired on	Optional
data.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
data.charge_code	string	The charge code is a replacement of the mortgage description	Optional
data.charge_number	integer	The charge number is used to reference an individual charge
data.classification[]	array	Classification information
data.classification[].description	string	Details of the charge classification
data.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`
data.covering_instrument_date	date	The date by which the series of debentures were created	Optional
data.created_on	date	The date the charge was created	Optional
data.delivered_on	date	The date the charge was submitted to Companies House	Optional
data.etag	string
data.id	string	The id of the charge
data.insolvency_cases[]	array	Transactions that have been filed for the charge.	Optional
data.insolvency_cases[].case_number	string	The number of this insolvency case	Optional
data.insolvency_cases[].links[]	array	The resources related to this insolvency case	Optional
data.insolvency_cases[].links[].case	string	Link to the insolvency case data	Optional
data.links[]	array	The resources related to this charge	Optional
data.links[].self	string	Link to the this charge data
data.more_than_four_persons_entitled	boolean	Charge has more than four person entitled	Optional
data.particulars[]	array	Details of charge or undertaking	Optional
data.particulars[].chargor_acting_as_bare_trustee	boolean	The chargor is acting as a bare trustee for the property	Optional
data.particulars[].contains_fixed_charge	boolean	The charge contains a fixed charge	Optional
data.particulars[].contains_floating_charge	boolean	The charge contains a floating charge	Optional
data.particulars[].contains_negative_pledge	boolean	The charge contains a negative pledge	Optional
data.particulars[].description	string	Details of charge particulars
data.particulars[].floating_charge_covers_all	boolean	The floating charge covers all the property or undertaking or the company	Optional
data.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`
data.persons_entitled[]	array	People that are entitled to the charge	Optional
data.persons_entitled[].name	string	The name of the person entitled.
data.resolved_on	date	The date the issue was resolved on	Optional
data.satisfied_on	date	The date the charge was satisfied	Optional
data.scottish_alterations[]	array	Information about alterations for Scottish companies	Optional
data.scottish_alterations[].has_alterations_to_order	boolean	The charge has alterations to order	Optional
data.scottish_alterations[].has_alterations_to_prohibitions	boolean	The charge has alterations to prohibitions	Optional
data.scottish_alterations[].has_alterations_to_provisions	boolean	The charge has provisions restricting the creation of further charges	Optional
data.secured_details[]	array	Information about what is secured against this charge	Optional
data.secured_details[].description	string	Details of the amount or obligation secured by the charge
data.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`
data.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`
data.transactions[]	array	Transactions that have been filed for the charge.	Optional
data.transactions[].delivered_on	date	The date the filing was submitted to Companies House	Optional
data.transactions[].filing_type	string	Filing type which created, updated or satisfied the charge	Optional
data.transactions[].insolvency_case_number	string	The insolvency case related to this filing	Optional
data.transactions[].links[]	array	The resources related to this filing	Optional
data.transactions[].links[].filing	string	Link to the charge filing data	Optional
data.transactions[].links[].insolvency_case	string	Link to the insolvency case related to this filing	Optional
event	object	Link to the related resource	Read only.
event.fields_changed[]	array of string	Array of fields that have been changed by this event. Nested fields are referenced by dot notation e.g. `links.document_metadata`	Optional, read only.
event.published_at	date-time	The date and time the data notification was raised in the format of `yyyy-MM-dd'T'HH:mm:ss` for example: `2024-09-04T10:52:22`	Read only.
event.timepoint	integer	The point-in-time identifier for this stream document. Use to re-establish a connection to the stream at this point.	Read only.
event.type	string	The type of event denoted by this stream document. Possible values are: `changed` `deleted`	Read only.
resource_id	string	The ID of the resource.	Read only.
resource_kind	string	The type of resource contained within the stream document. Possible values are: `company-profile#company-profile` `filing-history#filing-history`	Read only.
resource_uri	string	The URI of the resource.	Read only.

chargesStream resource

Methods

Resource

Properties