Banking

Read reconciliation setup context

Returns account readiness, optional OCR statement candidates, and searchable posted imported or bank-feed activity through the cutoff for carry-forward selection. Statement verification is not required to finish setup.

get/bank-accounts/{id}/reconciliation-setup

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-accounts/{id}/reconciliation-setup
  • 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

idstring uuid required

Bank account UUID

Query parameters

cutoffDatestring date
statementIdstring uuid
statementExtractionIdstring uuid
searchstring
windowStartstring date

Only list carry-forward candidates dated on or after this date. Ignored while searching.

pageinteger

Page through carry-forward candidates. Omit to return every candidate.

pageSizeinteger
correctionboolean

Include the saved starting-point baseline and current outstanding imported-item selection.

Response

Reconciliation setup context

Changes

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