STstuut
invoices

Get Consolidated Invoices

List Consolidated Invoices

Retrieve a paginated list of consolidated invoices — ERP-side billing groups shown and paid as a single document — with filtering and sorting.

Gated by the consolidated-invoices-view feature flag; 403s for organizations it isn't enabled for.

get/v2/invoices/consolidated

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

sort_by'default' | 'due_date' | 'issued_at' | 'number' | 'total_amount' | 'amount_paid' | 'amount_remaining' | 'pending_amount_remaining' | 'promised_to_pay_date' | 'member_invoice_count' nullable
sort_order'asc' | 'desc'
partner_idstring nullable

Only consolidated invoices with at least one member invoice belonging to this partner.

number__instring[] nullable

Filter by consolidated invoice numbers

currency__inCurrency[] nullable

Filter by currency codes (ISO 4217, e.g., ['usd', 'eur'])

searchstring nullable

Search by consolidated invoice number or billing partner name

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

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