---
title: "Retorna a lista de boletos ativos de aluguel do locatário na Área do Cliente"
method: GET
path: "/Locatario/RetornarBoletosAtivos"
tags: ["Locatário"]
---

# Retorna a lista de boletos ativos de aluguel do locatário na Área do Cliente

`GET /Locatario/RetornarBoletosAtivos`

## Request

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

Retorno JSON da lista de boletos ativos finalidade aluguel do locatário na área do cliente do imoview ADM

## Query parameters

- `numeroPagina` integer, required
- `numeroRegistros` integer, required
- `codigoCliente` integer, required

## Response `200`

Dados retornados com sucesso

- object
  - `quantidade` integer: Total de boletos ativos do locatário (para paginação)
  - `lista` object[]: Boletos ativos (em aberto) da página solicitada
    - `codigo` integer: Código do boleto
    - `situacao` string, string: Situação do boleto: Ativo, Quitado, Cancelado ou Moderação (aqui sempre Ativo)
    - `dataemissao` string, string: Data no formato dd/MM/yyyy de emissão
    - `datavencimento` string, string: Data no formato dd/MM/yyyy de vencimento
    - `valor` number: Valor numérico com 2 casas decimais. Valor do boleto
    - `vencido` boolean: true quando a data de vencimento é anterior à data atual (boleto pode ser prorrogado via ProrrogarBoletoVencido)
    - `linhadigitavel` string, string: Linha digitável formatada. Vazio quando o boleto ultrapassou o prazo de baixa do banco e não pode mais ser pago
    - `urlacessoexterno` string, string: URL pública para visualizar/imprimir o boleto (2ª via). Vazio quando ultrapassou o prazo de baixa
    - `boletodigital` boolean: true quando é boleto de cobrança digital (registrado via API do banco)
    - `movimentos` object[]: Movimentos (contas) cobrados no boleto, ordenados por vencimento
      - `codigo` integer: Código do movimento
      - `historico` string, string: Histórico/descrição do movimento
      - `datavencimento` string, string: Data no formato dd/MM/yyyy de vencimento do movimento
      - `datapagamento` string, string: Data no formato dd/MM/yyyy do pagamento do movimento. Vazio quando em aberto
      - `valor` number: Valor numérico com 2 casas decimais. Valor do movimento para o locatário
      - `detalhes` object[]: Lançamentos que compõem o movimento, agrupados por plano de contas
        - `planoconta` string, string: Nome do plano de contas
        - `codigocontabil` string, string: Código contábil do plano de contas
        - `historico` string, string: Histórico do lançamento. Vazio quando agrupado
        - `valor` number: Valor numérico com 2 casas decimais. Valor do lançamento (negativo = desconto)

## 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`: 5 breaking, 5 info
  - for the `query` request parameter `codigoCliente`, the format changed from `Int64` to `int64`
  - for the `query` request parameter `numeroPagina`, the format changed from `Int64` to `int64`
  - for the `query` request parameter `numeroRegistros`, the format changed from `Int64` to `int64`
  - the `lista/items/codigo` response's property format changed from `Int64` to `int64` for status `200`
  - …6 more

[Operation history](https://skmtc.dev/imoview/apis/imoview-api/changes/Locatario/RetornarBoletosAtivos/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)