List reconciliation candidates

Returns the transactions on the bank account that can be pulled into this reconciliation, together with the ones already pulled in and how they are marked. Requires the reconciliations:read permission.

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

bankAccountIdstringrequired

The bank account being reconciled.

example: 1830472847398404096

manualReconciliationIdstringrequired

Snowflake id of the reconciliation.

example: 1830472847398409100

Query parameters

showAllboolean

By default transactions paid by internal credit are left out, because they never appear on a bank statement. Set true to see them as well.

default: false

Response

200 · The candidate transactions and the deposit slips they belong to.

candidatesCandidate[]

One row per transaction that can be, or already is, part of this reconciliation.

depositSlipsDepositSlip[]

The deposit slips the candidate transactions belong to, so you can offer slip-level selection.

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

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

404 · The bank account is not in the caller's company, or no reconciliation with this id belongs to that bank account.

Which transactions appear

Two sets are merged. New candidates are transactions on this bank account that no manual reconciliation has claimed, finalized on or before endDate and no earlier than one month before startDate — that month of slack is there so a late-arriving payment from the previous period is still offerable. Already selected transactions are whatever this reconciliation has entries for, fetched by id and therefore never filtered by date. A transaction claimed by a different reconciliation never appears.