Match a transaction to a document (creates/links a receipt) or an expense (AP)

Inflows match an AR document — a receipt is created via the real receipts path (correct GL) when the document is unpaid, or linked when already paid. Outflows match an expense. Omit amount for a full match; a smaller amount leaves the remainder open (partial match).

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Bank transaction ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

documentId?string

AR document to match (inflows). Creates or links a receipt.

receiptDocumentId?string

Existing receipt / already-paid document to link to instead of creating one.

expenseId?string

Expense to match (outflows, AP side).

amount?number

Amount of the transaction to apply. Defaults to the full open remainder.

notes?string

Optional note stored on the match link.

fxRate?number

T2.4 (cross-currency settlement) — the rate the money ACTUALLY converted at (ILS per 1 unit of the transaction currency). Only meaningful when the bank transaction is not in ILS. Defaults to the Bank-of-Israel rate for the transaction date; supply it when the bank applied its own conversion rate (which is the authoritative one for the books).

Response Body

`application/json`

curl -X POST "https://example.com/bank-reconciliation/transactions/string/match" \  -H "Content-Type: application/json" \  -d '{}'

{  "match": {    "id": "string",    "businessId": "string",    "transactionId": "string",    "documentId": {},    "receiptDocumentId": {},    "expenseId": {},    "amount": 500,    "matchType": "receipt_created",    "notes": {},    "createdAt": "2019-08-24T14:15:22Z"  },  "transactionId": "string",  "transactionStatus": "partially_matched",  "matchedAmount": 300,  "remainder": 200,  "message": "string",  "cardSettlement": {    "gross": 1000,    "net": 989.38,    "fee": 9,    "vatOnFee": 1.62,    "vatRate": 18,    "bankAccountCode": "1101",    "feeExpenseAccountCode": "5980",    "settledInstallmentCount": 1,    "inputVatAccountCode": "1200",    "clearingAccountCode": "1099",    "chargeCount": 40,    "processorLabel": "Isracard"  },  "fx": {    "currency": "USD",    "foreignAmount": 392.68,    "bookedRate": 3.005,    "settlementRate": 3.062,    "settlementRateSource": "boi",    "ilsMoved": 1202.39,    "settledIls": 1180,    "fxDifference": 22.39,    "direction": "gain",    "fxAccountCode": "5990",    "bankAccountCode": "1101",    "posted": true  }}