> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rangler.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Financial statements and source tables fields

> Definitions, types, allowed values, and defaults for financial statements and source tables.

Use this reference with the endpoint documentation. A required field must be present; a nullable field can still contain `null`. Missing data does not mean zero. See [Field guide](/field-guide) for unit and status conventions.

### `GET /v1/companies/{company_id}/statement-table-index`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `statement_type` | query | string | required | Financial statement category used to select reported tables. Allowed values: `income_statement`, `balance_sheet`, `cash_flow`, `changes_in_equity`. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `100`. |

### `GET /v1/companies/{company_id}/statement-tables`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `filing_id` | query | string (uuid) or null | optional | Stable Rangler identifier of the requested filing. |
| `statement_type` | query | string or null | optional | Financial statement category used to select reported tables. Allowed values: `income_statement`, `balance_sheet`, `cash_flow`, `changes_in_equity`. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `20`. |

### `GET /v1/companies/{company_id}/statement-cells/{cell_id}/source`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `cell_id` | path | string (uuid) | required | Identifier of the statement cell whose source evidence is requested. |
| `dpi` | query | integer | optional | Dots per inch used to render the source-page image. Default: `150`. |

### `GET /v1/companies/{company_id}/statement-table-values/{value_id}/source`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `value_id` | path | string (uuid) | required | Identifier of the reported-table value whose source evidence is requested. |
| `dpi` | query | integer | optional | Dots per inch used to render the source-page image. Default: `150`. |

### `GET /v1/companies/{company_id}/statement-cells/{cell_id}/geometry`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company_id` | path | string (uuid) | required | Filter or identify a company using its stable Rangler identifier. |
| `cell_id` | path | string (uuid) | required | Identifier of the statement cell whose source evidence is requested. |

### `GET /v1/company/financials/income-statement/standardized`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `currency` | query | string or null | optional | Display currency. Use native or an ISO 4217 currency code. |
| `periodType` | query | array of string or null | optional | Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual. |
| `scope` | query | string | optional | Statement scope. Auto selects the strongest available company or group view. Allowed values: `auto`, `consolidated`, `separate`, `unspecified`. Default: `"auto"`. |
| `scopeLabel` | query | string or null | optional | Optional reported subject label used to disambiguate statement scope. |
| `includeSources` | query | boolean | optional | Include source-cell references for the returned metrics. Default: `true`. |
| `includeMetadata` | query | boolean | optional | Embed definitions for the returned metrics. Default: `false`. |
| `periodLimit` | query | integer | optional | Maximum periods returned from each requested series. Default: `12`. |

### `GET /v1/company/financials/balance-sheet/standardized`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `currency` | query | string or null | optional | Display currency. Use native or an ISO 4217 currency code. |
| `periodType` | query | array of string or null | optional | Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual. |
| `scope` | query | string | optional | Statement scope. Auto selects the strongest available company or group view. Allowed values: `auto`, `consolidated`, `separate`, `unspecified`. Default: `"auto"`. |
| `scopeLabel` | query | string or null | optional | Optional reported subject label used to disambiguate statement scope. |
| `includeSources` | query | boolean | optional | Include source-cell references for the returned metrics. Default: `true`. |
| `includeMetadata` | query | boolean | optional | Embed definitions for the returned metrics. Default: `false`. |
| `periodLimit` | query | integer | optional | Maximum periods returned from each requested series. Default: `12`. |

### `GET /v1/company/financials/cash-flow-statement/standardized`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `currency` | query | string or null | optional | Display currency. Use native or an ISO 4217 currency code. |
| `periodType` | query | array of string or null | optional | Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual. |
| `scope` | query | string | optional | Statement scope. Auto selects the strongest available company or group view. Allowed values: `auto`, `consolidated`, `separate`, `unspecified`. Default: `"auto"`. |
| `scopeLabel` | query | string or null | optional | Optional reported subject label used to disambiguate statement scope. |
| `includeSources` | query | boolean | optional | Include source-cell references for the returned metrics. Default: `true`. |
| `includeMetadata` | query | boolean | optional | Embed definitions for the returned metrics. Default: `false`. |
| `periodLimit` | query | integer | optional | Maximum periods returned from each requested series. Default: `12`. |

