List Invoices
This endpoint allows for the retrieval of a list of invoices based on customerId, customerExternalId, invoiceStartDateFrom, invoiceStartDateTo, invoiceEndDateFrom, and invoiceEndDateTo. The response will include a list of invoices that match the provided filters. It also returns, if available, a pix and bank_slip URL for each invoice, which expires after 15 minutes.
Query Parameters
Filter invoices by the start date of the billing cycle. The date must be in ISO 8601 format.
Filter invoices by the end date of the billing cycle. The date must be in ISO 8601 format.
Filter invoices by the end date of the billing cycle. The date must be in ISO 8601 format.
Filter invoices by the end date of the billing cycle. The date must be in ISO 8601 format.
The internal unique identifier of the customer.
The external unique identifier of the customer provided by the tenant.
Response
The unique identifier of the invoice.
The human-readable identifier of the invoice.
The customer associated with this invoice.
The payment account used for this invoice.
The start date of the billing period.
The end date of the billing period.
The total amount to be paid for this invoice.
x > 0The reason why the billing cycle was closed.
end_of_cycle, billing_end_day_updated List of payments associated with this invoice.
The current status of the invoice.
open, closed, paid, canceled