List reconciliation periods
Returns every reconciliation period on one bank account. The list is not paginated. Requires the reconciliations:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
bankAccountIdstringrequiredThe bank account whose periods you want. It is required — periods are always read per account.
Response
200 · The bank account's reconciliation periods.
itemsReconciliationPeriod[]The periods, each with its dispositions.
400 · `bankAccountId` is missing or is not a Snowflake.
401 · The access token is missing, expired, or not for this company.
403 · The caller does not hold the `reconciliations:read` permission.
A period is one bank statement's worth of time on one bank account. You create it as a draft with the statement's closing balance, work through the reconciliation items inside it, and lock it once the bank's figures and MagicDoor's agree. Periods sit end to end: each one starts the day after the last locked one ended and opens with that period's closing balance.
status | What it means | What you can do |
|---|---|---|
draft | Being prepared. Nothing is frozen. | Edit it, delete it, or lock it. |
locked | Closed. Its items are frozen into a snapshot and can no longer be resolved or rematched. | Reopen it — but only if no later period is still locked. |
reopened | Was locked, then opened up again. Editable like a draft, and its items are free again. | Edit it, delete it, or lock it again. |
A bank account can have at most one draft or reopened period. Creating a second one is rejected until the existing one is locked or deleted.