List invoices

Lists the invoices registered in the account according to the filters provided.

Use this operation for one-off lookups, reconciliation, or finding invoices by period, customer, payment, installment, external reference, or status. Filters can be combined and, when no record matches the criteria provided, the list is returned with no items.

To view a specific invoice by ID, use Retrieve a single invoice.

📘

Tracking changes

To track creation, updates, submission to the city hall, authorization, cancellation, and failures of invoices, use Webhooks instead of repeatedly querying this endpoint.

Use this GET for one-off lookups, historical retrieval, or reconciliation.

See the events for invoices.

Related content

Guides

Webhooks

Error Library

Query Params
integer

List starting element

integer
≤ 100

Number of list elements (max: 100)

string

Filter by an issue date

string

Filter by an issue date

string

Filter by unique payment identifier

string

Filter by the unique installment identifier

string

Filter by invoice identifier in your system

string
enum

Filter by situation

Allowed:
string

Filter by unique customer identifier

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json