Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Simulation

Simular o crédito antes da operação usando configurações do convênio.

Criação de uma simulação usando o simulador com configurações pré estabelecidas via identificador do convênio

post/simulation

Request body

agreementIdstring required

Identificador do convênio

amountnumber required

Valor do desembolso para simulação

interestRatenumber

Percentual da taxa aplicada no Empréstimo para simulação

startDatestring date

Data inicial do contrato

minimumInstallmentAmountnumber

Valor mínimo de parcela para simulação

maximumInstallmentAmountnumber

Valor máximo de parcela para simulação

minimumInstallmentsnumber

Quantidade de parcelas mínima para simulação

maximumInstallmentsnumber

Quantidade de parcelas máxima para simulação

firstPaymentDatestring date

Data de vencimento da primeira parcela

paymentDaynumber

Dia do vencimento das parcelas (Primeira parcela irá ter a data enviada no campo firstPaymentDate, caso o mesmo seja enviado)

Example request

{
  "agreementId": "e83fb70e-b7d6-40c1-9c44-9c63c0a3150d",
  "amount": 125.32,
  "interestRate": 0.12,
  "startDate": "2023-08-03T00:00:00.000Z",
  "minimumInstallmentAmount": 100,
  "maximumInstallmentAmount": 200.5,
  "minimumInstallments": 1,
  "maximumInstallments": 12,
  "firstPaymentDate": "2023-08-03T00:00:00.000Z",
  "paymentDay": 12,
  "fees": [
    {
      "type": "TAC",
      "percentage": 10.01
    }
  ]
}

Response

Sucesso

executionIdstring

Identificador de excecução da simulação

dayCountCodenumber

Código de aplicação de dias de cálculo

firtsInstallmentDatestring date

Data do primeiro pagamento

monthlyInterestRatestring

Taxa mensal

annualInterestRatestring

Taxa anual

Example response

[
  {
    "executionId": "b2eaa18b-985e-473f-92bf-8cf9a407aee1",
    "dayCountCode": 303601,
    "firtsInstallmentDate": "2024-05-06",
    "monthlyInterestRate": "0.0099",
    "annualInterestRate": "0.1254",
    "operations": [
      {
        "operationId": "067bbc5e36984331ba72e14c1700fae4",
        "term": 1,
        "totalAmount": "36954.35",
        "amount": "30887.96",
        "clientNetAmount": "30000.00",
        "cetRate": "0.1475",
        "tax": "887.96",
        "fees": [
          {
            "code": "CMPA",
            "isFinanciable": true,
            "isGrossupable": true,
            "isDebitable": true,
            "amount": "2692.84",
            "percentage": "0.08",
            "pmt": "92.00",
            "pprFee": "0.0800",
            "grossValue": "2692.84"
          }
        ],
        "cashFlows": [
          {
            "code": 1,
            "amortization": "1014.11",
            "interest": "12.39",
            "tax": "7.09",
            "amount": "1026.50",
            "maturityDate": "2024-05-06T00:00:00",
            "startAccrual": "2024-05-06T00:00:00",
            "endAccrual": "2024-05-06T00:00:00"
          }
        ]
      }
    ]
  }
]