Skip to main content
GET
List statements
Statements are the invoice’s financial record: the charges generated for it and the payments made against it. An invoice can be paid with more than one payment method — part by PIX, part by boleto, or a payment received outside Portão 3 — so its statements carry the full list of everything that moved on the invoice, and the invoice’s balance is computed from them. The balance of the invoice comes from its DONE statements: what is owed is the sum of billingAmount over the DEBIT ones, and what was paid is the sum over the CREDIT ones. Statements in any other status are listed but do not count yet. Read the invoice as its issuer (role=VENDOR, the default) or as its payer (role=BUYER, when your organization is the invoice’s payer). Any member of the organization, or an admin of the realm, can list them. Page with limit + next.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization: the one that issued the invoice, or the one that pays it when role is BUYER.

Format: UUID

invoiceId
string<uuid>
required

ID of the invoice whose statements you want to list.

Format: UUID

Query Parameters

limit
integer

Page size, 1–100. Defaults to 100.

Required range: 1 <= x <= 100
next
string

Cursor returned as next by the previous page; it must be valid base64. Omit it for the first page. A valid cursor that no longer matches a statement also returns the first page.

Maximum string length: 128
Pattern: ^[A-Za-z0-9+/]+={0,2}$
role
enum<string>

Your side of the invoice. VENDOR (the default): your organization issued it. BUYER: your organization is the invoice's payer.

Available options:
VENDOR,
BUYER

Response

Successful response

A page of an invoice's statements.

items
object[]
required

Statements, newest first.

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"