Reservas

Retornar fluxo de recebimento mensal da reserva

Retorna o fluxo de recebimento mensal de uma reserva, mesma estrutura exibida no modal "Fluxo de Recebimento Mensal" da tela de aprovação de condição. Os filtros (valor, comissao, juros, incluirCustas) determinam qual das 8 variantes de cálculo é devolvida.

get/v4/comercial/reservas/{idReserva}/fluxo-recebimento

Request

Base URL
https://integracao.cvcrm.com.br/api
URL
https://integracao.cvcrm.com.br/api/v4/comercial/reservas/{idReserva}/fluxo-recebimento
Auth
HTTP bearer

Path parameters

idReservainteger required

Query parameters

valor'vgv' | 'vp'

VGV (valor nominal) ou VP (valor presente)

comissao'nominal' | 'liquido'

Nominal (bruto) ou Líquido (bruto - comissão)

juros'sem-juros' | 'com-juros'

Inclui juros embutidos das parcelas

incluirCustasboolean

Se true, inclui parcelas com custa_escrituracao='S' nos totais

idTabelainteger

Override do idtabela da reserva (também aceito via body).

idTabelaMinimainteger

Override do idtabela_minima. Se omitido, resolvido via empreendimentos_tabelasdepreco.idtabela_minima.

Response

Fluxo de recebimento mensal calculado

statusstring

codeinteger

Example response

{
  "status": "success",
  "code": 200,
  "data": {
    "periodos": [
      {
        "ordem": 1,
        "periodo": "2026/05"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.