Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
invoices
List invoices
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/invoices/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "SENT",
      "sent_at": "2023-11-07T05:31:56Z",
      "due_at": "2023-11-07T05:31:56Z",
      "paid_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "is_overdue": false,
      "invoice_number": "<string>",
      "invoice_type": "invoice",
      "currency": "<string>",
      "customer": {
        "type": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "reference_number": "<string>",
        "individual_name": "<string>",
        "company_name": "<string>",
        "display_name": "<string>",
        "email": "[email protected]",
        "mobile_phone": "<string>",
        "office_phone": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "city": "<string>",
        "state_county": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "full_address": "<string>",
        "address_string": "<string>",
        "vat_number": "<string>",
        "tax_exempt": true,
        "status": "<string>",
        "is_active": true,
        "is_archived": true,
        "transaction_tags": [
          "<unknown>"
        ],
        "notes": "<string>",
        "metadata": "<unknown>",
        "payment_terms_days": 123,
        "credit_limit": 123,
        "credit_limit_cents": 123,
        "outstanding_balance": 123,
        "documents": [
          {
            "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",
        "archived_at": "2023-11-07T05:31:56Z"
      },
      "line_items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_identifier": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "AccountId"
          },
          "description": "<string>",
          "unit_price": 123,
          "quantity": 123,
          "subtotal": 123,
          "discount_amount": 123,
          "sales_taxes_total": 123,
          "total_amount": 123,
          "external_id": "<string>",
          "product": "<string>"
        }
      ],
      "subtotal": 123,
      "additional_discount": 123,
      "additional_sales_taxes": [
        {
          "amount": 123,
          "tax_account": "<unknown>",
          "rate": "<string>",
          "name": "<string>"
        }
      ],
      "additional_sales_taxes_total": 123,
      "tips": 123,
      "tips_account": "<string>",
      "total_amount": 123,
      "outstanding_balance": 123,
      "payment_allocations": [
        {
          "amount_cents": 123,
          "payment_date": "2023-12-25",
          "payment_method": "<string>",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "credit_allocations": [
        {
          "amount_cents": 123,
          "applied_at": "2023-11-07T05:31:56Z",
          "credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "reference_number": "<string>"
        }
      ],
      "refund_allocations": [
        {
          "refund_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount_cents": 123,
          "allocated_at": "2023-11-07T05:31:56Z",
          "reference_number": "<string>"
        }
      ],
      "write_offs": [
        {
          "write_off_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount_cents": 123,
          "reason": "<string>",
          "status": "<string>",
          "write_off_at": "2023-11-07T05:31:56Z"
        }
      ],
      "document": {
        "url": "<string>",
        "expires_in": 123,
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "<string>",
        "file_size": 123,
        "mime_type": "<string>"
      },
      "imported_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "memo": "<string>"
    }
  ]
}

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)

​
due_at_end
string<date-time>

Filter invoices due before this date (ISO format)

​
due_at_start
string<date-time>

Filter invoices due after this date (ISO format)

​
max_amount
integer

Maximum amount in cents

​
memo
string

Filter by exact memo text

​
memo_contains
string

Filter by memo containing text

​
min_amount
integer

Minimum amount in cents

​
page
integer

Page number (default: 1)

​
page_size
integer

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

​
reference_numbers
string

Filter by reference numbers (comma-separated)

​
search
string
​
sent_at_end
string<date-time>

Filter invoices sent before this date (ISO format)

​
sent_at_start
string<date-time>

Filter invoices sent after this date (ISO format)

​
sort
string
default:-imported_at

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

​
status
string

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

Response

200 - application/json
​
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