Documentation
/api/financialsmetadata
Version 2 (current) Version 1

Deprecated - Please use v2

This API endpoint returns the available financials meta data for a company using its Companies House registration number. This end point is free to call and can be used to determine which financial data fields are available for a given company before making a call to the financials end point to get the actual results.
Request
https://convert-ixbrl.co.uk/api/financialsMetaData?companynumber=012345678&apiversion=1
Rate limit
This endpoint is rate limited to 1 request per 2 seconds with requests exceeding this limit served with HTTP 429 code. Limit increase requests can be sent to support@convert-ixbrl.co.uk
Authentication
This endpoint requires the authentication header to be supplied. See the authentication section.
Request Parameters
Name Type Optional Description
apiVersion
 string No API Version
companyNumber
 string No Companies House registration number
HTTP Response codes
Status Code Description
200 Successful requests with results
204 Successful requests with no results
400 Authorisation error for when the secret key header is missing or is invalid
429 Request throttled for exceeding rate limits
Response JSON (Sample, extracted from a real result) 

{
    "status": "Ok",
    "lastDataUpdatedDate": "31/10/2024"
    "result": {
       "company_financial_list": [
      {
        "end_date": "29/06/2021",
        "profit_loss": {
          "turnover": "available",
          "consolidated_accounts": null,
          "cost_of_sales": "available",
          "export": null,
          "gross_profit": "available",
          "directors_emoluments": null,
          "operating_profits": "available",
          "depreciation": null,
          "audit_fees": null,
          "interest_payments": null,
          "pre_tax": null,
          "tax_on_profit": "available",
          "profit_loss": "available",
          "post_tax": null,
          "dividends_payable": null,
          "retained_profits": "available",
          "salaries": null
        },
        "balance_sheet": {
          "intangible_assets": "available",
          "tangible_assets": "available",
          "fixed_assets": "available",
          "current_assets": "available",
          "stock": "available",
          "debtors_amounts_falling_due_within_one_year": "available",
          "debtors_amounts_falling_due_after_one_year": null,
          "creditors_amounts_falling_due_within_one_year": "available",
          "creditors_amounts_falling_due_after_more_than_one_year": null,
          "cash": "available",
          "net_current_assets_liabilities": "available",
          "total_assets": null,
          "total_assets_less_current_liabilities": "available",
          "total_current_liabilities": null,
          "liabilities": null,
          "net_assets": "available",
          "working_capital": null,
          "shareholders_equity": "available",
          "calledup_share_capital": "available",
          "retained_earnings_accumulated_losses": "available"
        },
        "cash_flow": {
          "cash_generated_from_operations": "available",
          "net_interest_paid_received_classified_as_operating_activities": "available",
          "income_taxes_paid_refund_classified_as_operating_activities": "available",
          "net_cash_flows_from_used_in_operating_activities": "available",
          "purchase_property_plant_equipment": "available",
          "proceeds_from_sales_property_plant_equipment": "available",
          "proceeds_from_sales_other_longterm_assets_classified_as_investing_activities": "available",
          "net_cash_flows_from_used_in_investing_activities": "available",
          "increase_decrease_in_cash_cash_equivalents_before_foreign_exchange_differences_changes_in_consolidation": "available",
          "cash_cash_equivalents_cash_flow_value": "available"
        },
        "allAvailableXBRLConceptsAndValues": [
         See description                  
        ],
        "title":"Company Name Limited"
    },
    "errorMessage": null
}
Name Type Nullable Description
status
 string no Contains
Ok
if the request was successful,
Error
if there was an error.
lastDataUpdatedDate
 string no The date of last data refresh
result[]
 array yes Contains the
company_financial_list
array. Each item in this array would contain a single financial year's data
company_financial_list[].end_date
 string no Contains the financial year end date string in "dd/MM/yyyy" format. For example, for December 10,2023, this would contain 10/12/2023
company_financial_list[].profit_loss
 object yes This will contain
available
if the data is available and
null
if it isn't.
company_financial_list[].balance_sheet
 object yes This will contain
available
if the data is available and
null
if it isn't.
company_financial_list[].cash_flow
 object yes This will contain
available
if the data is available and
null
if it isn't.
company_financial_list[].allAvailableXBRLConceptsAndValues
 array yes The raw xbrl tag data is not sent across anymore. Instead, from v2 of the API, the values available have been added to the available financial statements objects directly for ease of access.
title
 string no Name of the company as it appears on Companies House register
errorMessage
 string yes Error message text, if available