List vendor credits

GET/api/v1/vendor-credits

List all vendor credits for the business with optional filtering.

Operation ID: list_vendor_credits_api_v1_vendor_credits_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

vendor_idstring

Filter by vendor ID

statusVendorCreditStatusEnum

Filter by status

has_remaining_balancebooleandefault: False

Only show credits with remaining balance

searchstring

Search by vendor credit number (e.g. VC-0001)

cursorstring

Pagination cursor

limitintegerdefault: 50

Page size

Responses

200Successful Response

successboolean
messagestring
codestring
dataVendorCreditsListResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject