Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
customer-credits
List Customer Credits
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/customer-credits/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "draft",
      "sent_at": "2023-11-07T05:31:56Z",
      "customer": {},
      "source_invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_items": [
        {
          "amount": 123,
          "revenue_account_identifier": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "AccountId"
          },
          "tags": [
            "<string>"
          ],
          "memo": "<string>",
          "metadata": "<unknown>"
        }
      ],
      "allocations": [
        {
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "amount_cents": 123,
          "invoice_outstanding_balance_cents": 123,
          "applied_at": "2023-11-07T05:31:56Z"
        }
      ],
      "tags": [
        {}
      ],
      "total_amount": 123,
      "applied_amount": 123,
      "document": {
        "url": "<string>",
        "expires_in": 123,
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "<string>",
        "file_size": 123,
        "mime_type": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "currency": "EUR"
    }
  ]
}

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<uuid>
required

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

Query Parameters

​
customer_external_id
string

Filter by customer external id

​
customer_id
string

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

​
page
integer

Page number (default: 1)

​
page_size
integer

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

​
search
string

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

​
sent_at_end
string

Filter credits sent at or before this ISO timestamp

​
sent_at_start
string

Filter credits sent at or after this ISO timestamp

​
source_invoice_id
string<uuid>

Filter by source invoice ID (origin tracking)

​
status
string

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

Response

​
count
integer
required

Total number of items

Example:

123

​
page_info
object
required
Example:
{
  "total_count": 123,
  "current_page": 1,
  "total_pages": 7,
  "page_size": 20
}
​
results
object[]
required