Locatário

Retorna a lista de contratos de aluguel do locatário na Área do Cliente

Changed on

Retorno JSON da lista de contratos aluguel do locatário na área do cliente do imoview ADM

get/Locatario/RetornarContratos

Request

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

Query parameters

numeroPaginainteger required

Usado para paginação, enviar o nº da página atual

numeroRegistrosinteger required

Nº de registros para retorno, máximo 20

codigoClienteinteger required

Código do cliente

enderecostring string

Parte do endereço do imóvel

codigoContrato integer

Código do contrato, enviar 0 para todos

mostrarRescindidosboolean

Enviar true para considerar os contratos rescindidos

Response

Dados retornados com sucesso

quantidadeinteger

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",
      "tipotaxaadministracao": "string",
      "tipotaxaintermediacao": "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",
      "complementomotivo": "string",
      "formacobranca": "string",
      "formarecebimento": "string",
      "comofazerrepasse": "string",
      "destinacao": "string",
      "ramoatividade": "string",
      "indicereajuste": "string",
      "tipogarantido": "string",
      "responsavel": "string",
      "advogadoresponsavel": "string",
      "resumo": "string",
      "contratosassinado": [
        {
          "titulo": "string",
          "url": "string"
        }
      ],
      "vistoriasassinado": [
        {
          "titulo": "string",
          "url": "string"
        }
      ],
      "imoveis": [
        {
          "codigo": "string",
          "resumo": "string",
          "finalidade": "string",
          "situacao": "string",
          "tipoimovel": "string",
          "endereco": "string",
          "fotoprincipal": "string",
          "numeroquartos": "string",
          "numerovagas": "string",
          "locadores": [
            {
              "codigo": "string",
              "nome": "string",
              "cpfcnpj": "string",
              "resumo": "string",
              "formarepasse": "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

    • info

      added the optional property // to the response with the status

    • breaking

      for the query request parameter codigoCliente, 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

      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