RoboLedger: Reports

Create Report

Generates report facts from the ledger and marks the report as published. The report is the entity's whose chart mapping_id maps from; made from the consolidation entity's mapping it is the group's consolidated statements: every member summed in full with the consolidating entries, under the group parent's Reporting Style. A consolidated column cannot span a member joining or leaving the group.

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/create-report

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/create-report
  • 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 the report is for, by id. Omit for the entity whose chart mapping_id maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused. The consolidation entity's report is the group's consolidated statements.

namestring required

Human-readable report name shown in lists and headers.

taxonomy_idstring

Taxonomy that defines the structures (BS / IS / CF / Equity / Schedules) this report can render. Accepts either an exact tenant-specific taxonomy UUID or a standard name (e.g. 'rs-gaap'). Standard names resolve to the latest reporting_standard taxonomy with that name. Defaults to 'rs-gaap', the canonical reporting vocabulary.

mapping_idstring required

Mapping structure that rolls up the tenant's chart of accounts to the taxonomy's reporting concepts. Created via create-mapping-association / auto-map-elements.

period_startstring date required

Current-period start (inclusive). Ignored when periods is supplied.

period_endstring date required

Current-period end (inclusive). Must be >= period_start. Ignored when periods is supplied.

period_typestring

Period cadence: monthly, quarterly, or annual.

comparativeboolean

When true, automatically generates a prior-period column (same length as the current period). Ignored when periods is supplied.

Example request

{
  "comparative": true,
  "mapping_id": "map_01HVF8T0M2YTAY3BBNRH0V0",
  "name": "Q3 2026 Financials",
  "period_end": "2026-09-30",
  "period_start": "2026-07-01",
  "period_type": "quarterly",
  "taxonomy_id": "tax_usgaap_reporting"
}

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.