Get Vendor Deposit
GET/api/vendor-deposits/:vendorDepositId
Retrieve a single vendor deposit with its relations (supplier, purchase order, payments, applications, refunds).
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The deposit's proportional-application setting is returned three ways: proportional_apply_enabled (the deposit's own choice, or null when it inherits), proportional_apply_effective (the value actually in force) and proportional_apply_source (deposit, supplier, term or global — which step of the deposit → supplier → payment term → account chain decided it).
Approval policy:
The response adds approval — the approval-policy summary for this deposit: policy_enabled (false when no policy governs vendor deposits; the other fields are then null/empty), request_id, status, reason, tier_name of the latest approval request, waiting_on (names of users who can act now), can_approve_directly (whether you can approve it now; on a document with no request yet, whether its amount falls within your limit) and blocked_reason. Full timeline: GET /api/approval-requests/for/vendor_deposit/{id}.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.