InvStatement Class

Properties   Methods   Events   Config 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:

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.

Method List

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

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.

Config Settings

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

AccountId Property (InvStatement Class)

The account number used for the next statement download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountId();
int SetAccountId(const char* lpszAccountId);

Unicode (Windows)
LPWSTR GetAccountId();
INT SetAccountId(LPCWSTR lpszAccountId);

char* inebank_invstatement_getaccountid(void* lpObj);
int inebank_invstatement_setaccountid(void* lpObj, const char* lpszAccountId);

QString GetAccountId();
int SetAccountId(QString qsAccountId);

Default Value

""

Remarks

This is the account number for which the user wishes to download a statement. This is used during signon. This property is required to be specified when the GetStatement method is called and is also included in the server response.

Data Type

String

AsOfDate Property (InvStatement Class)

Date for returned list of positions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAsOfDate();
int SetAsOfDate(const char* lpszAsOfDate);

Unicode (Windows)
LPWSTR GetAsOfDate();
INT SetAsOfDate(LPCWSTR lpszAsOfDate);

char* inebank_invstatement_getasofdate(void* lpObj);
int inebank_invstatement_setasofdate(void* lpObj, const char* lpszAsOfDate);

QString GetAsOfDate();
int SetAsOfDate(QString qsAsOfDate);

Default Value

""

Remarks

This property is optional. It must be specified when IncludePositions property is set to True. If it is not included with the request, the server should return the most current position information available.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Data Type

String

AvailableCash Property (InvStatement Class)

Cash balance across all sub-accounts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAvailableCash();

Unicode (Windows)
LPWSTR GetAvailableCash();

char* inebank_invstatement_getavailablecash(void* lpObj);

QString GetAvailableCash();

Default Value

""

Remarks

This should include sweep funds as well.

This property is always returned with the balance information if such information is requested to be included (IncludeBalances was set to True) in the investment statement download request (when calling the GetStatement method).

This property is read-only.

Data Type

String

BalCount Property (InvStatement Class)

The number of records in the Bal arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBalCount();

Unicode (Windows)
INT GetBalCount();

int inebank_invstatement_getbalcount(void* lpObj);

int GetBalCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BalAggregate
• BalAmount
• BalDescription
• BalName
• BalType
• BalTypeDescription

The array indices start at 0 and end at BalCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

BalAggregate Property (InvStatement Class)

Wrapper for an investment balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalAggregate(int iBalIndex);

Unicode (Windows)
LPWSTR GetBalAggregate(INT iBalIndex);

char* inebank_invstatement_getbalaggregate(void* lpObj, int balindex);

QString GetBalAggregate(int iBalIndex);

Default Value

""

Remarks

Wrapper for an investment balance.

This allows an FI to send any number of balances to the user, complete with description and Help text. The intent is to capture the same type of balance information present on the first page of many FI brokerage statements. This aggregate can also be used to send margin call information.

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

String

BalAmount Property (InvStatement Class)

The value of the current balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalAmount(int iBalIndex);

Unicode (Windows)
LPWSTR GetBalAmount(INT iBalIndex);

char* inebank_invstatement_getbalamount(void* lpObj, int balindex);

QString GetBalAmount(int iBalIndex);

Default Value

""

Remarks

The value of the current balance. Interpretation of this depends on the value of BalType property:

If a balance list is present in the server response, the BalAmount is always present in the response for each balance listed.

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

String

BalType Property (InvStatement Class)

The type of balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBalType(int iBalIndex);

Unicode (Windows)
INT GetBalType(INT iBalIndex);

BT_DOLLAR(0), 
BT_PERCENT(1), 
BT_NUMBER(2), 
BT_OTHER(255)

int inebank_invstatement_getbaltype(void* lpObj, int balindex);

int GetBalType(int iBalIndex);

Default Value

0

Remarks

The type of balance. Possible values for balance types and their meanings are as follows:

If a balance list is present in the server response, the BalType is always present in the response for each balance listed.

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

Integer

BalDescription Property (InvStatement Class)

A description of the current balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalDescription(int iBalIndex);

Unicode (Windows)
LPWSTR GetBalDescription(INT iBalIndex);

char* inebank_invstatement_getbaldescription(void* lpObj, int balindex);

QString GetBalDescription(int iBalIndex);

Default Value

""

Remarks

A description of the current balance. If a balance list is present in the server response, the BalDescription is always present in the response for each balance listed.

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

String

BalName Property (InvStatement Class)

The name for the current balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalName(int iBalIndex);

Unicode (Windows)
LPWSTR GetBalName(INT iBalIndex);

char* inebank_invstatement_getbalname(void* lpObj, int balindex);

QString GetBalName(int iBalIndex);

Default Value

""

Remarks

The name for the current balance. If a balance list is present in the server response, the BalName is always present in the response for each balance listed.

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

String

BalTypeDescription Property (InvStatement Class)

A description of the balance type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBalTypeDescription(int iBalIndex);

Unicode (Windows)
LPWSTR GetBalTypeDescription(INT iBalIndex);

