InvStatement Component
Properties Methods Events Configuration Settings Errors
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.
Syntax
IPWorksOFX.Invstatement
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. |
| Balances | A list of balances in an investment statement for the date range ( StartDate and EndDate ) selected. |
| BrokerId | Unique identifier for the FI. |
| BuyingPower | Buying power. |
| ClosingDetails | A list of investment statement closing information for the date range ( StartDate and EndDate ) selected. |
| CurrencyCode | Default currency code for this statement. |
| EndDate | End date of requested transaction list. |
| FIId | Financial institution identifier. |
| FIOrganization | Financial institution organization name. |
| Firewall | A set of properties related to firewall access. |
| 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. |
| OpenOrders | A list of open orders in an investment statement for the date range ( StartDate and EndDate ) selected. |
| Positions | A list of positions in an investment statement for the date range ( StartDate and EndDate ) selected. |
| Securities | A list of securities in an investment statement for the date range ( StartDate and EndDate ) selected. |
| ShortBalance | Market value of all short positions. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| StartDate | Start date of requested transaction list. |
| StatementDate | Date and time for the statement download. |
| Timeout | A timeout for the component. |
| Transactions | A list of transactions in an investment statement for the date range ( StartDate and EndDate ) selected. |
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.
| AuthToken | Authentication token required for this signon session only. |
| ClientUId | Unique ID identifying OFX Client. |
| CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
| CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
| CurrencyFormat | The format to be used for returning currency values. |
| DateFormat | The format to be used for input and output dates. |
| GetResponseVar | Parses additional information out of the response. |
| NewPassword | New password for the current OFX user. |
| OFXDateFormat | The date format as required by OFX FI server. |
| OFXLog | Log file for the OFX transaction. |
| ServerMessage | Server message if a warning or other information returned. |
| UserCred1A | Additional user credential required by server. |
| UserCred2A | Additional user credential required by server. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| 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. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| 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. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| 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. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| 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;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLContextProtocol | The protocol used when getting an SSLContext instance. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| 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. |
| BuildInfo | Information about the product's build. |
| GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
| LicenseInfo | Information about the current license. |
| UseDaemonThreads | Whether threads created by the component are daemon threads. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |