Pular para o conteúdo principal

Cadastro de Ativos - Emissões


Criação - Nota Comercial​

Utilizando o endpoint a seguir, é possível cadastrar uma nova nota no orquestrador de ativos estruturados.

Os ativos cadastrados surgem no status pre_operational para que sejam submetidos os documentos relacionados ao ativo. Deste modo, é possível pré cadastrar um ativo e habilitá-lo para operação somente após as devidas formalizações estarem concluídas, como detalhado no próximo segmento.

A seguir consta uma listagem explicativa dos campos, e o detalhamento de suas obrigatoriedades e tipos.

Request​

ENDPOINT
/security/security
MÉTODO
POST
Request Body
{
"external_id": "string",
"asset_type": "commercial_paper",
"b3_code":"25M000000",
"isin_code":"BR00ABCDE000",
"contract_number": "SCR12345",
"ipoc_code": "string",
"maturity_date": "YYYY-MM-DD",
"allowed_managers": ["00.000.000/0000-00", "00.000.000/0000-00", "00.000.000/0000-00"],
"allowed_consultants": ["00.000.000/0000-00", "00.000.000/0000-00", "00.000.000/0000-00"],
"issuer_document_number": "00.000.000/0000-00",
"bookkeeper_document_number": "00.000.000/0000-00",
"number_of_units": 1,
"principal_unit_price": 1000000.00,
"issue_value": 1000000.00,
"issue_unit_price": 1000000.00,
"issue_date": "YYYY-MM-DD",
"amortization_type": "sac",
"installments": [
{
"installment_number": 1,
"maturity_date": "YYYY-MM-DD",
"principal_unit_price": 1000000.00,
"face_unit_price": 1010000.00,
"amortization_percentage": 1
}
],
"delay": {
"fine": {
"fine_type": "percentage",
"percentage_value": 0.0
},
"interest": {
"method": "compound",
"pre_fixed": {
"monthly_rate": 0.0,
"calendar_base": "calendar_360"
}
}
},
"pre_fixed": {
"monthly_rate": 0.01,
"calendar_base": "calendar_360"
},
"post_fixed": {
"lag": {
"amount": 1,
"reference": "daily"
},
"rate": 1,
"indexer": "di",
"calendar_base": "workdays"
}
}

Definições​

Objeto Ativo (Request Body)​

CampoTipoDescriçãoObrigatório
asset_typestringEnumerador que determina o Tipo de AtivoSim
external_idstringIdentificador externo do ativo; Chave utilizada para acessar a entidadeSim
b3_codestringCódigo cetip do ativoNão
isin_codestringCódigo ISIN (International Securities Identification Number)Não
ipoc_codestringCódigo IPOC do ativoNão
allowed_managerslistLista com CNPJ's de gestores com permissão de operar na emissãoNão
allowed_consultantslistLista com CNPJ's de consultores com permissão de operar na emissãoNão
issuer_document_numberstringNúmero do CNPJ ou CPF do emissorSim
bookkeeper_document_numberstringNúmero do CNPJ do escrituradorSim
number_of_unitsfloatNúmero de unidadesSim
issue_unit_pricefloatPreço unitário na emissãoSim
issue_valuefloatValor do ativo na emissãoSim
principal_unit_pricefloatValor unitário de princial do ativo na emissãoSim
issue_datestringData de emissão no formato YYYY-MM-DDSim
disbursement_datestringData de emissão no formato YYYY-MM-DDSim
amortization_typestringEnumerador de Tipo de AmortizaçãoSim
contract_numberstringNúmero do contratoSim
maturity_datestringData de vencimento do ativoSim
installmentsdictObjeto de parcelasSim
delaydictObjeto de atrasoSim
pre_fixeddictObjeto de pré fixadoSim
post_fixeddictObjeto de pós fixadoNão

Enumerador Tipo de Ativo​

EnumeradorDescrição
commercial_paperAtivo do tipo Nota Comercial
debentureAtivo do tipo Debênture
criAtivo do tipo CRI
craAtivo do tipo CRA

Enumerador Tipo de Amortização​

EnumeradorDescrição
sacAmortização do tipo SAC
priceAmortização do tipo Price

Objeto de Parcela​

CampoTipoDescriçãoObrigatório
installment_numberintNúmero da ParcelaSim
maturity_datestringData de Vencimento no formato YYYY-MM-DDSim
principal_unit_pricefloatValor de principal unitário do ativoSim
face_unit_pricefloatValor de face unitário do ativoSim
amortization_percentagefloatPorcentagem de AmortizaçãoNão

Objeto Atraso​

CampoTipoDescriçãoObrigatório
fineobjectObjeto da multa no vencimento. Ver Objeto Multa de Atraso.Sim
interestobjectObjeto do juros de mora. Ver Objeto Juros de Mora.Sim

Objeto Multa de Atraso​

CampoTipoDescriçãoObrigatório
fine_typestringTipo de Multa.Sim
percentage_valuenumberValor da Multa, se tipo da multa for percentage. Unidade de medida: de 0 à 1, considerando 0 à 100%Sim
amountnumberValor da Multa, se tipo de multa for fixed.Sim
Enumerador Tipo da Multa​
EnumeradorDescrição
percentageMulta percentual sobre o valor da parcela
fixedValor fixo de Multa

Objeto Juros de Mora​

CampoTipoDescriçãoObrigatório
method *stringVer Enumerador Método do Juros de Mora.Sim
pre_fixed *objectVer Objeto de Pré Fixado.Sim
Enumerador Método do Juros de Mora​
EnumeradorDescrição
compoundPara juros de mora composto
simplePara juros de mora simples

Objeto Pré Fixado​

CampoTipoDescriçãoObrigatório
calendar_base *stringA base de cálculo utilizada.enumerator
monthly_rate *numberA taxa mensal do contrato. Para 1% usar 0.01Até 8 casas decimais

Objeto Pós Fixado​

CampoTipoDescriçãoObrigatório
rateintTaxa fixa aplicadaSim
indexerstringÍndice de referência da correção (di, ipca)Sim
calendar_basestringTipo de calendário consideradoSim

Objeto de Lag​

CampoTipoDescriçãoObrigatório
amountintQuantidade de unidades de defasagemSim
referencestringUnidade de tempo de defasagemSim

Enumerador Base de Cálculo​

EnumeradorDescrição
dailyPara valores diários de atraso
monthlyPara valores mensais de atraso

Enumerador Referência de Atraso​

EnumeradorDescrição
workdaysPara base de cálculo dias úteis (252)
calendar_365Para base de cálculos 365
calendar_360Para base de cálculos 360

Response​

STATUS
201
Response Body
{
"security_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"status": "pre_operational",
}