Reconciliation

Reconcile bank accounts to statement balances.

List reconciliations

GET /reconciliations

Sends Vortex-Entity.

Reconciliations, newest first, up to 50. Requires banking:read.

Parameters

NameInTypeAbout
bank_account_idquerystring

Answers

  • 200 object. The reconciliations.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Reconcile a bank account

POST /reconciliations

Sends Vortex-Entity and Idempotency-Key.

Compares a statement's ending balance to the book balance less items that haven't cleared the bank. When they agree the account is marked reconciled through that date; when they don't, the result lists uncleared items, unreviewed bank lines and a plain-English explanation of the gap. Requires banking:write.

Body

FieldTypeAbout
bank_account_id requiredstring
as_of requiredstring (date)
ending_balance requiredAmount
statement_idstring

Answers

  • 201 Reconciliation. The reconciliation.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Get a reconciliation

GET /reconciliations/{reconciliation_id}

Sends Vortex-Entity.

Parameters

NameInTypeAbout
reconciliation_id requiredpathstring

Answers

  • 200 Reconciliation. The reconciliation.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what