Skip to main content
GET
Get boleto dashboard

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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.

Parâmetros de consulta

from
string<date>

Created-from date, inclusive.

Exemplo:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Exemplo:

"2026-12-31"

dueDateFrom
string<date>

Due-date lower bound, inclusive.

Exemplo:

"2026-02-01"

dueDateTo
string<date>

Due-date upper bound, inclusive.

Exemplo:

"2026-11-30"

type
enum<string>

Boleto type filter.

Opções disponíveis:
TRADITIONAL,
HYBRID,
QR_CODE
Exemplo:

"TRADITIONAL"

Resposta

OK

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