THthredfi
Vendor Credits

List Vendor Credits

List all vendor credits for a business with optional filtering and pagination. Supports filtering by status, vendor, and date ranges.

get/v1/platform/businesses/{business_id}/vendor-credits/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring required

Query parameters

pageinteger

Page number (default: 1)

page_sizeinteger

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

received_at_endstring

Filter credits received at or before this ISO timestamp

received_at_startstring

Filter credits received at or after this ISO timestamp

searchstring

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

source_bill_idstring uuid

Filter by source bill ID (origin tracking)

statusstring

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

vendor_external_idstring

Filter by vendor external id

vendor_idstring

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

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.