Sign in
Bank Match

Confirm a bank-match

Record that bank-feed row(s) correspond to DualEntry transaction(s)/entry(s). On success each row's matching_status flips to matched, the pairing shows up in the DualEntry reconciliation view, and the response returns the match_group_id.

Pass singular fields for a 1:1 match, or financial_transaction_ids plus transaction_ids/entry_ids for an M:N match.

Constraints (validated server-side and reported as 400 on failure):

  • All bank-feed rows must be on the same financial account as the DualEntry targets' bank/credit-card entries.
  • Amounts must reconcile (sum of bank amounts equals net entry amount) in a single currency.
  • All bank-feed rows must share the same sign; balance alone is not enough.
  • No item may already be part of another match (call /unmatches/ first to redo a pairing).

This endpoint kicks a fresh suggestion run for the org after a successful match so future suggestions reflect the new state.

post/public/v2/bank-match/matches/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

financial_transaction_idinteger nullable

ID of the bank-feed row to match (from /bank-transactions/).

transaction_idinteger nullable

DualEntry transaction id to match against. Pass this or entry_id, not both.

entry_idinteger nullable

DualEntry entry id to match against (use for partial matches like a single line of a journal entry). Pass this or transaction_id.

financial_transaction_idsinteger[] nullable

M:N: bank-feed row ids to match as one group. Same account and same sign.

transaction_idsinteger[] nullable

M:N: DualEntry transaction ids for the group. May be combined with entry_ids.

entry_idsinteger[] nullable

M:N: DualEntry entry ids for the group. May be combined with transaction_ids.

Response

OK

successtrue
errorsobject
match_group_idinteger nullable

Changes

Changed in 2 of the 15 revisions of this API.7

  • 34b7cf5b4b6c1See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 506e6073d1916See the full diff
    • ○

      added the new optional request property entry_ids

      new-optional-request-property

    • ○

      added the new optional request property financial_transaction_ids

      new-optional-request-property

    • ○

      added the new optional request property transaction_ids

      new-optional-request-property

    • ○

      the request property financial_transaction_id became nullable

      request-property-became-nullable

    • ○

      the request property financial_transaction_id became optional

      request-property-became-optional

    • ○

      added the optional property match_group_id to the response with the 200 status

      response-optional-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog