Simulação de Acordos/Renegociações (Desconto “Geral”) — Segunda Etapa

A segunda etapa da simulação tem como objetivo calcular os valores das opções de parcelamento disponíveis, considerando:

• As parcelas selecionadas;
• Os descontos aplicados em cada parcela.

Antes disso, é obrigatório já ter executado a primeira etapa da simulação.

Parâmetros obrigatórios

Além de:

• cliente
• negociacao
• meioPagamento

na segunda etapa também é obrigatório informar:

• A lista de parcelas da dívida que participarão da negociação.

A seleção das parcelas deve respeitar as regras retornadas na primeira etapa:

• multiplosContratos
• obrigatorio

Personalização de descontos

Cada parcela deve conter:

• parcela (ID da parcela)

Opcionalmente, podem ser enviados descontos personalizados nos campos:

• valorDesconto
• descontoPrincipal
• descontoJuros
• descontoPermanencia
• descontoMora
• descontoMulta
• descontoOutros

Esses descontos devem respeitar os limites retornados na primeira etapa, além da regra:

• permiteValoresForaMinimoMaximo

Principais retornos da segunda etapa

valorDivida

Passa a retornar o valor total das parcelas selecionadas já com os descontos aplicados.

Parcelas

Retorna todas as parcelas disponíveis, inclusive as não selecionadas.

Campos importantes

• Os descontos retornam:
  • os valores personalizados enviados;
  • ou os valores sugeridos, caso nada tenha sido alterado.
• selecionado
  • true: parcela incluída na simulação;
  • false: parcela fora da simulação.

Parcelamentos

Agora os parcelamentos vêm com valores calculados.

habilitado

• true: parcelamento disponível e calculado;
• false: opção indisponível por regras da negociação (ex.: limites de entrada/parcela).

numeroParcelas

• 0 = à vista;
• 1 = parcela única;
• 2+ = parcelado.

Datas negociáveis

Os parcelamentos retornam:

• dataEmissao
• dataVencimento

Essas datas podem ser alteradas dentro dos limites:

• dataEmissaoMin / dataEmissaoMax
• dataVencimentoMin / dataVencimentoMax

Valores negociáveis

Também são retornados valores sugeridos para:

• valorParcela
• taxaOperacao
• valorEntrada
• descontoDivida
• descontoTarifa
• descontoTarifaParcela

Todos possuem limites mínimo/máximo permitidos para negociação.

Fluxo das parcelas

Cada opção de parcelamento inclui o detalhamento completo das parcelas:

• numeroParcela
  • 0 = entrada;
• dataVencimento
• valorPrincipal
• valorJuros
• valorTarifa
• valorTarifaParcela
• valorTotal

Observação importante

Se forem aceitos os valores e datas sugeridos pela segunda etapa, a negociação pode seguir normalmente.

A terceira etapa só é necessária caso seja preciso alterar datas ou valores do parcelamento sugerido.

Exemplos de chamadas e de retornos do método Acordos API - Simular acordo (Etapa 2) constam no arquivo Assessorias - Acordos API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.