Book an outflow (or its open remainder) as a SUPPLIER ADVANCE — מקדמה לספק

The AP mirror of an advance receipt. Use it for money paid to a supplier BEFORE any bill exists, and for the EXCESS of an overpayment once every open bill has been settled — both of which previously stayed orphan unmatched remainders. Records a supplier_advances row and posts one balanced, valve-gated entry Dr 1260 מקדמות לספקים / Cr . Unmatch reverses it exactly (refused once any part has been applied). Draw it down later with POST /supplier-advances/:id/apply.

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 (must be an outflow)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

supplierId*string

Supplier the money was paid to (suppliers.id)

Formatuuid

amount?number

Portion of the outflow to book as an advance. Defaults to the full open remainder.

notes?string

Optional note stored on the advance and the match link.

Response Body

`application/json`

curl -X POST "https://example.com/bank-reconciliation/transactions/string/advance" \  -H "Content-Type: application/json" \  -d '{    "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db"  }'

{  "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  }}