v4

latestOpenAPI 3.1.02026-08-031873791.4 MB
Invoices

List Invoice records

Retrieve a paginated list of Invoice records with filtering and ordering options.

get/public/v1/invoices/

Query parameters

integration_sourcesIntegrationSourceSlug[] nullable
searchstring nullable
company_idinteger[] nullable
numberinteger[] nullable
customer_idinteger[] nullable
start_datestring date nullable
end_datestring date nullable
due_datestring date nullable
due_date_untilstring date nullable
transaction_currencySystemCurrencies[] nullable
record_statusRecordStatus[] nullable
approval_statusstring[] nullable
number
OR
string

Return invoices whose outstanding balance (amount_due) is greater than or equal to this value.

number
OR
string

Return invoices whose outstanding balance (amount_due) is less than or equal to this value.

amount_due_updated_at_gtestring date-time nullable

Return invoices whose amount_due_updated_at is greater than or equal to this timestamp.

Return invoices whose amount_due_updated_at is greater than or equal to this timestamp.

amount_due_updated_at_ltestring date-time nullable

Return invoices whose amount_due_updated_at is less than or equal to this timestamp.

Return invoices whose amount_due_updated_at is less than or equal to this timestamp.

updated_afterstring date-time nullable
updated_beforestring date-time nullable
orderingstring nullable
limitinteger

Number of records to return per page (capped at 100)

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Number of records to skip before starting to return results

Response

OK

countinteger required