char* inebank_invstatement_getbaltypedescription(void* lpObj, int balindex);

QString GetBalTypeDescription(int iBalIndex);

Default Value

""

Remarks

A description of the balance type. This is a string representation of the value returned by the BalType property.

The corresponding description for each balance type are as follows:

The BalIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

This property is read-only and not available at design time.

Data Type

String

BrokerId Property (InvStatement Class)

Unique identifier for the FI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerId();
int SetBrokerId(const char* lpszBrokerId);

Unicode (Windows)
LPWSTR GetBrokerId();
INT SetBrokerId(LPCWSTR lpszBrokerId);

char* inebank_invstatement_getbrokerid(void* lpObj);
int inebank_invstatement_setbrokerid(void* lpObj, const char* lpszBrokerId);

QString GetBrokerId();
int SetBrokerId(QString qsBrokerId);

Default Value

""

Remarks

This property holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

It is required to be specified when the GetStatement method is called and is also included in the server response.

Data Type

String

BuyingPower Property (InvStatement Class)

Buying power.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuyingPower();

Unicode (Windows)
LPWSTR GetBuyingPower();

char* inebank_invstatement_getbuyingpower(void* lpObj);

QString GetBuyingPower();

Default Value

""

Remarks

The amount of money available to buy securities. In a margin account, the buying power is the total cash held in the brokerage account plus maximum margin available.

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.

This property is read-only.

Data Type

String

ClosingDetailCount Property (InvStatement Class)

The number of records in the ClosingDetail arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClosingDetailCount();

Unicode (Windows)
INT GetClosingDetailCount();

int inebank_invstatement_getclosingdetailcount(void* lpObj);

int GetClosingDetailCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClosingDetailAggregate
• ClosingDetailFITID
• ClosingDetailImageRef
• ClosingDetailImageRefType

The array indices start at 0 and end at ClosingDetailCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ClosingDetailAggregate Property (InvStatement Class)

Aggregates are pieces of XML taken from the financial institution's original response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailAggregate(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailAggregate(INT iClosingDetailIndex);

char* inebank_invstatement_getclosingdetailaggregate(void* lpObj, int closingdetailindex);

QString GetClosingDetailAggregate(int iClosingDetailIndex);

Default Value

""

Remarks

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

This aggregate describes a statement closing information. It contains data (elements and values) associated with the following properties:

• ClosingDetailFITID
• ClosingDetailDateStart
• ClosingDetailDateEnd
• ClosingDetailDateOpen
• ClosingDetailDateClose
• ClosingDetailDateDue (applicable to credit card accounts only)
• ClosingDetailBalanceOpening
• ClosingDetailBalanceClosing
• ClosingDetailTotalInterest (not applicable to credit card accounts)
• ClosingDetailTotalFees
• ClosingDetailTotalCredit
• ClosingDetailTotalDebit
• ClosingDetailCreditLimit (applicable to credit card accounts only)
• ClosingDetailImageRef
• ClosingDetailImageRefType

For each aggregate returned, clients can retrieve corresponding transactions by using ClosingDetailDateStart and ClosingDetailDateEnd in a statement download request (when calling GetStatement method).

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailFITID Property (InvStatement Class)

