IPWorks OFX 2020 Kotlin Edition

Questions / Feedback?

OpenOrderDetail Type

This type corresponds to a single investment open order in the list of open orders.

Remarks

OpenOrderDetail objects are used when listing open orders (if any) returned by the FI OFX server when the GetStatement, ReadOFXDataFile, or WriteOFXDataFile methods are called.

Fields

Aggregate
String?

Wrapper for a general open order, each pertaining to a different aggregate 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 fields. 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.

BuyType
String?

Type of purchase for this open order. Possible values are: BUY and BUYTOCOVER (used to close short sales).

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

DatePlaced
String?

Date-time the order was placed.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

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.

Duration
String?

Indicates how long the open order is good for. The possible values are: DAY, GOODTILCANCEL, IMMEDIATE.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

FITID
String?

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

Memo
String?

Other information about an open order (at most one).

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.

OOType
TOOTypes

Type for general open order aggregate. The open order types and their meanings are as follows:

ootOOBUYDEBT (0)Buy Debt
ootOOBUYMF (1)Buy Mutual Fund
ootOOBUYOPT (2)Buy Option
ootOOBUYOTHER (3)Buy Other
ootOOBUYSTOCK (4)Buy Stock
ootOOSELLDEBT (5)Sell Debt
ootOOSELLMF (6)Sell Mutual Fund
ootOOSELLOPT (7)Sell Option
ootOOSELLOTHER (8)Sell Other
ootOOSELLSTOCK (9)Sell Stock
ootSWITCHMF (10)Switch to Mutual Fund
ootOTHER (255)Other

Restriction
String?

Special restriction on the open order. The possible values are: ALLORNONE, MINUNITS, NONE.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

SecurityId
String?

Security ID for this open order.

This field 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 field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

SellType
String?

Type of sale. Possible values are: SELL, SELLSHORT.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

SubAccountType
String?

This identifies the type of a sub-account.

Many Financial Institutions (FIs) distinguish between activity and positions in cash, margin, and short accounts, with some FIs having many other types of 'sub-accounts'. Open Financial Exchange (OFX) defines four standard sub-account types: CASH, MARGIN, SHORT, and OTHER.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

TypeDescription
String?

A description of the open order type. This is a string representation of the value returned by the OOType field.

The types and their meanings are as follows:

ootOOBUYDEBT (0)Buy Debt
ootOOBUYMF (1)Buy Mutual Fund
ootOOBUYOPT (2)Buy Option
ootOOBUYOTHER (3)Buy Other
ootOOBUYSTOCK (4)Buy Stock
ootOOSELLDEBT (5)Sell Debt
ootOOSELLMF (6)Sell Mutual Fund
ootOOSELLOPT (7)Sell Option
ootOOSELLOTHER (8)Sell Other
ootOOSELLSTOCK (9)Sell Stock
ootSWITCHMF (10)Switch to Mutual Fund
ootOTHER (255)Other

Units
String?

Quantity of the security the open order is for.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

UnitType
String?

What the units represent. Possible values are: SHARES and CURRENCY.

This field is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders 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 Kotlin Edition - Version 20.0 [Build 7941]