Calcula a revisão de contrato (revisional)

Revisa um contrato de financiamento/empréstimo: recalcula a tabela de amortização (price ou sac) aplicando a taxa média de mercado, apura as diferenças (a pagar ou a receber) e, quando o resultado é a pagar (type: "payable"), monta o cronograma de refinanciamento. Informe os dados do contrato (valor, parcelas, taxas e datas), a taxa média (average_interest/own_average_interest) e as parcelas pagas (paid_installments). A resposta traz o cronograma recalculado (schedule), os totais e os valores apurados.

Os campos contract_type e contract_price_index referenciam índices do backend (GET /api/calculadoras/indices-correcao) e devem existir; caso contrário o cálculo falha.

POST /api/calculadoras/revisional

Calcula a revisão de contrato (revisional)

cURL

curl --request POST \
  --url https://api.jusfy.com.br/api/calculadoras/revisional \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "contract_number": "VEIC-2021-0042",
  "amortization_system": "price",
  "average_interest": 1.8,
  "average_interest_periodicity": "monthly",
  "contract_another_taxes": 0,
  "contract_balance_index": "",
  "contract_balance_period": "Mensal",
  "contract_date": "2021-01-10",
  "contract_goods": 0,
  "contract_installments": 24,
  "contract_iof": 0,
  "contract_price_index": 6,
  "contract_service_tax": 0,
  "contract_type": 24,
  "contract_value": 40000,
  "differences_has_interests": false,
  "differences_interest_rate": 1,
  "first_installment_date": "2021-02-10",
  "installment_amount": 2100,
  "interest_rate": 3,
  "interest_rate_periodicity": "monthly",
  "own_average_interest": true,
  "paid_installments": [
    {
      "date": "2021-02-10",
      "amount": 2100,
      "paid": true
    },
    {
      "date": "2021-03-10",
      "amount": 2100,
      "paid": true
    },
    {
      "date": "2021-04-10",
      "amount": 2100,
      "paid": true
    }
  ],
  "report_date": "2023-01-10"
}
'

200

Example

{
  "statusCode": 200,
  "message": "Cálculo concluído com sucesso",
  "timestamp": "2026-06-22T18:00:00.000Z",
  "path": "/api/calculadoras/revisional",
  "result": {
    "odds": 25,
    "type": "payable",
    "contract_number": "VEIC-2021-0042",
    "calculation_remaining_installments": 21,
    "schedule": [
      {
        "number": -1,
        "interest": 0,
        "amortization": null,
        "installmentAmount": null,
        "outstandingBalance": 40720,
        "updatedBalance": 40720,
        "due": "2020-12-10",
        "paymentDate": null,
        "paidAmount": null,
        "differenceAmount": null,
        "differenceAdjustedAmount": null,
        "adjusted": null,
        "delayDays": null,
        "interests": null,
        "total": null
      },
      {
        "number": 0,
        "interest": 732.96,
        "amortization": null,
        "installmentAmount": null,
        "updatedBalance": 40720,
        "due": "2021-01-10",
        "outstandingBalance": 41452.96,
        "paymentDate": null,
        "paidAmount": null,
        "differenceAmount": null,
        "differenceAdjustedAmount": null,
        "adjusted": null,
        "delayDays": null,
        "interests": null,
        "total": null
      },
      {
        "number": 1,
        "interest": 746.15,
        "amortization": 1396.17,
        "installmentAmount": 2142.32,
        "updatedBalance": 41452.96,
        "due": "2021-02-10",
        "outstandingBalance": 40056.79,
        "paymentDate": "2021-02-10",
        "paidAmount": 2100,
        "differenceAmount": -42.32,
        "differenceAdjustedAmount": -48.51,
        "adjustedPercentage": 14.63,
        "delayDays": 0,
        "interests": 0,
        "total": -48.51
      },
      {
        "number": 24,
        "interest": 37.88,
        "amortization": 2104.44,
        "installmentAmount": 2142.32,
        "updatedBalance": 2104.54,
        "due": "2023-01-10",
        "outstandingBalance": 0.1,
        "paymentDate": null,
        "paidAmount": null,
        "differenceAmount": -2142.32,
        "differenceAdjustedAmount": -2142.32,
        "adjustedPercentage": 0,
        "delayDays": 0,
        "interests": 0,
        "total": -2142.32
      }
    ],
    "refinancing_schedule": {
      "schedule": [
        {
          "number": 0,
          "interest": 0,
          "amortization": null,
          "installmentAmount": null,
          "outstandingBalance": 37332.96,
          "updatedBalance": 37332.96,
          "due": "2021-04-10"
        },
        {
          "number": 1,
          "interest": 671.99,
          "amortization": 1478.65,
          "installmentAmount": 2150.64,
          "updatedBalance": 37332.96,
          "due": "2021-05-10",
          "outstandingBalance": 35854.31
        },
        {
          "number": 21,
          "interest": 38.03,
          "amortization": 2112.61,
          "installmentAmount": 2150.64,
          "updatedBalance": 2112.61,
          "due": "2023-01-10",
          "outstandingBalance": 0
        }
      ],
      "summary": {
        "firstInstallmentAmount": 2150.64
      },
      "totalInstallments": 45163.44,
      "totalInterests": 7830.48,
      "totalAmortizations": 37332.96
    },
    "contract_date": "2021-01-10",
    "first_installment_date": "2021-02-10",
    "differences_has_interests": false,
    "differences_interest_rate": 1,
    "total_amortizations": 41452.86,
    "total_installments": 51415.68,
    "total_interests": 10695.78,
    "total_paid_amount": 6300,
    "total_difference_amount": -45115.68,
    "calculation_differences_total": -46777.67,
    "calculation_adjusted_amounts": -46777.67,
    "calculations_interests_total": 0,
    "contract_another_taxes": 0,
    "contract_service_tax": 0,
    "contract_iof": 0,
    "grace_period": 1,
    "gracePeriodInDays": 0,
    "amortization_system": "PRICE",
    "report_date": "2023-01-10",
    "adjustment_until": " (correção até 10/2022)",
    "differences_index": true,
    "differences_index_name": "IPCA (GERAL)",
    "refinancing_balance": 37188.61,
    "differences_paid": -144.35,
    "refinancing_amount": 37332.96,
    "petition_filename": "aquisicao-veiculos.docx",
    "sector": "",
    "contract_type": "Aquisição de veículos",
    "contract_type_code_monthly": "25447",
    "contract_type_code_annually": "20728",
    "bacen_average_interest_monthly": 1.8,
    "bacen_average_interest_annually": 23.87205315755283,
    "bacen_interest_percentage_increase": 7.777777777777772,
    "contract_amount": 40000,
    "contract_goods": 40000,
    "contract_installments": 24,
    "contract_paid_installments": 3,
    "contract_installment_amount": 2100,
    "contract_amount_cost_effective": 50400,
    "contract_interest_rate_monthly": 1.94,
    "contract_interest_rate_annually": 25.931840613381894,
    "calculation_receivable_amount": 37332.96,
    "calculation_payable_amount": 37332.96,
    "calculation_difference": 37332.96,
    "calculation_installment_adjusted": 2142.32,
    "calculation_refinancing_installments_amount": 2150.64,
    "own_average_interest": true
  }
}

