Financial Data

Retrieve Line Item Definition

Retrieve a single line item definition by its code.

Access Level Required: Requires Standard Access (Level 1).

get/line-item-definitions/{code}/

Request

  • Base URL: https://api.financialreports.eu
  • URL: https://api.financialreports.eu/line-item-definitions/{code}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

codestring required

Response

codestring required

Stable machine code, e.g. 'revenue', 'total_assets'. Never rename in place — deprecate and add a new code.

namestring required

Human display name, e.g. 'Total Revenue'.

statement_type'IS' | 'BS' | 'CFS' | 'SUP' required
  • IS - Income Statement
  • BS - Balance Sheet
  • CFS - Cash Flow Statement
  • SUP - Supplemental / Ratio
statement_type_displaystring required

Human-readable statement type.

depthinteger

Hierarchy depth: 0 = top-level total/heading, 1 = component of a parent, 2 = sub-component.

parent_codestring nullable

Code of the parent line item in the hierarchy, or null for top-level items.

sort_orderinteger

Display order within (statement_type, category).

categorystring

Optional grouping within a statement (e.g. 'Operating Expenses').

descriptionstring

Definition of the KPI. Used in the extraction prompt.

aliasesstring[] required

Alternative labels this line item may appear under in source filings.

templatesstring[] required

KPI templates this line item is meaningful for: industrial, bank, insurer. Industrial-only items (gross profit, current assets, ...) are still served for banks and insurers but do not mean the same thing there. A company's template is the template field of its financials.

Changes

No recorded changes to this operation across all 2 revisions of this API.