Skip to main content
GET
Get boleto dashboard

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Query Parameters

from
string<date>

Created-from date, inclusive.

Example:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Example:

"2026-12-31"

dueDateFrom
string<date>

Due-date lower bound, inclusive.

Example:

"2026-02-01"

dueDateTo
string<date>

Due-date upper bound, inclusive.

Example:

"2026-11-30"

type
enum<string>

Boleto type filter.

Available options:
TRADITIONAL,
HYBRID,
QR_CODE
Example:

"TRADITIONAL"

Response

OK

byStatus
object
required
byType
object
required
settlementRate
number<double>
required
totalAmount
string
required
totalCanceled
integer<int64>
required
totalFailed
integer<int64>
required
totalInactivated
integer<int64>
required
totalIssued
integer<int64>
required
totalOverdue
integer<int64>
required
totalOverdueAmount
string
required
totalPending
integer<int64>
required
totalSettled
integer<int64>
required
totalSettledAmount
string
required