List invoices
Invoices
List invoices
Returns a paginated list of invoices. The list excludes draft invoices
that belong to a subscription, and (unless filtered by bulk) invoices
attached to a bulk in pending, processing or failed status.
GET
List invoices
Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Query Parameters
Page number to retrieve (1-indexed).
Required range:
x >= 1Number of items per page.
Required range:
1 <= x <= 100Field to sort results by. Prefix with - for descending order
(e.g. -created).
Use lookups: date__gte, date__lte.
Available options:
deferred, deferred_dues, automatically Available options:
draft, finalized, paid, cancelled, uncollectible, pending Response
Paginated invoice list.
