List Vendor Credits
GET/api/vendor-credits
Returns a paginated list of vendor credits. Supports Spatie QueryBuilder filters, sorting, and search. Each row is transformed via vendor credit object.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The response also includes unfiltered_total, the count of rows in the base scope before any user filters are applied — used by the frontend to show export totals.
Search (filter[search]) matches across: ID, Credit Number (vendor_credit_number), Additional Reference (supplier_reference), Supplier PO # (supplier_po_number), Supplier Name, Supplier Email, line item SKU, and Purchase Order #.
Documents. Each row carries attachments_count (how many documents are attached to the credit) and attachment_filenames (their file names). Both filter[attachments_count] and filter[attachment_filename] are available, so you can isolate credits that are missing a supporting document or find the credit a given file belongs to. attachments_count is also sortable.
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.