# Charges

### Output

| Attribute              | Type   | Description                                  | Additional |
| ---------------------- | ------ | -------------------------------------------- | ---------- |
| etag                   | string | The ETag of the resource.                    |            |
| [items](#charge-items) | array  | List of charges.                             |            |
| partSatisfiedCount     | number | Number of satisfied charges.                 | Optional   |
| satisfiedCount         | number | Number of satisfied charges.                 | Optional   |
| totalCount             | number | Total number of charges returned by the API. | Optional   |
| unfileteredCount       | number | Number of satisfied charges.                 | Optional   |

### Charge Items

<table><thead><tr><th width="283">Attribute</th><th>Type</th><th>Description</th><th>Additional</th></tr></thead><tbody><tr><td>acquiredOn</td><td>date</td><td>The date the property or undertaking was acquired on.</td><td>Optional</td></tr><tr><td>assestsCeasedReleased</td><td>string</td><td>Cease/release information about the charge. (See values below)</td><td><p>Optional. Possible values are:</p><ul><li><code>property-ceased-to-belong</code></li><li><code>part-property-release-and-ceased-to-belong</code></li><li><code>part-property-released</code></li><li><code>part-property-ceased-to-belong</code></li><li><code>whole-property-released</code></li><li><code>multiple-filings</code></li><li><code>whole-property-released-and-ceased-to-belong</code></li></ul></td></tr><tr><td>chargeCode</td><td>string</td><td>The charge code is a replacement of the mortgage description.</td><td>Optional</td></tr><tr><td>chargeNumber</td><td>number</td><td>The charge number is used to reference an individual charge.</td><td></td></tr><tr><td><a href="#charge-classification">classification</a></td><td>array&#x3C;object></td><td>Classification information.</td><td></td></tr><tr><td>coveringInstrumentDate</td><td>date</td><td>The date by which the series of debentures were created.</td><td>Optional</td></tr><tr><td>createdOn</td><td>date</td><td>The date the charge was created.</td><td>Optional</td></tr><tr><td>deliveredOn</td><td>date</td><td>The date the charge was submitted to Companies House.</td><td>Optional</td></tr><tr><td>etag</td><td>string</td><td></td><td></td></tr><tr><td>id</td><td>string</td><td>The id of the charge.</td><td></td></tr><tr><td><a href="#insolvency-cases">insolvencyCases</a></td><td>array&#x3C;object></td><td>Transactions that have been filed for the charge.</td><td>Optional</td></tr><tr><td><a href="#charge-links">links</a></td><td>array&#x3C;object></td><td>The resources related to this charge.</td><td>Optional</td></tr><tr><td>moreThanFourPersonsEntitled</td><td>boolean</td><td>Charge has more than four persons entitled.</td><td>Optional</td></tr><tr><td><a href="#particulars">particulars</a></td><td>array&#x3C;object></td><td>Details of charge or undertaking.</td><td>Optional</td></tr><tr><td><a href="#persons-entitled">personsEntitled</a></td><td>array&#x3C;object></td><td>People that are entitled to the charge.</td><td>Optional</td></tr><tr><td>resolvedOn</td><td>date</td><td>The date the issue was resolved on.</td><td>Optional</td></tr><tr><td>satisfiedOn</td><td>date</td><td>The date the charge was satisfied.</td><td>Optional</td></tr><tr><td><a href="#scottish-alterations">scottishAlterations</a></td><td>array&#x3C;object></td><td>Information about alterations for Scottish companies.</td><td>Optional</td></tr><tr><td><a href="#secured-details">securedDetails</a></td><td>array&#x3C;object></td><td>Information about what is secured against this charge.</td><td>Optional</td></tr><tr><td>status</td><td>string</td><td>The status of the charge. (See values below)</td><td><p>Possible values are:</p><ul><li><code>outstanding</code></li><li><code>fully-satisfied</code></li><li><code>part-satisfied</code></li><li><code>satisfied</code></li></ul></td></tr><tr><td><a href="#transactions">transactions</a></td><td>array&#x3C;object></td><td>Transactions that have been filed for the charge.</td><td>Optional</td></tr></tbody></table>

### Charge Classification

| Attribute   | Type   | Description                                                                                                                                          |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| description | string | Details of the charge classification.                                                                                                                |
| type        | string | <p>The type of charge classification.Possible values are:</p><ul><li><code>charge-description</code></li><li><code>nature-of-charge</code></li></ul> |

### Insolvency Cases

| Attribute                       | Type   | Description                                    | Additional |
| ------------------------------- | ------ | ---------------------------------------------- | ---------- |
| caseNumber                      | string | The number of this insolvency case.            | Optional   |
| [links](#insolvency-case-links) | array  | The resources related to this insolvency case. | Optional   |

### Insolvency Case Links

| Attribute | Type   | Description                       | Additional |
| --------- | ------ | --------------------------------- | ---------- |
| case      | string | Link to the insolvency case data. | Optional   |

### Particulars

<table><thead><tr><th width="279.3333333333333">Attribute</th><th>Type</th><th>Description</th><th>Additional</th></tr></thead><tbody><tr><td>chargorActingAsBareTrustee</td><td>boolean</td><td>The chargor is acting as a bare trustee for the property.</td><td>Optional</td></tr><tr><td>containsFixedCharge</td><td>boolean</td><td>The charge contains a fixed charge.</td><td>Optional</td></tr><tr><td>containsFloatingCharge</td><td>boolean</td><td>The charge contains a floating charge.</td><td>Optional</td></tr><tr><td>containsNegativePledge</td><td>boolean</td><td>The charge contains a negative pledge.</td><td>Optional</td></tr><tr><td>description</td><td>string</td><td>Details of charge particulars.</td><td></td></tr><tr><td>floatingChargeCoversAll</td><td>boolean</td><td>The floating charge covers all the property or undertaking or the company.</td><td>Optional</td></tr><tr><td>type</td><td>string</td><td><p>The type of charge particulars. Possible values are:</p><ul><li><code>short-particulars</code></li><li><code>charged-property-description</code></li><li><code>charged-property-or-undertaking-description</code></li><li><code>brief-description</code></li></ul></td><td></td></tr></tbody></table>

### Persons Entitled

| Attribute | Type   | Description                      |
| --------- | ------ | -------------------------------- |
| name      | string | The name of the person entitled. |

### Scottish Alterations

<table><thead><tr><th width="274.3333333333333">Attribute</th><th>Type</th><th>Description</th><th>Additional</th></tr></thead><tbody><tr><td>hasAlterationsToOrder</td><td>boolean</td><td>The charge has alterations to order.</td><td>Optional</td></tr><tr><td>hasAlterationsToProhibitions</td><td>boolean</td><td>The charge has alterations to prohibitions.</td><td>Optional</td></tr><tr><td>hasAlterationsToProvisions</td><td>boolean</td><td>The charge has provisions restricting the creation of further charges.</td><td>Optional</td></tr></tbody></table>

### Secured Details

| Attribute   | Type   | Description                                                                                                                                    |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| description | string | Details of the amount or obligation secured by the charge.                                                                                     |
| type        | string | <p>The type of secured details. Possible values are:</p><ul><li><code>amount-secured</code></li><li><code>obligations-secured</code></li></ul> |

### Transactions

| Attribute                   | Type           | Description                                                 | Additional |
| --------------------------- | -------------- | ----------------------------------------------------------- | ---------- |
| deliveredOn                 | date           | The date the filing was submitted to Companies House.       | Optional   |
| filingType                  | string         | Filing type which created, updated or satisfied the charge. | Optional   |
| insolvencyCaseNumber        | string         | The insolvency case related to this filing.                 | Optional   |
| [links](#transaction-links) | array\<object> | The resources related to this filing.                       | Optional   |

### Transaction Links

| Attribute      | Type   | Description                                         | Additional |
| -------------- | ------ | --------------------------------------------------- | ---------- |
| filing         | string | Link to the charge filing data.                     | Optional   |
| insolvencyCase | string | Link to the insolvency case related to this filing. | Optional   |

### Charge Links

| Attribute | Type   | Description                   |
| --------- | ------ | ----------------------------- |
| self      | string | Link to the this charge data. |

### Example

```
{
    "etag": "abc123",
    "items": [
        {
            "acquiredOn": "2022-01-10",
            "assetsCeasedReleased": "Assets released",
            "chargeCode": "CHG123",
            "chargeNumber": 123,
            "classification": {
                "description": "Description of classification",
                "type": "Type A"
            },
            "coveringInstrumentDate": "2022-01-05",
            "createdOn": "2022-01-01",
            "deliveredOn": "2022-01-02",
            "etag": "def456",
            "id": "ID123",
            "insolvencyCases": [
                {
                    "caseNumber": "CASE456",
                    "links": [
                        {
                            "caseItem": "https://example.com/case/CASE456"
                        }
                    ]
                }
            ],
            "links": {
                "self": "https://example.com/charge/CHG123"
            },
            "moreThanFourPersonsEntitled": true,
            "particulars": {
                "chargorActingAsBareTrustee": true,
                "containsFixedCharge": false,
                "containsFloatingCharge": true,
                "containsNegativePledge": false,
                "description": "Particulars description",
                "floatingChargeCoversAll": true,
                "type": "Particulars Type"
            },
            "personsEntitled": [
                {
                    "name": "John Doe"
                },
                {
                    "name": "Jane Smith"
                }
            ],
            "resolvedOn": "2022-02-15",
            "satisfiedOn": "2022-02-20",
            "scottishAlterations": [
                {
                    "hasAlterationsToOrder": true,
                    "hasAlterationsToProhibitions": false,
                    "hasAlterationsToProvisions": true
                }
            ],
            "securedDetails": [
                {
                    "description": "Secured detail description",
                    "type": "Secured Detail Type"
                }
            ],
            "status": "Active",
            "transactions": [
                {
                    "deliveredOn": "2022-01-02",
                    "filingType": "Filing Type A",
                    "insolvencyCaseNumber": "CASE456",
                    "links": {
                        "filing": "https://example.com/filing/123",
                        "insolvencyCase": "https://example.com/case/CASE456"
                    }
                }
            ]
        }
    ],
    "partSatisfiedCount": 10,
    "satisfiedCount": 20,
    "totalCount": 30,
    "unfilteredCount": 40
}

```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.transactionlink.io/docs/v1/integrations/companies-house/public-data-api/charges.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.