IMimoview
Locatário

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

Changed on

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

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

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

Response

Dados retornados com sucesso

quantidadeinteger

Total de boletos ativos do locatário (para paginação)

Example response

{
  "lista": [
    {
      "situacao": "string",
      "dataemissao": "string",
      "datavencimento": "string",
      "linhadigitavel": "string",
      "urlacessoexterno": "string",
      "movimentos": [
        {
          "historico": "string",
          "datavencimento": "string",
          "datapagamento": "string",
          "detalhes": [
            {
              "planoconta": "string",
              "codigocontabil": "string",
              "historico": "string"
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • d7f65bff1506Revision changes
    • 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

    • 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