Skip to main content

Record Mercury Bank Transaction As Vendor Deposit

POST 

/api/mercury/bank-transactions/:transaction/record-deposit

Records an outgoing transfer as a paid vendor deposit on a purchase order — e.g. a deposit or pre-shipment balance wired straight from Mercury. An open deposit on the order for exactly this amount is paid; otherwise a new deposit is created for the order's supplier, approved and paid, dated on the bank date. When a vendor deposit approval policy needs someone else's approval, the deposit is created and waits, the transaction stays open with the new deposit suggested, and message says who it waits on.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token and the Record bank transactions permission (mercury.record). It records money that has already moved, so it never needs the Pay with Mercury permission (mercury.pay); roles and users that held mercury.pay when mercury.record was introduced were given it automatically.

Request​

Responses​

OK

Response Headers
    Content-Type