New debt simulation

At QI Tech we provide our clients with the possibility to simulate the values of a credit operation before its actual issuance. The simulation follows the same pattern as the debt issuance request, but it is not necessary to provide the cadastral data and disbursement account of the debtor.

Request

In the example below, a debt simulation request is described.

ENDPOINT

/v2/credit_operation/simulation

METHOD

POST

Request Body

Due date and installment amount

{
    "credit_operation_type": "ccb",
    "disbursed_issue_amount": 2800,
    "disbursement_date": "2025-09-24",
    "first_due_date": "2025-10-24",
    "force_installments_on_workdays": true,
    "interest_type": "pre_price_days",
    "issuer_person_type": "natural",
    "monthly_interest_rate": 0.04488,
    "number_of_installments": 12,
    "principal_amortization_month_period": 1
}

Disbursed amount and installments

{
   "credit_operation_type": "ccb",
   "disbursed_issue_amount": 460,
   "disbursement_date": "2025-09-24",
   "first_due_date": "2025-10-24",
   "force_installments_on_workdays": true,
   "interest_type": "pre_price_days",
   "issuer_person_type": "natural",
   "number_of_installments": 3,
   "principal_amortization_month_period": 1,
   "interest_base": "calendar_days_365",
   "installments": [
     {
       "due_date": "2026-02-26",
       "amount": 137.48
     },
     {
       "due_date": "2026-03-26",
       "amount": 180.56
     },
     {
       "due_date": "2026-04-27",
       "amount": 180.56
     }
   ]
 }

Response

STATUS

200

Response Body

{
  "additional_iof": 0.14,
  "annual_cet": 145.08,
  "assignment_amount": 36.21,
  "base_iof": 0.1,
  "cet": 7.76,
  "disbursed_amount": 35.9,
  "disbursement_date": "2024-09-06",
  "fees": [
    {
      "amount": 0.0,
      "fee_amount": 0.0,
      "amount_type": "absolute",
      "fee_type": "tac",
      "type": "external"
    },
    {
      "amount": 0.0,
      "fee_amount": 0.0,
      "amount_type": "absolute",
      "fee_type": "spread",
      "type": "external"
    },
    {
      "amount": 0.2,
      "fee_amount": 0.07,
      "amount_type": "percentage",
      "fee_type": "spread",
      "type": "internal"
    }
  ],
  "first_due_date": "2024-09-25",
  "installments": [
    {
      "due_date": "2024-09-25",
      "amount": 19.5,
      "due_principal": 36.14,
      "due_interest": 0.0,
      "has_interest": true,
      "period": 0.6129032258064516,
      "period_workdays": 0.6190476190476191,
      "calendar_days": 19,
      "workdays": 13,
      "installment_number": 1,
      "period_to_disbursement": 0.6129032258064516,
      "prefixed_amount": 1.58227236,
      "period_workdays_to_disbursement": 1.0,
      "calendar_days_to_disbursement": 19,
      "workdays_to_disbursement": 13,
      "tax_amount": 0.02791582,
      "principal_amortization_amount": 17.91772764
    },
    {
      "due_date": "2024-10-25",
      "amount": 19.5,
      "due_principal": 18.22227236,
      "due_interest": 0.0,
      "has_interest": true,
      "period": 1.0,
      "period_workdays": 1.0,
      "calendar_days": 30,
      "workdays": 22,
      "installment_number": 2,
      "period_to_disbursement": 1.6129032258064515,
      "prefixed_amount": 1.27772764,
      "period_workdays_to_disbursement": 2.0,
      "calendar_days_to_disbursement": 49,
      "workdays_to_disbursement": 35,
      "tax_amount": 0.07321709,
      "principal_amortization_amount": 18.22227236
    }
  ],
  "interest_type": "pre_price_days",
  "issue_amount": 36.14,
  "prefixed_interest_rate": {
    "interest_base": "calendar_days",
    "annual_rate": 1.25219159,
    "daily_rate": 0.00225783,
    "monthly_rate": 0.07
  },
  "tax_configuration": {
    "additional_rate": 0.0038,
    "base_rate": 0.000082
  },
  "total_iof": 0.24
}

Definitions

Request Body

Payload

Field	Type	Description	Max. Chars.
credit_operation_type	enum	Credit Operation Type Enumerator - Credit contract type	-
disbursed_issue_amount	float	Issue/nominal amount of the credit operation	-
disbursement_date	date	Disbursement date of the operation	-
first_due_date	date	Due date of the first installment	-
force_installments_on_workdays	boolean	true - Indicator for installments scheduled on workdays	-
interest_type	enum	Interest Type Enumerator - Amortization method and interest calculation form	-
issuer_person_type	enum	Person Type Enumerator	-
monthly_interest_rate	float	Pre-fixed monthly interest rate of the contract	-
number_of_installments	int	Number of installments of the credit operation	-
principal_amortization_month_period	int	Number of months for principal amortization	-
installments	list	Installments Object - Operation installments	-

Response Body

Payload

