Create Vendor Deposit

POST 
/api/vendor-deposits

Create a new vendor deposit. Validated by CreateVendorDepositRequest. Returns 201 with the created deposit.

Required scope: accounting:write

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

Proforma invoice / payment request fields:

• payee_bank_details (string, nullable, max 2000) — payee bank block captured from the supplier's proforma invoice. If it matches the supplier profile's wire_instructions (case/whitespace-insensitive) it is normalized to null ("per supplier profile").
• bank_details_verified (boolean, default false) — acknowledgment that details differing from the supplier profile were verified out-of-band. When true (and a differing snapshot is present), bank_details_verified_at/bank_details_verified_by are stamped. A deposit with an UNVERIFIED differing snapshot saves as draft but cannot be submitted for approval (422).

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.