BSbs2
Listar boleto(s)

Listar boletos conforme os filtros informados.

get/pj/forintegration/cobranca/v1/boletos

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

iniciointeger nullable

Página dos registros

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

limiteinteger nullable

Quantidade de registros (MÁXIMO 100)

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

emissaoInicialstring date-time nullable

Data início de emissão do boleto

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

emissaoFinalstring date-time nullable

Data final de emissão do boleto

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

vencimentoInicialstring date-time nullable

Data início de vencimento do boleto

Data inicial do filtro por data de vencimento do boleto.

vencimentoFinalstring date-time nullable

Data final de vencimento do boleto

Data final do filtro por data de vencimento do boleto.

statusinteger

Status atual do boleto no ciclo de vida.

Filtro pelo status atual do boleto.

documentoSacadostring nullable

Cpf ou Cnpj do sacado

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

canalstring nullable

Apelido para identificação do Beneficiário

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

seuNumerostring nullable

Seu número do boleto

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

nossoNumerointeger nullable

Nosso número do boleto

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

Response

Success

iniciointeger nullable

Posição da paginação

limiteinteger nullable

Limite por páginas

totalinteger nullable

Total de registros disponíveis na consulta.

Changes

No recorded changes to this operation across all 1 revision of this API.