Pular para o conteúdo principal
POST
Calcula o plano de pagamento no superendividamento

Autorizações

x-api-key
string
header
obrigatório

Corpo

application/json

Payload da calculadora de superendividamento.

Payload do cálculo de superendividamento. Informe as dívidas a renegociar, os parâmetros do plano (prazo, carência, juros e sistema de amortização) e o mínimo existencial; a resposta traz o resumo do plano, o rateio das parcelas por credor e o cronograma consolidado de amortização.

planning_start_date
string<date>
obrigatório

Data de início do planejamento (YYYY-MM-DD).

number_of_months
number
obrigatório

Quantidade de meses do plano (inteiro positivo).

grace_period
number
obrigatório

Período de carência, em dias (0..180).

debts
object[]
obrigatório

Dívidas a renegociar. Deve conter pelo menos um item.

amortization_type
enum<string>
obrigatório

Sistema de amortização aplicado ao plano.

Opções disponíveis:
price,
sac
interest_rate
number
obrigatório

Juros mensal (%) aplicado ao plano (>= 0).

minimum_living_income
object
obrigatório

Parâmetros do mínimo existencial usados para limitar o valor da parcela.

name
string

Nome do cálculo. Opcional; não afeta o resultado.

Resposta

Resultado do plano, com resumo, rateio por credor e cronograma.

The response is of type object.