Debt Simulation

At QI Tech, we provide our clients the ability to simulate credit operation values before their actual issuance. The simulation follows the same pattern as the debt issuance request, but it's not necessary to provide the debtor's registration and disbursement account details. Furthermore, we offer the possibility to perform several simulations with a single request.

Request

In the example below, a debt simulation request is described, where two simulations are performed in a single call.

ENDPOINT

/debt_simulation

METHOD

POST

Request Body

{
  "complex_operation": true,
  "operation_batch": [
    {
      "borrower": {
        "person_type": "natural"
      },
      "financial": {
        "amount": 123456,
        "interest_type": "pre_price_days",
        "credit_operation_type": "ccb",
        "annual_interest_rate": 2.32,
        "disbursement_date": "2023-03-01",
        "interest_grace_period": 0,
        "principal_grace_period": 0,
        "number_of_installments": 2,
        "fine_configuration": {
          "contract_fine_rate": 0.02,
          "interest_base": "calendar_days",
          "monthly_rate": 0.01
        }
      }
    },
    {
      "borrower": {
        "person_type": "natural"
      },
      "financial": {
        "amount": 123456,
        "interest_type": "pre_price_days",
        "credit_operation_type": "ccb",
        "annual_interest_rate": 2.32,
        "disbursement_date": "2023-03-02",
        "interest_grace_period": 0,
        "principal_grace_period": 0,
        "number_of_installments": 2,
        "fine_configuration": {
          "contract_fine_rate": 0.02,
          "interest_base": "calendar_days",
          "monthly_rate": 0.01
        }
      }
    }
  ]
}

Response

STATUS

200

Response Body

