STstuut
partners

List Customer Transactions

Retrieve a unified, date-ordered ledger of a customer's invoices, payments, and credit memos. All monetary fields are in standard units (e.g., 10.25 for $10.25). Each row carries an open_balance: the invoice amount remaining, the payment's unapplied amount, or the credit memo's remaining amount.

get/v2/partners/{partner_id}/transactions

Request

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

Path parameters

partner_idstring required

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

type__instring[] nullable

Filter by transaction type. Defaults to all types when omitted.

status__inCustomerTransactionStatus[] nullable

Filter by unified settlement status.

searchstring nullable

Case-insensitive substring match on the reference number (invoice/credit-memo number or payment reference number).

currency__inCurrency[] nullable

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

date__gtestring date nullable

Only include transactions dated on or after this date.

date__ltestring date nullable

Only include transactions dated on or before this date.

sort_by'date' | 'due_date' | 'cleared_at' | 'number' | 'po_number'

Field to sort by: transaction date (default), due date, cleared date, reference number, or purchase order number. Rows without a value for the chosen field sort last regardless of direction — payments have no due date or PO number, and open transactions have no cleared date.

sort_order'asc' | 'desc'

Sort direction. Defaults to newest first.

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.