---
title: "Simular o crédito antes da operação usando configurações do convênio."
method: POST
path: "/simulation"
tags: ["Simulation"]
---

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

`POST /simulation`

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

## Request body

- object
  - `agreementId` string, required — Identificador do convênio
  - `amount` number, required — Valor do desembolso para simulação
  - `interestRate` number — Percentual da taxa aplicada no Empréstimo para simulação
  - `startDate` string, date — Data inicial do contrato
  - `minimumInstallmentAmount` number — Valor mínimo de parcela para simulação
  - `maximumInstallmentAmount` number — Valor máximo de parcela para simulação
  - `minimumInstallments` number — Quantidade de parcelas mínima para simulação
  - `maximumInstallments` number — Quantidade de parcelas máxima para simulação
  - `firstPaymentDate` string, date — Data de vencimento da primeira parcela
  - `paymentDay` number — Dia do vencimento das parcelas (Primeira parcela irá ter a data enviada no campo firstPaymentDate, caso o mesmo seja enviado)
  - `fees` object[] — Taxas adicionais de bancarização. Se aplicável.
    - `type` 'REGISTRATOR' | 'BROKER' | 'RCO' | 'CIP' | 'TAC' — Tipo do Fee
    - `percentage` number, double — Percentual do crédito

## Response `201`

Sucesso

- object[]
  - `executionId` string — Identificador de excecução da simulação
  - `dayCountCode` number — Código de aplicação de dias de cálculo
  - `firtsInstallmentDate` string, date — Data do primeiro pagamento
  - `monthlyInterestRate` string — Taxa mensal
  - `annualInterestRate` string — Taxa anual
  - `operations` object[]
    - `operationId` string — Id da operação de simulação
    - `term` number — Quantidade de parcelas referente a essa simulação
    - `totalAmount` string — Valor total com o juros acruado (soma das PMTs)
    - `amount` string — Valor total do principal (financiado)
    - `clientNetAmount` string — valor do desembolso
    - `cetRate` string — Taxa de Custo Efetivo Total (CET)
    - `tax` string — Valor total de IOF
    - `fees` object[]
      - `code` string — Código da taxa
      - `isFinanciable` boolean — Permite financiamento
      - `isGrossupable` boolean — Indica que qualquer imposto deve implicar no valor bruto na hora do pagamento
      - `isDebitable` boolean — Permite débito da taxa
      - `amount` string — Valor total do fee
      - `percentage` string — Taxa do fee
      - `pmt` string — Tipo de valorização
      - `pprFee` string — Percentual por Fee relativo ao valor principal do contrato
      - `grossValue` string — Valor bruto do fee
    - `cashFlows` object[]
      - `code` number — Número da parcela
      - `amortization` string — Valor de amortização da parcela
      - `interest` string — Valor de juros da parcela
      - `tax` string — Valor de IOF da parcela
      - `amount` string — Valor total da parcela (PMT)
      - `maturityDate` string — Data do pagamento da parcela
      - `startAccrual` string — Data de inicio de accrual da parcela
      - `endAccrual` string — Data de termino de accrual da parcela

## Other responses

- `400` — Erro
- `401` — Não autorizado

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)