Skip to main content

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.

Required scope: accounting:read

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

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.

filter[credit_reason] — exact match on the credit's reason code (see List Vendor Credit Reasons).

credit_reason also accepts the advanced text operators used by credit_status and payment_status — e.g. filter[credit_reason.contains]=rebate, filter[credit_reason.is_not]=other, filter[credit_reason.is_empty]=1.

Request​

Responses​

OK

Response Headers
    Content-Type