TxUnits Property
The quantity for security-based actions other than stock splits.
Syntax
invstatement.getTxUnits(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 getTxUnits([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 setTxUnits([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
The quantity for security-based actions other than stock splits. The TxUnits differ for each type of security.
Depending on the type of the security, the TxUnits indicates the following:
- Stocks, Mutual Funds and Other : number of shares.
- Bonds : face value. For example, a $25,000 bond trading at $88 would use 25000 as the units and 88 as the unit price.
- Options : number of contracts (not shares).
This property is always returned with the transaction information if such an information is requested to be included (IncludeTransactions was set to True) in the investment statement download request (when calling the GetStatement method).
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