v9

latestOpenAPI 3.1.02026-08-08435208464.3 KB
internal

List Invoices

List invoices with optional filters.

get/api/internal/invoices

Query parameters

user_idstring
org_idstring
client_idstring nullable

Filter by client UUID

Filter by client UUID

invoice_statusstring nullable

Filter by invoice status: draft, estimate, issued, void

Filter by invoice status: draft, estimate, issued, void

payment_statusstring nullable

Filter by payment status: unpaid, paid, overdue, partial

Filter by payment status: unpaid, paid, overdue, partial

is_archivedboolean nullable

Filter by archived status

Filter by archived status

order_bystring nullable

Column to sort by (e.g., issue_date, due_date, created_at, invoice_number)

Column to sort by (e.g., issue_date, due_date, created_at, invoice_number)

order_descboolean nullable

Sort in descending order (most recent first)

Sort in descending order (most recent first)

limitinteger

Maximum number of invoices to return

Maximum number of invoices to return

offsetinteger

Number of invoices to skip

Number of invoices to skip

Response

Successful Response

{"stackTrail":"paths:/api/internal/invoices:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}