Reconciliation

Start a reconciliation

Starts a reconciliation session after Account Settings has saved its date and carry-forward selection. The first session requires explicitFirstStart=true from Bank Recs; statement OCR and setup never start it automatically. Signed balances are integer cents. Only one in-progress session is allowed per bank account.

post/bank-accounts/{bankAccountId}/reconciliations

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-accounts/{bankAccountId}/reconciliations
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

bankAccountIdstring uuid required

LedgerHQ bank account UUID

Request body

startDatestring date
endDatestring date required
startBalanceinteger

Signed cents. Credit-card and loan/liability balances due should be negative.

endBalanceinteger

Signed cents

sourceStatementIdstring uuid nullable
sourceStatementExtractionIdstring uuid nullable
statementStartDatestring date nullable
statementEndDatestring date nullable
statementOpeningBalanceinteger nullable
statementEndingBalanceinteger nullable
firstReconciliationMode'never_reconciled'

Required only when the configured account has never been reconciled and its first period is being opened.

explicitFirstStartboolean

Explicitly start the first period after configuration; omitted by unattended reconciliation.

Response

Reconciliation started

Changes

No recorded changes to this operation across all 5 revisions of this API.