IMimoview
Locatário

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

Changed on

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

get/Locatario/RetornarExtrato

Request

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

Query parameters

codigoClienteinteger required

Código do cliente

codigoContratointeger

Código do contrato aluguel

codigoImovelinteger

Código do imóvel

anointeger required

Ano referência

mesinteger required

Mês referência

Response

Retornado com sucesso

quantidadeinteger
urlacessoexternotodosimoveisstring string
totalnumber

Example response

{
  "lista": [
    {
      "locador": "string",
      "imovel": "string",
      "contrato": "string",
      "locatário": "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

    • 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