IPWorks OFX 2020 Delphi Edition

Questions / Feedback?

PositionDetail Type

This type corresponds to a single investment position in the list of positions.

Remarks

PositionDetail objects are used when listing investment positions (if any) returned by the FI OFX server when the GetStatement, ReadOFXDataFile, or WriteOFXDataFile methods are called.

Fields

Account
String

Indicates the type of sub-account where the position is held in. Possible values are: CASH, MARGIN, SHORT, OTHER.

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).

Aggregate
String

Wrapper for a position information.

This aggregate contains properties relevant to all investment position types, as well as those specific to a given position type.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the component internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

DatePriceAsOf
String

Date and time of unit price and market value. Can be 0 if unit price and market value are unknown.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

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).

MarketValue
String

Current market value of this position.

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).

Memo
String

Memo regarding this position.

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.

Option
String

Indicates position type for the given sub-account where this position takes place. Each statement response must contain a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.

Possible values are: SHORT (Writer for options, Short for all others) and LONG (Holder for options, Long for all others). For options, position type SHORT is equivalent to WRITING an option, and position type LONG is equivalent to HOLDING an option.

For security types where there is only one type (for example, bonds), LONG is used.

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).

PosType
TiboTPosTypes

Type for general position aggregate. The positions types and their meanings are as follows:

ptPOSDEBT (0)Debt
ptPOSMF (1)Mutual Fund
ptPOSOPT (2)Option
ptPOSOTHER (3)Other Position
ptPOSSTOCK (4)Stock
ptOTHER (255)Other

SecurityId
String

The security ID for this position.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. 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).

TypeDescription
String

A description of the position type. This is a string representation of the value returned by the PosType.

The types and their meanings are as follows:

ptPOSDEBT (0)Debt
ptPOSMF (1)Mutual Fund
ptPOSOPT (2)Option
ptPOSOTHER (3)Other Position
ptPOSSTOCK (4)Stock
ptOTHER (255)Other

UnitPrice
String

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

Stocks, Market Funds, OtherPrice per share
BondsPercentage of par
OptionsPremium per share of underlying security

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).

Units
String

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).

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