STstuut
invoices

Get Invoices

List Invoices

Retrieve a paginated list of invoices with filtering and sorting.

get/v2/invoices

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' | 'paid_at' | 'amount_due' | 'amount_remaining' | 'pending_amount_remaining' | 'total_amount' | 'number' | 'last_outreach_at' | 'promised_to_pay_date' nullable
sort_order'asc' | 'desc'
status__inInvoiceVirtualStatus[] nullable

Filter by invoice status. Includes virtual statuses: 'processing' (open with payment), 'partially_paid', 'overdue' (open and past due), 'promised' (open with an upcoming or current promise-to-pay date), 'broken_promise' (open with a promise-to-pay date that has passed).

partner_idstring nullable

Filter by partner ID

assignee_idstring nullable

Filter by assignee ID

number__instring[] nullable

Filter by invoice numbers

number
OR
string decimal
number
OR
string decimal
in_disputeboolean

Filter by whether invoice is in dispute

due_date__eqstring date nullable

Due date exactly on

due_date__gtestring date nullable

Due date on or after

due_date__ltestring date nullable

Due date on or before

issued_at__eqstring date nullable

Issued at exactly on

issued_at__gtestring date-time nullable

Issued at on or after

issued_at__ltestring date-time nullable

Issued at on or before

promised_to_pay_date__eqstring date nullable

Promised to pay exactly on

promised_to_pay_date__ltestring date-time nullable

Promised to pay on or before

promised_to_pay_date__gtestring date-time nullable

Promised to pay on or after

searchstring nullable

Search in invoice number, partner name, account number, PO number, order number

business_unit_id__instring[] nullable

Filter by business unit IDs (via partner)

has_outreachboolean

Filter by whether invoice has had outreach

customer_outreach_pausedboolean

Filter by whether customer outreach is paused

currency__inCurrency[] nullable

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

ap_portal_status__inAPPortalInvoiceStatus[] nullable

Filter by AP portal status (lowercase wire values, e.g. ['submitted', 'approved']). 'not_submitted' also matches invoices whose PO is swept on the partner's portal account but have no portal invoice row. Untracked invoices are excluded when set.

custom_fieldsstring nullable

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.