### `GET /v1/company/ratios`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `currency` | query | string or null | optional | Display currency. Use native or an ISO 4217 currency code. |
| `periodType` | query | array of string or null | optional | Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ltm, ytd, latest. Defaults to annual. |
| `ratioId` | query | array of string or null | optional | Return selected ratio IDs. Repeat or provide a comma-separated list. |
| `scope` | query | string | optional | Statement scope used to calculate ratios. Allowed values: `auto`, `consolidated`, `separate`, `unspecified`. Default: `"auto"`. |
| `scopeLabel` | query | string or null | optional | Optional reported subject label used to disambiguate statement scope. |
| `includeMetadata` | query | boolean | optional | Embed definitions for the returned ratios. Default: `false`. |
| `periodLimit` | query | integer | optional | Maximum periods returned from each requested series. Default: `12`. |

### `GET /v1/company/financials/revenue-segments`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `periodType` | query | array of string or null | optional | Period filter. Repeat or use a comma-separated list: annual, quarterly, semi-annual, ytd, latest. Defaults to annual. |
| `periodLimit` | query | integer | optional | Maximum revenue-segment periods returned. Default: `12`. |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |

### `GET /v1/company/financials/income-statement/as-reported`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `filingId` | query | string (uuid) or null | optional | Return tables from one filing. Omit it to return the latest available history. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `20`. |

### `GET /v1/company/financials/balance-sheet/as-reported`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `filingId` | query | string (uuid) or null | optional | Return tables from one filing. Omit it to return the latest available history. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `20`. |

### `GET /v1/company/financials/cash-flow-statement/as-reported`

| Parameter | Location | Type | Presence | Meaning |
| - | - | - | - | - |
| `company` | query | string | required | Rangler company UUID or exchange ticker, matched case-insensitively. |
| `countryCode` | query | string or null | optional | ISO 3166-1 alpha-2 market code. Use it when a ticker is shared across markets. |
| `filingId` | query | string (uuid) or null | optional | Return tables from one filing. Omit it to return the latest available history. |
| `limit` | query | integer | optional | Maximum number of records to return in this page; the schema gives the allowed range. Default: `20`. |

<a id="reported-statement-cell-read" />

