Skip to main content

Portfolio

Portfolio is the entity meant to store all transactional information in Gorila, which can be entered via the API or the front-end, or calculated and generated by Gorila's own engine.

The portfolioId is the unique identifier of each portfolio. Portfolios can be given nicknames (or control IDs) to make it easier to keep track of the portfolios created.

Portfolio status​

The portfolio status indicates the current processing state of the transactions that make up the portfolio. It is set to PROCESSING when one or more transactions within the portfolio are still in the calculation and validation phase. During this stage, Gorila's engine is performing all the calculations and checks needed to ensure that the transactions are correctly reflected in the portfolio. Once all transactions in the portfolio reach the COMPLETED status, the portfolio status also changes to COMPLETED, indicating that all transactions have been fully and accurately processed and integrated into the portfolio. This status update process ensures that the portfolio is always consistent and up to date, correctly reflecting all the operations performed.

Cash components and provisions​

Gorila's calculation engine always takes the account's cash components and provisions into account in its calculations, in order to produce consistent results.

However, not all cash components are the same. Below, we explain the differences between them.

  • Security cash flow​

    This type of cash component is automatically generated by our engine and is part of the security's modeling. An example would be a stock that pays dividends; on the date the stock goes ex-dividend, a credit provision 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 of any asset class in any currency.

  • Contributions and redemptions​

    This cash component relates to the money that flows into and out of a given portfolio. Using the analogy of a fund, it is the money that an investor contributes/deposits into the fund when they want to invest, or the money that an investor redeems/withdraws from a fund when they want to divest.

    Information about this cash component is not always available, easily accessible, or accurate and identifiable. It is often mixed with other cash components. Given the low availability and quality of this information in the market, we created an autoRnC property that lets you set contributions and redemptions as manual or automatic.

    Manual contributions and redemptions (autoRnC = False)​

    This is the default option, which means the user needs to provide all the information related to the contributions and redemptions of each portfolio; therefore, the user needs accurate information so that we can produce consistent results.

    Automatic contributions and redemptions (autoRnC = True)​

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

    It is worth noting that the autoRnC parameter does not affect what happens to the security's cash flow: in both cases, we always automatically generate all of the security's "endogenous" cash flow.

Automatic come-cotas​

It is also possible to create portfolios in which there is no need to manually enter come-cotas information for funds subject to this taxation. When creating a portfolio, you can use the autoComeCotas parameter with the value true, and every time a transaction of an eligible fund is entered in the past, all come-cotas will be calculated and recorded in the portfolio. When the last business day of the come-cotas semester arrives (in May and November), a come-cotas is automatically created. Even with this parameter turned on, if a come-cotas is manually registered in a given semester, the manual entry will prevail over the automatic one if it is registered on the correct date (last business day of May and November).

Investment profile​

Each portfolio can be associated with an investment profile, a target allocation used to measure the portfolio's target allocation compliance. The association is made through the investmentProfileId field when updating the portfolio, and the associated profile is returned in the investmentProfile field.

Properties restricted to GorilaVIEW​

Some portfolio properties are important due to their relationship with GorilaVIEW.

Alias​

In GorilaVIEW, it is possible to "nickname" a shared portfolio. For example, if a user shares a portfolio called "José's Portfolio" and your organization names portfolios using codes or another internal identification, it is possible to override this portfolio's name. What actually happens is that the alias property is filled in. Use this property to change how the name appears within GorilaVIEW, and also if you want to keep your own naming record.

Connected portfolio and deletion of connected portfolios​

Through GorilaVIEW's portfolio sharing feature, a portfolio that belongs to another user can appear in the organization to which it was connected or shared. This is what the portfolio's connected property determines. However, the owner (OWNER) of this portfolio is not your organization. Your organization (the one that received the share) has EDITOR permission on this portfolio and, therefore, cannot delete the portfolio.

To remove the portfolio from your organization, you need to cancel the sharing through GorilaVIEW. Only authorized users and organization administrators can do this.

Where to access​

In GorilaCORE, you can create, list, read, update and delete portfolios. The list endpoint lets you search portfolios by name and filter by creation date.