Field	Type	Description	Max. Chars.
annual_cet	float	Total effective cost expressed in decimal per year	-
assignment_amount	float	Acquisition amount of the credit operation	-
cet	float	Total effective cost expressed in decimal per month	-
fees	object	Fees Object - List of QI Tech fees charged on the operation	-
disbursed_amount	float	Amount disbursed in the credit operation	-
disbursement_date	date	Disbursement date of the operation	-
installments	list	Installments Response Object - Operation installments	-
interest_type	enum	Interest Type Enumerator - Amortization method and interest calculation form	-
additional_iof	float	Additional IOF amount	-
base_iof	float	Base IOF amount	-
total_iof	float	Total IOF amount	-
issue_amount	float	Issue/nominal amount of the credit operation	-
tax_configuration	object	Tax Configuration Object - Tax rate values	-
first_due_date	date	Due date of the first installment	-
prefixed_interest_rate	object	Interest Rate Object - Pre-fixed nominal interest rate of the contract	-

Fees Object

Field	Type	Description	Max. Chars.
amount	float	Fee amount (in percentage or absolute value, depending on the value provided in the amount_type field)	-
amount_type	enum	amount_type Enumerator - Fee amount unit	-
fee_amount	float	Absolute fee amount charged on the operation	-
fee_type	enum	Fee Type Enumerator - Type of fee charged on the operation	-
type	enum	Origin Type Enumerator - Origin of the fee charged on the operation	-

Installments Request Object

Field	Type	Description	Max. Chars.
due_date	date	Due date in calendar days of the installment	-
total_amount	float	Total installment amount	-

Installments Response Object

Field	Type	Description	Max. Chars.
calendar_days	int	How many calendar days between one installment and another	-
due_date	date	Due date in calendar days of the installment	-
due_principal	float	Remaining principal on the installment due date before its payment	-
has_interest	boolean	true - Indicator of interest incidence on the installment	-
installment_number	int	Installment number	-
prefixed_amount	float	Pre-fixed interest amount paid in the installment	-
principal_amortization_amount	float	Amortization amount paid in the installment	-
tax_amount	float	Base IOF of the installment	-
amount	float	Total installment amount	-
due_interest	float	Remaining interest after the installment due date before its payment	-
period	float	Installment period	-
period_workdays	float	Installment period in workdays	-
period_to_disbursement	float	Period until disbursement	-
period_workdays_to_disbursement	float	Period in workdays until disbursement	-
calendar_days_to_disbursement	int	How many calendar days until disbursement	-
workdays	int	How many workdays between one installment and another	-
workdays_to_disbursement	int	How many workdays until disbursement	-

Interest Rate Object

Field	Description	Max. Chars.
annual_rate	Pre/post-fixed interest rate expressed in decimal per year	-
daily_rate	Pre/post-fixed interest rate expressed in decimal per day	-
interest_base	Interest Base Enumerator - Interest calculation base	-
monthly_rate	Pre/post-fixed interest rate expressed in decimal per month	-

Tax Configuration Object

Field	Description	Max. Chars.
base_rate	Base rate value	-
additional_rate	Additional rate value	-

Enumerators

Person Type Enumerator

Enumerator	Description
legal	Legal entity
natural	Natural person

Account Type Enumerator

Enumerator	Description
checking_account	Checking account
deposit_account	Deposit account
guaranteed_account	Guarantee account
investment_account	Investment account
payment_account	Payment account
saving_account	Savings account
salary_account	Salary account

Amount Type Enumerator

Enumerator	Description
absolute	Absolute value
percentage	Percentage value

Interest Type Enumerator

Enumerator	Description
pre_price_days	Price amortization method (equal installments) with pre-fixed interest calculation per day
pre_price	Price amortization method (equal installments) with pre-fixed interest calculation in fixed periods (30 days)
pre_sac	SAC amortization method (constant amortization) with pre-fixed interest calculation per day
post_sac	SAC amortization method (constant amortization) with interest calculation based on a pre-fixed rate + post-fixed indexer (cdi, ipca or igpm) per day
post_price	Price amortization method (equal installments) with interest calculation based on a pre-fixed rate + post-fixed indexer (cdi, ipca or igpm) in fixed periods (30 days)
post_price_days	Price amortization method (equal installments) with interest calculation based on a pre-fixed rate + post-fixed indexer (cdi, ipca or igpm) per day

Credit Operation Type Enumerator

Enumerator	Description
ccb	Banking Credit Note
cce	Export Credit Note
cci	Real Estate Credit Note
nce	Export Credit Note

Interest Base Enumerator

Enumerator	Description
workdays	Interest calculation base on workdays considering a year of 252 days
calendar_days	Interest calculation base on calendar days considering a year of 360 days
calendar_days_365	Interest calculation base on calendar days considering a year of 365 days

Fee Type Enumerator

Each fee type must be previously enabled and configured by QI Tech

Enumerator	Description
tac	Account opening fee
spread	Premium charged on the acquisition amount of the credit operation
warranty_analysis	Warranty analysis fee
ted_fee	TED fee
spread_ted_fee	TED fee premium charged on the acquisition amount of the credit operation

Origin Type Enumerator

Each fee type must be previously enabled and configured by QI Tech

Enumerator	Description
internal	Internal origin fee
external	External origin fee