IMimoview
Locador

Retorna a lista de extratos do locador na Área do Cliente

Changed on

Retorno JSON da lista de extrato do locador na área do cliente do imoview ADM

get/Locador/RetornarExtrato

Request

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

Query parameters

codigoClienteinteger required

Código do cliente

codigoContratointeger

Código do contrato aluguel

codigoImovelinteger required

Código imóvel

anointeger required

Ano referência

mesinteger required

Mês referência

Response

Locador

quantidadeinteger

Quantidade de movimentos do locador no mês

urlacessoexternotodosimoveisstring string

URL pública do extrato do mês com todos os imóveis do locador. Vazio quando não há movimentos

totalnumber

Valor numérico com 2 casas decimais. Soma de todos os imóveis do locador no mês

Example response

{
  "lista": [
    {
      "locador": "string",
      "imovel": "string",
      "contrato": "string",
      "locatario": "string",
      "urlacessoexterno": "string",
      "movimentos": [
        {
          "datavencimento": "string",
          "datapagamento": "string",
          "historico": "string",
          "detalhes": [
            {
              "planoconta": "string",
              "historico": "string"
            }
          ],
          "formasrepasse": [
            {
              "resumo": "string"
            }
          ]
        }
      ]
    }
  ],
  "urlacessoexternotodosimoveis": "string"
}

Changes

  • d7f65bff1506Revision changes
    • breaking

      for the query request parameter ano, the format changed from Int64 to int64

    • breaking

      for the query request parameter codigoCliente, the format changed from Int64 to int64

    • breaking

      for the query request parameter codigoContrato, the format changed from Int64 to int64

    • breaking

      for the query request parameter codigoImovel, the format changed from Int64 to int64

    • breaking

      for the query request parameter mes, the format changed from Int64 to int64

    • breaking

      the response's property format changed from Int64 to int64 for status

    • warning

      removed the optional property // from the 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

    • info

      added the non-success response with the status

    • info

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