Read statement notes
get_statement_notesRead the line-by-line breakdown of a generated statement's notes — every line's current and prior-year amount, and the note total. Pass note_numbers (from get_statement_figures' note_index) to fetch specific notes, or omit for all. Use this to answer "what's in Other Expenses?" or "what makes up trade receivables?". Each line has a kind: 'component' (an additive line), 'subtotal' (a presentational group subtotal — do NOT add it into the total, or you double-count), or 'header'. Fixed-asset / intangible notes carry a block per class with gross_block, accumulated depreciation, and net (the additions/deletions movement schedule itself lives in the workbook). If the full set is too large it returns too_large:true with a note_index — fetch note_numbers in small batches. A single very large note (e.g. a PPE schedule or an ageing note) is returned in explicitly-flagged line pages: each page carries the authoritative note total, lines_page, lines_total, and has_more_lines — keep fetching lines_page until has_more_lines is false; never treat one page's lines as the whole note. Amounts are decimal strings in rupees. Figures are Datavrn's deterministic engine output; interpretation is your assistant's.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | A specific statement version; omit for the latest. | |
| client_id | Yes | The entity (client) id — from list_clients. | |
| period_id | Yes | The reporting period id — from list_periods. | |
| lines_page | No | For a single very large note returned in line pages: the 1-based line page to fetch (fetch exactly one note; keep going until has_more_lines is false). | |
| template_id | Yes | The statement template id (e.g. 'schedule3_v1' Division I; see list_snapshots/workspace). | |
| note_numbers | No | Specific note numbers to fetch (from note_index); omit for all notes. |