Autorizações

x-api-key · string · header · obrigatório

Corpo

application/json

Payload da calculadora revisional.

Payload da revisão de contrato. Informe os dados do contrato (valor, parcelas, taxas, datas e tipo), a taxa média de mercado e as parcelas pagas. A resposta traz a tabela de amortização recalculada, as diferenças apuradas (a pagar ou a receber), os totais e, quando aplicável, o cronograma de refinanciamento.

Os campos contract_type e contract_price_index referenciam índices (Index) do backend (obtidos em GET /api/calculadoras/indices-correcao) e devem existir; caso contrário o cálculo falha.

amortization_system · enum<string> · obrigatório

Sistema de amortização. Retornado em maiúsculo (PRICE/SAC).

Opções disponíveis: price, sac

average_interest · number · obrigatório

Taxa média de mercado informada (usada quando own_average_interest é true).

average_interest_periodicity · string · obrigatório

Periodicidade da taxa média (ex.: monthly).

contract_another_taxes · number · obrigatório

Outras taxas/tarifas do contrato.

contract_balance_index · string · obrigatório

Índice de correção do saldo. String vazia ("") = sem índice de saldo.

contract_balance_period · string · obrigatório

Periodicidade da correção do saldo (ex.: Mensal).

contract_date · string<date> · obrigatório

Data do contrato (YYYY-MM-DD).

contract_goods · number · obrigatório

Valor de bens/entrada.

contract_installments · number · obrigatório

Número de parcelas do contrato.

contract_iof · number · obrigatório

IOF do contrato.

contract_service_tax · number · obrigatório

Taxa de serviço do contrato.

contract_type · number · obrigatório

Id do tipo de contrato (Index) do backend. Precisa existir.

contract_value · number · obrigatório

Valor financiado do contrato.

differences_has_interests · boolean · obrigatório

Se as diferenças apuradas incidem juros.

differences_interest_rate · number · obrigatório

Taxa de juros aplicada às diferenças.

first_installment_date · string<date> · obrigatório

Data da primeira parcela (YYYY-MM-DD).

installment_amount · number · obrigatório

Valor da parcela do contrato.

interest_rate · number · obrigatório

Taxa de juros do contrato.

interest_rate_periodicity · string · obrigatório

Periodicidade da taxa de juros do contrato (ex.: monthly).

own_average_interest · boolean · obrigatório

Se true, usa a average_interest informada; se false, busca a taxa média Bacen no backend.

paid_installments · object[] · obrigatório

Parcelas pagas. O cálculo considera apenas as com paid: true.

Show child attributes

report_date · string<date> · obrigatório

Data-base do cálculo/relatório (YYYY-MM-DD).

contract_number · string

Número do contrato. Opcional (default "").

contract_price_index · number | null

Id do índice (Index) de correção das diferenças. Precisa existir. Opcional/null quando não há correção.

Resposta

200

application/json

Resultado da revisão, com cronograma recalculado, diferenças e totais.

The response is of type object.