v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Reserva

Cadastra 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 cadastrar 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.

post/v1/comercial/reservas

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Request body

idpessoa_cvinteger required

Identificador do cliente no Construtor de Vendas.

idpessoa_intstring string required

Identificador interno do cliente no sistema externo.

idempreendimento_cvinteger required

Identificador do empreendimento no Construtor de Vendas.

idempreendimento_intstring string required

Identificador interno do empreendimento no sistema externo.

idunidade_cvinteger required

Identificador da unidade no Construtor de Vendas.

idunidade_intstring string required

Identificador interno da unidade no sistema externo.

idcorretor_cvinteger required

Identificador do corretor no Construtor de Vendas.

idcorretor_intstring string required

Identificador interno do corretor no sistema externo.

idreserva_intstring string

Identificador interno da reserva no sistema externo.

idtipovendainteger

Identificador do tipo de venda.

Example request

{
  "idpessoa_cv": 256,
  "idpessoa_int": "P457",
  "idempreendimento_cv": 32,
  "idempreendimento_int": "E3",
  "idunidade_cv": 14,
  "idunidade_int": "UN258",
  "idcorretor_cv": 15,
  "idcorretor_int": "CO15",
  "idreserva_int": "EX1234",
  "idtipovenda": 3,
  "condicoes": [
    {
      "idserie_cv": 1,
      "idserie_int": "S125",
      "quantidade_parcelas": 2,
      "valor_parcela": 1234.56,
      "primeiro_vencimento": "27/09/2025",
      "idindexador": 1,
      "idportador": 3,
      "retirar_comissao": "N"
    }
  ],
  "associado": {
    "idpessoa_cv": 257,
    "idpessoa_int": "P458",
    "idtipo_associacao": 1,
    "participacao_contrato": "S",
    "percentual_participacao": 12.5
  },
  "espacos_complementares": [
    {
      "idespaco_cv": 939,
      "idespaco_int": "EC939",
      "valor": 1234.56
    }
  ]
}

Response

Cadastro de reserva realizado 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"
}