Skip to main content
POST
Match a bank transaction to a posted journal entry

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Deduplicates retried match submissions for 24 hours.

Maximum string length: 255

Path Parameters

entity_id
string<uuid>
required

Body

application/json
bank_transaction_id
string<uuid>
required

The bank transaction to match. Must be unreconciled, not excluded and not pending.

journal_entry_id
string<uuid>
required

The posted journal entry that already carries this cash. Must not be voided, reversed, or claimed by another bank transaction.

reconciliation_id
string<uuid> | null

Optional open bank-reconciliation to attach the match to.

Response

Match recorded. No journal entry was posted.

bank_transaction_id
string<uuid>
journal_entry_id
string<uuid>
entry_number
string | null
matched
boolean
entry_bank_net
number

The entry's own signed net across this entity's bank GL accounts, read from the ledger. Comparable to the bank line's signed amount.

amount_warning
string | null

Set when the bank amount and the entry's bank net differ by more than half a cent.

posted_journal_entry
boolean

Always false. This verb records a link and posts no GL.