Search: 
Available in: OFX
InvStatement Component [IBiz E-Banking Integrator V2]

Properties   Methods   Events   Configuration Settings  

The InvStatement component is a single component that supports the SignOn and Investment Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component adds detailed investment account statement download functionality to your desktop application, or allows your web application to fetch a user's investment statement without having to redirect to another website. All downloads are done using a secure HTTPS Post to send account sign on information to a financial institution. The InvStatement component receives the secure response and parses the response into its properties.

To use the InvStatement component first identify the financial institution by setting the FIId, FIOrganization and FIUrl, properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. Next set the BrokerId and AccountId properties to the appropriate values to identify the account for which you wish to download a statement.

The following properties provide additional control over the request:

IncludeTransactionsWhether you want the investment transactions to be included in the statement download.
StartDateTo constrain the investment transaction list.
EndDateTo constrain the investment transaction list.
IncludePositionsWhether you want the positions to be included in the statement download.
AsOfDateTo constrain the positions list.
IncludeOpenOrdersWhether you want the open orders to be included in the statement download.
IncludeBalancesWhether you want the account balances to be included in the statement download.

Once you have finished setting the properties that describe the statement you wish to download, use the GetStatement method to build and transmit the request automatically. When the response returns, the transaction(s) properties will be populated automatically, together with StartDate, EndDate and any other data the investment statement includes.

The server's response consists of five blocks of information:

  • Transactions: a combination of bank transaction detail records and investment transaction detail records. Transactions only within the specified start and stop dates are sent.
  • Positions: positions a user has at a brokerage. Each statement response contains a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.
  • Balances: current balances typically reported on an FI statement, such as cash balance or buying power. They can also convey other items of interest, such as current interest rates.
  • Open Orders: current open trading orders that a user has at a brokerage.
  • Securities: any security referenced in either transactions, positions, or open orders.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

AccountId The account number used for the next statement download.
AsOfDate Date for returned list of positions.
AvailableCash Cash balance across all sub-accounts.
BalAggregate Balance aggregate (one or more).
BalCount Number of balance aggregates included in the response.
BalDescription Description for this balance.
BalName Name for this balance.
BalType Balance type.
BalTypeDescription A description of the balance type.
BalValue Balance value.
BrokerId Unique identifier for the FI.
BuyingPower Buying power.
DefaultCurrency Default currency for this statement.
EndDate End date of requested transaction list.
FIId Financial institution identifier.
FIOrganization Financial institution organization name.
FIUrl Financial institution URL.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
IncludeBalances Specifies whether or not to include balances in the statement download.
IncludeOpenOrders Specifies whether or not to include open orders in the response.
IncludePositions Specifies whether or not to include positions in the statement download.
IncludeTransactions Whether to include transactions in the statement download.
MarginBalance Margin balance.
MarketingInfo Marketing information (at most one).
OFXAppId OFX application identifier.
OFXAppVersion OFX application version.
OFXPassword User's password.
OFXRequest The current OFX request aggregate.
OFXResponse The current OFX response aggregate.
OFXUser User's id.
OOAggregate Wrapper for general open order, each pertaining to a different aggregate type.
OOBuyType Type of purchase for this open order.
OOCount Number of open order aggregates included in the response.
OODatePlaced Date-time the order was placed.
OODuration Indicates how long the open order is good for.
OOFITID Unique FI-assigned transaction ID.
OOMemo Other information about an open order (at most one).
OORestriction Special restriction on the open order.
OOSecurityId Security ID for this open order.
OOSellType Type of sale.
OOSubAccountType Type of sub-account.
OOType Type for general open order aggregate.
OOTypeDescription A description of the open order type.
OOUnitType What the units represent.
OOUnits Quantity of the security the open order is for.
PosAccount Indicates the type of sub-account where the position is held in.
PosAggregate Wrapper for position information.
PosCount Number of positions included in the response.
PosDatePriceAsOf Date and time of unit price and market value.
PosMarketValue Current market value of this position.
PosMemo Memo regarding this position.
PosOption Indicates position type for the given sub-account where this position takes place.
PosSecurityId Security ID for this position.
PosType Type for general position aggregate.
PosTypeDescription A description of the position type.
PosUnitPrice Unit price.
PosUnits Quantity of positions.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
SecAssetClass Asset Class for the security (at most one).
SecCount Number of security aggregates included in the response.
SecFIID FI specific ID for the security.
SecInfoAggregate Wrapper for security information.
SecMemo Memo regarding this security.
SecName Full name of the security.
SecSecurityId Security identifier.
SecTicker Ticker symbol of the security.
SecType The type of security.
SecTypeDescription A description of the security type.
SecUnitPrice Unit price for the security.
SecYield Current yield reported as portion of the fund's assets (at most one).
ShortBalance Market value of all short positions.
StartDate Start date of include-transactions request.
StatementDate Date and time for the statement download.
Timeout A timeout for the component.
TxAggregate Investment statement transaction aggregates (zero or more).
TxCount The number of investment transaction aggregates in the response.
TxDate Trade or posted date for the transaction.
TxDateSettle Settlement date.
TxFITID Transaction Id used by the financial institution.
TxMemo Other information (memo) regarding this transaction.
TxName Name for this bank transaction.
TxSecurityId Security ID for this investment transaction.
TxSubAccountFund The sub-account associated with the funds for the transaction.
TxSubAccountSec Sub-account type for the security.
TxTotal Transaction amount.
TxType The type of transaction.
TxTypeDescription A description of the transaction type.
TxUnitPrice Price per commonly-quoted unit.
TxUnits The quantity for security-based actions other than stock splits.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
GetStatement Downloads statement for an investment account.
ReadOFXDataFile Reads an OFX response from a file.
Reset Reset the internal state of the component and all properties to their default values.
WriteOFXDataFile Writes the OFX response sent by the server to a file.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

ConnectionStatus Fired to indicate changes in connection state.
Error Information about errors during data delivery.
SSLServerAuthentication Fired after the server presents its certificate to the client.
SSLStatus Shows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyFormat The format to be used for returning currency values.
DateFormat The format to be used for returning and parsing date strings.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
NewPassword New password for the current OFX user.
OFXLog Log file for the OFX transaction.
OpenSSLCADir The path to a directory containing CA certificates.
OpenSSLCAFile Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData The data to seed the pseudo random number generator(PRNG).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if Basic authentication is to be used for the proxy.
SSLCipherStrength The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols Used to enable/disable the supported security protocols.
SSLProvider The name of the security provider to use.
SSLSecurityFlags Flags that control certificate verification
ServerMessage Server message if a warning or other information returned.
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.