Skip to main content
GET
Listar faturas

Authorizations

Authorization
string
header
required

Token Bearer obtido em POST /v1/authenticate.

Query Parameters

from-dt
string<date>

Data inicial do filtro (ISO 8601, YYYY-MM-DD).

until-dt
string<date>

Data final do filtro (ISO 8601, YYYY-MM-DD). Deve ser maior que from-dt.

status
enum<string>

Filtra as faturas pelo status agregado de pagamento. Status agregado de pagamento da fatura. information-unavailable indica que o status do(s) boleto(s) não está disponível para vencimentos anteriores a 2026-05-01 ou sem data de vencimento.

Available options:
all-paid,
paid-and-pending,
paid-pending-and-overdue,
all-pending,
all-overdue,
pending-and-overdue,
paid-and-overdue,
information-unavailable,
other
page
integer

Número da página (padrão 1).

Required range: x >= 1
per-page
integer

Quantidade de itens por página (padrão 20).

Required range: x >= 1

Response

Lista paginada de faturas.

result
object[]
pagination
object