THthredfi
Customer Credits

List Customer Credits

List all customer credits for a business with filtering and pagination.

get/v1/platform/businesses/{business_id}/customer-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 uuid required

Business UUID provided by Thred (unique identifier for the business)

Query parameters

customer_external_idstring

Filter by customer external id

customer_idstring

Filter by customer ID (supports comma-separated UUIDs for multiple customers)

pageinteger

Page number (default: 1)

page_sizeinteger

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

searchstring

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

sent_at_endstring

Filter credits sent at or before this ISO timestamp

sent_at_startstring

Filter credits sent at or after this ISO timestamp

source_invoice_idstring uuid

Filter by source invoice ID (origin tracking)

statusstring

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

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.