Reconciliation periods

Get a reconciliation period

Fetches one period with its bank-side figures, its item counts, its lock history, and exactly which actions are currently possible and why. Requires the reconciliations:read permission.

GET

https://services.magicdoor.com/accounting/company-portal/reconciliations/periods/{reconciliationPeriodId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

reconciliationPeriodIdstringrequired

Snowflake id of the reconciliation period.

example: 1830472847398411100

Response

200 · The period in full.

idstring

Snowflake id of the period.

periodStartstring · date

First day of the period, in the company's timezone.

periodEndstring · date

Last day of the period, in the company's timezone.

statusenum<string>

draft, locked or reopened.

draftreopenedlocked

validityobject

Whether a locked period's numbers still hold.

bankAccountobject

The bank account, resolved for display.

financialSummaryobject

The bank side of the period, computed from the bank feed entries that are still active. It says nothing about whether those entries have been resolved.

itemSummaryobject

How the reconciliation items inside the period stand.

lockSummaryobject

The period's lock history. Reopening keeps the history and locking again appends to it.

dispositionsDisposition[]

Things that changed after this period was locked, newest first. A disposition is acknowledged once, on the period it directly affects — it is not copied onto the later periods it makes impacted.

capabilitiesobject

What the period will currently accept. Advisory, for enabling and disabling buttons — the endpoints enforce their own rules.

blockersBlocker[]

Why the unavailable actions are unavailable.

createdstring · date-time

When the period was created, in the company's timezone.

updatedstring · date-time

When it last changed, in the company's timezone.

401 · The access token is missing, expired, or not for this company.

403 · The caller does not hold the `reconciliations:read` permission.

404 · No reconciliation period with this id belongs to the caller's company.

Reading the blockers

capabilities says what is possible; blockers says why the rest is not. Each blocker names the action it stops and, where there is one, the relatedId of the record causing it.

`type`	What it means
`periodStatus`	The period is in the wrong state for this action.
`draftPeriod`	The action needs a locked period, and this one has never been locked.
`subsequentPeriodNotReopened`	A later period is still locked, so this one cannot be reopened yet.
`earlierEditablePeriod`	An earlier period is still `draft` or `reopened` and must be dealt with first.
`unresolvedBankFeedEntry`	A bank feed entry inside the period has no reconciliation item.
`missingReconciliationItemResolution`	An item inside the period is still `open`.
`openReconciliationItemReview`	An item inside the period has an unacknowledged review.
`duplicateReconciliationItems`	Two items point at the same bank feed entry.
`reconciliationItemAlreadyLocked`	An item inside the period is already locked into another period.
`missingReconciliationItemTransactionLinks`	A resolved item has no transaction links behind it.
`duplicateReconciliationItemTransactionLinks`	The same transaction is linked twice.
`openPeriodDisposition`	The period has an unacknowledged disposition.
`balanceDifference`	`financialSummary.difference` is not zero — the bank's closing balance and the cleared balance disagree.