v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Reserva

Retorna a reserva de acordo com os filtros

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta API serve como um informativo ao sistema legado acerca de determinada reserva que pode ser integrada como vendida.

Obs: Ela fará consultas no Construtor de Vendas pelo id da reserva que ainda não foi integrada.

get/v1/comercial/reservas/{idReserva}

Path parameters

idReservainteger required

Example:7367

Identificador da reserva.

Query parameters

condicao_completaboolean

Adiciona à condição da reserva os campos: valor_liquido_com_juros, idusuario_quem_aprovou, indexador, forma_pagamento, possui_juros, possui_correcao, juros_condicao, juros_contrato, prestacao_saf, valor_seriecomissaoforadocontrato e valor_seriecomissaonocontrato.

series_por_valor_liquidoboolean

Retorna a condição da reserva separando a série por valor líquido.

pagamento_comissaoboolean

Retorna a condição da reserva separando a série por valor menos o valor da comissão e o campo Comissão paga pela condição da reserva. Adiciona à condição da reserva o campo: valor_liquido_com_juros. Retorna array da programação da comissão.

campos_adicionais_reserva_contratoboolean

Retorna também os valores de campos adicionais do tipo Reservas/Contratos.

Headers

emailstring required

Example:email@email.com

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Response

Reservas retornas com sucesso.

RetornoReservas required

Lista as reservas no CVCRM. As chaves do objeto são os IDs das reservas (número inteiro).

Example response

{
  "$ref": "#/components/examples/RetornoReserva"
}