{
  "data": [
    {
      "data": {
        "annual_cet": 2.5903084589853727,
        "assignment_amount": 123456,
        "cet": 0.1124,
        "contract_fee_amount": 0,
        "contract_fees": [],
        "credit_operation_type": "ccb",
        "disbursed_issue_amount": 122513.07,
        "disbursement_date": "2023-03-01",
        "disbursement_options": [
          {
            "annual_cet": 2.5903084589853727,
            "assignment_amount": 123456,
            "cet": 0.1124,
            "contract_fee_amount": 0,
            "contract_fees": [],
            "disbursed_issue_amount": 122513.07,
            "disbursement_date": "2023-03-01",
            "external_contract_fee_amount": 0,
            "external_contract_fees": [],
            "first_due_date": "2023-04-01",
            "installments": [
              {
                "business_due_date": "2023-04-03",
                "calendar_days": 31,
                "due_date": "2023-04-01",
                "due_principal": 123456,
                "has_interest": true,
                "installment_number": 1,
                "post_fixed_amount": 0,
                "pre_fixed_amount": 13439.137542938823,
                "principal_amortization_amount": 58427.86245706118,
                "tax_amount": 148.5236263658495,
                "total_amount": 71867,
                "workdays": 22
              },
              {
                "business_due_date": "2023-05-02",
                "calendar_days": 30,
                "due_date": "2023-05-01",
                "due_principal": 65028.13754293882,
                "has_interest": true,
                "installment_number": 2,
                "post_fixed_amount": 0,
                "pre_fixed_amount": 6838.864642778799,
                "principal_amortization_amount": 65028.1353572212,
                "tax_amount": 325.27073305682046,
                "total_amount": 71867,
                "workdays": 18
              }
            ],
            "iof_amount": 942.93,
            "issue_amount": 123456,
            "net_external_contract_fee_amount": 0,
            "prefixed_interest_rate": {
              "annual_rate": 2.32,
              "daily_rate": 0.0033388,
              "interest_base": "calendar_days",
              "monthly_rate": 0.10516767
            },
            "total_pre_fixed_amount": 20278.00218571762
          }
        ],
        "external_contract_fee_amount": 0,
        "external_contract_fees": [],
        "final_disbursement_amount": 122513.07,
        "installments": [
          {
            "business_due_date": "2023-04-03",
            "calendar_days": 31,
            "due_date": "2023-04-01",
            "due_principal": 123456,
            "has_interest": true,
            "installment_number": 1,
            "post_fixed_amount": 0,
            "pre_fixed_amount": 13439.137542938823,
            "principal_amortization_amount": 58427.86245706118,
            "tax_amount": 148.5236263658495,
            "total_amount": 71867,
            "workdays": 22
          },
          {
            "business_due_date": "2023-05-02",
            "calendar_days": 30,
            "due_date": "2023-05-01",
            "due_principal": 65028.13754293882,
            "has_interest": true,
            "installment_number": 2,
            "post_fixed_amount": 0,
            "pre_fixed_amount": 6838.864642778799,
            "principal_amortization_amount": 65028.1353572212,
            "tax_amount": 325.27073305682046,
            "total_amount": 71867,
            "workdays": 18
          }
        ],
        "interest_grace_period": 0,
        "interest_payment_month_period": 1,
        "interest_type": "pre_price_days",
        "iof_amount": 942.93,
        "issue_amount": 123456,
        "issue_date": "2023-03-01",
        "net_external_contract_fee_amount": 0,
        "number_of_installments": 2,
        "operation_type": "structured_operation",
        "post_fixed_interest_base": "workdays",
        "post_fixed_interest_rate": null,
        "prefixed_interest_rate": {
          "annual_rate": 2.32,
          "daily_rate": 0.0033388,
          "interest_base": "calendar_days",
          "monthly_rate": 0.10516767
        },
        "principal_amortization_month_period": 1,
        "principal_grace_period": 0,
        "requester_key": "ef48fbe4-267b-45c1-9049-75345c075486",
        "total_pre_fixed_amount": 20278.00218571762
      },
      "event_datetime": "2023-03-02 01:42:16",
      "key": "bedef24d-e1da-4b8b-84d0-d25b6704f2f9",
      "status": "finished",
      "type": "debt"
    },
    {
      "data": {
        "annual_cet": 2.5903084589853727,
        "assignment_amount": 123456,
        "cet": 0.1124,
        "contract_fee_amount": 0,
        "contract_fees": [],
        "credit_operation_type": "ccb",
        "disbursed_issue_amount": 122513.07,
        "disbursement_date": "2023-03-02",
        "disbursement_options": [
          {
            "annual_cet": 2.5903084589853727,
            "assignment_amount": 123456,
            "cet": 0.1124,
            "contract_fee_amount": 0,
            "contract_fees": [],
            "disbursed_issue_amount": 122513.07,
            "disbursement_date": "2023-03-02",
            "external_contract_fee_amount": 0,
            "external_contract_fees": [],
            "first_due_date": "2023-04-02",
            "installments": [
              {
                "business_due_date": "2023-04-03",
                "calendar_days": 31,
                "due_date": "2023-04-02",
                "due_principal": 123456,
                "has_interest": true,
                "installment_number": 1,
                "post_fixed_amount": 0,
                "pre_fixed_amount": 13439.137542938823,
                "principal_amortization_amount": 58427.86245706118,
                "tax_amount": 148.5236263658495,
                "total_amount": 71867,
                "workdays": 21
              },
              {
                "business_due_date": "2023-05-02",
                "calendar_days": 30,
                "due_date": "2023-05-02",
                "due_principal": 65028.13754293882,
                "has_interest": true,
                "installment_number": 2,
                "post_fixed_amount": 0,
                "pre_fixed_amount": 6838.864642778799,
                "principal_amortization_amount": 65028.1353572212,
                "tax_amount": 325.27073305682046,
                "total_amount": 71867,
                "workdays": 19
              }
            ],
            "iof_amount": 942.93,
            "issue_amount": 123456,
            "net_external_contract_fee_amount": 0,
            "prefixed_interest_rate": {
              "annual_rate": 2.32,
              "daily_rate": 0.0033388,
              "interest_base": "calendar_days",
              "monthly_rate": 0.10516767
            },
            "total_pre_fixed_amount": 20278.00218571762
          }
        ],
        "external_contract_fee_amount": 0,
        "external_contract_fees": [],
        "final_disbursement_amount": 122513.07,
        "installments": [
          {
            "business_due_date": "2023-04-03",
            "calendar_days": 31,
            "due_date": "2023-04-02",
            "due_principal": 123456,
            "has_interest": true,
            "installment_number": 1,
            "post_fixed_amount": 0,
            "pre_fixed_amount": 13439.137542938823,
            "principal_amortization_amount": 58427.86245706118,
            "tax_amount": 148.5236263658495,
            "total_amount": 71867,
            "workdays": 21
          },
          {
            "business_due_date": "2023-05-02",
            "calendar_days": 30,
            "due_date": "2023-05-02",
            "due_principal": 65028.13754293882,
            "has_interest": true,
            "installment_number": 2,
            "post_fixed_amount": 0,
            "pre_fixed_amount": 6838.864642778799,
            "principal_amortization_amount": 65028.1353572212,
            "tax_amount": 325.27073305682046,
            "total_amount": 71867,
            "workdays": 19
          }
        ],
        "interest_grace_period": 0,
        "interest_payment_month_period": 1,
        "interest_type": "pre_price_days",
        "iof_amount": 942.93,
        "issue_amount": 123456,
        "issue_date": "2023-03-02",
        "net_external_contract_fee_amount": 0,
        "number_of_installments": 2,
        "operation_type": "structured_operation",
        "post_fixed_interest_base": "workdays",
        "post_fixed_interest_rate": null,
        "prefixed_interest_rate": {
          "annual_rate": 2.32,
          "daily_rate": 0.0033388,
          "interest_base": "calendar_days",
          "monthly_rate": 0.10516767
        },
        "principal_amortization_month_period": 1,
        "principal_grace_period": 0,
        "requester_key": "ef48fbe4-267b-45c1-9049-75345c075486",
        "total_pre_fixed_amount": 20278.00218571762
      },
      "event_datetime": "2023-03-02 01:42:16",
      "key": "699a80c0-206e-4dba-a672-117c90a0d02f",
      "status": "finished",
      "type": "debt"
    }
  ]
}

