> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-formalizacao-de-credito/api-reference/simulador-de-credito.md).

# Simulador de Crédito

## Simulador de Empréstimo

> Simula um novo empréstimo com base nos parâmetros fornecidos.

```json
{"openapi":"3.0.0","info":{"title":"API de Formalização de Crédito","version":"1.0.0"},"servers":[{"url":"https://api.staging.scd.giro.tech/integration/v3","description":"Ambiente de Staging"},{"url":"https://api.scd.giro.tech/integration/v3","description":"Ambiente de Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/simulations/simulate":{"post":{"summary":"Simulador de Empréstimo","description":"Simula um novo empréstimo com base nos parâmetros fornecidos.","tags":["Simulação"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["numero_parcelas","data_emprestimo","taxa_juros_mensal","valor_emprestimo","tipo_pessoa"],"properties":{"data_emprestimo":{"type":"string","format":"date","description":"Data de solicitação do empréstimo."},"taxa_juros_mensal":{"type":"number","format":"double","description":"Taxa de juros ao mês do empréstimo, expressa em percentual.","maximum":99.99999999,"minimum":0},"numero_parcelas":{"type":"integer","format":"int32","description":"Total de parcelas para pagamento.","maximum":99,"minimum":1},"data_primeiro_vencimento_parcela":{"type":"string","format":"date","description":"Data do primeiro vencimento da parcela."},"valor_emprestimo":{"type":"number","format":"double","description":"Valor do empréstimo solicitado.","maximum":999999999.99,"minimum":0.01},"tipo_pessoa":{"type":"string","enum":["PESSOA_FISICA","PESSOA_JURIDICA"],"description":"Tipo de pessoa (Física ou Jurídica)."},"valor_tarifas":{"type":"number","format":"double","description":"Valor das tarifas a serem aplicadas.","maximum":999999999.99,"minimum":0},"tipo_aliquota_iof":{"type":"string","enum":["EMPRESAS_NO_GERAL","PESSOA_FISICA","MEI_COM_ALIQUOTA_REDUZIDA","MEI_ACIMA_DO_LIMITE","SIMPLES_COM_ALIQUOTA_REDUZIDA","SIMPLES_ACIMA_DO_LIMITE"],"description":"Este campo deve refletir o enquadramento fiscal, considerando regimes como MEI, Simples Nacional ou outros.<br/>\nAs alíquotas de IOF serão aplicadas no cálculo do empréstimo, levando em conta o tipo de pessoa (tipo_pessoa), o enquadramento fiscal e o valor do empréstimo (valor_emprestimo), conforme a regulamentação vigente.<br/>\nO preenchimento é obrigatório para o tipo_pessoa informado como PJ.\n"},"calculo":{"type":"object","description":"Informações sobre o cálculo.","properties":{"dias_compensar":{"type":"string","enum":["DIAS_CORRIDOS","MES_FECHADO_30_DIAS"],"default":"DIAS_CORRIDOS","description":"Dias entre a data do empréstimo e o vencimento da parcela."},"carencia":{"type":"string","enum":["COM_JUROS_A_PARTIR_31_DIAS","COM_JUROS_A_PARTIR_32_DIAS","SEM_JUROS_ATE_PRIMEIRO_VENCIMENTO"],"default":"COM_JUROS_A_PARTIR_31_DIAS","description":"Dias a serem considerados para a carência da primeira parcela."},"limite_iof":{"type":"string","enum":["ANO_FECHADO_365_DIAS","ANO_FECHADO_360_DIAS"],"default":"ANO_FECHADO_365_DIAS","description":"Dias no ano para cálculo do IOF."}}},"financiamento":{"type":"object","description":"Informações sobre o financiamento.","properties":{"iof":{"type":"string","enum":["IOF_NAO_FINANCIADO","IOF_FINANCIADO"],"default":"IOF_FINANCIADO","description":"Indica se o valor total do IOF será adicionado às parcelas."},"tarifas":{"type":"string","enum":["TARIFAS_NAO_FINANCIADO","TARIFAS_FINANCIADO"],"default":"TARIFAS_FINANCIADO","description":"Indica se o valor das tarifas informado será adicionado às parcelas."}}}}}}}},"responses":{"200":{"description":"Empréstimo solicitado com sucesso.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do empréstimo."},"numero_parcelas":{"type":"integer","format":"int32","description":"Total de parcelas para pagamento.","maximum":99,"minimum":1},"data_emprestimo":{"type":"string","format":"date","description":"Data de solicitação do empréstimo."},"data_primeiro_vencimento_parcela":{"type":"string","format":"date","description":"Data de vencimento da primeira parcela."},"data_ultimo_vencimento_parcela":{"type":"string","format":"date","description":"Data de vencimento da última parcela."},"taxa_juros_mensal":{"type":"number","format":"double","description":"Taxa de juros ao mês do empréstimo, expressa em percentual.","maximum":99.99999999,"minimum":0},"taxa_juros_anual":{"type":"number","format":"double","description":"Taxa de juros anual aplicada ao empréstimo.","maximum":9999.99999999,"minimum":0},"valor_tarifas":{"type":"number","format":"double","description":"Valor das tarifas a serem aplicadas.","maximum":999999999.99,"minimum":0},"valor_iof":{"type":"number","format":"double","description":"Valor total do IOF aplicado.","maximum":9999999.99,"minimum":0},"valor_emprestimo":{"type":"number","format":"double","description":"Valor do empréstimo solicitado.","maximum":999999999.99,"minimum":0.01},"valor_primeira_parcela":{"type":"number","format":"double","description":"Valor da primeira parcela.","maximum":999999999.99,"minimum":0},"valor_juros":{"type":"number","format":"double","description":"Valor total dos juros aplicados.","maximum":9999999.99,"minimum":0},"valor_desembolso":{"type":"number","format":"double","description":"Valor total do desembolso.","maximum":999999999.99,"minimum":0},"valor_financiado":{"type":"number","format":"double","description":"Valor total financiado.","maximum":999999999.99,"minimum":0},"saldo_devedor":{"type":"number","format":"double","description":"Saldo devedor total.","maximum":999999999.99,"minimum":0},"custo_efetivo_total_mensal":{"type":"number","format":"double","description":"Custo efetivo total mensal.","maximum":9999.99,"minimum":0},"custo_efetivo_total_anual":{"type":"number","format":"double","description":"Custo efetivo total anual.","maximum":9999.99,"minimum":0},"parcelas":{"type":"array","items":{"type":"object","required":["numero_parcela","dias_compensar","data_vencimento","valor_parcela","valor_juros","saldo_devedor","valor_iof_parcela"],"properties":{"numero_parcela":{"type":"integer","format":"int32","description":"Número da parcela.","minimum":1,"maximum":99},"dias_compensar":{"type":"integer","format":"int32","description":"Dias a compensar a parcela.","minimum":0,"maximum":999},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento da parcela. <br> Deve ser única dentre todas as datas de vencimento."},"valor_parcela":{"type":"number","format":"double","description":"Valor da parcela.","maximum":999999999.99,"minimum":0},"valor_juros":{"type":"number","format":"double","description":"Valor de juros da parcela.","maximum":999999.99,"minimum":0},"saldo_devedor":{"type":"number","description":"Saldo devedor após o pagamento da parcela.","maximum":999999999.99,"minimum":0},"capital_amortizado":{"type":"number","format":"double","description":"Capital amortizado.","maximum":999999999.99,"minimum":0},"valor_iof_parcela":{"type":"number","format":"double","description":"Valor do IOF.","maximum":999999.99,"minimum":0}}}}}}}}},"400":{"description":"Requisição inválida."},"401":{"description":"Não autorizado."},"500":{"description":"Erro interno do servidor."}}}}}}
```
