Skip to main content
GET
List Vendor Credits

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string
required
Pattern: ^[0-9a-f-]+$

Query Parameters

page
integer

Page number (default: 1)

page_size
integer

Items per page (default: 20, max: 100)

received_at_end
string

Filter credits received at or before this ISO timestamp

received_at_start
string

Filter credits received at or after this ISO timestamp

Search in credit note number, external ID, and vendor name

source_bill_id
string<uuid>

Filter by source bill ID (origin tracking)

status
string

Comma-separated statuses (draft,received,applied,partially_applied,void)

vendor_external_id
string

Filter by vendor external id

vendor_id
string

Filter by vendor ID (supports comma-separated UUIDs for multiple vendors)

Response

count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required