Interface which allows you to import a dividend income item (to be imported).
Assets > Markets > Income (Dividend)
Assets > Markets > Income (Dividend)
Namespace: Stator.libPublic.ImportPlugins.DataObjectInterfaces
Assembly: libPublic (in libPublic.dll) Version: 4.0.2018.0 (4.0.18103)
Syntax
The IAssetsMarketsIncomeDividend type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| BaseTypeIdentifier |
The base type identifier for the ticker. (Inherited from IAssetsMarketsIncome.)i.e. X_AUS_ASX = Australian Stock Exchange | |
| CashAccountUniqueIdentifier |
A unique identifier for the cash account which the cash transaction will be assigned to. (Inherited from IAssetsMarketsIncome.)For reference see: UniqueIdentifier | |
| CompanyTaxRate |
The company tax rate for the dividend.
| |
| CreateCashTransaction |
True if you would like a cash transaction to be created for this income item.
(Inherited from IAssetsMarketsIncome.) | |
| CurrencyCode |
The currency code for the ticker (three letter ISO Code, i.e. AUD, USD).
(Inherited from IAssetsMarketsIncome.) | |
| EstateUniqueIdentifier |
A unique identifier for the estate which the income belongs to. (Inherited from IAssetsMarketsIncome.)For more information regarding unique identifiers see: UniqueIdentifier | |
| ExchangeRateToAccount |
An exchange rate between the income currency and the cash account currency. (Inherited from IAssetsMarketsIncome.)Known as the Income Account Exchange Rate | |
| ExchangeRateToEstate |
An exchange rate between the income item currency and the estate currency. (Inherited from IAssetsMarketsIncome.)Known as the Income Exchange Rate | |
| FrankedAmount |
The franked amount for the dividend.
| |
| FrankedPercent |
The franked percent for the dividend.
| |
| GrossAmount |
The gross amount for the dividend.
| |
| ImputationCredit |
The imputation credits for the dividend.
| |
| IncomeDate |
The date/time for the income item (when the income event occured).
(Inherited from IAssetsMarketsIncome.) | |
| IncomeEventType |
The event type for the income item.
(Inherited from IAssetsMarketsIncome.) | |
| IncomeStatus |
The status for the income item. (Inherited from IAssetsMarketsIncome.)Setting this enumeration will result in different import actions. | |
| NetAmount |
The net amount for the dividend. If this field is set to 0 or omitted from the import Stator will automatically calculate the following fields: - Gross total - Franked amount - Unfranked amount - Imputation credit - Net total Stator will use the following fields to make the calculation - Quantity - Rate per unit (cents) - Company tax rate - Franked percent - Withholding tax | |
| OpenPositionEntryPrice |
The entry price for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.) | |
| OpenPositionInstrument |
The trading instrument for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.) | |
| OpenPositionQuantity |
The quantity for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.) | |
| Quantity |
The quantity for the income.
(Inherited from IAssetsMarketsIncome.) | |
| RatePerUnit |
The rate per unit for the income (cents per unit).
(Inherited from IAssetsMarketsIncome.) | |
| TickerCode |
The ticker code for the income item, i.e. MSFT = Microsoft.
(Inherited from IAssetsMarketsIncome.) | |
| UnfrankedAmount |
The unfranked amount for the dividend.
| |
| UniqueIdentifier |
Unique identifier for this income item.
(Inherited from IAssetsMarketsIncome.) | |
| WithholdingTax |
The withholding tax for the dividend.
|
Remarks
Why is this interface required?
This interface allows you to import a dividend income item into Stator.
See Also