get_fact_decomposition
Break down an XBRL financial fact into rollup components, calculation linkbase children, and dimensional slices by entity and fiscal year.
Instructions
Decompose a financial fact into its constituent parts.
Pass EITHER hub_concept_code (preferred - e.g. TOTAL_ASSETS) OR qname
(raw XBRL like 'us-gaap:DeferredRevenueNoncurrent') for concepts without
a hub mapping.
Returns three layers:
rollup_children- the components this issuer reported for the figure, with their sign, on a paid plan; empty below it, with a note.linkbase_children- XBRL calc linkbase children, RECURSIVE up todepth(max 3). Each child has its ownchildrenlist.dimensional_breakdown- axis/member slices (segment, geography), on a paid plan; empty below it, with a note.
depth=1 is open to every caller. On a paid plan, use depth=2 for
aggregates (TOTAL_ASSETS, TOTAL_LIABILITIES) to get the full breakdown tree
in ONE call instead of N round-trips.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| qname | No | ||
| entity_id | Yes | ||
| fiscal_year | Yes | ||
| hub_concept_code | No | ||
| fiscal_period_type | No | FY |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |