Get a reconciliation item
Fetches one reconciliation item with its suggestions, its transaction links, what it will currently accept, and the names of everything it references. Requires the reconciliations:read permission.
Authorization
AuthorizationstringrequiredPath parameters
reconciliationItemIdstringrequiredSnowflake id of the reconciliation item.
Response
200 · The reconciliation item in full.
idstringSnowflake id of the reconciliation item.
bankAccountIdstringThe bank account the bank feed entry landed in.
bankFeedEntryIdstringThe bank feed entry this item is about. One item exists per entry.
statusenum<string>Derived, not stored: open when there is no resolution, needsReview when there is one but something underneath it changed, completed when there is one and nothing is outstanding.
amountnumberThe amount the bank reported, as a decimal. Signed, unlike almost every other amount in this API: positive means money arriving in the bank account, negative means money leaving it.
occurredstring · date-timeWhen the bank says the money moved, in the company's timezone.
descriptionstringThe description the bank supplied for the entry.
sourceTypeenum<string>How the entry reached MagicDoor — a provider feed, a manual entry, or a file import.
entryStatusenum<string>active normally; retracted once the bank withdraws the entry. A retracted entry under a resolved item raises a review.
lockedPeriodIdstringThe locked reconciliation period this item belongs to. Absent while it is not locked, and while it is absent the item can still be changed.
candidateCountintegerHow many suggestions are currently on the item, so a list can show a badge without loading them.
candidateGenerationobjectThe state of the last suggestion run. Absent when generation has never been asked for.
resolutionobjectHow the entry was explained. Absent while the item is open.
reviewobjectAn outstanding question about a resolution that is already in place. Absent when there is none.
createdstring · date-timeWhen the item was created, in the company's timezone.
updatedstring · date-timeWhen it last changed, in the company's timezone.
metadataobjectWhatever extra key-value pairs the feed provider attached to the entry. Provider-specific; treat the keys as opaque.
candidatesCandidate[]Current suggestions, at most five. They are disposable, not history: regenerating replaces the whole set, and resolving, invalidating or raising a review clears it. Accepting one keeps only that one, for as long as its resolution stands.
transactionLinksLink[]The transactions the resolution ties this bank entry to, each with a frozen copy of the transaction at the moment it was linked. Comparing that copy with the live transaction is what raises a review.
capabilitiesobjectWhat the item will currently accept. It is advisory — meant for greying out buttons and explaining why — and is not the authorization check. The endpoints enforce their own rules.
chartOfAccountsChartOfAccount[]The accounts referenced anywhere in this payload, resolved for display.
transactionsTransaction[]The transactions referenced by candidates and links, resolved so you do not have to fetch them one by one.
vendorBillsVendorBill[]The vendor bills referenced by the current settling candidates, resolved for display.
portfoliosReference[]Id-to-name pairs for every portfolio mentioned anywhere in this payload, so you do not have to look them up.
propertiesReference[]Id-to-name pairs for every property mentioned anywhere in this payload, so you do not have to look them up.
leasesReference[]Id-to-name pairs for every lease mentioned anywhere in this payload, so you do not have to look them up.
tenantsReference[]Id-to-name pairs for every tenant mentioned anywhere in this payload, so you do not have to look them up.
ownersReference[]Id-to-name pairs for every owner mentioned anywhere in this payload, so you do not have to look them up.
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 item with this id belongs to the caller's company.
One line on the bank statement, waiting to be explained. MagicDoor creates an item for every entry the bank feed reports and keeps it until you say what it was: a transaction already in the books (matched), a payment of vendor bills (settled), a transaction that should now be created (posted), or nothing MagicDoor needs to record (ignored).
status | What it means | What you can do |
|---|---|---|
open | No resolution yet. | Resolve it, or ask for fresh suggestions. |
needsReview | It was resolved, then something underneath changed — the bank edited or withdrew the entry, or a linked transaction moved. | Acknowledge the review, or rematch to start over. |
completed | Resolved and nothing outstanding. | Rematch if you need to redo it, unless it is locked in a period. |