Preview Reconciliations

post/extensions/roboledger/{graph_id}/operations/preview-reconciliations

Compare the ledger's account balances at a period end with the books they were synced from. Reads QuickBooks' own trial balance for the period end and sets it beside the ledger's, account by account: each row carries both balances, the difference, and whether the account ties. Balance-sheet accounts are compared cumulatively; income and expense accounts from the start of the fiscal year. A difference 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 this before trusting any other figure on a synced ledger. Writes nothing. Only for a graph with a connected QuickBooks ledger.

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 Constraints: matches `^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?\|sec(?:_[a-zA-Z0-9]{1,20})?\|library)$`

Header parameters

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

Request body

Required, application/json.

Field Type Description

Field	Type	Description
`period`required	string	Period to compare at its last day, as YYYY-MM.
`include_tied`optional	boolean	Also return the accounts that tie. Off by default: the differences are the work, and the counts cover the rest. Default: `false`

periodrequired

string

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

include_tiedoptional

boolean

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

Default: false

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/preview-reconciliations" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "period": "2026-08"
}'

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

ReconciliationPreviewResponse

Command-specific result payload

ReconciliationPreviewResponse fields

Field Type Description

periodrequired string

as_ofrequired

string (date)

The period's last day.

fiscal_year_startrequired

string (date)

Income-statement accounts are compared from this date to as_of.

methodrequired string

sourcerequired

string

The system the independent side was read from.

report_basisoptional

string

Accounting basis the source reported on.

last_sync_atoptional

string (date-time)

When the source was last synced. A difference on a sync older than the period end may be activity not yet synced, not a fault in the mirror.

accounts_comparedrequired

integer

Accounts with a balance on either side; zero on both is left out.

accounts_tiedrequired integer

accounts_differentrequired

integer

Every account that does not tie, whatever the reason.

total_differencerequired

number

Sum of the absolute differences across accounts, not a net figure: one missing transaction counts on each account it touches.

rowsrequired

ReconciliationRow[]

Accounts that do not tie, largest difference first; tied accounts follow when include_tied is set.

ReconciliationRow fields

Field	Type	Description
`element_id`optional	string	The chart account; null when the ledger has none for it.
`account_code`optional	string	The chart account's code.
`account_name`required	string	The account's name in the ledger, else in the source.
`source_account_id`optional	string	The account's id in the source system, when it has one.
`statement`optional	string	`balance_sheet` or `income_statement`. Balance-sheet accounts are compared cumulatively to the period end; income-statement accounts from the start of the fiscal year. Null when the ledger has no account.
`ledger_balance`required	number	What the ledger holds, from landed entries.
`independent_balance`required	number	What the independent source says.
`difference`required	number	Ledger minus independent.
`status`required	string	`tied`: both sides agree to the cent. `different`: both know the account and disagree. `not_in_ledger`: the source reports an account the ledger has none for. `not_in_source`: the ledger holds a balance on an account the source does not have.

notesoptional

string[]

How the comparison was made, and anything that qualifies it.

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation

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