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

Midaz organization whose boletos are aggregated. Required: a request without it, or with a value that is not a canonical UUID, is refused with 400 PBP-0025. Only boletos of this organization are counted and summed. Declared optional on the schema so that refusal keeps its own code instead of the schema's PBP-0001.

Query Parameters

from
string

Created-from bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and starts at its first instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T00:00:00-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
Example:

"2026-01-01"

to
string

Created-to bound, inclusive. A calendar date (YYYY-MM-DD) is a UTC day and covers it to its last instant; an RFC 3339 date-time with offset (e.g. 2026-09-30T23:59:59.999999-03:00) is used as the exact instant. A positive offset must be percent-encoded (%2B).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?(Z|[+-][0-9]{2}:[0-9]{2}))?$
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

Boletos past their due date and still unpaid: due before today in the Brazilian civil calendar (UTC-3), with status CREATED, or PENDING with a provider identifier (accepted by the provider and awaiting payment). A boleto due today is not overdue. No business-day calendar is applied: a boleto due on a weekend or holiday counts as overdue from the next calendar day, although it stays payable on the next business day. Every filter of the request applies.

totalOverdueAmount
string
required

Sum of the amount of the boletos counted in totalOverdue, as a decimal string with two decimal places.

totalPending
integer<int64>
required
totalSettled
integer<int64>
required
totalSettledAmount
string
required