IPWorks OFX 2020 Node.js Edition

Questions / Feedback?

PosUnits Property

Quantity of positions.

Syntax

 invstatement.getPosUnits(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 getPosUnits([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 setPosUnits([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

Quantity of positions. Depending on the type of sub-account where this position takes place, this indicates the following:

Stocks, Market Funds, Other,Number of shares held
BondsThe face value
OptionsNumber of contracts

This property is always returned with the positions information if such an information is requested to be included (IncludePositions 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 PosCount property.

This property is read-only and not available at design time.

Data Type

String

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Node.js Edition - Version 20.0 [Build 7941]