Companies House · Schema

filingHistoryItem

CompaniesUK GovernmentBusiness RegistrationCompany SearchOfficersFiling HistoryInsolvencyChargesPersons of Significant ControlOpen Data

Properties

Name Type Description
annotations array Annotations for the filing
associated_filings array Any filings associated with the current item
barcode string The barcode of the document.
transaction_id string The transaction ID of the filing.
category string The category of the document filed.
date string The date the filing was processed.
description string A description of the filing. For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descript
links object Links to other resources associated with this filing history item.
pages integer Number of pages within the PDF document (links.document_metadata)
paper_filed boolean If true, indicates this is a paper filing.
resolutions array Resolutions for the filing
subcategory string The sub-category of the document filed.
type string The type of filing.
View JSON Schema on GitHub

JSON Schema

filinghistoryitem.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "filingHistoryItem",
  "required": [
    "category",
    "date",
    "description",
    "type",
    "transaction_id"
  ],
  "properties": {
    "annotations": {
      "description": "Annotations for the filing",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/definitions/annotation"
      },
      "type": "array"
    },
    "associated_filings": {
      "description": "Any filings associated with the current item",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/definitions/associatedFiling"
      },
      "type": "array"
    },
    "barcode": {
      "description": "The barcode of the document.",
      "type": "string"
    },
    "transaction_id": {
      "description": "The transaction ID of the filing.",
      "type": "string"
    },
    "category": {
      "description": "The category of the document filed.",
      "enum": [
        "accounts",
        "address",
        "annual-return",
        "capital",
        "change-of-name",
        "incorporation",
        "liquidation",
        "miscellaneous",
        "mortgage",
        "officers",
        "resolution"
      ],
      "type": "string"
    },
    "date": {
      "description": "The date the filing was processed.",
      "type": "string",
      "format": "date"
    },
    "description": {
      "description": "A description of the filing.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descriptions.yml) file.",
      "type": "string"
    },
    "links": {
      "description": "Links to other resources associated with this filing history item.",
      "type": "object",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/definitions/filingHistoryItemLinks"
      }
    },
    "pages": {
      "description": "Number of pages within the PDF document (links.document_metadata)",
      "type": "integer"
    },
    "paper_filed": {
      "description": "If true, indicates this is a paper filing.",
      "type": "boolean"
    },
    "resolutions": {
      "description": "Resolutions for the filing",
      "items": {
        "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/definitions/resolution"
      },
      "type": "array"
    },
    "subcategory": {
      "description": "The sub-category of the document filed.",
      "enum": [
        "resolution"
      ],
      "type": "string"
    },
    "type": {
      "description": "The type of filing.",
      "type": "string"
    }
  }
}