Live Financial Statement

post/extensions/roboledger/{graph_id}/operations/live-financial-statement

Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. Rejected on shared-repository graphs; those should use financial-statement-analysis instead.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`statement_type`required	string	income_statement \| balance_sheet \| cash_flow_statement \| equity_statement. ``equity_statement`` is provisional — equity balances, not a rollforward — and is not offered on the MCP surface until it articulates.
`period_start`optional	string (date)	Explicit window start. Overrides period_type/fiscal_year.
`period_end`optional	string (date)	Explicit window end. Overrides period_type/fiscal_year.
`period_type`optional	string	annual \| quarterly \| instant (ignored when dates supplied)
`fiscal_year`optional	integer	Fiscal year for annual window (anchored on FiscalCalendar)
`limit`optional	integer	Max fact rows returned. Defaults to the ceiling so a statement is never cut mid-section — visible rows would stop footing to visible subtotals. Lower it only for a preview. Default: `1000`

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/live-financial-statement" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "statement_type": "string"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

LiveFinancialStatementResponse

Command-specific result payload

LiveFinancialStatementResponse fields

Field Type Description

graph_idrequired string

statement_typerequired string

periodsrequired

PeriodSpec[]

Rendered columns, aligned with each row's ``values``. Current and prior for income_statement and balance_sheet; current only for cash_flow_statement — the prior period is pivoted as the indirect-method delta basis and not rendered.

PeriodSpec fields

Field	Type	Description
`start`required	string (date)	Period start date (inclusive). Window the column rolls up.
`end`required	string (date)	Period end date (inclusive). Window the column rolls up.
`label`required	string	Column header label (e.g. 'FY2025 Q3', '2024', 'YTD').

factsrequired

LiveStatementFactRow[]

A single row of an OLTP-backed ad-hoc statement.

LiveStatementFactRow fields

Field	Type	Description
`qname`required	string
`name`required	string
`trait`optional	string
`values`required	number[]
`depth`optional	integer	Default: `0`
`is_subtotal`optional	boolean	Default: `false`

fact_countrequired integer

validationoptional

ValidationCheckResponse

Guard-rail outcome for the rendered columns — accounting equation, net-income equation, totals footing, operating-plug size. Null only when no structure rendered.

ValidationCheckResponse fields

Field	Type	Description
`passed`required	boolean	True iff at least one rule ran and every rule produced zero failures on every rendered column. False when nothing was checked (`status == 'inconclusive'`).
`status`required	string	`passed` — every rule ran on every column with zero failures; `failed` — at least one rule failed; `inconclusive` — no validation rules exist for this block type, so nothing was checked.
`checks`required	string[]	Names of rules that were evaluated.
`failures`required	string[]	Human-readable descriptions of rule failures.
`warnings`required	string[]	Non-blocking advisories from rule evaluation.

unmapped_countoptional

integer

Default: 0

truncatedoptional

boolean

Default: false

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error