Financial Conditions Simulation

This endpoint allows simulating the financial conditions and payment flow of an operation.

---

Request

ENDPOINT

/commercial_paper/simulation

METHOD

POST

Request Body

Released Amount

{
    "interest_type": "pre_price_days",
    "financial_base_date": "2025-01-20",
    "released_amount": 1000000,
    "number_of_installments": 5,
    "prefixed_interest_rate": {
        "interest_base": "calendar_days_365", 
        "monthly_rate": 0.05
    },
    "fine_delay_rate": {
        "interest_base": "calendar_days_365", 
        "monthly_rate": 0.01
    },
    "contract_fine_rate": 0.02,
    "fees": [
        {
            "amount": 5, 
            "amount_type": "percentage", 
            "fee_type": "implementation_fee",
            "type": "internal"
        }
    ]
}

Informing Installments

{
    "interest_type": "pre_price_days",
    "financial_base_date": "2025-01-20",
    "number_of_installments": 2,
    "installments": [
        {
            "due_date": "2026-01-01",
            "amount": 500000
        },
        {
            "due_date": "2026-02-01",
            "amount": 502004.01
        }
    ],
    "prefixed_interest_rate": {
        "interest_base": "calendar_days_365", 
        "monthly_rate": 0.05
    },
    "fine_delay_rate": {
        "interest_base": "calendar_days_365", 
        "monthly_rate": 0.01
    },
    "contract_fine_rate": 0.02,
    "fees": [
        {
            "amount": 5,
            "amount_type": "percentage",
            "fee_type": "bookkeeping_fee"
        }
    ],
}

Request Body Params

Field	Type	Description	Max Characters
interest_type *	string	Applied interest type.	interest_type Enumerators
financial_base_date *	string	Operation base date (format "YYYY-MM-DD").	-
released_amount *	number	Total amount released in the operation.	-
number_of_installments *	integer	Total number of installments.	-
prefixed_interest_rate *	object	Object containing prefixed interest rate details.	prefixed_interest_rate Object
fine_delay_rate *	object	Object containing delay fine details.	fine_delay_rate Object
contract_fine_rate *	number	Contractual fine applied in percentage.	-
fees	array	List of fees associated with the operation.	fees Object

prefixed_interest_rate Object

Field	Type	Description	Max Characters
interest_base *	string	Calculation base for interest.	interest_base Enumerators
monthly_rate *	number	Applied monthly interest rate.	-

fine_delay_rate Object

Field	Type	Description	Max Characters
interest_base *	string	Base for fine calculation.	interest_base Enumerators
monthly_rate *	number	Monthly fine rate.	-

fees Object

Field	Type	Description	Max Characters
amount *	number	Applied fee value.	-
amount_type *	string	Fee value type.	amount_type Enumerators
fee_type *	string	Fee type.	fee_type Enumerators
type *	string	Fee recipient.	fee_recipient Enumerators

interest_type Enumerators

Enum	Description
pre_price	Prefixed interest in Price model.
pre_price_days	Prefixed interest in Price model by calendar days.
pre_sac	Prefixed interest in SAC model.
post_sac	Post-fixed interest in SAC model.

interest_base Enumerators

Enum	Description
calendar_days	Calendar days base.
calendar_days_365	365 calendar days base.
workdays	Business days base.

amount_type Enumerators

Enum	Description
percentage	Percentage value.
absolute	Absolute value in currency.

fee_type Enumerators

Enum	Description
implementation_fee	Implementation fee.
implementation_fee_financed	Financed implementation fee.

fee_recipient Enumerators

Enum	Description
internal	Fee paid to the bookkeeper.
external	Rebate paid to the originator.

Response

STATUS

200

Response Body