Definições

Request Body

Field	Type	Description	Max. Caract.
complex_operation	boolean	true - indicates that multiple simulations can be performed in the same request	-
operation_batch	object	List of simulation requests - Object da Lista Operation Batch	-

Object List Operation Batch

Field	Type	Description	Max. Caract.
borrower	object	Object Borrower - Credit operation debtor	-
financial	object	Object Financial - Financial data of the operation	-

Object Borrower

Field	Type	Description	Max. Caract.
person_type	object	Enumerador Person Type - Legal Nature of the credit operation debtor	-

Object Financial

Campo	Tipo	Descrição	Máx. Caract.
amout	float	Valor de emissão/nominal da operação de crédito	-
interest_type	object	Enumerador Interest Type - Método de amortização e forma de cálculo de juros	-
credit_operation_type	object	Enumerador Credit Operation Type - Tipo do contrato de crédito	-
annual_interest_rate	float	Taxa de juros pré-fixada expressa em decimal ao ano	-
disbursement_date	date	Data do desembolso da operação	-
interest_grace_period	int	Carência de juros (em meses)	-
principal_grace_period	int	Período carência de principal	-
number_of_installments	int	Número de parcelas da operação de crédito	-
fine_configuration	object	Object fine_configuration - Configuração de juros e multa por atraso	-

Object Fine Configuration

Campo	Tipo	Descrição	Máx. Caract.
contract_fine_rate	float	Percentual de multa por atraso expresso em decimal	-
interest_base	enum	Enumerador Interest Base - Base de cálculo de juros	-
monthly_rate	float	Percentual de juros de atraso ao mês expresso em decimal	-

Response Body

Campo	Tipo	Descrição	Máx. Caract.
data[n].data	object	Object Data	-
data[n].event_datetime	date	Momento da geração da simulação	-
data[n].key	string	Chave única da simulação	-
data[n].status	string	finished	-
data[n].type	string	debt	-

Object Data

Campo	Tipo	Descrição	Máx. Caract.
annual_cet	float	Custo efetivo total expresso em decimal ao ano	-
assignment_amount	float	Valor de aquisição da operação de crédito	-
cet	float	Custo efetivo total expresso em decimal ao mês	-
contract_fee_amount	float	Fee da QI Tech cobrado na operação	-
contract_fees	object	Object Contract Fees - Lista de Fee's da QI Tech cobrados na operação	-
credit_operation_type	enum	Enumerador Credit Operation Type - Tipo do contrato de crédito	-
disbursed_issue_amount	float	Valor desembolsado na operação de crédito	-
disbursement_date	date	Data do desembolso da operação	-
disbursement_options	list	Lista de opções de desembolso da operação (os valores financeiros da operação podem variar de acordo com o dia do desembolso)	-
external_contract_fee_amount	float	Valor do Fee cobrado na operação rebatido pela QI ao parceiro	-
external_contract_fees	list	Object Contract Fees - Lista de Fee's cobrados na operação rebatidos pela QI ao parceiro	-
final_disbursement_amount	float	Valor efetivamente desembolsado para o devedor	-
installments	list	Object Installments - Parcelas da operação	-
interest_grace_period	int	Carência de juros (em meses)	-
interest_payment_month_period	int	Frequência da cobrança de juros nas parcelas (em meses)	-
interest_type	enum	Enumerador Interest Type - Método de amortização e forma de cálculo de juros	-
iof_amount	float	Valor total do iof	-
issue_amount	float	Valor de emissão/nominal da operação de crédito	-
issue_date	date	Data da emissão do cotrato da operação	-
net_external_contract_fee_amount	float	Valor líquido do Fee cobrado na operação rebatido pela QI ao parceiro	-
operation_type	enum	Enumerador Operation Type	-
post_fixed_interest_base	enum	Enumerador Interest Base - Base de cálculo de juros	-
post_fixed_interest_rate	object	Object Interest Rate - Indexador de juros pós-fixados do contrato	-
prefixed_interest_rate	object	Object Interest Rate - Taxa de juros Nominal pré-fixada do contrato	-
principal_amortization_month_period	int	Frequência da cobrança de principal nas parcelas (em meses)	-
principal_grace_period	int	Período carência de principal (em meses)	-
requester_key	string	Chave única identificadora do parceiro dentro da QI.	-
total_pre_fixed_amount	float	Total de juros pago pelo devedor na operação de crédito	-

