Get Vendor Credit

GET 
/api/vendor-credits/:vendor_credit

Show a single vendor credit with all eager-loaded relations: supplier, purchase order, purchase invoice, warehouse, store, currency, tax rate, vendor credit lines (with product, PO line, nominal code, tax rate), allocations (with purchase invoice and allocator), payments, tags, and the linked accounting transaction.

Required scope: accounting:read

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

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.