IAssetsMarketsIncomeDividend Properties

Stator | API Documentation

The IAssetsMarketsIncomeDividend type exposes the following members.

Properties

  NameDescription
Public propertyBaseTypeIdentifier
The base type identifier for the ticker.
i.e. X_AUS_ASX = Australian Stock Exchange
(Inherited from IAssetsMarketsIncome.)
Public propertyCashAccountUniqueIdentifier
A unique identifier for the cash account which the cash transaction will be assigned to.
For reference see: UniqueIdentifier
(Inherited from IAssetsMarketsIncome.)
Public propertyCompanyTaxRate
The company tax rate for the dividend.
Public propertyCreateCashTransaction
True if you would like a cash transaction to be created for this income item.
(Inherited from IAssetsMarketsIncome.)
Public propertyCurrencyCode
The currency code for the ticker (three letter ISO Code, i.e. AUD, USD).
(Inherited from IAssetsMarketsIncome.)
Public propertyEstateUniqueIdentifier
A unique identifier for the estate which the income belongs to.
For more information regarding unique identifiers see: UniqueIdentifier
(Inherited from IAssetsMarketsIncome.)
Public propertyExchangeRateToAccount
An exchange rate between the income currency and the cash account currency.
Known as the Income Account Exchange Rate
(Inherited from IAssetsMarketsIncome.)
Public propertyExchangeRateToEstate
An exchange rate between the income item currency and the estate currency.
Known as the Income Exchange Rate
(Inherited from IAssetsMarketsIncome.)
Public propertyFrankedAmount
The franked amount for the dividend.
Public propertyFrankedPercent
The franked percent for the dividend.
Public propertyGrossAmount
The gross amount for the dividend.
Public propertyImputationCredit
The imputation credits for the dividend.
Public propertyIncomeDate
The date/time for the income item (when the income event occured).
(Inherited from IAssetsMarketsIncome.)
Public propertyIncomeEventType
The event type for the income item.
(Inherited from IAssetsMarketsIncome.)
Public propertyIncomeStatus
The status for the income item.
Setting this enumeration will result in different import actions.
(Inherited from IAssetsMarketsIncome.)
Public propertyNetAmount
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
Public propertyOpenPositionEntryPrice
The entry price for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.)
Public propertyOpenPositionInstrument
The trading instrument for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.)
Public propertyOpenPositionQuantity
The quantity for the reinvested open position (if applicable).
(Inherited from IAssetsMarketsIncome.)
Public propertyQuantity
The quantity for the income.
(Inherited from IAssetsMarketsIncome.)
Public propertyRatePerUnit
The rate per unit for the income (cents per unit).
(Inherited from IAssetsMarketsIncome.)
Public propertyTickerCode
The ticker code for the income item, i.e. MSFT = Microsoft.
(Inherited from IAssetsMarketsIncome.)
Public propertyUnfrankedAmount
The unfranked amount for the dividend.
Public propertyUniqueIdentifier
Unique identifier for this income item.
(Inherited from IAssetsMarketsIncome.)
Public propertyWithholdingTax
The withholding tax for the dividend.
Top
See Also

Reference