{
    "financial_base_date": "2025-01-20",
    "issue_amount": 1075268.82,
    "released_amount": 1000000.0,
    "issue_quantity": 1075268,
    "unit_price": 1.00000076,
    "cet": 7.7,
    "annual_cet": 143.55,
    "number_of_installments": 5,
    "prefixed_interest_rate": {
        "interest_base": "calendar_days_365",
        "monthly_rate": 0.05,
        "daily_rate": 0.0016053474,
        "annual_rate": 0.795856326
    },
    "fees": [
        {
            "amount": 2.0,
            "fee_amount": 21505.38,
            "amount_type": "percentage",
            "fee_type": "implementation_fee_financed",
            "type": "internal"
        },
        {
            "amount": 5.0,
            "fee_amount": 53763.44,
            "amount_type": "percentage",
            "fee_type": "implementation_fee_financed",
            "type": "external"
        }
    ],
    "installments": [
        {
            "installment_number": 1,
            "workdays": 23,
            "calendar_days": 31,
            "principal_amortization_amount": 193292.79655634,
            "principal_amortization_unit_price": 0.17976244,
            "interest_amount": 54820.37344366,
            "amount": 248113.17,
            "due_principal": 1075268.82,
            "due_interest": 0.0,
            "due_date": "2025-02-20",
            "has_interest": true
        },
        {
            "installment_number": 2,
            "workdays": 18,
            "calendar_days": 28,
            "principal_amortization_amount": 207597.32873049,
            "principal_amortization_unit_price": 0.19306566,
            "interest_amount": 40515.84126951,
            "amount": 248113.17,
            "due_principal": 881976.02344366,
            "due_interest": 0.0,
            "due_date": "2025-03-20",
            "has_interest": true
        },
        {
            "installment_number": 3,
            "workdays": 21,
            "calendar_days": 33,
            "principal_amortization_amount": 211453.91638185,
            "principal_amortization_unit_price": 0.19665229,
            "interest_amount": 36659.25361815,
            "amount": 248113.17,
            "due_principal": 674378.69471317,
            "due_interest": 0.0,
            "due_date": "2025-04-22",
            "has_interest": true
        },
        {
            "installment_number": 4,
            "workdays": 19,
            "calendar_days": 28,
            "principal_amortization_amount": 226847.52746545,
            "principal_amortization_unit_price": 0.21096836,
            "interest_amount": 21265.64253455,
            "amount": 248113.17,
            "due_principal": 462924.77833132,
            "due_interest": 0.0,
            "due_date": "2025-05-20",
            "has_interest": true
        },
        {
            "installment_number": 5,
            "workdays": 22,
            "calendar_days": 31,
            "principal_amortization_amount": 236077.25086587,
            "principal_amortization_unit_price": 0.21955201,
            "interest_amount": 12035.91913413,
            "amount": 248113.17,
            "due_principal": 236077.25086587,
            "due_interest": 0.0,
            "due_date": "2025-06-20",
            "has_interest": true
        }
    ],
    "fine_delay_rate": {
        "interest_base": "calendar_days_365",
        "monthly_rate": 0.01
    },
    "contract_fine_rate": 0.02
}

Response Body Params

Field	Type	Description	Max Characters
financial_base_date *	string	Operation financial base date (format "YYYY-MM-DD").	-
issue_amount *	number	Total issued amount of the operation.	-
released_amount *	number	Net amount released in the operation.	-
issue_quantity *	integer	Total quantity of units issued.	-
unit_price *	number	Unit price of the issuance.	-
cet *	number	Total Effective Cost (CET) in percentage.	-
annual_cet *	number	Annual CET in percentage.	-
number_of_installments *	integer	Total number of installments.	-
prefixed_interest_rate *	object	Object containing prefixed interest rate details.	prefixed_interest_rate Object
fees	array	List of fees associated with the operation.	fees Object
installments	array	List of installment details generated in the operation.	installments Object
fine_delay_rate *	object	Object containing delay fine details.	fine_delay_rate Object
contract_fine_rate *	number	Contractual fine applied in percentage.	-

prefixed_interest_rate Object

Field	Type	Description	Max Characters
interest_base *	string	Calculation base for interest.	interest_base Enumerators
monthly_rate *	number	Applied monthly interest rate.	-
daily_rate *	number	Applied daily interest rate.	-
annual_rate *	number	Applied annual interest rate.	-

fees Object

Field	Type	Description	Max Characters
amount *	number	Percentage value of the fee.	-
fee_amount *	number	Monetary value corresponding to the fee.	-
amount_type *	string	Fee value type.	amount_type Enumerators
fee_type *	string	Fee type.	fee_type Enumerators
type *	string	Fee recipient.	fee_recipient Enumerators

installments Object

Field	Type	Description
installment_number *	integer	Installment number.
workdays *	integer	Business days until installment due date.
calendar_days *	integer	Calendar days until installment due date.
principal_amortization_amount *	number	Principal amortized amount.
principal_amortization_unit_price *	number	Amortized amount per unit.
interest_amount *	number	Interest amount applied in the installment.
amount *	number	Total installment amount.
due_date *	string	Installment due date (format "YYYY-MM-DD").