Preview Vendor Deposit Application
POST/api/vendor-deposits/:vendorDepositId/applications/preview
Preview the effect of applying a deposit amount to a purchase invoice (bill) without committing anything. Returns the before/after balances on both the deposit and the bill, the tenant-currency amount, and any FX gain/loss that would be posted when the deposit and bill currencies differ.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Validation problems (deposit not applicable, supplier mismatch, amount exceeding the deposit's unapplied balance, amount exceeding what the bill still owes) are returned in the errors and warnings arrays rather than as an HTTP error.
A deposit can only settle what the bill still owes (its total with tax, less payments, deposits and vendor credits already applied). An amount above that is reported in errors, and applying it would be refused with 422.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.
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.