Contrato aluguel

Retorna a lista de contratos de aluguel

Changed on Oct 20, 2026

Retorno JSON da lista de contratos de aluguel do convênio, com filtros por locatário, locador, imóvel, situação e períodos (início do contrato, próximo reajuste e última alteração). O período de última alteração permite carga incremental.

get/ContratoAluguel/RetornarContratos

Request

Base URL
https://api.imoview.com.br
URL
https://api.imoview.com.br/ContratoAluguel/RetornarContratos
Auth
API key in header chave

Query parameters

numeroPaginainteger required

Usado para paginação, enviar a quantidade de registros já retornados (0 para a primeira chamada)

numeroRegistrosinteger required

Nº de registros para retorno, máximo 50

codigoUnidadeinteger

Código da unidade/filial, enviar 0 para todas as unidades do convênio

codigoLocatariointeger

Código do locatário, enviar 0 para todos

codigoLocadorinteger

Código do locador/proprietário, enviar 0 para todos

codigoImovelinteger

Código do imóvel, enviar 0 para todos

situacaointeger

Informe 1-Ativo, 2-Moderação, 3-Rescindido, 4-Cancelado ou 0 para todos

dataInicialstring string

Data inicial do período de início do contrato no formato (dd/MM/yyyy)

dataFinalstring string

Data final do período de início do contrato no formato (dd/MM/yyyy)

dataInicialProximoReajustestring string

Data inicial do período do próximo reajuste no formato (dd/MM/yyyy)

dataFinalProximoReajustestring string

Data final do período do próximo reajuste no formato (dd/MM/yyyy)

dataHoraInicialUltimaAlteracaostring string

Data/hora inicial da última alteração no formato (dd/MM/yyyy HH:mm:ss)

dataHoraFinalUltimaAlteracaostring string

Data/hora final da última alteração no formato (dd/MM/yyyy HH:mm:ss)

ordenacaointeger

Informe 0-Data/hora alteração, 1-Código, 2-Situação, 3-Status, 9-Valor, 10-Locatário, 11-Data início, 12-Data fim, 13-Data próximo reajuste, 15-Imóvel, 17-Data rescisão. Envie o valor negativo para ordem decrescente. Não informar = por código

Response

Dados retornados com sucesso

quantidadeinteger

Total de contratos encontrados pelo filtro (para paginação), independente da página retornada

Example response

{
  "lista": [
    {
      "codigoauxiliar": "string",
      "unidade": "string",
      "locatarionome": "string",
      "locatariotelefone1": "string",
      "locatariotelefone2": "string",
      "locatarioemail": "string",
      "locatariocpf": "string",
      "locatarioformacorrespondencia": "string",
      "locatariossolidarios": [
        {
          "nome": "string",
          "cpfcnpj": "string",
          "telefone1": "string",
          "telefone2": "string",
          "email": "string"
        }
      ],
      "situacao": "string",
      "status": "string",
      "motivostatus": "string",
      "taxaadministracao": "string",
      "tipotaxaadministracao": "string",
      "taxaintermediacao": "string",
      "tipotaxaintermediacao": "string",
      "garantia": "string",
      "datainclusao": "string",
      "dataultimaalteracao": "string",
      "dataativacao": "string",
      "datainicio": "string",
      "datafim": "string",
      "dataproximoreajuste": "string",
      "dataproximoaluguel": "string",
      "dataproximorepasse": "string",
      "diavencimento": "string",
      "diarepasse": "string",
      "dataavisodesocupacao": "string",
      "dataprevisaorescisao": "string",
      "datarescisao": "string",
      "motivorescisao": "string",
      "complementomotivorescisao": "string",
      "formacobranca": "string",
      "formarecebimento": "string",
      "comofazerrepasse": "string",
      "destinacao": "string",
      "ramoatividade": "string",
      "indicereajuste": "string",
      "garantido": "string",
      "tipogarantido": "string",
      "responsavel": "string",
      "advogadoresponsavel": "string",
      "resumo": "string",
      "imoveis": [
        {
          "resumo": "string",
          "finalidade": "string",
          "situacao": "string",
          "tipoimovel": "string",
          "endereco": "string",
          "cep": "string",
          "locadores": [
            {
              "nome": "string",
              "cpfcnpj": "string",
              "resumo": "string",
              "formarepasse": "string",
              "responsavelfiscalnome": "string",
              "responsavelfiscalcpfcnpj": "string"
            }
          ]
        }
      ],
      "seguroincendio": {
        "seguradora": "string",
        "corretora": "string",
        "datainicio": "string",
        "datafim": "string",
        "valor": "string",
        "valorvenal": "string",
        "numeroapolice": "string"
      },
      "garantialocaticia": {
        "forma": "string",
        "tipo": "string",
        "seguradora": "string",
        "corretora": "string",
        "datainicio": "string",
        "datafim": "string",
        "valor": "string",
        "numeroapolice": "string",
        "fiador": "string"
      }
    }
  ]
}

Changes

Oct 20, 2026436e609983d0 Revision changes
- info
  added the optional property // to the response with the status
Oct 9, 2026d7f65bff1506 Revision changes
- breaking
  for the query request parameter codigoImovel, the format changed from Int64 to int64
- breaking
  for the query request parameter codigoLocador, the format changed from Int64 to int64
- breaking
  for the query request parameter codigoLocatario, the format changed from Int64 to int64
- breaking
  for the query request parameter codigoUnidade, the format changed from Int64 to int64
- breaking
  for the query request parameter numeroPagina, the format changed from Int64 to int64
- breaking
  for the query request parameter numeroRegistros, the format changed from Int64 to int64
- breaking
  for the query request parameter ordenacao, the format changed from Int64 to int64
- breaking
  for the query request parameter situacao, the format changed from Int64 to int64
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the //// response's property format changed from Int64 to int64 for status
- breaking
  the ////// response's property format changed from Int64 to int64 for status
- breaking
  the ////// response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the // response's property format changed from Int64 to int64 for status
- breaking
  the response's property format changed from Int64 to int64 for status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history