IPWorks OFX 2020 Android Edition

Questions / Feedback?

InvTransactionDetail Type

This type corresponds to a single bank investment transaction in the list of such transactions.

Remarks

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

Fields

Aggregate
String

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

Date
String

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

DateSettle
String

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

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

Memo
String

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

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

SubAccountFund
String

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

SubAccountSec
String

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

Total
String

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

TxType
int

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:

ittBUYDEBT (0)Buy debt security
ittBUYMF (1)Buy mutual fund (being switched to).
ittBUYOPT (2)Buy option.
ittBUYOTHER (3)Buy other security type
ittBUYSTOCK (4)Buy stock.
ittCLOSUREOPT (5)Close a position for an option.
ittINCOME (6)Investment income is realized as cash into the investment account. A negative TOTAL is used to denote adjustments to income.
ittINVEXPENSE (7)Misc. investment expense that is associated with a specific security.
ittJRNLFUND (8)Journaling cash holdings between sub-accounts within the same investment account.
ittJRNLSEC (9)Journaling security holdings between sub-accounts within the same investment account.
ittMARGININTEREST (10)Margin interest expense
ittREINVEST (11)Reinvestment of income
ittRETOFCAP (12)Return of capital
ittSELLDEBT (13)Sell debt security. Used when debt is sold, called, or reached maturity.
ittSELLMF (14)Sell mutual fund (being switched from).
ittSELLOPT (15)Sell option.
ittSELLOTHER (16)Sell other type of security
ittSELLSTOCK (17)Sell stock
ittSPLIT (18)Stock or Mutual Fund Split. (Note: the trade date is interpreted as the 'day of record' for the split.)
ittTRANSFERS (19)Transfer holdings in and out of the investment account.
ittINVBANKTRAN (20)Banking related transactions for the investment account.
ittOTHER (255)Other

TypeDescription
String

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:

ttBUYDEBT (0)Buy debt security
ttBUYMF (1)Buy mutual fund (being switched to).
ttBUYOPT (2)Buy option
ttBUYOTHER (3)Buy other security type
ttBUYSTOCK (4)Buy stock
ttCLOSUREOPT (5)Close a position for an option
ttINCOME (6)Investment income is realized as cash into the investment account
ttINVEXPENSE (7)Misc. investment expense that is associated with a specific security
ttJRNLFUND (8)Journaling cash holdings between sub-accounts
ttJRNLSEC (9)Journaling security holdings between sub-accounts
ttMARGININTEREST (10)Margin interest expense
ttREINVEST (11)Reinvestment of income
ttRETOFCAP (12)Return of capital
ttSELLDEBT (13)Sell debt security
ttSELLMF (14)Sell mutual fund
ttSELLOPT (15)Sell option
ttSELLOTHER (16)Sell other type of security
ttSELLSTOCK (17)Sell stock
ttSPLIT (18)Stock or Mutual Fund Split
ttTRANSFER (19)Transfer holdings
ttINVBANKTRAN (20)Bank transactions
ttOTHER (255)Other

UnitPrice
String

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

Units
String

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

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