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

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

• as parcelas de dívida disponíveis para negociação;
• as opções de parcelamento disponíveis para o cliente.

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, o meio de pagamento é recomendado, pois sem ele o sistema não retorna as opções de parcelamento, apenas as parcelas da dívida.

Parâmetro calcularDescontoParcelamento

• Se informado como true:
  • o retorno já inclui os descontos disponíveis para cada parcela em cada plano de parcelamento.
• Se informado como false ou omitido:
  • os descontos só serão calculados e retornados na segunda etapa da simulação.

Principais informações retornadas

valorDivida

• Retorna 0 na primeira etapa, porque nenhuma parcela foi selecionada ainda.

multiplosContratos

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

permiteValoresForaMinimoMaximo

• true: permite enviar negociações fora da alçada, sujeitas à aprovação;
• false: impede envio fora dos limites permitidos.

parcelas

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

• dados detalhados da dívida;
• indicador obrigatorio:
  • define se a parcela deve obrigatoriamente entrar na negociação;
• indicador selecionado:
  • inicialmente sempre false, pois nenhuma parcela foi escolhida ainda.

Nesta etapa, os valores de desconto:

• valorDesconto,
• descontoPrincipal,
• descontoJuros,
• descontoMora,

Não vêm calculados, exceto se calcularDescontoParcelamento=true.

parcelamentos

Lista as opções de parcelamento disponíveis:

• mostra quantidade de parcelas;
• mostra fluxo/datas de vencimento;
• ainda sem valores calculados.

Campo habilitado

• Sempre false na primeira etapa, porque ainda não houve seleção de parcelas.

Campo numeroParcelas

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

Os valores financeiros dessa lista devem ser desconsiderados nesta etapa, pois ainda não foram calculados. Já as datas podem ser utilizadas, embora seja recomendado tratá-las apenas na segunda etapa.

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.