Evenbead docs
Contents

Reconciliation

8 operations. All areas

POST/v1/bank-accounts/{id}/reconciliations

Start reconciling a statement. The beginning balance is the last finished statement's ending balance. auto_clear pre-clears lines the bank already showed.

  • Operation startReconciliation
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • statement_date string, required Calendar date, YYYY-MM-DD.
  • statement_ending_balance_cents integer, required Signed integer cents.
  • auto_clear boolean
Responses
  • 201 Started (ReconciliationDetail)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/reconciliations

Reconciliations, newest statement first

  • Operation listReconciliations
  • Scope: read
  • Read
Parameters
  • bank_account_id query, string
Responses
  • 200 Reconciliations (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reconciliations/{id}

A reconciliation with its cleared lines and (while in progress) the uncleared candidates

  • Operation getReconciliation
  • Scope: read
  • Read
Parameters
  • id path, string, required
Responses
  • 200 Reconciliation (ReconciliationDetail)
  • Errors 400, 401, 403, 404, 429, 500 (Error: error.type, message)

POST/v1/reconciliations/{id}/update

Clear or unclear ledger lines, or correct the statement date/ending balance, while in progress

  • Operation updateReconciliation
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • clear array of integer
  • unclear array of integer
  • statement_date string Calendar date, YYYY-MM-DD.
  • statement_ending_balance_cents integer Signed integer cents.
Responses
  • 200 Updated (ReconciliationDetail)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/reconciliations/{id}/finish

Finish: only at zero difference. Finished reconciliations are immutable and audited by the database.

  • Operation finishReconciliation
  • Scope: approve
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body

Empty object {}.

Responses
  • 200 Finished (ReconciliationDetail)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

POST/v1/reconciliations/{id}/cancel

Discard an in-progress reconciliation (finished ones can never be removed)

  • Operation cancelReconciliation
  • Scope: propose
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • reason string, required
Responses
  • 200 Cancelled (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)

GET/v1/reconciliations/{id}/report

Reconciliation report: cleared deposits and payments, uncleared items, book vs statement tie-out

  • Operation getReconciliationReport
  • Scope: read
  • Read
Parameters
  • id path, string, required
  • format query, "json" | "csv"
Responses
  • 200 Report (ReconciliationReport)
  • Errors 400, 401, 403, 404, 429, 500 (Error: error.type, message)

POST/v1/reconciliations/{id}/undo

Undo the latest finished reconciliation of a bank account (audited; refused while a period containing or after its statement is locked)

  • Operation undoReconciliation
  • Scope: approve
  • Write: needs Idempotency-Key (or dry_run)
Parameters
  • id path, string, required
Request body
  • reason string, required
Responses
  • 200 Undone (object)
  • Errors 400, 401, 403, 404, 409, 422, 429, 500 (Error: error.type, message)