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

class ipworksofx.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 fi_id, fi_organization and fi_url, properties. Next identify the OFX user and application by setting the ofx_user, ofx_password, ofx_app_id and ofx_app_version properties. Next set the broker_id and account_id 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:


include_transactions	Whether you want the investment transactions to be included in the statement download.
start_date	To constrain the investment transaction list.
end_date	To constrain the investment transaction list.
include_positions	Whether you want the positions to be included in the statement download.
as_of_date	To constrain the positions list.
include_open_orders	Whether you want the open orders to be included in the statement download.
include_balances	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 get_statement method to build and transmit the request automatically. When the response returns, the transaction(s) properties will be populated automatically, together with start_date, end_date 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.


account_id	The account number used for the next statement download.
as_of_date	Date for returned list of positions.
available_cash	Cash balance across all sub-accounts.
bal_count	The number of records in the Bal arrays.
bal_aggregate	Wrapper for an investment balance.
bal_amount	The value of the current balance.
bal_type	The type of balance.
bal_description	A description of the current balance.
bal_name	The name for the current balance.
bal_type_description	A description of the balance type.
broker_id	Unique identifier for the FI.
buying_power	Buying power.
closing_detail_count	The number of records in the ClosingDetail arrays.
closing_detail_aggregate	Aggregates are pieces of XML taken from the financial institution's original response.
closing_detail_fitid	Unique identifier assigned by financial institution to identify this particular statement closing information.
closing_detail_image_ref	Server specified unique identifier for the statement closing image.
closing_detail_image_ref_type	Type of retrieval method for actual statement closing image.
currency_code	Default currency code for this statement.
end_date	End date of requested transaction list.
fi_id	Financial institution identifier.
fi_organization	Financial institution organization name.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
fi_url	Financial institution URL.
image_file_name	Filename and location to save the image content of a transaction or statement.
include_balances	Specifies whether or not to include balances in the statement download.
include_images	Whether the server has to return data for bank transactions or closing statements images.
include_open_orders	Specifies whether or not to include open orders in the response.
include_positions	Specifies whether or not to include positions in the statement download.
include_transactions	Whether to include transactions in the statement download.
margin_balance	Margin balance.
marketing_info	Marketing information (at most one).
ofx_access_key	Access key value received after a MFA authentication in a previous signon.
ofx_app_id	OFX application identifier.
ofx_app_version	OFX application version.
ofx_password	User's password.
ofx_request	The current OFX request aggregate.
ofx_response	The current OFX response aggregate.
ofx_user	User's id.
ofx_version	OFX API version.
oo_count	The number of records in the OO arrays.
oo_aggregate	Wrapper for a general open order, each pertaining to a different aggregate type.
oo_buy_type	Type of purchase for this open order.
oo_date_placed	Date-time the order was placed.
oo_duration	Indicates how long the open order is good for.
oofitid	Transaction Id assigned by the financial institution.
oo_memo	Other information about an open order (at most one).
oo_type	Type for general open order aggregate.
oo_restriction	Special restriction on the open order.
oo_security_id	Security ID for this open order.
oo_sell_type	Type of sale.
oo_sub_account_type	This identifies the type of a sub-account.
oo_type_description	A description of the open order type.
oo_units	Quantity of the security the open order is for.
oo_unit_type	What the units represent.
pos_count	The number of records in the Pos arrays.
pos_account	Indicates the type of sub-account where the position is held in.
pos_aggregate	Wrapper for a position information.
pos_date_price_as_of	Date and time of unit price and market value.
pos_market_value	Current market value of this position.
pos_memo	Memo regarding this position.
pos_option	Indicates position type for the given sub-account where this position takes place.
pos_type	Type for general position aggregate.
pos_security_id	The security ID for this position.
pos_type_description	A description of the position type.
pos_unit_price	Unit price.
pos_units	Quantity of positions.
sec_count	The number of records in the Sec arrays.
sec_aggregate	Wrapper for security information.
sec_asset_class	Asset Class for the security (at most one).
sec_fitid	Transaction Id assigned by the financial institution.
sec_memo	Memo regarding this security.
sec_name	Full name of the security.
sec_type	The type of security.
sec_security_id	Security identifier.
sec_ticker	Ticker symbol of the security.
sec_type_description	A description of the security type.
sec_unit_price	This is the current unit price of the security as provided by the server.
sec_yield	Current yield reported as portion of the fund's assets (at most one).
short_balance	Market value of all short positions.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	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.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
start_date	Start date of requested transaction list.
statement_date	Date and time for the statement download.
timeout	A timeout for the class.
tx_count	The number of records in the Tx arrays.
tx_aggregate	Wrapper for an investment statement transaction.
tx_date	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.
tx_date_settle	For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.
tx_fitid	Transaction Id assigned by the financial institution.
tx_memo	Other information (memo) regarding this transaction.
tx_name	Name for this bank transaction.
tx_security_id	Security ID for this investment transaction.
tx_sub_account_fund	The sub-account associated with the funds for the transaction.
tx_sub_account_sec	Sub-account type for the security.
tx_total	Transaction amount.
tx_type	This is the type of transaction that was made on the account.
tx_type_description	A description of the transaction type.
tx_unit_price	Price per commonly-quoted unit, excluding markup/markdown.
tx_units	The 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.


config	Sets or retrieves a configuration setting.
get_closing_info	Download a statement closing information for an investment account.
get_image	Request and retrieve a check or statement image (if available).
get_statement	Downloads statement for an investment account.
read_ofx_data_file	Reads an OFX response from a file.
reset	Reset the internal state of the class and all properties to their default values.
write_ofx_data_file	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 class with short descriptions. Click on the links for further details.


on_connection_status	Fired to indicate changes in connection state.
on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows 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.


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.
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 class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class 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 class.
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.
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 class.
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.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
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 class 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.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
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.
SSLSecurityFlags	Flags that control certificate verification.
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.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.