Browse the API reference

Extensions: RoboLedger

Named commands for accounting & reporting writes and analytical views

57 operations.

post/extensions/roboledger/{graph_id}/operations/initialize
Initialize Ledger
One-time setup: creates the fiscal calendar and seeds periods.
post/extensions/roboledger/{graph_id}/operations/update-entity
Update Entity
Update the graph's primary entity.
post/extensions/roboledger/{graph_id}/operations/change-reporting-style
Change Reporting Style
Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks).
post/extensions/roboledger/{graph_id}/operations/create-taxonomy-block
Create Taxonomy Block
Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules.
post/extensions/roboledger/{graph_id}/operations/initialize-chart-of-accounts
Initialize Chart of Accounts
Create the graph's chart of accounts from a shipped template — the fresh-company path to native books.
post/extensions/roboledger/{graph_id}/operations/update-taxonomy-block
Update Taxonomy Block
Incrementally mutate a taxonomy block via typed delta lists (elements/structures/associations/rules to add, update, remove).
post/extensions/roboledger/{graph_id}/operations/delete-taxonomy-block
Delete Taxonomy Block
Delete a taxonomy block and return a thin confirmation.
post/extensions/roboledger/{graph_id}/operations/link-entity-taxonomy
Link Entity to Taxonomy
Link the graph's entity to a taxonomy.
post/extensions/roboledger/{graph_id}/operations/create-mapping-association
Create Mapping Association
Link a chart-of-accounts element to a US GAAP reporting concept.
post/extensions/roboledger/{graph_id}/operations/delete-mapping-association
Delete Mapping Association
Remove a single CoA → reporting-concept mapping edge by id.
post/extensions/roboledger/{graph_id}/operations/auto-map-elements
Auto-Map Elements via AI (async)
Dispatches to the background worker — returns a pending envelope immediately.
post/extensions/roboledger/{graph_id}/operations/create-information-block
Create Information Block
Generic Information Block construction entry.
post/extensions/roboledger/{graph_id}/operations/update-information-block
Update Information Block
Generic Information Block update entry.
post/extensions/roboledger/{graph_id}/operations/delete-information-block
Delete Information Block
Generic Information Block deletion entry.
post/extensions/roboledger/{graph_id}/operations/evaluate-rules
Evaluate Rules for an Information Block
Runs every rule targeting the given structure (plus element- and association-scoped rules for the structure's atoms), binds $Variable references to in-scope facts via qname…
post/extensions/roboledger/{graph_id}/operations/compute-metrics
Compute Metrics for a Metric Block
Resolves the Derive rules scoped to a metric block (blocktype='metric'), binds each rule's operands to the entity's most recent persisted report facts at periodend, evaluates, and…
post/extensions/roboledger/{graph_id}/operations/assert-metrics
Assert Metrics for a Metric Block
Writes externally-observed metric values (usage counts, marketing numbers, hand-carried figures) into the period's standing factsettype='metric' FactSet with AssertedProvenance —…
post/extensions/roboledger/{graph_id}/operations/compute-forecast
Compute Forecast for a Forecast Block
Walks a forecast block's driver cascade month-by-month forward from its base period: lever-driven rs-driver Derive rules in dependency order, carry-forward for unmodeled…
post/extensions/roboledger/{graph_id}/operations/bind-text-block
Bind Text Block
Bind a platform Document (markdown) — or one of its sections — to a disclosure element as a Nonnumeric text-block fact.
post/extensions/roboledger/{graph_id}/operations/create-agent
Create Agent
Create a counterparty record (customer, vendor, employee, etc.).
post/extensions/roboledger/{graph_id}/operations/update-agent
Update Agent
Patch counterparty fields.
post/extensions/roboledger/{graph_id}/operations/create-event-block
Create Event Block
Persist a real-world business event.
post/extensions/roboledger/{graph_id}/operations/update-event-block
Update Event Block
Apply a status transition (captured → classified | committed | voided) and/or field corrections (description, effectiveat, metadatapatch) to an existing event block.
post/extensions/roboledger/{graph_id}/operations/execute-event-block
Execute Event Block (publish to source-of-truth system)
For events on a connection with writepolicy='qbauthoritative' or 'hybrid', publish the captured GL plan to the source-of-truth system (QuickBooks).
post/extensions/roboledger/{graph_id}/operations/create-event-handler
Create Event Handler
Define a rule that fires GL transactions when a matching event block is created with applyhandlers=True.
post/extensions/roboledger/{graph_id}/operations/update-event-handler
Update Event Handler
Patch an event handler's match criteria, template, priority, or active state.
post/extensions/roboledger/{graph_id}/operations/preview-event-block
Preview Event Block
Dry-run: resolve the matching handler and evaluate the transaction template without writing any rows.
post/extensions/roboledger/{graph_id}/operations/preview-reconciling-item
Preview Reconciling Item
Read what changed on a reconciling item — an event whose source-system payload changed after it was posted (list them with list-event-blocks isreconcilingitem=true).
post/extensions/roboledger/{graph_id}/operations/resolve-reconciling-item
Resolve Reconciling Item
Dispose of one reconciling item and clear its flag.
post/extensions/roboledger/{graph_id}/operations/update-journal-entry
Update Journal Entry
Update a draft journal entry.
post/extensions/roboledger/{graph_id}/operations/delete-journal-entry
Delete Journal Entry
Hard-delete a draft journal entry.
post/extensions/roboledger/{graph_id}/operations/promote-obligations
Promote Due Schedule Obligations
Promote matured pending schedule obligations (scheduleentrydue events whose period boundary has passed) to 'classified', and — when dispatchhandlers=true (default) — draft their…
post/extensions/roboledger/{graph_id}/operations/rebuild-schedule
Rebuild Schedule In Place
Re-run the schedule generator in place on an existing schedule.
post/extensions/roboledger/{graph_id}/operations/terminate-schedule
Terminate Schedule Early (No Entry)
End a schedule early at a month-end cutoff without booking any entry.
post/extensions/roboledger/{graph_id}/operations/set-close-target
Set Close Target
Set the user-controlled goal period for closing (closetarget).
post/extensions/roboledger/{graph_id}/operations/close-period
Close Fiscal Period
Lock a single fiscal period.
post/extensions/roboledger/{graph_id}/operations/reopen-period
Reopen Fiscal Period
Reopen a closed period for adjustment.
post/extensions/roboledger/{graph_id}/operations/backfill-plan-history
Backfill Plan History
Compile monthly statement history behind the close boundary — the plan's historical columns.
post/extensions/roboledger/{graph_id}/operations/create-report
Create Report
Generates report facts from the ledger and marks the report as published.
post/extensions/roboledger/{graph_id}/operations/regenerate-report
Regenerate Report
Re-runs fact generation for an existing Report against the latest ledger state.
post/extensions/roboledger/{graph_id}/operations/delete-report
Delete Report
Deletes the report definition and all generated facts.
post/extensions/roboledger/{graph_id}/operations/share-report
Share Report
Pushes a published report to every member of the target publish list.
post/extensions/roboledger/{graph_id}/operations/revoke-report-share
Revoke Report Share
Withdraws a report previously shared to one recipient graph: deletes the copy from that recipient's schema and stamps the share record revoked.
post/extensions/roboledger/{graph_id}/operations/file-report
File Report
Transitions the Report's filingstatus to 'filed' — locks the package.
post/extensions/roboledger/{graph_id}/operations/transition-filing-status
Transition Filing Status
Move a Report along the non-file legs of the filing lifecycle (draft ↔ underreview, filed → archived).
post/extensions/roboledger/{graph_id}/operations/create-publish-list
Create Publish List
Create a publish list (a saved set of recipient graphs).
post/extensions/roboledger/{graph_id}/operations/update-publish-list
Update Publish List
Updates the publish list's name and/or description.
post/extensions/roboledger/{graph_id}/operations/delete-publish-list
Delete Publish List
Delete a publish list and its membership rows.
post/extensions/roboledger/{graph_id}/operations/add-publish-list-members
Add Members to Publish List
Add one or more recipient graphs to a publish list.
post/extensions/roboledger/{graph_id}/operations/remove-publish-list-member
Remove Member from Publish List
Remove a single recipient from a publish list.
post/extensions/roboledger/{graph_id}/operations/block-source-graph
Block Source Graph
Bars a graph from sharing reports into this one.
post/extensions/roboledger/{graph_id}/operations/unblock-source-graph
Unblock Source Graph
Lifts a block, allowing that graph to share reports into this one again.
post/extensions/roboledger/{graph_id}/operations/live-financial-statement
Live Financial Statement
Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping.
post/extensions/roboledger/{graph_id}/operations/build-fact-grid
Build Fact Grid
Queries LadybugDB Fact nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context.
post/extensions/roboledger/{graph_id}/operations/financial-statement-analysis
Financial Statement Analysis
Query a rendered financial statement from the graph-backed XBRL hypercube (Structure → FactSet → Fact).
post/extensions/roboledger/{graph_id}/operations/disclosures
Disclosures
The map of a report's sections: one row per disclosure family — a note with its policies, tables and details, a statement with its parenthetical, the cover page — with block…
post/extensions/roboledger/{graph_id}/operations/information-block
Information Block
One section of a report read whole — the expensive call: rows in presentation order with the consolidated value per period column, the same rows broken out by the section's own…

Initialize Ledger

Update Entity

Change Reporting Style

Create Taxonomy Block

Initialize Chart of Accounts

Update Taxonomy Block

Delete Taxonomy Block

Link Entity to Taxonomy

Create Mapping Association

Delete Mapping Association

Auto-Map Elements via AI (async)

Create Information Block

Update Information Block

Delete Information Block

Evaluate Rules for an Information Block

Compute Metrics for a Metric Block

Assert Metrics for a Metric Block

Compute Forecast for a Forecast Block

Bind Text Block

Create Agent

Update Agent

Create Event Block

Update Event Block

Execute Event Block (publish to source-of-truth system)

Create Event Handler

Update Event Handler

Preview Event Block

Preview Reconciling Item

Resolve Reconciling Item

Update Journal Entry

Delete Journal Entry

Promote Due Schedule Obligations

Rebuild Schedule In Place

Terminate Schedule Early (No Entry)

Set Close Target

Close Fiscal Period

Reopen Fiscal Period

Backfill Plan History

Create Report

Regenerate Report

Delete Report

Share Report

Revoke Report Share

File Report

Transition Filing Status

Create Publish List

Update Publish List

Delete Publish List

Add Members to Publish List

Remove Member from Publish List

Block Source Graph

Unblock Source Graph

Live Financial Statement

Build Fact Grid

Financial Statement Analysis

Disclosures

Information Block