API Reference

Faturas - Listar faturas

get
https://api-bnpl-wl.sandbox.open-co.tech/invoices

Retorna uma lista paginada de faturas para uma pessoa. As faturas consolidam parcelas de múltiplos empréstimos BNPL com vencimento no mesmo período, semelhante ao extrato mensal de um cartão de crédito.

Filtros:

  • Por status: OPEN, CLOSED, PAID, PARTIALLY_PAID, OVERDUE_GRACE, OVERDUE_PENALTY
  • Por mês de referência: formato YYYY-MM
  • Por intervalo de datas: parâmetros from/to
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required

Identificador da pessoa (UUID)

string
enum

Filtrar por status da fatura

Show Details
OPENFatura aberta e aceitando pagamentos dentro do período de cobrança
CLOSEDPeríodo de cobrança encerrado; fatura finalizada e aguardando pagamento
PAIDFatura totalmente paga
PARTIALLY_PAIDUm pagamento parcial foi recebido; saldo restante está pendente
OVERDUE_GRACEFatura com vencimento passado; limite BNPL normal mantido; sem multas ou juros aplicados ainda
OVERDUE_PENALTYFatura com vencimento passado além do período de carência; multas e juros sendo aplicados
Allowed:
string

Filtrar por mês de referência (formato YYYY-MM)

date

Filtrar faturas com vencimento a partir desta data (inclusive)

date

Filtrar faturas com vencimento até esta data (inclusive)

integer
≥ 1
Defaults to 1

Número da página (baseado em 1)

integer
1 to 100
Defaults to 20

Número de itens por página

boolean
Defaults to false

Quando false (padrão), faturas cujos itens pertencem todos a aplicações com status REFUNDED são excluídas da resposta. Use true para incluí-las.

Responses

Updated 3 months ago

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

Updated 3 months ago