Simulando Pagamentos Avulsos — Primeira Etapa

A primeira etapa da simulação de pagamentos avulsos tem como objetivo:

• obter os descontos disponíveis para cada parcela da dívida;
• retornar a única opção de parcelamento disponível.

Parâmetros de entrada

Obrigatórios

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

Opcional

• meioPagamento

No caso de pagamentos avulsos:

• o meio de pagamento não influencia o parcelamento;
• portanto, não é obrigatório informar esse parâmetro.

Principais informações retornadas

valorDivida

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

multiplosContratos

Define se podem ser negociadas parcelas de:

• contratos diferentes (true);
• apenas do mesmo contrato (false).

permiteValoresForaMinimoMaximo

• true → permite enviar descontos fora da alçada, sujeitos à aprovação;
• false → não permite ultrapassar os limites.

parcelas

Lista todas as parcelas disponíveis para negociação.

Cada parcela já retorna:

• os descontos sugeridos;
• e os limites permitidos para negociação.

Descontos disponíveis

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

Limites de negociação

Retornados nos atributos:

• Min
• Max

Outros indicadores importantes

obrigatorio

Define se a parcela:

• deve obrigatoriamente participar da negociação (true);
• ou não (false).

selecionado

Indica se a parcela foi escolhida para a negociação.
Na primeira etapa:

• todas vêm com false.

parcelamentos

Retorna apenas:

• a única opção de parcelamento disponível para pagamentos avulsos.

Na primeira etapa:

• os valores ainda não são calculados;
• habilitado = false.

numeroParcelas

Em pagamentos avulsos:

• sempre será 1 parcela.

Datas e valores

• Os valores financeiros retornados devem ser desconsiderados nesta etapa.
• As datas já vêm calculadas, mas recomenda-se utilizá-las apenas na segunda etapa, quando os valores também estarão definidos.

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.