---
title: "Retorna a lista de boletos ativos e quitados"
method: GET
path: "/Boleto/RetornarBoletos"
tags: ["Boleto"]
---

# Retorna a lista de boletos ativos e quitados

`GET /Boleto/RetornarBoletos`

## Request

- Base URL: `https://api.imoview.com.br`
- URL: `https://api.imoview.com.br/Boleto/RetornarBoletos`
- Auth: API key in header `chave`

Retorno JSON da lista de boletos do convênio nas situações ativo e/ou quitado (cancelados e em moderação não são retornados), com filtros por cliente, contrato, imóvel e períodos de vencimento, pagamento e emissão. A linha digitável e a url de acesso só são preenchidas para boleto ativo que ainda pode ser pago.

## Query parameters

- `numeroPagina` integer, required
- `numeroRegistros` integer, required
- `situacao` integer
- `codigoUnidade` integer
- `codigoCliente` integer
- `codigoContrato` integer
- `codigoImovel` integer
- `dataInicialVencimento` string, string
- `dataFinalVencimento` string, string
- `dataInicialPagamento` string, string
- `dataFinalPagamento` string, string
- `dataInicialEmissao` string, string
- `dataFinalEmissao` string, string
- `ordenacao` integer

## Response `200`

Dados retornados com sucesso

- object
  - `quantidade` integer
  - `lista` object[]
    - `codigo` integer
    - `unidadecodigo` integer
    - `unidade` string, string
    - `situacao` string, string
    - `clientecodigo` integer
    - `clientenome` string, string
    - `clientecpfcnpj` string, string
    - `carteiracodigo` integer
    - `carteira` string, string
    - `nossonumero` string, string
    - `boletodigital` boolean
    - `dataemissao` string, string
    - `datavencimento` string, string
    - `dataativacao` string, string
    - `datapagamento` string, string
    - `valor` number
    - `valorpago` number
    - `vencido` boolean
    - `linhadigitavel` string, string: Preenchida só para boleto ativo que ainda pode ser pago
    - `urlacessoexterno` string, string: Url curta da página do boleto (com o botão para gerar o PDF), a mesma enviada ao cliente. Não é o PDF direto. Preenchida só para boleto ativo que ainda pode ser pago
    - `movimentos` object[]
      - `codigo` integer
      - `historico` string, string
      - `contratocodigo` integer
      - `imovelcodigo` integer
      - `datavencimento` string, string
      - `datapagamento` string, string
      - `valor` number

## Other responses

- `401`: Header 'chave' ausente ou inválido, ou chave/usuário sem permissão para a operação
- `403`: Regra de negócio violada ou limite de paginação excedido
- `404`: Parâmetro obrigatório ausente ou inválido, registro não encontrado ou consulta sem resultado
- `429`: Limite de requisições da chave excedido
- `500`: Falha interna não prevista

## Changes

- **2026-10-09** `d7f65bff1506`: 16 breaking, 5 info
  - for the `query` request parameter `codigoCliente`, the format changed from `Int64` to `int64`
  - for the `query` request parameter `codigoContrato`, the format changed from `Int64` to `int64`
  - for the `query` request parameter `codigoImovel`, the format changed from `Int64` to `int64`
  - for the `query` request parameter `codigoUnidade`, the format changed from `Int64` to `int64`
  - …17 more
- **2026-10-09** `63f55b56fd2d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/imoview/apis/imoview-api/changes/Boleto/RetornarBoletos/get.md)

---

[API](https://skmtc.dev/imoview/apis/imoview-api.md) - [All operations](https://skmtc.dev/imoview/apis/imoview-api/llms.txt) - [OpenAPI document](https://skmtc.dev/imoview/apis/imoview-api/revisions/436e609983d0?raw)