Events for custom securities
You can now register and manage the events of your custom securities, such as expiration, amortization, interest and dividends, so that they are reflected in the positions, Profit & Loss and returns of your portfolios.
New endpoints:
- Create Security Event: registers one event per request.
- List Security Custom Events: lists the registered events, with filters by period (
startDate,endDate) and type (types). - Update Security Event and Delete Security Event: update and delete an event.
Supported types:
- Expiration (
EXPIRATION), with the settlement price (settlementPrice). It closes the positions in the security on the event date, and each security can have only one. - Cash events (
CASH_AMORTIZATION,CASH_AMORTIZATION_UNSCHEDULED,CASH_DIVIDEND,CASH_INCOME,CASH_INTEREST,CASH_JSCP,CASH_PREMIUMandCASH_RETURN_OF_CAPITAL), with the amount paid per unit of the security (unitValue).
Every event has a reference date (referenceDate) and a payment date (paymentDate), which cannot be earlier than the reference date.
// REQUEST
// POST https://core.gorila.com.br/securities/{securityId}/events
{
"type": "CASH_AMORTIZATION",
"referenceDate": "2024-01-31",
"paymentDate": "2024-02-05",
"unitValue": 2.5
}
Learn more in Custom Security.