InvStatement Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

InvStatement

Remarks

This class 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 class receives the secure response and parses the response into its properties.

To use the InvStatement class 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 class with short descriptions. Click on the links for further details.

AccountIdThe account number used for the next statement download.
AsOfDateDate for returned list of positions.
AvailableCashCash balance across all sub-accounts.
BalCountThe number of records in the Bal arrays.
BalAggregateWrapper for an investment balance.
BalAmountThe value of the current balance.
BalTypeThe type of balance.
BalDescriptionA description of the current balance.
BalNameThe name for the current balance.
BalTypeDescriptionA description of the balance type.
BrokerIdUnique identifier for the FI.
BuyingPowerBuying power.
ClosingDetailCountThe number of records in the ClosingDetail arrays.
ClosingDetailAggregateAggregates are pieces of XML taken from the financial institution's original response.
ClosingDetailFITIDUnique identifier assigned by financial institution to identify this particular statement closing information.
ClosingDetailImageRefServer specified unique identifier for the statement closing image.
ClosingDetailImageRefTypeType of retrieval method for actual statement closing image.
CurrencyCodeDefault currency code for this statement.
EndDateEnd date of requested transaction list.
FIIdFinancial institution identifier.
FIOrganizationFinancial institution organization name.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FIUrlFinancial institution URL.
ImageFileNameFilename and location to save the image content of a transaction or statement.
IncludeBalancesSpecifies whether or not to include balances in the statement download.
IncludeImagesWhether the server has to return data for bank transactions or closing statements images.
IncludeOpenOrdersSpecifies whether or not to include open orders in the response.
IncludePositionsSpecifies whether or not to include positions in the statement download.
IncludeTransactionsWhether to include transactions in the statement download.
MarginBalanceMargin balance.
MarketingInfoMarketing information (at most one).
OFXAccessKeyAccess key value received after a MFA authentication in a previous signon.
OFXAppIdOFX application identifier.
OFXAppVersionOFX application version.
OFXPasswordUser's password.
OFXRequestThe current OFX request aggregate.
OFXResponseThe current OFX response aggregate.
OFXUserUser's id.
OFXVersionOFX API version.
OOCountThe number of records in the OO arrays.
OOAggregateWrapper for a general open order, each pertaining to a different aggregate type.
OOBuyTypeType of purchase for this open order.
OODatePlacedDate-time the order was placed.
OODurationIndicates how long the open order is good for.
OOFITIDTransaction Id assigned by the financial institution.
OOMemoOther information about an open order (at most one).
OOTypeType for general open order aggregate.
OORestrictionSpecial restriction on the open order.
OOSecurityIdSecurity ID for this open order.
OOSellTypeType of sale.
OOSubAccountTypeThis identifies the type of a sub-account.
OOTypeDescriptionA description of the open order type.
OOUnitsQuantity of the security the open order is for.
OOUnitTypeWhat the units represent.
PosCountThe number of records in the Pos arrays.
PosAccountIndicates the type of sub-account where the position is held in.
PosAggregateWrapper for a position information.
PosDatePriceAsOfDate and time of unit price and market value.
PosMarketValueCurrent market value of this position.
PosMemoMemo regarding this position.
PosOptionIndicates position type for the given sub-account where this position takes place.
PosTypeType for general position aggregate.
PosSecurityIdThe security ID for this position.
PosTypeDescriptionA description of the position type.
PosUnitPriceUnit price.
PosUnitsQuantity of positions.
SecCountThe number of records in the Sec arrays.
SecAggregateWrapper for security information.
SecAssetClassAsset Class for the security (at most one).
SecFITIDTransaction Id assigned by the financial institution.
SecMemoMemo regarding this security.
SecNameFull name of the security.
SecTypeThe type of security.
SecSecurityIdSecurity identifier.
SecTickerTicker symbol of the security.
SecTypeDescriptionA description of the security type.
SecUnitPriceThis is the current unit price of the security as provided by the server.
SecYieldCurrent yield reported as portion of the fund's assets (at most one).
ShortBalanceMarket value of all short positions.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartDateStart date of requested transaction list.
StatementDateDate and time for the statement download.
TimeoutA timeout for the class.
TxCountThe number of records in the Tx arrays.
TxAggregateWrapper for an investment statement transaction.
TxDateFor 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.
TxDateSettleFor other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.
TxFITIDTransaction Id assigned by the financial institution.
TxMemoOther information (memo) regarding this transaction.
TxNameName for this bank transaction.
TxSecurityIdSecurity ID for this investment transaction.
TxSubAccountFundThe sub-account associated with the funds for the transaction.
TxSubAccountSecSub-account type for the security.
TxTotalTransaction amount.
TxTypeThis is the type of transaction that was made on the account.
TxTypeDescriptionA description of the transaction type.
TxUnitPricePrice per commonly-quoted unit, excluding markup/markdown.
TxUnitsThe quantity for security-based actions other than stock splits.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
GetClosingInfoDownload a statement closing information for an investment account.
GetImageRequest and retrieve a check or statement image (if available).
GetStatementDownloads statement for an investment account.
ReadOFXDataFileReads an OFX response from a file.
ResetReset the internal state of the class and all properties to their default values.
WriteOFXDataFileWrites the OFX response sent by the server to a file.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AuthTokenAuthentication token required for this signon session only.
ClientUIdUnique 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.
CurrencyFormatThe format to be used for returning currency values.
DateFormatThe format to be used for input and output dates.
GetResponseVarParses additional information out of the response.
NewPasswordNew password for the current OFX user.
OFXDateFormatThe date format as required by OFX FI server.
OFXLogLog file for the OFX transaction.
ServerMessageServer message if a warning or other information returned.
UserCred1AAdditional user credential required by server.
UserCred2AAdditional user credential required by server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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