E-Banking Integrator InvStatement Component : InvStatement OCX, InvStatement .NET Component, InvStatement Class, InvStatement Bean, InvStatement Object

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:


IncludeTransactions	Whether you want the investment transactions to be included in the statement download.
StartDate	To constrain the investment transaction list.
EndDate	To constrain the investment transaction list.
IncludePositions	Whether you want the positions to be included in the statement download.
AsOfDate	To constrain the positions list.
IncludeOpenOrders	Whether you want the open orders to be included in the statement download.
IncludeBalances	Whether 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 further details.


AccountId	The account number used for the next statement download.
AsOfDate	Date for returned list of positions.
AvailableCash	Cash balance across all sub-accounts.
BalCount	The number of records in the Bal arrays.
BalAggregate	Wrapper for an investment balance.
BalAmount	The value of the current balance.
BalType	The type of balance.
BalDescription	A description of the current balance.
BalName	The name for the current balance.
BalTypeDescription	A description of the balance type.
BrokerId	Unique identifier for the FI.
BuyingPower	Buying power.
ClosingInfoCount	The number of records in the ClosingInfo arrays.
ClosingInfoAggregate	Aggregates are pieces of XML taken from the financial institution's original response.
ClosingInfoFITID	Unique identifier assigned by financial institution to identify this particular statement closing information.
ClosingInfoImageRef	Server specified unique identifier for the statement closing image.
ClosingInfoImageRefType	Type of retrieval method for actual statement closing image.
CurrencyCode	Default currency code for this statement.
EndDate	End date of requested transaction list.
FIId	Financial institution identifier.
FIOrganization	Financial institution organization name.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
FIUrl	Financial institution URL.
ImageFileName	Filename and location to save the image content of a transaction or statement.
IncludeBalances	Specifies whether or not to include balances in the statement download.
IncludeImages	Whether the server has to return data for bank transactions or closing statements images.
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).
OFXAccessKey	Access key value received after a MFA authentication in a previous signon.
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.
OFXVersion	OFX API version.
OOCount	The number of records in the OO arrays.
OOAggregate	Wrapper for a general open order, each pertaining to a different aggregate type.
OOBuyType	Type of purchase for this open order.
OODatePlaced	Date-time the order was placed.
OODuration	Indicates how long the open order is good for.
OOFITID	Transaction Id assigned by the financial institution.
OOMemo	Other information about an open order (at most one).
OOType	Type for general open order aggregate.
OORestriction	Special restriction on the open order.
OOSecurityId	Security ID for this open order.
OOSellType	Type of sale.
OOSubAccountType	This identifies the type of a sub-account.
OOTypeDescription	A description of the open order type.
OOUnits	Quantity of the security the open order is for.
OOUnitType	What the units represent.
PosCount	The number of records in the Pos arrays.
PosAccount	Indicates the type of sub-account where the position is held in.
PosAggregate	Wrapper for a position information.
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.
PosType	Type for general position aggregate.
PosSecurityId	The security ID for this position.
PosTypeDescription	A description of the postion type.
PosUnitPrice	Unit price.
PosUnits	Quantity of positions.
SecCount	The number of records in the Sec arrays.
SecAggregate	Wrapper for security information.
SecAssetClass	Asset Class for the security (at most one).
SecFITID	Transaction Id assigned by the financial institution.
SecMemo	Memo regarding this security.
SecName	Full name of the security.
SecType	The type of security.
SecSecurityId	Security identifier.
SecTicker	Ticker symbol of the security.
SecTypeDescription	A description of the security type.
SecUnitPrice	This is the current unit price of the security as provided by the server.
SecYield	Current yield reported as portion of the fund's assets (at most one).
ShortBalance	Market value of all short positions.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
StartDate	Start date of requested transaction list.
StatementDate	Date and time for the statement download.
Timeout	A timeout for the component.
TxCount	The number of records in the Tx arrays.
TxAggregate	Wrapper for an investment statement transaction.
TxDate	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.
TxDateSettle	For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.
TxFITID	Transaction Id assigned 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	This is the type of transaction that was made on the account.
TxTypeDescription	A description of the transaction type.
TxUnitPrice	Price per commonly-quoted unit, excluding markup/markdown.
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 further details.


Config	Sets or retrieves a configuration setting.
GetClosingInfo	Download a statement closing information for an investment account.
GetImage	Request and retrieve a check or statement image (if available).
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 further details.


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


CurrencyFormat	The format to be used for returning currency values.
OFXDateFormat	The date format as required by OFX FI server.
DateFormat	The format to be used for input and output dates.
NewPassword	New password for the current OFX user.
OFXLog	Log file for the OFX transaction.
ServerMessage	Server message if a warning or other information returned.
ClientUId	Unique ID identifying OFX Client.
UserCred1A	Additional user credential required by server.
UserCred2A	Additional user credential required by server.
AuthToken	Authentication token required for this signon session only.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if 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 authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
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.
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).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|