IMimoview
Boleto

Retorna a lista de boletos ativos e quitados

Changed on

Retorno JSON da lista de boletos do convênio nas situações ativo e/ou quitado (cancelados e em moderação não são retornados), com filtros por cliente, contrato, imóvel e períodos de vencimento, pagamento e emissão. A linha digitável e a url de acesso só são preenchidas para boleto ativo que ainda pode ser pago.

get/Boleto/RetornarBoletos

Request

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

Query parameters

numeroPaginainteger required

Usado para paginação, enviar o nº da página atual (1 para a primeira)

numeroRegistrosinteger required

Nº de registros para retorno, máximo 50

situacaointeger

Informe 0-Ativos e quitados, 1-Ativos, 2-Quitados. Não informar = ativos e quitados

codigoUnidadeinteger

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

codigoClienteinteger

Código do cliente (sacado do boleto), enviar 0 para todos

codigoContratointeger

Código do contrato de aluguel, enviar 0 para todos

codigoImovelinteger

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

dataInicialVencimentostring string

Data inicial de vencimento no formato (dd/MM/yyyy)

dataFinalVencimentostring string

Data final de vencimento no formato (dd/MM/yyyy)

dataInicialPagamentostring string

Data inicial de pagamento no formato (dd/MM/yyyy). Ao informar, só retornam boletos quitados no período

dataFinalPagamentostring string

Data final de pagamento no formato (dd/MM/yyyy). Ao informar, só retornam boletos quitados no período

dataInicialEmissaostring string

Data inicial de emissão no formato (dd/MM/yyyy)

dataFinalEmissaostring string

Data final de emissão no formato (dd/MM/yyyy)

ordenacaointeger

Informe 1-Código, 2-Cliente, 3-Data vencimento, 4-Nosso número, 5-Valor. Envie o valor negativo para ordem decrescente. Não informar = por data de vencimento

Response

Dados retornados com sucesso

quantidadeinteger

Example response

{
  "lista": [
    {
      "unidade": "string",
      "situacao": "string",
      "clientenome": "string",
      "clientecpfcnpj": "string",
      "carteira": "string",
      "nossonumero": "string",
      "dataemissao": "string",
      "datavencimento": "string",
      "dataativacao": "string",
      "datapagamento": "string",
      "linhadigitavel": "string",
      "urlacessoexterno": "string",
      "movimentos": [
        {
          "historico": "string",
          "datavencimento": "string",
          "datapagamento": "string"
        }
      ]
    }
  ]
}

Changes

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

    • 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

  • 63f55b56fd2dRevision changes
    • info

      endpoint added