---
title: "Listar boletos conforme os filtros informados."
method: GET
path: "/pj/forintegration/cobranca/v1/boletos"
tags: ["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

- `inicio` integer, nullable: Página dos registros
- `limite` integer, nullable: Quantidade de registros (MÁXIMO 100)
- `emissaoInicial` string, date-time, nullable: Data início de emissão do boleto
- `emissaoFinal` string, date-time, nullable: Data final de emissão do boleto
- `vencimentoInicial` string, date-time, nullable: Data início de vencimento do boleto
- `vencimentoFinal` string, date-time, nullable: Data final de vencimento do boleto
- `status` integer: Status atual do boleto no ciclo de vida.
- `documentoSacado` string, nullable: Cpf ou Cnpj do sacado
- `canal` string, nullable: Apelido para identificação do Beneficiário
- `seuNumero` string, nullable: Seu número do boleto
- `nossoNumero` integer, nullable: Nosso número do boleto

## Response `200`

Success

- SwaggerCobrancaBs2PjCobrancaBoletosObterBoletosPaginaBoletoBuscadoHateoas: Página de resultados da consulta paginada de boletos, contendo a lista de boletos e os metadados de paginação (início, itens, total).
  - `itens` SwaggerCobrancaBs2PjCobrancaBoletosObterBoletosBoletoBuscadoHateoas[], nullable: Registros por página
    - `item` SwaggerCobrancaBs2PjCobrancaBoletosObterBoletosBoletoBuscadoResumido: Versão resumida do boleto retornada na listagem paginada.
      - `id` string, uuid: Identificador único no formato GUID. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
      - `nossoNumero` integer, nullable: Identificador do boleto gerado pelo banco.
      - `seuNumero` string, nullable: Identificador do boleto definido pelo próprio emissor, usado para reconhecimento no seu sistema (ex.: número da venda ou nota fiscal). Aceita apenas letras e números.
      - `valor` number, double, nullable: Valor monetário em reais.
      - `valorLiquidado` number, double, nullable: Valor liquidado do boleto.
      - `vencimento` string, date-time, nullable: Data de vencimento do boleto.
      - `emissao` string, date-time, nullable: Data de emissão do boleto.
      - `notificacaoPagamento` string, date-time, nullable: Data e hora em que o pagamento do boleto foi notificado ao sistema.
      - `pagamento` string, date-time, nullable: Data em que o boleto foi pago pelo pagador na rede bancária.
      - `cancelamento` string, date-time, nullable: Data de cancelamento do boleto.
      - `canal` string, nullable: Apelido para identificação do beneficiário.
      - `nomeSacado` string, nullable: Nome do pagador (sacado) do boleto.
      - `codigoBarras` string, nullable: Código de barras do boleto. Exemplo: 21895787100000000000010000000000000000000000.
      - `linhaDigitavel` string, nullable: Linha digitável do boleto. Exemplo: 21090010070000000000000860000000000000000000000.
      - `registrado` boolean: Indica se o boleto foi registrado na Nuclea, o que o torna disponível para pagamento na rede bancária. Exemplo: true.
      - `status` integer: Status atual do boleto no ciclo de vida.
      - `bancoPagamento` integer, nullable: Banco onde o pagamento do boleto foi realizado.
      - `agenciaPagamento` integer, nullable: Agência bancária onde o pagamento do boleto foi realizado.
      - `canalPagamento` integer, nullable: Canal pelo qual o pagamento do boleto foi realizado.
      - `dataLimitePagamento` string, date-time, nullable: Data limite até a qual o boleto pode ser pago após o vencimento. O prazo configurável é de 1 a 90 dias após o vencimento.
      - `sacadorAvalista` SwaggerCobrancaBs2PjCobrancaBoletosObterBoletosSacadorAvalistaBoletoBuscado: Sacador avalista retornado na consulta do boleto.
        - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075.
        - `nome` string, nullable: Nome da pessoa física ou razão social da pessoa jurídica.
      - `beneficiarioFinal` SwaggerCobrancaBs2PjCobrancaBoletosObterBoletosBeneficiarioFinal: Beneficiário final retornado na consulta do boleto.
        - `razaoSocial` string, nullable: Razão social do beneficiário final (pessoa jurídica).
        - `nomeFantasia` string, nullable: Nome fantasia do beneficiário final (pessoa jurídica).
        - `documento` string, nullable: CPF ou CNPJ da pessoa física ou jurídica. Exemplo: CNPJ: 24401281000152 ou CPF: 75956344075.
  - `inicio` integer, nullable: Posição da paginação
  - `limite` integer, nullable: Limite por páginas
  - `total` integer, nullable: Total de registros disponíveis na consulta.

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/bs2/apis/api-boletos.md) - [All operations](https://skmtc.dev/bs2/apis/api-boletos/llms.txt) - [OpenAPI document](https://skmtc.dev/bs2/apis/api-boletos/revisions/5d82dc00a3f9?raw)