Get Vendor Deposit Accounting Transactions
GET/api/vendor-deposits/:vendorDepositId/accounting
Get the accounting transactions posted for a vendor deposit. The primary vendor-deposit-paid transaction is returned in data (null when none exists yet); application, refund, and write-off transactions are returned in related_transactions.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The eligibility object indicates whether an accounting transaction can currently be generated for this deposit and, when it cannot, why (e.g. the Prepaid Vendor Deposits nominal code is not configured, or the deposit has no payments, applications, refunds, or write-offs to post).
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.