Listar boletos conforme os filtros informados.

get

https://example.com/pj/forintegration/cobranca/v1/boletos

Query Params

inicio

int64 | null

Posição inicial da paginação (offset).

limite

int64 | null

Número máximo de registros a retornar por página. Valor máximo: 100.

emissaoInicial

date-time | null

Data inicial do filtro por data de emissão do boleto.

emissaoFinal

date-time | null

Data final do filtro por data de emissão do boleto.

vencimentoInicial

date-time | null

Data inicial do filtro por data de vencimento do boleto.

vencimentoFinal

date-time | null

Data final do filtro por data de vencimento do boleto.

status

int32

enum

Filtro pelo status atual do boleto.

Allowed:

documentoSacado

string | null

CPF ou CNPJ do pagador (sacado) usado como filtro de consulta.

canal

string | null

Apelido para identificação do beneficiário, usado como filtro de consulta.

seuNumero

string | null

Identificador do boleto definido pelo emissor (seu número).

nossoNumero

int64 | null

Identificador do boleto gerado pelo banco (nosso número). Exemplo: 12345678901.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad Request

404Not Found