Skip to main content

Portfolio

Portfolio is the entity meant to hold all transactional information at Gorila, inputted either via the API, Front-end or calculated by Gorila's engine.

The portfolioId is the unique identifier of each portfolio.

Portfolios can receive nicknames to help the API's user keep track of its created Portfolios.

Cash components and provisions​

Gorila's portfolio engine always takes under consideration the account's cash components and provisions in its calculations in order to output consistent results.

However, not all cash components are created equal. We divide the cash components into different categories:

  • Product cashflow​

    This type of cash component is generated automatically by our engine. It is a part of the modeling of securities. An example would be a stock that pays a dividend; on the date the stock is ex-dividend, a provision of credit is created, and on the day the company settles that dividend, this provision becomes a cash balance. This is a simple example, but it holds true for any security from any asset class in any currency.

  • Contributions and redemptions​

    This cash component has to do with the money that flows in and out of a given portfolio. Using the analogy of a fund, it is the cash that an investor contributes/deposits to the fund when he wants to invest or the cash that an investor redeems/withdraws from a fund when he wants to divest.

    Because the information available regarding the transactions of this cash component is not always accurate or tagged, it is usually mixed with other cash components. We created a property autoRnC that lets you set the contributions and redemptions to manual or automatic.

    Manual contributions and redemptions (autoRnC=False)​

    This is the default option, meaning the user needs to provide all information related to contributions and redemptions to the portfolio, so the user needs accurate information.

    Automatic contributions and redemptions (autoRnC=True)​

    This is the option used by users that do not have accurate information about the contributions and redemptions. What this option does, is it keeps the cash impact of a given transaction at 0. For example, suppose the user buys a security worth BRL 100,000.00 that settles in t+2. In that case, our engine will automatically generate a cash contribution in t+2 that will be used to settle the transaction, keeping the cash impact from that transaction at 0.