Simular Aditamento

Este endpoint devolve o efeito de uma repactuação de fluxo sem criar nada: o saldo devedor na data base, o cronograma vigente, o cronograma proposto, o resultado do fechamento e o valor da taxa do aditamento. Use a simulação para apresentar o cenário ao emissor antes de qualquer compromisso.

Escopo da simulação

A simulação aceita exatamente uma alteração, e ela precisa ser do tipo financial_flow. Qualquer outro tipo é recusado com AMD000013. Para conferir um conjunto completo de alterações, use a validação.

Request

ENDPOINT

/security_amendment/amendment/simulation

MÉTODO

POST

Request Body

{
  "security_key": "2d35b5a7-4cd1-4960-b1d7-4a53668e85b5",
  "financial_base_date": "2026-09-20",
  "changes": [
    {
      "type": "financial_flow",
      "operation": "modification",
      "new_value": {
        "installments": [
          { "installment_number": 3, "due_date": "2026-10-20" },
          { "installment_number": 4, "due_date": "2026-11-20" },
          { "installment_number": 5, "due_date": "2026-12-20" }
        ]
      }
    }
  ]
}

Request Body Params

Campo	Tipo	Obrigatório	Descrição
`security_key`	string (UUID)	Sim	Chave do título a ser aditado.
`financial_base_date`	string (date)	Sim	Data base em `YYYY-MM-DD`. Âncora do saldo devedor e do novo fluxo.
`changes`	array	Sim	Exatamente 1 item, do tipo `financial_flow`. Formato em Tipos de Alteração.

Response

STATUS

200

Response Body

{
  "financial_base_date": "2026-09-20",
  "outstanding_balance": 152340.55,
  "closing": {
    "present_value": 152340.55,
    "difference": 0.00,
    "tolerance": 0.01,
    "passed": true
  },
  "preserved_installments": [
    {
      "installment_number": 1,
      "due_date": "2026-07-20",
      "principal_amortization_amount": 48000.00,
      "interest_amount": 2100.00,
      "installment_status": "paid",
      "paid_amount": 50100.00,
      "paid_at": "2026-07-20T13:42:11"
    }
  ],
  "previous_financial": {
    "interest_rate": {
      "monthly_rate": 0.0180,
      "interest_base": "workdays"
    },
    "installments": [
      {
        "installment_number": 3,
        "due_date": "2026-09-20",
        "principal_amortization_amount": 50000.00,
        "interest_amount": 2680.00,
        "installment_status": "pending"
      }
    ]
  },
  "new_financial": {
    "interest_rate": {
      "monthly_rate": 0.0180,
      "interest_base": "workdays"
    },
    "installments": [
      {
        "installment_number": 3,
        "due_date": "2026-10-20",
        "principal_amortization_amount": 49210.33,
        "interest_amount": 3470.22,
        "installment_status": "pending"
      },
      {
        "installment_number": 4,
        "due_date": "2026-11-20",
        "principal_amortization_amount": 49563.87,
        "interest_amount": 3116.68,
        "installment_status": "pending"
      },
      {
        "installment_number": 5,
        "due_date": "2026-12-20",
        "principal_amortization_amount": 49920.40,
        "interest_amount": 2760.15,
        "installment_status": "pending"
      }
    ]
  },
  "charge_amount": 500.00
}

Response Body Params

Campo	Tipo	Descrição
`financial_base_date`	string (date)	Data base usada no cálculo, ecoada da requisição.
`outstanding_balance`	number	Saldo devedor apurado na data base.
`closing`	object	Resultado do fechamento contra o valor presente.
`preserved_installments`	array	Parcelas que não entram na repactuação e são mantidas como estão.
`previous_financial`	object	Taxa e cronograma vigentes antes do aditamento.
`new_financial`	object	Taxa e cronograma resultantes da proposta.
`charge_amount`	number	Valor da taxa do aditamento, conforme seu contrato.

closing

Campo	Tipo	Descrição
`present_value`	number	Valor presente do título na data base.
`difference`	number	Diferença entre o fluxo proposto e o valor presente.
`tolerance`	number	Diferença máxima aceita.
`passed`	boolean	`true` quando a diferença está dentro da tolerância. Um fluxo com `false` faria o aditamento nascer em `validation_failed`.

installments[] (em preserved_installments, previous_financial e new_financial)

Campo	Tipo	Descrição
`installment_number`	integer	Número da parcela no cronograma.
`due_date`	string (date)	Vencimento.
`principal_amortization_amount`	number	Parcela de amortização do principal.
`interest_amount`	number	Parcela de juros.
`installment_status`	string	Estado da parcela.
`paid_amount`	number	Valor pago. Presente apenas em parcelas com pagamento.
`paid_at`	string (datetime)	Momento do pagamento. Presente apenas em parcelas pagas.

Erros

Status	Código	Descrição
404	`AMD000001`	Título não encontrado para este tenant.
422	`AMD000002`	Título não está ativo.
422	`AMD000003`	Operação de origem não está finalizada.
422	`AMD000004`	Título já liquidado.
422	`AMD000005`	Data base retroativa.
422	`AMD000013`	A simulação aceita apenas uma alteração de `financial_flow`.
422	`AMD000020`	Parcela com pagamento já aplicado não pode ser renegociada.

O catálogo completo está em Catálogo de erros.

Request​

Request Body​

Request Body Params​

Response​

Response Body Params​

Erros​

Veja também​