Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Distrato

Altera situação da reserva para distrato

🔒 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)

O sistema legado fará uma requisição a esta API para alterar a situação da reserva no Construtor de Vendas. A reserva terá sua situação modificada para a que tiver a flag 'distrato'.

Obs: Para que esta ação seja executada com êxito o campo preenchido idreserva deve existir no Construtor de Vendas. É obrigatório o preenchimento do campo relacionado no item body.

post/v1/comercial/reservas/distratos

Headers

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

Request body

idreservastring string required

Identificador da reserva no Construtor de Vendas

idreserva_intstring string

Identificador interno da reserva no sistema externo

valor_distratostring string

Valor do distrato

motivo_distratostring string

Motivo do distrato

descricao_motivo_distratostring string

Detalhamento do motivo

Example request

{
  "idreserva": "1515",
  "idreserva_int": "CI1515",
  "valor_distrato": "30000",
  "motivo_distrato": "Doação",
  "descricao_motivo_distrato": "CI4587"
}

Response

Distrato realizado com sucesso.

codigostring
mensagemstring

Example response

{
  "codigo": "200",
  "mensagem": "Operação realizada com sucesso."
}