RoboLedger: Analytical Views

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. One entity's books: entity_id names a subsidiary, omitted means the group parent. On the parent, scope: combined sums every member consolidated in full at the rs-gaap concepts for the months each was a member, nothing eliminated, and scope: consolidated adds the consolidation entity's entries — the eliminations and noncontrolling interest. 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.

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

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/live-financial-statement
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

entity_idstring nullable

The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.

statement_typestring required

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_startstring date nullable

Explicit window start. Overrides period_type/fiscal_year.

period_endstring date nullable

Explicit window end. Overrides period_type/fiscal_year.

period_typestring nullable

annual | quarterly | instant (ignored when dates supplied)

fiscal_yearinteger nullable

Fiscal year for annual window (anchored on FiscalCalendar)

scope'entity' | 'combined' | 'consolidated' nullable

entity (the default): one entity's own books. combined: on the group parent, every member consolidated in full rendered under the parent's Reporting Style and summed per rs-gaap concept, each for the months it was a member — the pre-adjustment total, nothing eliminated. consolidated: the same sum plus the consolidation entity, whose eliminations and noncontrolling interest are the adjustments column, so a group that posts its consolidating entries there reads its consolidated statement. An equity-method or cost member is never summed (its consolidation_method says so). Both group scopes are read on the group parent only (422 on a subsidiary). An entity with no CoA mapping yet contributes nothing and is left out of combined_entity_ids.

consolidatedboolean

The older spelling of scope: consolidated, kept for callers that pass it; scope wins when both are given.

limitinteger

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.

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.