Asset
This page contains all relevant terminology regarding Assets.
Asset
Definition
Assets represent everything that has value. The possible types of individual assets are:
- Stock
- Bond
- Loan
- Fund
- ETF
- Certificate
- Option
- Warrant
Each Label can specify per asset what type of actions (e.g., buying, selling and reinvesting) are allowed for that asset.
Within GiroPro, each individual Asset is linked to 5 Ledgers:
- AssetLedger (for counting bought units of the Asset).
- CashLedger (for counting Cash coming from the trade of the Asset).
- AssetReservedLedger (for counting units of the Asset that are set to be sold).
- CashReservedLedger (for counting Cash reserved for the buying of the Asset).
- AssetDividendLedger (for counting Dividend that has been reserved before payout).
Each of these Ledgers represent the Label side of the Asset bookkeeping process.
Relevant endpoints
- POST /Assets
- GET /AssetGetById/{labelId}/{assetId}
- POST /AssetAdd
- PUT /AssetUpdate
- DELETE /AssetDeleteById/{labelId}/{assetId}
- POST /Prices
- POST /PriceAdd
AssetMix
Definition
Next to individual Assets, there is also the option to create AssetMixes. An AssetMix combines AssetMixRecords (several individual Assets) into a collection for which it is specified for each AssetMixRecord what percentage of the total value of the AssetMix that AssetMixRecord should take up. An AssetMix should contain at least two AssetMixRecords.
AssetMixRecord
Definition
See AssetMix above.
Portfolio
Definition
A Portfolio is the collection of all Assets that at a certain point in time are in possession of an Investor and registered in their InvestorAccount.
Relevant endpoints
- GET /PortfolioGetByInvestorAccountId/{labelId}/{investorAccountId}
- POST /PortfolioAdd
- PUT /PortfolioUpdate
PortfolioMixRecord
Definition
A PortfolioMixRecord specifies how many units (this does not have to be an integer amount because GiroPro allows fractional investing) of one specific Asset are in possession of an Investor at a certain time. Just as with Assets, each PortfolioMixRecord is linked to 5 Ledgers (of the same types as mentioned above), only this time the Ledgers represent the Investor side of the bookkeeping process.
Rebalance
Definition
After having invested in an AssetMix for a certain period of time, the value of the individual AssetMixRecords will have changed. This causes the percentages of the total value of the AssetMix for each of the AssetMixRecords to be different from their corresponding desired percentages. For this purpose, an AssetMix can be rebalanced by selling units of one or more Assets for which the percentage is higher than desired and buying with these sale proceeds units of one or more Assets for which the percentage is lower than desired.
Market
Definition
Each Asset can be bought or sold through a specific Label at a specific Market. Each Market has its own CutoffTime, which is the time of day before which an Order needs to be placed for it to be included in the next trading round.
Relevant endpoints
- GET /Markets/{labelId}
- GET /MarketGetById/{labelId}/{marketId}
- POST /MarketAdd
- PUT /MarketUpdate
- DELETE /MarketDeleteById/{labelId}/{marketId}
MarketDay
Definition
Each Market has its own list of MarketDays, which are days upon which trades can be executed. This does not necessarily include all days that together form a year. A Market has a specific opening and closing time for each MarketDay. Usually, it is allowed to both buy and sell Assets on a certain MarketDay. In some cases, however, only one of these or neither are allowed, e.g., when a Label only allows Investors to sell Assets once every month but does allow them to always buy.
Relevant endpoints
GET /OrderGetOrderTotalByLabelIdAndMarketDayId/{labelId}
ProcessingDays
Definition
The ProcessingDays represent the number of days before the MarketDay, during which Investors are no longer allowed to add, delete or update Orders that are set to be executed on that MarketDay. Generally, the number of ProcessingDays is the same for all MarketDays (a default is set per Market), but it can be set individually per MarketDay.
CutoffTime
Definition
The CutoffTime represents the local Market time on the day that equals (MarketDay - ProcessingDays) after which Investors are no longer allowed to add, delete or update Orders that are set to be executed on the corresponding MarketDay. Generally, the CutoffTime is the same for all MarketDays (a default is set per Market), but it can be set individually per MarketDay.
Dividend
Definition
A Dividend is the distribution of some of a company’s earnings to a class of its shareholders, as determined by the board of directors. Common shareholders of dividend-paying companies are typically eligible if they have not sold the stock before the ex-dividend date (the first business day after the dividend is paid). Dividend can be paid out either in cash or in the form of additional stock.
Relevant endpoints
- PUT /CalculateDividendAssetEventProductTotals
- POST /DividendRecords
- GET /DividendRecordGetById/{labelId}/{dividendRecordId}
AssetEvent
Definition
An AssetEvent represents an event that concerns all the Investors from one Label that have invested in a specific Asset. Currently, an AssetEvent can be either the paying out of dividends or the rebalancing of an AssetMix (that was created by a Label). In the future, other events such as stock splitting and collective switching may also be added to the options.
Relevant endpoints
- POST /AssetEvents
- GET /AssetEventGetById/{labelId}/{assetEventId}
- POST /AssetEventAdd
- PUT /AssetEventUpdate
AssetPriceCorrection
Definition
It is possible that an ~AssetPrice~ has been entered into GiroPro with a wrong value or a wrong ~PriceDate~. In both of these cases, ~CorrectionOrders~ with Reverse (see ~Order MS~) will need to be created to correct either the wrong value or the wrong date in already existing Orders. In the case of a wrong ~AssetPrice~ value, UnitBased Sell OrderTrades with automatic payouts may have been executed with in correct payout amounts. SEPATransactions corrections may have to be performed. Because the ~AssetPrice~(Date) was only wrongly stored within GiroPro but not on the actual Market, the total number of Asset units on the Label level will remain the same so no correction trades will need to be performed.
Relevant endpoints
WithdrawDeposit
Definition
Sometimes one or multiple Assets need to be internally transferred from one InvestorAccount to another. This can happen for example in the case of a divorce. With a WithdrawDeposit, such a transfer is performed.
Relevant endpoints
- POST /WithdrawDeposits
- GET /WithdrawDepositGetById/{labelId}/{withdrawDepositId}
- POST /WithdrawDepositAdd
- PUT /WithdrawDepositCalculate
OngoingChargesFigure
Definition
The OngoingChargesFigure (OCF) is used to calculate fees that are paid by the InvestorAccount to the Label.