Preview Reconciliation Endpoint

POST

/api/v1/budget/reconciliations/preview

curl --request POST \
  --url https://example.com/api/v1/budget/reconciliations/preview \
  --header 'Content-Type: application/json' \
  --data '{ "account_id": 1, "statement_date": "2026-04-15", "statement_balance": 1, "opening_balance": 1, "write_snapshot": true, "replace_snapshot": false }'

Report the statement difference without writing anything.

A POST only because it takes a body.

Request Body^required

Media typeapplication/json

ReconcileRequest

What the bank statement says. statement_balance is signed: a statement may close overdrawn (such a reconcile locks its rows but writes no snapshot).

object

account_id

required

Account Id

integer

statement_date

required

Statement Date

string format: date

statement_balance

required

Any of:

number

number

string

string

opening_balance

Any of:

number

number

string

string

null

null

write_snapshot

Write Snapshot

boolean

default: true

replace_snapshot

Replace Snapshot

boolean

Responses

200

Successful Response

Media typeapplication/json

ReconcilePreviewOut

The difference a reconcile would report. With anchor_kind == "none" the balance fields are null and the client asks for an opening balance.

object

account_id

required

Account Id

integer

currency

required

Currency

string

statement_date

required

Statement Date

string format: date

statement_balance

required

Statement Balance

string

anchor_kind

required

Anchor Kind

string

Allowed values: reconcile snapshot opening none

anchor_date

Any of:

string

string format: date

null

null

anchor_balance

Any of:

string

string

null

null

included_count

Any of:

integer

integer

null

null

included_sum

Any of:

string

string

null

null

pending_count

Any of:

integer

integer

null

null

stale_count

Any of:

integer

integer

null

null

ledger_balance

Any of:

string

string

null

null

difference

Any of:

string

string

null

null

existing_snapshot_balance

Any of:

string

string

null

null

Example

{
  "anchor_kind": "reconcile"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}