THthredfi
Invoices

List invoices

List all invoices for a business with comprehensive filtering options and standardized pagination

get/v1/platform/businesses/{business_id}/invoices/

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)

due_at_endstring date-time

Filter invoices due before this date (ISO format)

due_at_startstring date-time

Filter invoices due after this date (ISO format)

max_amountinteger

Maximum amount in cents

memostring

Filter by exact memo text

memo_containsstring

Filter by memo containing text

min_amountinteger

Minimum amount in cents

pageinteger

Page number (default: 1)

page_sizeinteger

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

reference_numbersstring

Filter by reference numbers (comma-separated)

searchstring
sent_at_endstring date-time

Filter invoices sent before this date (ISO format)

sent_at_startstring date-time

Filter invoices sent after this date (ISO format)

sortstring

Sort order. Values: imported_at, -imported_at, updated_at, -updated_at (prefix with - for descending)

statusstring

Filter by invoice status (comma-separated). Values: sent, paid, partially_paid, voided, refunded

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
  },
  "results": [
    {
      "status": "SENT"
    }
  ]
}

Changes

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