Object Contract Fees

Campo	Tipo	Descrição	Máx. Caract.
amount	float	Valor do Fee (em percentual ou valor absoluto, a depender do valor informado no campo amount_type	-
amount_type	enum	Enumeradores amount_type - Unidade do valor do Fee	-
fee_amount	float	Valor absoluto do Fee cobrado na operação	-
fee_type	enum	Enumerador Fee Type - Tipo do Fee cobrado na operação	-

Object Installments

Campo	Tipo	Descrição	Máx. Caract.
business_due_date	date	Data do vencimento em dia útil da parcela	-
calendar_days	int	Quantos dias corridos entre uma parcela e outra	-
due_date	date	Data do vencimento em dia corrido da parcela	-
due_principal	float	Principal remanescente na data de vencimento da parcela antes de seu pagamento	-
has_interest	boolean	true - Indicador de incidência de juros na parcela	-
installment_number	int	Número da parcela	-
post_fixed_amount	float	Valor de juros pós-fixado pago na parcela	-
pre_fixed_amount	float	Valor de juros pré-fixado pago na parcela	-
principal_amortization_amount	float	Valor de amortização pago na parcela	-
tax_amount	float	IOF da parcela	-
total_amount	float	Valor total da parcela	-
workdays	int	Quantos dias úteis entre uma parcela e outra	-

Object Interest Rate

Campo	Descrição	Máx. Caract.
annual_rate	Taxa de juros pré/pós expressa em decimal ao ano	-
daily_rate	Taxa de juros pré/pós expressa em decimal ao dia	-
interest_base	Enumerador Interest Base - Base de cálculo de juros	-
monthly_rate	Taxa de juros pré/pós expressa em decimal ao mês	-

Enumeradores

Enumerador Person Type

Enumerador	Descrição
legal	Pessoa juridica
natural	Pesso física

Enumerador Account Type

Enumerador	Descrição
checking_account	Conta corrente
deposit_account	Conta de depósito
guaranteed_account	Conta de garantia
investment_account	Conta de investimento
payment_account	Conta de pagamento
saving_account	Conta poupança
salary_account	Conta salário

Enumerador Interest Type

Enumerador	Descrição
pre_price_days	Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia
pre_price	Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias)
pre_sac	Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia
post_sac	Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia
post_price	Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias)
post_price_days	Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia

Enumerador Credit Operation Type

Enumerador	Descrição
ccb	Cédula de Crédito Bancário
cce	Cédula de Crédito à Exportação
cci	Cédula de Crédito Imobiliário
nce	Nota de Crédito à Exportação

Enumerador Interest Base

Enumerador	Descrição
workdays	Base de cálculo de juros em dias úteis considerando um ano de 252 dias
calendar_days	Base de cálculo de juros em dias corridos considerando um ano de 360 dias
calendar_days_365	Base de cálculo de juros em dias corridos considerando um ano de 365 dias

Enumerador Fee Type

Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech

Enumerador	Descrição
tac	Tarifa de abertura de cadastro
spread	Ágio cobrado no valor de aquisição da operação de crédito
warranty_analysis	Tarifa de análise de garantias
ted_fee	Tarifa de TED
spread_ted_fee	Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito

Debt Simulation

Request​

Response​

Definições​

Request Body​

Object List Operation Batch​

Object Borrower​

Object Financial​

Object Fine Configuration​

Response Body​

Object Data​

Object Contract Fees​

Object Installments​

Object Interest Rate​