Get Vendor Credit Stats
GET/api/vendor-credits/stats
Aggregate statistics for vendor credits: the number and remaining balance of open credits, the subset that is still fully unapplied, and the total amount ever allocated to purchase invoices.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Balances are summed in each credit's original currency; currency_code is the tenant's default currency and is intended for display formatting. On multi-currency tenants treat these totals as an indicator rather than an exact figure.
Request
Responses
- 200
- 401
- 403
- 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.
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.