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

A primeira etapa da simulação tem como objetivo retornar:

• As opções de desconto disponíveis para cada parcela da dívida;
• As opções de parcelamento disponíveis para o cliente, negociação e meio de pagamento informados.

Parâmetros obrigatórios

• cliente: ID do cliente;
• negociacao: ID da negociação escolhida.

Parâmetro opcional

• meioPagamento: ID do meio de pagamento.

Embora opcional, é recomendado informar o meio de pagamento, pois sem ele o método não retorna as opções de parcelamento — apenas os descontos das parcelas.

Principais informações retornadas

valorDivida

Retorna 0 nesta etapa, pois ainda não foram selecionadas parcelas para negociação.

multiplosContratos

• true: permite negociar parcelas de contratos diferentes;
• false: permite negociar apenas parcelas do mesmo contrato.

permiteValoresForaMinimoMaximo

• true: permite enviar descontos fora da alçada, sujeitos à aprovação;
• false: impede descontos fora dos limites permitidos.

Parcelas

Lista todas as parcelas disponíveis para negociação, contendo:

• Valores sugeridos de desconto:
  • valorDesconto
  • descontoPrincipal
  • descontoJuros
  • descontoPermanencia
  • descontoMora
  • descontoMulta
  • descontoOutros
• Limites máximos/mínimos permitidos para negociação.

Campos importantes

• obrigatório
  • true: parcela deve obrigatoriamente entrar na negociação;
  • false: parcela é opcional.
• selecionado
• Sempre retorna false nesta etapa, pois nenhuma parcela foi escolhida ainda.

Parcelamentos

Lista as opções de parcelamento disponíveis, incluindo fluxos e datas, porém sem cálculo de valores nesta etapa.

Campo importante

• habilitado
• Sempre retorna false nesta etapa, porque ainda não há parcelas selecionadas.

Numeroparcelas

Indica a quantidade de parcelas sem considerar entrada:

• 0 = à vista;
• 1 = parcela única;
• 2 = duas parcelas;

Os valores financeiros retornados em parcelamentos nesta etapa devem ser desconsiderados, pois ainda não foram calculados.

Já as datas retornadas podem ser utilizadas, embora seja recomendado tratá-las apenas na segunda etapa, quando os valores estarão calculados.

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