v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Simular operação

Simulação de operação de crédito (CCB e Nota comercial).

post/laas/v2/simulation/{credit_type}

Path parameters

credit_type'ccb' | 'nc' required

Tipo de operação de crédito que será simulada.

Query parameters

save_as_draftboolean

Determina se a simulação deve ser salva para utilização posterior.

Request body

amortization_rule'252-business-days' | '360-calendar-days' | '365-calendar-days' | 'by-period' required

Regra de dias considerados para amortização.

amortization_table'price' | 'sac' required

Sistema de amortização da operação.

contract_datestring date required

Data de ínicio do contrato de crédito. Deve ser sempre igual ou maior a data de simulação.

first_installment_datestring date required

Data de vencimento para a primeira parcela.

installments_quantityinteger required

Número total de parcelas da operação.

installment_amountnumber double

Valor da parcela da operação de crédito. Se informado, o parâmetro tax_percentage não pode ser incluído na simulação.

indication'pre-fixed' | 'pos-fixed' required

Natureza da taxa de juros da operação.

partner_idstring required

Uuid do parceiro bancarizador ou escriturador, a depender do tipo de operação de crédito.

payments_frequency'monthly' | 'biweekly' | 'weekly' | 'annually' | 'daily' required

Frequência no pagamento de parcelas da operação de crédito.

valuenumber double required

Valor total da operação de crédito.

tax_percentagenumber double

Taxa de juros aplicada a operação de crédito. Se informado, o parâmetro installmente_amount não pode ser incluído na simulação.

waiting_periodinteger

Tempo de carência para iniciar o pagamento de uma operação. Deve ser sempre menor que o número máximo de parcelas da operação e durante o período de carência, serão cobrados apenas os juros da operação.

person_type'natural_person' | 'legal_person' required

Tipo de tomador de crédito (PF ou PJ).

indexer'ipca' | 'cdi' | 'cdi+' | 'igpm'

Indexador de juros da operação. Obrigatório caso a operação utilize juros pós-fixados: indication = pos-fixed.

percentual_comissionnumber double

Valor percentual da comissão que o credor receberá. A comissão deverá ser acordada com o time comercial da Grafeno para que fique disponível para uso.

type_of_calculation'net_value' | 'gross_value' required

Base de cálculo da operação.

include_daily_databoolean

Indica se a simulação irá retornar ou não dados diários de custos e juros.

Response

201

simulation_idstring

Example response

{
  "simulation_id": "9a050836-5252-4f92-9740-49bf4b9fe688"
}