Simulação de condições financeiras

Este endpoint permite simular as condições financeiras e o fluxo de pagamentos de uma operação

---

Request

ENDPOINT

/commercial_paper/simulation

MÉTODO

POST

Request Body

Response Body

{
    "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"
        }
    ]
}

Response Body Params

Campo	Tipo	Descrição	Caracteres Máx.
interest_type *	string	Tipo de juros aplicado.	Enumeradores interest_type
financial_base_date *	string	Data base da operação (formato "YYYY-MM-DD").	-
released_amount *	number	Valor total liberado na operação.	-
number_of_installments *	integer	Número total de parcelas.	-
prefixed_interest_rate *	object	Objeto contendo detalhes da taxa de juros prefixada.	Objeto prefixed_interest_rate
fine_delay_rate *	object	Objeto contendo detalhes da multa por atraso.	Objeto fine_delay_rate
contract_fine_rate *	number	Multa contratual aplicada em percentual.	-
fees	array	Lista de taxas associadas à operação.	Objeto fees

Objeto prefixed_interest_rate

Campo	Tipo	Descrição	Caracteres Máx.
interest_base *	string	Base de cálculo para os juros.	Enumeradores interest_base
monthly_rate *	number	Taxa de juros mensal aplicada.	-

Objeto fine_delay_rate

Campo	Tipo	Descrição	Caracteres Máx.
interest_base *	string	Base para cálculo da multa.	Enumeradores interest_base
monthly_rate *	number	Taxa de multa mensal.	-

Objeto fees

Campo	Tipo	Descrição	Caracteres Máx.
amount *	number	Valor da taxa aplicada.	-
amount_type *	string	Tipo do valor da taxa.	Enumeradores amount_type
fee_type *	string	Tipo da taxa.	Enumeradores fee_type
type *	string	Destinatário da taxa.	Enumeradores fee_recipient

Enumeradores interest_type

Enum	Descrição
pre_price	Juros pré-fixados no modelo Price.
pre_price_days	Juros pré-fixados no modelo Price por dias corridos.
pre_sac	Juros pré-fixados no modelo SAC.
post_sac	Juros pós-fixados no modelo SAC.

Enumeradores interest_base

Enum	Descrição
calendar_days	Base de dias corridos.
calendar_days_365	Base de 365 dias corridos.
workdays	Base de dias úteis.

Enumeradores amount_type

Enum	Descrição
percentage	Valor em percentual.
absolute	Valor absoluto em moeda.

Enumeradores fee_type

Enum	Descrição
implementation_fee	Taxa de implementação.
implementation_fee_financed	Taxa de implementação financiada.

Enumeradores fee_recipient

Enum	Descrição
internal	Taxa paga ao escriturador.
external	Rebate pago ao originador.

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

Campo	Tipo	Descrição	Caracteres Máx.
financial_base_date *	string	Data base financeira da operação (formato "YYYY-MM-DD").	-
issue_amount *	number	Valor total emitido da operação.	-
released_amount *	number	Valor líquido liberado na operação.	-
issue_quantity *	integer	Quantidade total de unidades emitidas.	-
unit_price *	number	Preço unitário da emissão.	-
cet *	number	Custo Efetivo Total (CET) em percentual.	-
annual_cet *	number	CET anual em percentual.	-
number_of_installments *	integer	Número total de parcelas.	-
prefixed_interest_rate *	object	Objeto contendo detalhes da taxa de juros prefixada.	Objeto prefixed_interest_rate
fees	array	Lista de taxas associadas à operação.	Objeto fees
installments	array	Lista de detalhes das parcelas geradas na operação.	Objeto installments
fine_delay_rate *	object	Objeto contendo detalhes da multa por atraso.	Objeto fine_delay_rate
contract_fine_rate *	number	Multa contratual aplicada em percentual.	-

Objeto prefixed_interest_rate

Campo	Tipo	Descrição	Caracteres Máx.
interest_base *	string	Base de cálculo para os juros.	Enumeradores interest_base
monthly_rate *	number	Taxa de juros mensal aplicada.	-
daily_rate *	number	Taxa de juros diária aplicada.	-
annual_rate *	number	Taxa de juros anual aplicada.	-

Objeto fees

Campo	Tipo	Descrição	Caracteres Máx.
amount *	number	Valor percentual da taxa.	-
fee_amount *	number	Valor monetário correspondente à taxa.	-
amount_type *	string	Tipo do valor da taxa.	Enumeradores amount_type
fee_type *	string	Tipo da taxa.	Enumeradores fee_type
type *	string	Destinatário da taxa.	Enumeradores fee_recipient

Objeto installments

Campo	Tipo	Descrição
installment_number *	integer	Número da parcela.
workdays *	integer	Dias úteis até o vencimento da parcela.
calendar_days *	integer	Dias corridos até o vencimento da parcela.
principal_amortization_amount *	number	Valor amortizado do principal.
principal_amortization_unit_price *	number	Valor amortizado por unidade.
interest_amount *	number	Valor dos juros aplicados na parcela.
amount *	number	Valor total da parcela.
due_date *	string	Data de vencimento da parcela (formato "YYYY-MM-DD").