## Reported statement cell

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `value_id` | string (uuid) | required | Identifier of the stored reported-table value. |
| `column_id` | string (uuid) or null | optional | Identifier of the printed statement column. |
| `raw_text` | string or null | optional | Cell text as printed in the statement, preserving display and magnitude information. |
| `numeric_value` | number or null | optional | Parsed numeric value from the printed cell. Apply the column's value\_scale; this is not automatically a standardized base-unit metric. |
| `statement_cell_id` | string (uuid) or null | optional | Identifier of the associated statement cell when one is available. |
| `source_region` | [Reported statement source region](/fields/financials#reported-statement-source-region-read) or null | optional | Page and table-position references used to locate the cell in its source. |

<a id="reported-statement-column-read" />

## Reported statement column

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `column_id` | string (uuid) | required | Identifier of the printed statement column. |
| `column_key` | string | required | Stable key identifying the column within its statement table. |
| `order` | integer | required | Display position within the statement's ordered rows or columns. |
| `label` | string or null | optional | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `scope` | string or null | optional | Statement reporting scope: consolidated group, separate company, or unspecified when source evidence cannot resolve it. |
| `scope_label` | string or null | optional | Human-readable reporting subject, such as Group, Company, or Bank. |
| `period_end_date` | string (date) or null | optional | Closing date of the reporting period. |
| `period_basis` | string or null | optional | Period interpretation assigned to this printed column, such as current or comparative. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `value_scale` | string or null | optional | Magnitude printed by the source, such as units, thousands, or millions. |
| `is_comparative` | boolean | optional | Whether this printed column contains comparative-period figures. Default: `false`. |

<a id="reported-statement-index-item-read" />

## Reported statement index item

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `filing_title` | string or null | optional | Title of the source filing. |
| `filing_published_at` | string (date-time) or null | optional | Publication timestamp of the source filing. |
| `statement_type` | string | required | Financial statement category: income\_statement, balance\_sheet, or cash\_flow\_statement as applicable. |
| `first_page_number` | integer | required | First PDF page containing this statement, using one-based numbering. |
| `primary_period_end_date` | string (date) or null | optional | End date of the statement's primary reporting period. |
| `primary_period_basis` | string or null | optional | Period basis assigned to the statement's primary column. |
| `source_label` | string | required | Source-reported label identifying the statement or table. |
| `context_label` | string | required | Reporting-subject or table-context label supporting interpretation of the statement. |
| `is_latest_filing` | boolean | optional | Whether this statement belongs to the latest eligible filing for the requested statement type. Default: `false`. |

<a id="reported-statement-index-response" />

## Reported statement index

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `items` | array of [Reported statement index item](/fields/financials#reported-statement-index-item-read) | optional | Returned records; the item schema defines their fields. |

<a id="reported-statement-response" />

## Reported statement

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `tables` | array of [Reported statement table](/fields/financials#reported-statement-table-read) | optional | Reported statement tables with printed columns, rows, and source references. |

<a id="reported-statement-row-read" />

## Reported statement row

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `row_id` | string (uuid) | required | Identifier of the printed statement row. |
| `parent_row_id` | string (uuid) or null | optional | Identifier of this row's parent in the statement hierarchy when applicable. |
| `order` | integer | required | Display position within the statement's ordered rows or columns. |
| `depth` | integer | required | Nesting depth of the row within the printed statement hierarchy. |
| `role` | string or null | optional | Statement-row role, distinguishing headings, detail rows, and totals when identified. |
| `label` | string | required | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `note_ref` | string or null | optional | Reference to the source statement's explanatory note when printed. |
| `value_unit` | string or null | optional | Source-reported unit for this row, when explicitly available. |
| `cells` | array of [Reported statement cell](/fields/financials#reported-statement-cell-read) | optional | Values belonging to this statement row, identified by their printed columns. |

<a id="reported-statement-source-region-read" />

## Reported statement source region

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `page_number` | integer or null | optional | One-based page number in the source document. |
| `page` | integer or null | optional | One-based page number in the source PDF. |
| `row_index` | integer or null | optional | Stored source-table row position for locating the printed cell. |
| `column_index` | integer or null | optional | Stored source-table column position for locating the printed cell. |

<a id="reported-statement-table-read" />

## Reported statement table

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `table_id` | string (uuid) | required | Identifier of the stored reported statement table. |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `filing_title` | string or null | optional | Title of the source filing. |
| `filing_published_at` | string (date-time) or null | optional | Publication timestamp of the source filing. |
| `page_number` | integer or null | optional | One-based page number in the source document. |
| `statement_type` | string or null | optional | Financial statement category: income\_statement, balance\_sheet, or cash\_flow\_statement as applicable. |
| `columns` | array of [Reported statement column](/fields/financials#reported-statement-column-read) | optional | Printed statement columns and their reporting scope, dates, currencies, and source scales. |
| `rows` | array of [Reported statement row](/fields/financials#reported-statement-row-read) | optional | Printed statement rows, including their labels, hierarchy, and cells. |

<a id="revenue-segment-period-read" />

## Revenue segment period

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `period_end_date` | string (date) | required | Closing date of the reporting period. |
| `period_type` | string or null | optional | Reporting-period category, such as FY, H1, Q1, or TTM when applicable. |
| `reporting_period` | string or null | optional | Human-readable reporting-period label; use typed date/year fields for calculations. |
| `period_family` | string or null | optional | Normalized grouping of the reporting period, separate from the source's display label. Allowed values: `annual`, `interim`, `trailing`. |
| `period_granularity` | string or null | optional | Time granularity of the financial period, such as annual or quarterly. Allowed values: `full_year`, `quarter`, `half_year`, `year_to_date`, `trailing_twelve_months`. |
| `currency` | string or null | optional | Currency of the associated monetary value, normally an ISO 4217 code such as NGN. |
| `segments` | array of [Revenue segment (financial statement)](/fields/financials#app--schemas--statement-financials--revenue-segment-read) | optional | Revenue segments disclosed for this reporting period. |

<a id="revenue-segments-response" />

## Revenue segments

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `periods` | array of [Revenue segment period](/fields/financials#revenue-segment-period-read) | optional | Reported or derived financial periods ordered by reporting date. |

<a id="statement-cell-geometry-read" />

## Statement cell geometry

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `filing_id` | string (uuid) | required | Stable Rangler identifier of the source filing. |
| `page` | integer | required | One-based page number in the source PDF. |
| `coordinate_space` | string | required | Coordinate system for the source region; pdf\_points\_top\_left uses PDF points from the top left. Allowed values: `pdf_points_top_left`. |
| `page_width` | number | required | Width of the PDF page in PDF points. |
| `page_height` | number | required | Height of the PDF page in PDF points. |
| `x` | number | required | Horizontal position of the source region's left edge in PDF points. |
| `y` | number | required | Vertical position of the source region's top edge in PDF points. |
| `width` | number | required | Width of the source region in PDF points. |
| `height` | number | required | Height of the source region in PDF points. |

<a id="statement-company-reference" />

## Statement company reference

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `id` | string (uuid) | required | Stable Rangler identifier for this record. Use the value exactly as returned. |
| `name` | string | required | Display name of the identified resource. |
| `ticker` | string | required | Exchange trading symbol when available. A ticker is not a substitute for the stable company ID. |
| `exchange` | string or null | optional | Exchange or trading venue code, such as NGX or NASD. |
| `country_code` | string | required | Two-letter ISO 3166-1 country code identifying the market, such as NG. |

<a id="statement-currency-conversion" />

## Statement currency conversion

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `source_currency` | string | required | Currency of the amount before conversion. |
| `target_currency` | string | required | Currency of the amount after conversion. |
| `rate` | number or null | optional | Exchange-rate multiplier applied to convert source\_currency into target\_currency. |
| `rate_date` | string (date) or null | optional | Date of the exchange-rate observation used for the conversion. |
| `status` | string or null | optional | Outcome of currency conversion, indicating whether a rate was applied or why conversion was unavailable. |

<a id="statement-financial-catalog-response" />

## Statement financial catalog

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `version` | string | required | Catalog version. It changes when a definition, unit, or formula changes. |
| `units` | map of [Statement unit convention](/fields/financials#statement-unit-convention) | required | Measurement conventions keyed by unit name, including numeric scale and representation. |
| `metrics` | map of [Statement metric definition](/fields/financials#statement-metric-definition-read) | required | Values or definitions keyed by standard metric name; consult the field's value schema and metric catalog. |
| `ratios` | map of [Statement ratio definition](/fields/financials#statement-ratio-definition-read) | required | Values or definitions keyed by standard ratio name; ratio units and formulas are specified in the catalog. |
| `growth` | map of object | required | Supported growth calculations grouped by metric and comparison window; definitions are in the financial catalog. |

<a id="statement-financial-period" />

## Statement financial period

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `period_id` | string | required | Identifier for this period within the selected company and reporting scope. Use it with company\_id, scope, scope\_label, and currency when storing results. |
| `period_end_date` | string (date) | required | Date on which the reported accounting period ends. |
| `calendar_year` | integer | required | Calendar year containing period\_end\_date. |
| `calendar_quarter` | integer | required | Calendar quarter, from 1 to 4, containing period\_end\_date. |
| `fiscal_year` | integer or null | optional | Issuer accounting year. It can differ from calendar\_year when the year end is not 31 December. |
| `fiscal_quarter` | integer or null | optional | Issuer accounting quarter, from 1 to 4. It can differ from calendar\_quarter. |
| `period_family` | string or null | optional | Normalized grouping of the reporting period, separate from the source's display label. Allowed values: `annual`, `quarterly`, `semi_annual`, `nine_month`, `trailing`. |
| `period_granularity` | string or null | optional | Time granularity of the financial period, such as annual or quarterly. Allowed values: `full_year`, `quarter`, `half_year`, `year_to_date`, `trailing_twelve_months`. |
| `reporting_period` | string or null | optional | Human-readable reporting-period label; use typed date/year fields for calculations. |
| `period_type` | string or null | optional | Reporting-period category, such as FY, H1, Q1, or TTM when applicable. |
| `duration_months` | integer or null | optional | Number of months covered by the flow metrics in this period. |
| `is_derived_period` | boolean | optional | Whether the period was assembled from reported periods, such as a standalone quarter or TTM. Default: `false`. |
| `is_restated` | boolean | optional | Whether at least one returned metric uses a restated comparative figure. Default: `false`. |
| `restated_metrics` | array of string | optional | Metric keys whose values came from restated comparative evidence. |
| `scope` | string or null | optional | Statement reporting scope: consolidated group, separate company, or unspecified when source evidence cannot resolve it. |
| `scope_label` | string or null | optional | Human-readable reporting subject, such as Group, Company, or Bank. |
| `income_basis` | string or null | optional | Flow-period basis identifying cumulative or standalone figures. |
| `reported_currency` | string or null | optional | ISO 4217 currency of the selected reported statement before display conversion. |
| `display_currency` | string or null | optional | ISO 4217 currency used for monetary values returned in this period. |
| `currency_conversion` | [Statement currency conversion](/fields/financials#statement-currency-conversion) or null | optional | Period-date currency conversion applied to monetary values, including rate and outcome. |
| `currency` | string or null | optional | ISO 4217 currency for this period after any requested display conversion. It applies to currency and per-share values; consult metric\_metadata for each metric's unit class. |
| `metrics` | map of number or null | optional | Standardized values. Currency amounts are base units, per-share values are major currency units per share, and share counts are individual shares. |
| `metric_origins` | map of string | optional | Origin of each returned metric value. Currency conversion is described separately by currency\_conversion and does not change a metric's accounting origin. |
| `ratios` | map of number or null | optional | Derived values. Percent-unit ratios are decimal fractions; ratio-unit values are decimal multiples. |
| `sources` | map of [Statement financial source reference](/fields/financials#statement-financial-source-reference) or null | optional | Filing evidence keyed by metric name, including direct cell references or derivation details. |
| `quarter_derivation` | [Statement quarter derivation](/fields/financials#statement-quarter-derivation-read) or null | optional | Current and previous cumulative periods used to derive a standalone quarter. |
| `ttm_components` | object or null | optional | Reported period components used to assemble trailing-twelve-month values. |
| `valuation_inputs` | [Statement valuation inputs](/fields/financials#statement-valuation-inputs-read) or null | optional | Market price, exchange rate, share count, and EPS inputs used for valuation ratios. |

<a id="statement-financial-source-reference" />

## Statement financial source reference

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `cell_id` | string or null | optional | Identifier of the statement cell supporting the value when direct cell evidence is available. |
| `page` | integer or null | optional | One-based page number in the source PDF. |
| `filing_id` | string or null | optional | Stable Rangler identifier of the source filing. |
| `derivation` | object or null | optional | Calculation and input-source evidence when the value was derived rather than read from one cell. |

<a id="statement-financials-response" />

## Statement financials

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `company_id` | string (uuid) | required | Stable Rangler company identifier. |
| `company` | [Statement company reference](/fields/financials#statement-company-reference) | required | Company identity or details associated with this record. |
| `issuer_company` | [Statement company reference](/fields/financials#statement-company-reference) or null | optional | Issuer that owns the statements when the selected company is a separate listed security. |
| `scope` | string | required | Statement reporting scope: consolidated group, separate company, or unspecified when source evidence cannot resolve it. Allowed values: `consolidated`, `separate`, `unspecified`. |
| `scope_label` | string or null | optional | Human-readable reporting subject, such as Group, Company, or Bank. |
| `selected_subject` | string or null | optional | Specific reporting subject selected for the financial response when available. |
| `catalog_version` | string | required | Version of the metric catalog used to produce this response. |
| `unit_convention` | map of [Statement unit convention](/fields/financials#statement-unit-convention) | required | Rules for interpreting the unit and scale of every value in the response. |
| `available_scopes` | array of [Statement scope option](/fields/financials#statement-scope-option) | optional | Statement scopes available for the selected issuer and reporting records. |
| `available_reported_currencies` | array of string | optional | Currencies found in the issuer's stored statements. |
| `available_display_currencies` | array of string | optional | Display modes the server can produce without mixing currencies or inventing FX rates. |
| `selected_reported_currency` | string or null | optional | Reported-currency selection used to choose the source statements. |
| `reported_currency` | string or null | optional | Currency used in the underlying disclosure before display conversion. |
| `display_currency` | string or null | optional | Currency selected for the monetary values returned to the caller. |
| `periods` | array of [Statement financial period](/fields/financials#statement-financial-period) | optional | Reported or derived financial periods ordered by reporting date. |
| `trailing_periods` | array of [Statement financial period](/fields/financials#statement-financial-period) | optional | Trailing-twelve-month periods assembled from eligible reported periods. |
| `metric_metadata` | map of [Statement metric definition](/fields/financials#statement-metric-definition-read) | optional | Definitions and units for returned metric keys, when metadata was requested. |
| `ratio_metadata` | map of [Statement ratio definition](/fields/financials#statement-ratio-definition-read) | optional | Definitions, formulas, and units for returned ratio keys, when metadata was requested. |
| `growth_metadata` | map of object | optional | Definitions and calculation rules for returned growth keys, when metadata was requested. |
| `historical_cagrs` | object | optional | Historical compound annual growth calculations, grouped by metric and available duration. |

<a id="statement-metric-catalog-response" />

## Statement metric catalog

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `version` | string | required | Metric catalog version. |
| `units` | map of [Statement unit convention](/fields/financials#statement-unit-convention) | required | Measurement conventions keyed by unit name, including numeric scale and representation. |
| `metrics` | map of [Statement metric definition](/fields/financials#statement-metric-definition-read) | required | Values or definitions keyed by standard metric name; consult the field's value schema and metric catalog. |

<a id="statement-metric-definition-read" />

## Statement metric definition

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `key` | string | required | Stable machine-readable key; use label for presentation. |
| `label` | string | required | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `definition` | string | required | Human-readable meaning of this metric or ratio. |
| `statement_types` | array of string | optional | Financial statements in which this metric can appear. |
| `unit` | string | required | Measurement unit of the associated value. Monetary units use the accompanying currency. |
| `display_unit` | string | required | Suggested display unit for this financial metric. |
| `value_representation` | string | required | How to interpret numbers, such as a base-unit amount, decimal ratio, or count. |
| `source` | string | optional | Value origin: reported for disclosure-backed metrics or derived for calculated ratios. Allowed values: `reported`. Default: `"reported"`. |

<a id="statement-quarter-derivation-read" />

## Statement quarter derivation

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `current_period_end_date` | string (date) | required | End date of the current cumulative period used in quarter derivation. |
| `current_income_basis` | string | required | Flow basis of the current period used in quarter derivation. |
| `previous_period_end_date` | string (date) | required | End date of the cumulative baseline subtracted to derive the standalone quarter. |
| `previous_income_basis` | string | required | Flow basis of the previous period used in quarter derivation. |

<a id="statement-ratio-catalog-response" />

## Statement ratio catalog

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `version` | string | required | Metric catalog version. |
| `units` | map of [Statement unit convention](/fields/financials#statement-unit-convention) | required | Measurement conventions keyed by unit name, including numeric scale and representation. |
| `ratios` | map of [Statement ratio definition](/fields/financials#statement-ratio-definition-read) | required | Values or definitions keyed by standard ratio name; ratio units and formulas are specified in the catalog. |

<a id="statement-ratio-definition-read" />

## Statement ratio definition

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `key` | string | required | Stable machine-readable key; use label for presentation. |
| `label` | string | required | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `definition` | string | required | Human-readable meaning of this metric or ratio. |
| `formula` | string | required | Formula used to calculate the ratio from its dependencies. |
| `category` | string | required | Financial ratio or revenue-segment classification. |
| `unit` | string | required | Measurement unit of the associated value. Monetary units use the accompanying currency. |
| `value_representation` | string | required | How to interpret numbers, such as a base-unit amount, decimal ratio, or count. |
| `dependencies` | array of string | optional | Metric keys required by the formula. |
| `uses_prior_period` | boolean | optional | Whether the formula requires a previous reporting period. Default: `false`. |
| `uses_market_data` | boolean | optional | Whether the formula depends on a market price or another market observation. Default: `false`. |
| `source` | string | optional | Value origin: reported for disclosure-backed metrics or derived for calculated ratios. Allowed values: `derived`. Default: `"derived"`. |

<a id="statement-scope-option" />

## Statement scope option

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `scope` | string | required | Statement reporting scope: consolidated group, separate company, or unspecified when source evidence cannot resolve it. Allowed values: `consolidated`, `separate`, `unspecified`. |
| `label` | string or null | optional | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `scope_label` | string or null | optional | Human-readable reporting subject, such as Group, Company, or Bank. |

<a id="statement-unit-convention" />

## Statement unit convention

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `label` | string | required | Human-readable label. Use the associated key or identifier for programmatic matching. |
| `description` | string | required | Human-readable explanation or source description of this resource. |
| `value_representation` | string | required | How to interpret numbers, such as a base-unit amount, decimal ratio, or count. |
| `scale` | integer | optional | Multiplier defining the unit convention. Standardized base-unit amounts use a scale of 1. Default: `1`. |
| `currency_field` | string or null | optional | Name of the response field specifying currency for this unit convention. |

<a id="statement-valuation-inputs-read" />

## Statement valuation inputs

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `price` | number or null | optional | Market price aligned to the financial response's currency for valuation calculations. |
| `price_currency` | string or null | optional | Currency in which the associated price is expressed. |
| `price_as_of_date` | string (date) or null | optional | Date of the market price used for valuation. |
| `source_price` | number or null | optional | Original stored market price before any currency alignment. |
| `source_price_currency` | string or null | optional | Currency of the original stored market price. |
| `statement_currency` | string or null | optional | Currency of the financial statements used in valuation. |
| `fx_rate` | number or null | optional | Exchange-rate multiplier used to align market price and financial-statement currencies. |
| `fx_rate_date` | string (date) or null | optional | Date of the exchange-rate observation used in valuation. |
| `fx_status` | string or null | optional | Outcome of currency alignment between the price and financial statements. |
| `shares` | number or null | optional | Outstanding share count used for per-share or valuation calculations. |
| `eps` | number or null | optional | Earnings per share used for valuation, in statement\_currency. |
| `eps_source` | string or null | optional | Source or method used to obtain the EPS value. |

<a id="app--schemas--filing--revenue-segment-read" />

## Revenue segment (disclosure)

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `segment` | string | required | Source-reported name of the revenue segment. |
| `category` | string or null | optional | Financial ratio or revenue-segment classification. |
| `products` | string or null | optional | Products or activities associated with the segment, as disclosed. |
| `revenue_value` | number or null | optional | Numeric disclosed revenue. Interpret its currency and source scale using the enclosing response. |
| `revenue_usd_value` | number or null | optional | Disclosed revenue converted to US dollars when available. |
| `revenue_contribution_pct` | number or null | optional | Segment's contribution to total revenue in percentage points: 25 means 25%. |

<a id="app--schemas--statement-financials--revenue-segment-read" />

## Revenue segment (financial statement)

| Field | Type | Presence | Meaning |
| - | - | - | - |
| `segment` | string | required | Source-reported name of the revenue segment. |
| `category` | string or null | optional | Financial ratio or revenue-segment classification. |
| `products` | string or null | optional | Products or activities associated with the segment, as disclosed. |
| `revenue_value` | number or null | optional | Numeric disclosed revenue. Interpret its currency and source scale using the enclosing response. |
| `revenue_usd_value` | number or null | optional | Disclosed revenue converted to US dollars when available. |
| `revenue_contribution_pct` | number or null | optional | Segment's contribution to total revenue in percentage points: 25 means 25%. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.