InvTransactionDetail Type

Wrapper for an investment statement transaction.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the bean's fields. However, some of these elements, and/or their potential values, may not be supported by the bean. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate bean 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 bean 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.

For other than banking transactions, this is the date when the transaction trade occurred, and for stock splits, this is the day of record stored as a string.

For banking transactions, this is the date the transaction was posted to the financial institution.

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

For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.

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

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

Other information (memo) regarding this transaction. The memo field stores a notice from the broker to the customer as a string.

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.

Name for this bank transaction. When there are bank transactions returned in the statement download (i.e. TxType returned is ttINVBANKTRAN), the Name stores the name of the financial institution or a name assigned by the institution to this transaction, such as 'Customer deposit'.

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.

Security ID for this investment transaction.

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 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 sub-account associated with the funds for the transaction. Where did the money for the transaction come from or go to. The possible values are : CASH, MARGIN, SHORT, OTHER.

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

Sub-account type for the security. The possible values are: CASH, MARGIN, SHORT, OTHER.

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

Transaction amount. For other than banking transactions (buys, sells, etc.) this is the transaction total: ((quantity * (price +/- markup/markdown)) +/- (commission + fees + load + taxes)).

Distributions, interest, margin interest, misc. expense, etc.: amount.

Return of cap: cost basis.

Banking transactions: this is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the bean will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the bean will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

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

This is the type of transaction that was made on the account. Checks, electronic funds transfers, and ATM transactions associated with CMA or money market sweep accounts are always represented with a bank transaction record.

Investment actions that involve securities (buy, sell, stock split, reinvest, etc.) are always represented with an investment record. Actions that are cash-only but are directly associated with a security are also investment actions (for example, dividends).

Other cash-only actions require careful analysis by the FI. Those that affect investment performance analysis should be sent using the appropriate investment action (investment income - miscellaneous, investment expense). Those that are completely unrelated to investment should be sent as a bank record.

The types and their meanings are as follows:

A description of the transaction type. This is a string representation of the value returned by the TxType field.

The types and their meanings are as follows:

Price per commonly-quoted unit, excluding markup/markdown.

It indicates:

• share price for stocks, mutual funds, and others.
• percentage of par for bonds.
• per share (not contract) for options.

This field 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 quantity for security-based actions other than stock splits. The Units differ for each type of security.

Depending on the type of the security, the Units 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 field 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).