RoboLedger: Ledger & Events

Preview Reconciliations

Compare the ledger at a period end with something outside it, without recording anything. method picks the check. source_ledger (the default) reads QuickBooks' own trial balance for the period end and sets it beside the ledger's, account by account: balance-sheet accounts cumulatively, income and expense accounts from the start of the fiscal year. A difference there means the ledger's copy of the books has drifted from the source (a transaction deleted or back-dated there after it was synced, or activity not yet synced), so run it before trusting any other figure on a synced ledger; it needs a connected QuickBooks ledger. schedule_register compares each asset account a schedule carries a balance on (a prepaid, accumulated depreciation, a fixed-asset cost account) with what its schedules say it holds, and lists the schedules behind each figure. A difference there is a balance with no schedule behind it, or a scheduled amount the ledger does not hold. Each row carries both balances, the difference, and whether the account ties.

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/preview-reconciliations

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/preview-reconciliations
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

periodstring required

Period to compare at its last day, as YYYY-MM.

method'source_ledger' | 'schedule_register' | 'statement'

Which check to preview. source_ledger compares every account with the synced accounting system's own trial balance. schedule_register compares each asset account a schedule carries a balance on with what its schedules say it holds. statement compares each account that has a statement covering the period with that balance, adjusted on a bank-fed account by the lines the bank had not cleared.

include_tiedboolean

Also return the accounts that tie. Off by default: the differences are the work, and the counts cover the rest.

entity_idstring nullable

The entity whose books to compare, by id. Omit for the group parent. source_ledger applies to the group parent only: QuickBooks keeps its books, not a subsidiary's.

Example request

{
  "period": "2026-08"
}

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.