Skip to main content
GET
Download a boleto PDF
Pass the boleto’s statement (statement, the ID of a BANK_SLIP_CREATED statement) or omit it for the invoice’s latest boleto that is not paid. The PDF comes base64-encoded, as text: decode it to get the file. The invoice must accept BANK_SLIP. Any member of the organization, or an admin of the realm, can download it.

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.

Format: UUID

invoiceId
string<uuid>
required

ID of the invoice.

Format: UUID

Query Parameters

statement
string<uuid>

ID of the boleto's statement (BANK_SLIP_CREATED). Omit it for the invoice's latest unpaid boleto.

Format: UUID

Response

The boleto's PDF, base64-encoded.

The boleto's PDF, base64-encoded.