IAssetsMarketsIncome Interface

public interface IAssetsMarketsIncome

Public Interface IAssetsMarketsIncome

public interface class IAssetsMarketsIncome

type IAssetsMarketsIncome =  interface end

The IAssetsMarketsIncome type exposes the following members.

	Name	Description
	BaseTypeIdentifier	The base type identifier for the ticker. i.e. X_AUS_ASX = Australian Stock Exchange
	CashAccountUniqueIdentifier	A unique identifier for the cash account which the cash transaction will be assigned to. For reference see: UniqueIdentifier
	CreateCashTransaction	True if you would like a cash transaction to be created for this income item.
	CurrencyCode	The currency code for the ticker (three letter ISO Code, i.e. AUD, USD).
	EstateUniqueIdentifier	A unique identifier for the estate which the income belongs to. For more information regarding unique identifiers see: UniqueIdentifier
	ExchangeRateToAccount	An exchange rate between the income currency and the cash account currency. Known as the Income Account Exchange Rate
	ExchangeRateToEstate	An exchange rate between the income item currency and the estate currency. Known as the Income Exchange Rate
	IncomeDate	The date/time for the income item (when the income event occured).
	IncomeEventType	The event type for the income item.
	IncomeStatus	The status for the income item. Setting this enumeration will result in different import actions.
	OpenPositionEntryPrice	The entry price for the reinvested open position (if applicable).
	OpenPositionInstrument	The trading instrument for the reinvested open position (if applicable).
	OpenPositionQuantity	The quantity for the reinvested open position (if applicable).
	Quantity	The quantity for the income.
	RatePerUnit	The rate per unit for the income (cents per unit).
	TickerCode	The ticker code for the income item, i.e. MSFT = Microsoft.
	UniqueIdentifier	Unique identifier for this income item.

Why is this interface required?
This interface allows you to import an income item into Stator. It specifies properties which are common to all
income items, i.e. dividends, trust distributions.

Inherited by:
IAssetsMarketsIncomeDividend
IAssetsMarketsIncomeTrustDistribution

What is an income item?
An income item can be a dividend or trust distribution usually paid out as a result of owning stock.

Reference