Unique identifier assigned by financial institution to identify this particular statement closing information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailFITID(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailFITID(INT iClosingDetailIndex);

char* inebank_invstatement_getclosingdetailfitid(void* lpObj, int closingdetailindex);

QString GetClosingDetailFITID(int iClosingDetailIndex);

Default Value

""

Remarks

Unique identifier assigned by financial institution to identify this particular statement closing information. This id provides a way for the client to distinguish one closing statement from another.

This is always returned in the server response for each statement.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailImageRef Property (InvStatement Class)

Server specified unique identifier for the statement closing image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailImageRef(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailImageRef(INT iClosingDetailIndex);

char* inebank_invstatement_getclosingdetailimageref(void* lpObj, int closingdetailindex);

QString GetClosingDetailImageRef(int iClosingDetailIndex);

Default Value

""

Remarks

Server specified unique identifier for the statement closing image.

This can be either image identifier (to be used during the request to retrieve the actual image when the GetImage method is called) or URL, depending on the value of ClosingDetailImageRefType.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailImageRefType Property (InvStatement Class)

Type of retrieval method for actual statement closing image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailImageRefType(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailImageRefType(INT iClosingDetailIndex);

char* inebank_invstatement_getclosingdetailimagereftype(void* lpObj, int closingdetailindex);

QString GetClosingDetailImageRefType(int iClosingDetailIndex);

Default Value

""

Remarks

Type of retrieval method for actual statement closing image.

If ClosingDetailImageRef is returned in the response, this can be either image identifier (to be used during the request for the image when the GetImage method is called) or a URL.

Possible values for ClosingDetailImageRefType are:

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

CurrencyCode Property (InvStatement Class)

Default currency code for this statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrencyCode();

Unicode (Windows)
LPWSTR GetCurrencyCode();

char* inebank_invstatement_getcurrencycode(void* lpObj);

QString GetCurrencyCode();

Default Value

""

Remarks

Indicates how to interpret the monetary amounts in the current statement. This is a 3-character ISO-4217 currency code, such as USD and EUR.

This property is read-only.

Data Type

String

EndDate Property (InvStatement Class)

End date of requested transaction list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEndDate();
int SetEndDate(const char* lpszEndDate);

Unicode (Windows)
LPWSTR GetEndDate();
INT SetEndDate(LPCWSTR lpszEndDate);

char* inebank_invstatement_getenddate(void* lpObj);
int inebank_invstatement_setenddate(void* lpObj, const char* lpszEndDate);

QString GetEndDate();
int SetEndDate(QString qsEndDate);

Default Value

""

Remarks

Date range if transactions should be downloaded. This is a string representing the date at which to stop listing transactions on the statement. Use this property and StartDate to constrain the list of transactions retrieved when calling GetStatement. This property is optional and can be specified when IncludeTransactions property is set to True. If this is empty, today's date will be passed in the request by default.

This is the value that should be sent in the next StartDate request to insure that no transactions are missed.

The EndDate will be returned in the server's response either with the value provided in the request, or as today's date if an end date was not included in the request.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Data Type

String

FIId Property (InvStatement Class)

Financial institution identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIId();
int SetFIId(const char* lpszFIId);

Unicode (Windows)
LPWSTR GetFIId();
INT SetFIId(LPCWSTR lpszFIId);

char* inebank_invstatement_getfiid(void* lpObj);
int inebank_invstatement_setfiid(void* lpObj, const char* lpszFIId);

QString GetFIId();
int SetFIId(QString qsFIId);

Default Value

""

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIOrganization Property (InvStatement Class)

Financial institution organization name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIOrganization();
int SetFIOrganization(const char* lpszFIOrganization);

Unicode (Windows)
LPWSTR GetFIOrganization();
INT SetFIOrganization(LPCWSTR lpszFIOrganization);

char* inebank_invstatement_getfiorganization(void* lpObj);
int inebank_invstatement_setfiorganization(void* lpObj, const char* lpszFIOrganization);

QString GetFIOrganization();
int SetFIOrganization(QString qsFIOrganization);

Default Value

""

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

FirewallAutoDetect Property (InvStatement Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int inebank_invstatement_getfirewallautodetect(void* lpObj);
int inebank_invstatement_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (InvStatement Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int inebank_invstatement_getfirewalltype(void* lpObj);
int inebank_invstatement_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (InvStatement Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* inebank_invstatement_getfirewallhost(void* lpObj);
int inebank_invstatement_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (InvStatement Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* inebank_invstatement_getfirewallpassword(void* lpObj);
int inebank_invstatement_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (InvStatement Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int inebank_invstatement_getfirewallport(void* lpObj);
int inebank_invstatement_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (InvStatement Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* inebank_invstatement_getfirewalluser(void* lpObj);
int inebank_invstatement_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (InvStatement Class)

Financial institution URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIUrl();
int SetFIUrl(const char* lpszFIUrl);

Unicode (Windows)
LPWSTR GetFIUrl();
INT SetFIUrl(LPCWSTR lpszFIUrl);

char* inebank_invstatement_getfiurl(void* lpObj);
int inebank_invstatement_setfiurl(void* lpObj, const char* lpszFIUrl);

QString GetFIUrl();
int SetFIUrl(QString qsFIUrl);

Default Value

""

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

Data Type

String

ImageFileName Property (InvStatement Class)

Filename and location to save the image content of a transaction or statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImageFileName();
int SetImageFileName(const char* lpszImageFileName);

Unicode (Windows)
LPWSTR GetImageFileName();
INT SetImageFileName(LPCWSTR lpszImageFileName);

char* inebank_invstatement_getimagefilename(void* lpObj);
int inebank_invstatement_setimagefilename(void* lpObj, const char* lpszImageFileName);

QString GetImageFileName();
int SetImageFileName(QString qsImageFileName);

Default Value

""

Remarks

When calling the GetImage method, the image content is returned by that method. If you want the image content to be written to disk, you can set the ImageFileName to a desired file name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

Note: Image download is available only for OFX version 2.1.1. When this method is called, the OFXVersion is automatically set to '211'.

Data Type

String

IncludeBalances Property (InvStatement Class)

Specifies whether or not to include balances in the statement download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeBalances();
int SetIncludeBalances(int bIncludeBalances);

Unicode (Windows)
BOOL GetIncludeBalances();
INT SetIncludeBalances(BOOL bIncludeBalances);

int inebank_invstatement_getincludebalances(void* lpObj);
int inebank_invstatement_setincludebalances(void* lpObj, int bIncludeBalances);

bool GetIncludeBalances();
int SetIncludeBalances(bool bIncludeBalances);

Default Value

TRUE

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeImages Property (InvStatement Class)

Whether the server has to return data for bank transactions or closing statements images.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeImages();
int SetIncludeImages(int bIncludeImages);

Unicode (Windows)
BOOL GetIncludeImages();
INT SetIncludeImages(BOOL bIncludeImages);

int inebank_invstatement_getincludeimages(void* lpObj);
int inebank_invstatement_setincludeimages(void* lpObj, int bIncludeImages);

bool GetIncludeImages();
int SetIncludeImages(bool bIncludeImages);

Default Value

FALSE

Remarks

If False (default value), the server will not return any image references in the response.

Otherwise, if the FI supports image download service :

• when the GetStatement method is called, the server will return the image references for each transaction (e.g., check image).
• when the GetClosingInfo method is called, the server will return a reference to the statement closing information image.

These references can then be used as parameters when the GetImage method is called.

This is optional and supported in OFX 2.1.1 version only (i.e., if this is requested, the OFXVersion should be set to '211').

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

Data Type

Boolean

IncludeOpenOrders Property (InvStatement Class)

Specifies whether or not to include open orders in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeOpenOrders();
int SetIncludeOpenOrders(int bIncludeOpenOrders);

Unicode (Windows)
BOOL GetIncludeOpenOrders();
INT SetIncludeOpenOrders(BOOL bIncludeOpenOrders);

int inebank_invstatement_getincludeopenorders(void* lpObj);
int inebank_invstatement_setincludeopenorders(void* lpObj, int bIncludeOpenOrders);

bool GetIncludeOpenOrders();
int SetIncludeOpenOrders(bool bIncludeOpenOrders);

Default Value

TRUE

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludePositions Property (InvStatement Class)

Specifies whether or not to include positions in the statement download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludePositions();
int SetIncludePositions(int bIncludePositions);

Unicode (Windows)
BOOL GetIncludePositions();
INT SetIncludePositions(BOOL bIncludePositions);

int inebank_invstatement_getincludepositions(void* lpObj);
int inebank_invstatement_setincludepositions(void* lpObj, int bIncludePositions);

bool GetIncludePositions();
int SetIncludePositions(bool bIncludePositions);

Default Value

TRUE

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeTransactions Property (InvStatement Class)

Whether to include transactions in the statement download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeTransactions();
int SetIncludeTransactions(int bIncludeTransactions);

Unicode (Windows)
BOOL GetIncludeTransactions();
INT SetIncludeTransactions(BOOL bIncludeTransactions);

int inebank_invstatement_getincludetransactions(void* lpObj);
int inebank_invstatement_setincludetransactions(void* lpObj, int bIncludeTransactions);

bool GetIncludeTransactions();
int SetIncludeTransactions(bool bIncludeTransactions);

Default Value

TRUE

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

MarginBalance Property (InvStatement Class)

Margin balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMarginBalance();

Unicode (Windows)
LPWSTR GetMarginBalance();

char* inebank_invstatement_getmarginbalance(void* lpObj);

QString GetMarginBalance();

Default Value

""

Remarks

A positive balance indicates a positive cash balance, while a negative balance indicates the customer has borrowed funds.

This property is always returned with the balance information if such information is requested to be included (IncludeBalances was set to True) in the investment statement download request (when calling the GetStatement method).

This property is read-only.

Data Type

String

MarketingInfo Property (InvStatement Class)

Marketing information (at most one).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMarketingInfo();

Unicode (Windows)
LPWSTR GetMarketingInfo();

char* inebank_invstatement_getmarketinginfo(void* lpObj);

QString GetMarketingInfo();

Default Value

""

Remarks

Optional. This information might be returned when the GetStatement method is called.

This property is read-only.

Data Type

String

OFXAccessKey Property (InvStatement Class)

Access key value received after a MFA authentication in a previous signon.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey);

Unicode (Windows)
LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);

char* inebank_invstatement_getofxaccesskey(void* lpObj);
int inebank_invstatement_setofxaccesskey(void* lpObj, const char* lpszOFXAccessKey);

QString GetOFXAccessKey();
int SetOFXAccessKey(QString qsOFXAccessKey);

Default Value

""

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile class). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (InvStatement Class)

OFX application identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppId();
int SetOFXAppId(const char* lpszOFXAppId);

Unicode (Windows)
LPWSTR GetOFXAppId();
INT SetOFXAppId(LPCWSTR lpszOFXAppId);

char* inebank_invstatement_getofxappid(void* lpObj);
int inebank_invstatement_setofxappid(void* lpObj, const char* lpszOFXAppId);

QString GetOFXAppId();
int SetOFXAppId(QString qsOFXAppId);

Default Value

""

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (InvStatement Class)

OFX application version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppVersion();
int SetOFXAppVersion(const char* lpszOFXAppVersion);

Unicode (Windows)
LPWSTR GetOFXAppVersion();
INT SetOFXAppVersion(LPCWSTR lpszOFXAppVersion);

char* inebank_invstatement_getofxappversion(void* lpObj);
int inebank_invstatement_setofxappversion(void* lpObj, const char* lpszOFXAppVersion);

QString GetOFXAppVersion();
int SetOFXAppVersion(QString qsOFXAppVersion);

Default Value

""

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (InvStatement Class)

User's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXPassword();
int SetOFXPassword(const char* lpszOFXPassword);

Unicode (Windows)
LPWSTR GetOFXPassword();
INT SetOFXPassword(LPCWSTR lpszOFXPassword);

char* inebank_invstatement_getofxpassword(void* lpObj);
int inebank_invstatement_setofxpassword(void* lpObj, const char* lpszOFXPassword);

QString GetOFXPassword();
int SetOFXPassword(QString qsOFXPassword);

Default Value

""

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (InvStatement Class)

The current OFX request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_invstatement_getofxrequest(void* lpObj);

QString GetOFXRequest();

Default Value

""

Remarks

Polling OFXRequest will cause the class to generate and return an OFX request aggregate.

This property is read-only and not available at design time.

Data Type

String

OFXResponse Property (InvStatement Class)

The current OFX response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXResponse();
int SetOFXResponse(const char* lpszOFXResponse);

Unicode (Windows)
LPWSTR GetOFXResponse();
INT SetOFXResponse(LPCWSTR lpszOFXResponse);

char* inebank_invstatement_getofxresponse(void* lpObj);
int inebank_invstatement_setofxresponse(void* lpObj, const char* lpszOFXResponse);

QString GetOFXResponse();
int SetOFXResponse(QString qsOFXResponse);

Default Value

""

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (InvStatement Class)

User's id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXUser();
int SetOFXUser(const char* lpszOFXUser);

Unicode (Windows)
LPWSTR GetOFXUser();
INT SetOFXUser(LPCWSTR lpszOFXUser);

char* inebank_invstatement_getofxuser(void* lpObj);
int inebank_invstatement_setofxuser(void* lpObj, const char* lpszOFXUser);

QString GetOFXUser();
int SetOFXUser(QString qsOFXUser);

Default Value

""

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (InvStatement Class)

OFX API version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXVersion();
int SetOFXVersion(const char* lpszOFXVersion);

Unicode (Windows)
LPWSTR GetOFXVersion();
INT SetOFXVersion(LPCWSTR lpszOFXVersion);

char* inebank_invstatement_getofxversion(void* lpObj);
int inebank_invstatement_setofxversion(void* lpObj, const char* lpszOFXVersion);

QString GetOFXVersion();
int SetOFXVersion(QString qsOFXVersion);

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

OOCount Property (InvStatement Class)

The number of records in the OO arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOOCount();

Unicode (Windows)
INT GetOOCount();

int inebank_invstatement_getoocount(void* lpObj);

int GetOOCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• OOAggregate
• OOBuyType
• OODatePlaced
• OODuration
• OOFITID
• OOMemo
• OORestriction
• OOSecurityId
• OOSellType
• OOSubAccountType
• OOType
• OOTypeDescription
• OOUnits
• OOUnitType

The array indices start at 0 and end at OOCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

OOAggregate Property (InvStatement Class)

Wrapper for a general open order, each pertaining to a different aggregate type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOAggregate(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOAggregate(INT iOOIndex);

char* inebank_invstatement_getooaggregate(void* lpObj, int ooindex);

QString GetOOAggregate(int iOOIndex);

Default Value

""

Remarks

Wrapper for a general open order, each pertaining to a different aggregate type.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOBuyType Property (InvStatement Class)

Type of purchase for this open order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOBuyType(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOBuyType(INT iOOIndex);

char* inebank_invstatement_getoobuytype(void* lpObj, int ooindex);

QString GetOOBuyType(int iOOIndex);

Default Value

""

Remarks

Type of purchase for this open order. Possible values are: BUY and BUYTOCOVER (used to close short sales).

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OODatePlaced Property (InvStatement Class)

Date-time the order was placed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOODatePlaced(int iOOIndex);

Unicode (Windows)
LPWSTR GetOODatePlaced(INT iOOIndex);

char* inebank_invstatement_getoodateplaced(void* lpObj, int ooindex);

QString GetOODatePlaced(int iOOIndex);

Default Value

""

Remarks

Date-time the order was placed.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OODuration Property (InvStatement Class)

Indicates how long the open order is good for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOODuration(int iOOIndex);

Unicode (Windows)
LPWSTR GetOODuration(INT iOOIndex);

char* inebank_invstatement_getooduration(void* lpObj, int ooindex);

QString GetOODuration(int iOOIndex);

Default Value

""

Remarks

Indicates how long the open order is good for. The possible values are: DAY, GOODTILCANCEL, IMMEDIATE.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOFITID Property (InvStatement Class)

Transaction Id assigned by the financial institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOFITID(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOFITID(INT iOOIndex);

char* inebank_invstatement_getoofitid(void* lpObj, int ooindex);

QString GetOOFITID(int iOOIndex);

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOMemo Property (InvStatement Class)

Other information about an open order (at most one).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOMemo(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOMemo(INT iOOIndex);

char* inebank_invstatement_getoomemo(void* lpObj, int ooindex);

QString GetOOMemo(int iOOIndex);

Default Value

""

Remarks

Other information about an open order (at most one).

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOType Property (InvStatement Class)

Type for general open order aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOOType(int iOOIndex);

Unicode (Windows)
INT GetOOType(INT iOOIndex);

OOT_OOBUYDEBT(0), 
OOT_OOBUYMF(1), 
OOT_OOBUYOPT(2), 
OOT_OOBUYOTHER(3), 
OOT_OOBUYSTOCK(4), 
OOT_OOSELLDEBT(5), 
OOT_OOSELLMF(6), 
OOT_OOSELLOPT(7), 
OOT_OOSELLOTHER(8), 
OOT_OOSELLSTOCK(9), 
OOT_SWITCHMF(10), 
OOT_OTHER(255)

int inebank_invstatement_getootype(void* lpObj, int ooindex);

int GetOOType(int iOOIndex);

Default Value

0

Remarks

Type for general open order aggregate. The open order types and their meanings are as follows:

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

Integer

OORestriction Property (InvStatement Class)

Special restriction on the open order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOORestriction(int iOOIndex);

Unicode (Windows)
LPWSTR GetOORestriction(INT iOOIndex);

char* inebank_invstatement_getoorestriction(void* lpObj, int ooindex);

QString GetOORestriction(int iOOIndex);

Default Value

""

Remarks

Special restriction on the open order. The possible values are: ALLORNONE, MINUNITS, NONE.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOSecurityId Property (InvStatement Class)

Security ID for this open order.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOSecurityId(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOSecurityId(INT iOOIndex);

char* inebank_invstatement_getoosecurityid(void* lpObj, int ooindex);

QString GetOOSecurityId(int iOOIndex);

Default Value

""

Remarks

Security ID for this open order.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOSellType Property (InvStatement Class)

Type of sale.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOSellType(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOSellType(INT iOOIndex);

char* inebank_invstatement_getooselltype(void* lpObj, int ooindex);

QString GetOOSellType(int iOOIndex);

Default Value

""

Remarks

Type of sale. Possible values are: SELL, SELLSHORT.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOSubAccountType Property (InvStatement Class)

This identifies the type of a sub-account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOSubAccountType(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOSubAccountType(INT iOOIndex);

char* inebank_invstatement_getoosubaccounttype(void* lpObj, int ooindex);

QString GetOOSubAccountType(int iOOIndex);

Default Value

""

Remarks

This identifies the type of a sub-account.

Many Financial Institutions (FIs) distinguish between activity and positions in cash, margin, and short accounts, with some FIs having many other types of 'sub-accounts'. Open Financial Exchange (OFX) defines four standard sub-account types: CASH, MARGIN, SHORT, and OTHER.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOTypeDescription Property (InvStatement Class)

A description of the open order type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOTypeDescription(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOTypeDescription(INT iOOIndex);

char* inebank_invstatement_getootypedescription(void* lpObj, int ooindex);

QString GetOOTypeDescription(int iOOIndex);

Default Value

""

Remarks

A description of the open order type. This is a string representation of the value returned by the OOType property.

The types and their meanings are as follows:

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOUnits Property (InvStatement Class)

Quantity of the security the open order is for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOUnits(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOUnits(INT iOOIndex);

char* inebank_invstatement_getoounits(void* lpObj, int ooindex);

QString GetOOUnits(int iOOIndex);

Default Value

""

Remarks

Quantity of the security the open order is for.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

OOUnitType Property (InvStatement Class)

What the units represent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOOUnitType(int iOOIndex);

Unicode (Windows)
LPWSTR GetOOUnitType(INT iOOIndex);

char* inebank_invstatement_getoounittype(void* lpObj, int ooindex);

QString GetOOUnitType(int iOOIndex);

Default Value

""

Remarks

What the units represent. Possible values are: SHARES and CURRENCY.

This property is always returned with the open order information if such an information is requested to be included (IncludeOpenOrders was set to True) in the investment statement download request (when calling the GetStatement method).

The OOIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OOCount property.

This property is read-only and not available at design time.

Data Type

String

PosCount Property (InvStatement Class)

The number of records in the Pos arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPosCount();

Unicode (Windows)
INT GetPosCount();

int inebank_invstatement_getposcount(void* lpObj);

int GetPosCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PosAccount
• PosAggregate
• PosDatePriceAsOf
• PosMarketValue
• PosMemo
• PosOption
• PosSecurityId
• PosType
• PosTypeDescription
• PosUnitPrice
• PosUnits

The array indices start at 0 and end at PosCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PosAccount Property (InvStatement Class)

Indicates the type of sub-account where the position is held in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosAccount(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosAccount(INT iPosIndex);

char* inebank_invstatement_getposaccount(void* lpObj, int posindex);

QString GetPosAccount(int iPosIndex);

Default Value

""

Remarks

Indicates the type of sub-account where the position is held in. Possible values are: CASH, MARGIN, SHORT, OTHER.

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosAggregate Property (InvStatement Class)

Wrapper for a position information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosAggregate(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosAggregate(INT iPosIndex);

char* inebank_invstatement_getposaggregate(void* lpObj, int posindex);

QString GetPosAggregate(int iPosIndex);

Default Value

""

Remarks

Wrapper for a position information.

This aggregate contains properties relevant to all investment position types, as well as those specific to a given position type.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosDatePriceAsOf Property (InvStatement Class)

Date and time of unit price and market value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosDatePriceAsOf(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosDatePriceAsOf(INT iPosIndex);

char* inebank_invstatement_getposdatepriceasof(void* lpObj, int posindex);

QString GetPosDatePriceAsOf(int iPosIndex);

Default Value

""

Remarks

Date and time of unit price and market value. Can be 0 if unit price and market value are unknown.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosMarketValue Property (InvStatement Class)

Current market value of this position.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosMarketValue(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosMarketValue(INT iPosIndex);

char* inebank_invstatement_getposmarketvalue(void* lpObj, int posindex);

QString GetPosMarketValue(int iPosIndex);

Default Value

""

Remarks

Current market value of this position.

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosMemo Property (InvStatement Class)

Memo regarding this position.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosMemo(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosMemo(INT iPosIndex);

char* inebank_invstatement_getposmemo(void* lpObj, int posindex);

QString GetPosMemo(int iPosIndex);

Default Value

""

Remarks

Memo regarding this position.

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty string.

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosOption Property (InvStatement Class)

Indicates position type for the given sub-account where this position takes place.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosOption(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosOption(INT iPosIndex);

char* inebank_invstatement_getposoption(void* lpObj, int posindex);

QString GetPosOption(int iPosIndex);

Default Value

""

Remarks

Indicates position type for the given sub-account where this position takes place. Each statement response must contain a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.

Possible values are: SHORT (Writer for options, Short for all others) and LONG (Holder for options, Long for all others). For options, position type SHORT is equivalent to WRITING an option, and position type LONG is equivalent to HOLDING an option.

For security types where there is only one type (for example, bonds), LONG is used.

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosType Property (InvStatement Class)

Type for general position aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPosType(int iPosIndex);

Unicode (Windows)
INT GetPosType(INT iPosIndex);

PT_POSDEBT(0), 
PT_POSMF(1), 
PT_POSOPT(2), 
PT_POSOTHER(3), 
PT_POSSTOCK(4), 
PT_OTHER(255)

int inebank_invstatement_getpostype(void* lpObj, int posindex);

int GetPosType(int iPosIndex);

Default Value

0

Remarks

Type for general position aggregate. The positions types and their meanings are as follows:

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

Integer

PosSecurityId Property (InvStatement Class)

The security ID for this position.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosSecurityId(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosSecurityId(INT iPosIndex);

char* inebank_invstatement_getpossecurityid(void* lpObj, int posindex);

QString GetPosSecurityId(int iPosIndex);

Default Value

""

Remarks

The security ID for this position.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard. This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosTypeDescription Property (InvStatement Class)

A description of the position type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosTypeDescription(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosTypeDescription(INT iPosIndex);

char* inebank_invstatement_getpostypedescription(void* lpObj, int posindex);

QString GetPosTypeDescription(int iPosIndex);

Default Value

""

Remarks

A description of the position type. This is a string representation of the value returned by the PosType.

The types and their meanings are as follows:

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosUnitPrice Property (InvStatement Class)

Unit price.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosUnitPrice(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosUnitPrice(INT iPosIndex);

char* inebank_invstatement_getposunitprice(void* lpObj, int posindex);

QString GetPosUnitPrice(int iPosIndex);

Default Value

""

Remarks

Unit price. Depending on the type of sub-account where this position takes place, this indicates the following:

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

PosUnits Property (InvStatement Class)

Quantity of positions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPosUnits(int iPosIndex);

Unicode (Windows)
LPWSTR GetPosUnits(INT iPosIndex);

char* inebank_invstatement_getposunits(void* lpObj, int posindex);

QString GetPosUnits(int iPosIndex);

Default Value

""

Remarks

Quantity of positions. Depending on the type of sub-account where this position takes place, this indicates the following:

This property is always returned with the positions information if such an information is requested to be included (IncludePositions was set to True) in the investment statement download request (when calling the GetStatement method).

The PosIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PosCount property.

This property is read-only and not available at design time.

Data Type

String

SecCount Property (InvStatement Class)

The number of records in the Sec arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecCount();

Unicode (Windows)
INT GetSecCount();

int inebank_invstatement_getseccount(void* lpObj);

int GetSecCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SecAggregate
• SecAssetClass
• SecFITID
• SecMemo
• SecName
• SecSecurityId
• SecTicker
• SecType
• SecTypeDescription
• SecUnitPrice
• SecYield

The array indices start at 0 and end at SecCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SecAggregate Property (InvStatement Class)

Wrapper for security information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecAggregate(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecAggregate(INT iSecIndex);

char* inebank_invstatement_getsecaggregate(void* lpObj, int secindex);

QString GetSecAggregate(int iSecIndex);

Default Value

""

Remarks

Wrapper for security information.

The value of this property is returned by the server when the investment statement download contains positions, transactions, or open orders.

The SecAggregate contains information about security referenced in the investment statement download. Clients are completely dependent on the security list to provide descriptive information for the securities referenced in positions, transactions, and open orders.

These aggregates define the type of security, and one or more sets of descriptive information.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecAssetClass Property (InvStatement Class)

Asset Class for the security (at most one).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecAssetClass(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecAssetClass(INT iSecIndex);

char* inebank_invstatement_getsecassetclass(void* lpObj, int secindex);

QString GetSecAssetClass(int iSecIndex);

Default Value

""

Remarks

Asset Class for the security (at most one). The possible values and their meanings are as follows:

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecFITID Property (InvStatement Class)

Transaction Id assigned by the financial institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecFITID(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecFITID(INT iSecIndex);

char* inebank_invstatement_getsecfitid(void* lpObj, int secindex);

QString GetSecFITID(int iSecIndex);

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

This is a character string up to 32 octets long.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecMemo Property (InvStatement Class)

Memo regarding this security.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecMemo(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecMemo(INT iSecIndex);

char* inebank_invstatement_getsecmemo(void* lpObj, int secindex);

QString GetSecMemo(int iSecIndex);

Default Value

""

Remarks

Memo regarding this security. This value is optional.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecName Property (InvStatement Class)

Full name of the security.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecName(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecName(INT iSecIndex);

char* inebank_invstatement_getsecname(void* lpObj, int secindex);

QString GetSecName(int iSecIndex);

Default Value

""

Remarks

Full name of the security. The name can be up to 120 characters long.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecType Property (InvStatement Class)

The type of security.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecType(int iSecIndex);

Unicode (Windows)
INT GetSecType(INT iSecIndex);

ST_DEBTINFO(0), 
ST_MFINFO(1), 
ST_OPTINFO(2), 
ST_OTHERINFO(3), 
ST_STOCKINFO(4), 
ST_OTHER(255)

int inebank_invstatement_getsectype(void* lpObj, int secindex);

int GetSecType(int iSecIndex);

Default Value

0

Remarks

The type of security. This is a string representation of the value returned by the SecType property.

The security types and their meanings are as follows:

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

Integer

SecSecurityId Property (InvStatement Class)

Security identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecSecurityId(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecSecurityId(INT iSecIndex);

char* inebank_invstatement_getsecsecurityid(void* lpObj, int secindex);

QString GetSecSecurityId(int iSecIndex);

Default Value

""

Remarks

Security identifier.

This property consists of a naming standard followed by a semicolon and a 9-character identifier. The naming standard identifies the method used for assigning the identifier ("CUSIP" in the US) and is unique within the indicated naming standard.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecTicker Property (InvStatement Class)

Ticker symbol of the security.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecTicker(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecTicker(INT iSecIndex);

char* inebank_invstatement_getsecticker(void* lpObj, int secindex);

QString GetSecTicker(int iSecIndex);

Default Value

""

Remarks

Ticker symbol of the security. The value can be up to 32 characters long.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecTypeDescription Property (InvStatement Class)

A description of the security type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecTypeDescription(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecTypeDescription(INT iSecIndex);

char* inebank_invstatement_getsectypedescription(void* lpObj, int secindex);

QString GetSecTypeDescription(int iSecIndex);

Default Value

""

Remarks

A description of the security type. This is a string representation of the value returned by the SecType property.

The types and their meanings are as follows:

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecUnitPrice Property (InvStatement Class)

This is the current unit price of the security as provided by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecUnitPrice(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecUnitPrice(INT iSecIndex);

char* inebank_invstatement_getsecunitprice(void* lpObj, int secindex);

QString GetSecUnitPrice(int iSecIndex);

Default Value

""

Remarks

This is the current unit price of the security as provided by the server. It may be a real-time or delayed quote. The delay amount is determined by the data provider.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

SecYield Property (InvStatement Class)

Current yield reported as portion of the fund's assets (at most one).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecYield(int iSecIndex);

Unicode (Windows)
LPWSTR GetSecYield(INT iSecIndex);

char* inebank_invstatement_getsecyield(void* lpObj, int secindex);

QString GetSecYield(int iSecIndex);

Default Value

""

Remarks

Current yield reported as portion of the fund's assets (at most one). This can be returned in the server reply only when SecType is stMFINFO or stSTOCKINFO.

The SecIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecCount property.

This property is read-only and not available at design time.

Data Type

String

ShortBalance Property (InvStatement Class)

Market value of all short positions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShortBalance();

Unicode (Windows)
LPWSTR GetShortBalance();

char* inebank_invstatement_getshortbalance(void* lpObj);

QString GetShortBalance();

Default Value

""

Remarks

This property is always returned with the balance information if such information is requested to be included (IncludeBalances was set to True) in the investment statement download request (when calling the GetStatement method).

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (InvStatement Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int inebank_invstatement_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_invstatement_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InvStatement Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int inebank_invstatement_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_invstatement_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InvStatement Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int inebank_invstatement_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_invstatement_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InvStatement Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* inebank_invstatement_getsslcertstorepassword(void* lpObj);
int inebank_invstatement_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (InvStatement Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int inebank_invstatement_getsslcertstoretype(void* lpObj);
int inebank_invstatement_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (InvStatement Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* inebank_invstatement_getsslcertsubject(void* lpObj);
int inebank_invstatement_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);