v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Reserva

Atualiza uma reserva no Construtor de Vendas

🔒 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 deve ser utilizada para atualizar uma reserva no Construtor de Vendas. É necessário informar ao menos um dos campos de identificador ou identificador interno para cada campo que possue essa opção.

put/v1/comercial/reservas

Headers

emailstring required

Example:email@email.com

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Request body

idreserva_intstring string required

Identificador interno da reserva no sistema externo

idreserva_cvinteger required

Identificador da reserva no Construtor de Vendas.

idpessoa_cvinteger

Identificador do cliente no Construtor de Vendas

idpessoa_intstring string

Identificador interno do cliente no sistema externo

idcorretor_cvinteger

Identificador do corretor no Construtor de Vendas

idcorretor_intstring string

Identificador interno do corretor no sistema externo.

Example request

{
  "idreserva_int": "EX1234",
  "idreserva_cv": 256,
  "idpessoa_cv": 256,
  "idpessoa_int": "P457",
  "idcorretor_cv": 15,
  "idcorretor_int": "CO15",
  "associados": [
    {
      "idpessoa_cv": 257,
      "idpessoa_int": "P458",
      "idtipo_associacao": 1,
      "idconjuge_cv": 258,
      "idconjuge_int": "P459",
      "participacao_contrato": "S",
      "percentual_participacao": 12.5
    }
  ],
  "regras_comissao": [
    {
      "tipo_comissao": "C",
      "tipo_valor": "V",
      "comissao_pagamento_tipo": "VGV",
      "comissao_juros": "N",
      "para": "UA",
      "quem": 15,
      "para_pagamento": "DU",
      "ordem": 1,
      "valor_comissao": 1000,
      "enviar_pagadoria": "N",
      "forma_pagamento": "BL",
      "proporcao": 10,
      "pago_pela_condicao_reserva": "S",
      "contrato": "S",
      "idindexador_sienge_comissao": 1,
      "descricao": "Teste"
    }
  ],
  "espacos_complementares": [
    {
      "idespaco_cv": 939,
      "idespaco_int": "EC939",
      "valor": 1234.56
    }
  ],
  "campos_adicionais": [
    {
      "idcampo_adicional": 10,
      "valor": "campo 1"
    }
  ],
  "resumo_insight_api": "Resumindo os principais pontos da reserva"
}

Response

Rerserva retornada com sucesso.

codigointeger

Código da resposta da alteração de reserva

mensagemstring string

Mensagem informativa do alteração

Example response

{
  "codigo": 200,
  "mensagem": "Mensagem informativa do alteração"
}