Developer API Suite

filingHistoryList resource

Methods

  • get - filingHistoryList resource

Resource

{
    "etag": "string",
    "filing_history_status": "string",
    "items": [
        {
            "annotations": [
                {
                    "annotation": "string",
                    "date": "date",
                    "description": "string"
                }
            ],
            "associated_filings": [
                {
                    "date": "date",
                    "description": "string",
                    "type": "string"
                }
            ],
            "barcode": "string",
            "category": "string",
            "date": "date",
            "description": "string",
            "links": {
                "document_metadata": "string",
                "self": "string"
            },
            "pages": "integer",
            "paper_filed": "boolean",
            "resolutions": [
                {
                    "category": "string",
                    "description": "string",
                    "document_id": "string",
                    "receive_date": "date",
                    "subcategory": "string",
                    "type": "string"
                }
            ],
            "subcategory": "string",
            "transaction_id": "string",
            "type": "string"
        }
    ],
    "items_per_page": "integer",
    "kind": "string",
    "start_index": "integer",
    "total_count": "integer"
}

Properties

Name Type Description Additional
etag string

The ETag of the resource.
filing_history_status string

The status of this filing history.

Possible values are:

  • filing-history-available
 Optional
items[] array

The filing history items.
items[].annotations[] array

Annotations for the filing

 Optional
items[].annotations[].annotation string

The annotation text.

 Optional
items[].annotations[].date date

The date the annotation was added.
items[].annotations[].description string

A description of the annotation. For enumeration descriptions see description section in the enumeration mappings file.
items[].associated_filings[] array

Any filings associated with the current item

 Optional
items[].associated_filings[].date date

The date the associated filing was processed.
items[].associated_filings[].description string

A description of the associated filing. For enumeration descriptions see description section in the enumeration mappings file.
items[].associated_filings[].type string

The type of the associated filing.
items[].barcode string

The barcode of the document.

 Optional
items[].category string

The category of the document filed.

Possible values are:

  • accounts
  • address
  • annual-return
  • capital
  • change-of-name
  • incorporation
  • liquidation
  • miscellaneous
  • mortgage
  • officers
  • resolution
items[].date date

The date the filing was processed.
items[].description string

A description of the filing. For enumeration descriptions see description section in the enumeration mappings file.
items[].links object

Links to other resources associated with this filing history item.

 Optional
items[].links.document_metadata string

Link to the document metadata associated with this filing history item. See the Document API documentation for more details.

 Optional
items[].links.self string

Link to this filing history item.

 Optional
items[].pages integer

Number of pages within the PDF document (links.document_metadata)

 Optional
items[].paper_filed boolean

If true, indicates this is a paper filing.

 Optional
items[].resolutions[] array

Resolutions for the filing

 Optional
items[].resolutions[].category string

The category of the resolution filed.

Possible values are:

  • miscellaneous
items[].resolutions[].description string

A description of the associated filing. For enumeration descriptions see description section in the enumeration mappings file.
items[].resolutions[].document_id string

The document id of the resolution.

 Optional
items[].resolutions[].receive_date date

The date the resolution was processed.
items[].resolutions[].subcategory string

The sub-category of the document filed.

Possible values are:

  • resolution
items[].resolutions[].type string

The type of the associated filing.
items[].subcategory string

The sub-category of the document filed.

Possible values are:

  • resolution
 Optional
items[].transaction_id string

The transaction ID of the filing.
items[].type string

The type of filing.
items_per_page integer

The number of filing history items returned per page.
kind string

Indicates this resource is a filing history.

Possible values are:

  • filing-history
start_index integer

The index into the entire result set that this result page starts.
total_count integer

The total number of filing history items for this company.
Built by Companies House