API Reference

Invoices - List invoices

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

Retrieves a paginated list of invoices (faturas) for a person. Invoices consolidate installments from multiple BNPL loans that are due in the same period, similar to a credit card monthly statement.

Filtering:

  • By status: OPEN, PAID, CLOSED, OVERDUE_GRACE, OVERDUE_PENALTY, CANCELLED
  • By reference month: YYYY-MM format
  • By date range: from/to parameters
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid
required

Person identifier (UUID)

string
enum

Filter by invoice status

Show Details
OPENInvoice is open and accepting payments within the billing period
PAIDInvoice has been fully paid
CLOSEDBilling period closed — no new charges accepted; payment is due
OVERDUE_GRACEInvoice is past due date; normal BNPL limit applies; no fines or interest yet
OVERDUE_PENALTYInvoice is past due date beyond the grace period; BNPL limit zeroed; fines and interest are being applied
CANCELLEDInvoice has been cancelled
Allowed:
string

Filter by billing month (YYYY-MM format). The billing month is the month prior to the installment due date (e.g. an invoice due on 2026-05-07 has reference_month "2026-04").

date

Filter invoices with due date from this date (inclusive)

date

Filter invoices with due date up to this date (inclusive)

integer
≥ 1
Defaults to 1

Page number (1-based)

integer
1 to 100
Defaults to 20

Number of items per page

boolean
Defaults to false

When false (default), invoices whose items all belong to REFUNDED applications are excluded from the response. Set to true to include them.

Responses

Updated about 1 month 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 about 1 month ago