TxTypeDescription Property
A description of the transaction type.
Syntax
invstatement.getTxTypeDescription(index, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getTxTypeDescription([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setTxTypeDescription([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
A description of the transaction type. This is a string representation of the value returned by the TxType property.
The types and their meanings are as follows:
| ttBUYDEBT (0) | Buy debt security |
| ttBUYMF (1) | Buy mutual fund (being switched to). |
| ttBUYOPT (2) | Buy option |
| ttBUYOTHER (3) | Buy other security type |
| ttBUYSTOCK (4) | Buy stock |
| ttCLOSUREOPT (5) | Close a position for an option |
| ttINCOME (6) | Investment income is realized as cash into the investment account |
| ttINVEXPENSE (7) | Misc. investment expense that is associated with a specific security |
| ttJRNLFUND (8) | Journaling cash holdings between sub-accounts |
| ttJRNLSEC (9) | Journaling security holdings between sub-accounts |
| ttMARGININTEREST (10) | Margin interest expense |
| ttREINVEST (11) | Reinvestment of income |
| ttRETOFCAP (12) | Return of capital |
| ttSELLDEBT (13) | Sell debt security |
| ttSELLMF (14) | Sell mutual fund |
| ttSELLOPT (15) | Sell option |
| ttSELLOTHER (16) | Sell other type of security |
| ttSELLSTOCK (17) | Sell stock |
| ttSPLIT (18) | Stock or Mutual Fund Split |
| ttTRANSFER (19) | Transfer holdings |
| ttINVBANKTRAN (20) | Bank transactions |
| ttOTHER (255) | Other |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.
This property is read-only and not available at design time.
Data Type
String