API V4 de Reservas: gerenciamento da condição de pagamento - Versão 26.06
Foi criada uma nova API no padrão V4 para permitir o gerenciamento da condição de pagamento das reservas de forma mais flexível e segura.
Com ela, integrações passam a poder:
- Adicionar séries
- Editar séries existentes
- Remover séries da condição de pagamento
Tudo isso sem a necessidade de recriar a condição completa da reserva.
Por que isso é importante?
Antes dessa melhoria, alterações na condição de pagamento dependiam de processos exclusivamente manuais.
Agora, sistemas integrados conseguem realizar ajustes pontuais diretamente na reserva, mantendo maior aderência aos fluxos comerciais e financeiros.
Como funciona?
Adicionar série
Permite incluir uma nova série na condição de pagamento da reserva.
Endpoint
POST /v4/comercial/reservas/{idReserva}/condições
Editar série
Permite alterar informações de uma série já existente na condição de pagamento.
Endpoint
PATCH /v4/comercial/reservas/{idReserva}/condicoes/{idReservasCondicoes}
Remover série
Permite excluir uma série da condição de pagamento da reserva.
Endpoint
DELETE /v4/comercial/reservas/{idReserva}/condicoes/{idReservasCondicoes}
Segurança e permissões
Todos os endpoints:
- Utilizam autenticação JWT
- Respeitam as permissões já existentes do módulo de reservas
- Validam regras de negócio antes da execução
O que pode ser alterado?
As APIs oferecem as mesmas possibilidades disponíveis na interface do sistema, incluindo:
- Quantidade de parcelas
- Valores
- Vencimentos
- Forma de pagamento
- Tipo de juros
- Correção monetária
- Comissão
- Portadores e indexadores
- Demais informações da série financeira
Regras de validação
A API valida automaticamente cenários como:
- Reserva inexistente
- Condição não pertencente à reserva
- Datas de vencimento inválidas
- Taxas incompatíveis
- Falta de permissão
- Regras comerciais que impeçam a alteração
Retornos da API
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso |
| 400 | Dados inválidos |
| 401 | Token JWT ausente ou inválido |
| 403 | Usuário sem permissão |
| 404 | Reserva ou condição não encontrada |
| 422 | Regra de negócio bloqueou a operação |
| 500 | Erro interno |
Pré-requisitos
- Integração utilizando a API V4
- Token JWT válido
- Permissões adequadas para manipulação de reservas
Onde utilizar?
A nova API é ideal para integrações que precisam realizar manutenção da condição de pagamento após a criação da reserva, sem depender de ações manuais na interface. Consulte em https://desenvolvedor.cvcrm.com.br/.