InvStatement Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiboInvStatement

Remarks

This component adds detailed investment account statement download functionality to your desktop application, or allows your web application to fetch a user's investment statement without having to redirect to another website. All downloads are done using a secure HTTPS Post to send account sign on information to a financial institution. The InvStatement component receives the secure response and parses the response into its properties.

To use the InvStatement component first identify the financial institution by setting the FIId, FIOrganization and FIUrl, properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. Next set the BrokerId and AccountId properties to the appropriate values to identify the account for which you wish to download a statement.

The following properties provide additional control over the request:

Once you have finished setting the properties that describe the statement you wish to download, use the GetStatement method to build and transmit the request automatically. When the response returns, the transaction(s) properties will be populated automatically, together with StartDate, EndDate and any other data the investment statement includes.

The server's response consists of five blocks of information:

• Transactions: a combination of bank transaction detail records and investment transaction detail records. Transactions only within the specified start and stop dates are sent.
• Positions: positions a user has at a brokerage. Each statement response contains a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.
• Balances: current balances typically reported on an FI statement, such as cash balance or buying power. They can also convey other items of interest, such as current interest rates.
• Open Orders: current open trading orders that a user has at a brokerage.
• Securities: any security referenced in either transactions, positions, or open orders.

Property List

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

Method List

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

Event List

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

Config Settings

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

AccountId Property (InvStatement Component)

The account number used for the next statement download.

Syntax

__property String AccountId = { read=FAccountId, write=FSetAccountId };

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 Component)

Date for returned list of positions.

Syntax

__property String AsOfDate = { read=FAsOfDate, write=FSetAsOfDate };

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 Component)

Cash balance across all sub-accounts.

Syntax

__property String AvailableCash = { read=FAvailableCash };

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 Component)

The number of records in the Bal arrays.

Syntax

__property int BalCount = { read=FBalCount };

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 Component)

Wrapper for an investment balance.

Syntax

__property String BalAggregate[int BalIndex] = { read=FBalAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

The value of the current balance.

Syntax

__property String BalAmount[int BalIndex] = { read=FBalAmount };

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 Component)

The type of balance.

Syntax

__property TiboInvStatementBalTypes BalType[int BalIndex] = { read=FBalType };

enum TiboInvStatementBalTypes {
  btDOLLAR=0,
  btPERCENT=1,
  btNUMBER=2,
  btOTHER=255
};

Default Value

btDOLLAR

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 Component)

A description of the current balance.

Syntax

__property String BalDescription[int BalIndex] = { read=FBalDescription };

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 Component)

The name for the current balance.

Syntax

__property String BalName[int BalIndex] = { read=FBalName };

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 Component)

A description of the balance type.

Syntax

__property String BalTypeDescription[int BalIndex] = { read=FBalTypeDescription };

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 Component)

Unique identifier for the FI.

Syntax

__property String BrokerId = { read=FBrokerId, write=FSetBrokerId };

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 Component)

Buying power.

Syntax

__property String BuyingPower = { read=FBuyingPower };

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 Component)

The number of records in the ClosingDetail arrays.

Syntax

__property int ClosingDetailCount = { read=FClosingDetailCount };

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 Component)

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

Syntax

__property String ClosingDetailAggregate[int ClosingDetailIndex] = { read=FClosingDetailAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

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

Syntax

__property String ClosingDetailFITID[int ClosingDetailIndex] = { read=FClosingDetailFITID };

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 Component)

Server specified unique identifier for the statement closing image.

Syntax

__property String ClosingDetailImageRef[int ClosingDetailIndex] = { read=FClosingDetailImageRef };

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 Component)

Type of retrieval method for actual statement closing image.

Syntax

__property String ClosingDetailImageRefType[int ClosingDetailIndex] = { read=FClosingDetailImageRefType };

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 Component)

Default currency code for this statement.

Syntax

__property String CurrencyCode = { read=FCurrencyCode };

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 Component)

End date of requested transaction list.

Syntax

__property String EndDate = { read=FEndDate, write=FSetEndDate };

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 Component)

Financial institution identifier.

Syntax

__property String FIId = { read=FFIId, write=FSetFIId };

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 Component)

Financial institution organization name.

Syntax

__property String FIOrganization = { read=FFIOrganization, write=FSetFIOrganization };

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 Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (InvStatement Component)

This property determines the type of firewall to connect through.

Syntax

__property TiboInvStatementFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TiboInvStatementFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (InvStatement Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (InvStatement Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (InvStatement Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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 Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

FIUrl Property (InvStatement Component)

Financial institution URL.

Syntax

__property String FIUrl = { read=FFIUrl, write=FSetFIUrl };

Default Value

""

Remarks

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

Data Type

String

ImageFileName Property (InvStatement Component)

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

Syntax

__property String ImageFileName = { read=FImageFileName, write=FSetImageFileName };

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 Component)

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

Syntax

__property bool IncludeBalances = { read=FIncludeBalances, write=FSetIncludeBalances };

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeImages Property (InvStatement Component)

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

Syntax

__property bool IncludeImages = { read=FIncludeImages, write=FSetIncludeImages };

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 component) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

Data Type

Boolean

IncludeOpenOrders Property (InvStatement Component)

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

Syntax

__property bool IncludeOpenOrders = { read=FIncludeOpenOrders, write=FSetIncludeOpenOrders };

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludePositions Property (InvStatement Component)

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

Syntax

__property bool IncludePositions = { read=FIncludePositions, write=FSetIncludePositions };

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeTransactions Property (InvStatement Component)

Whether to include transactions in the statement download.

Syntax

__property bool IncludeTransactions = { read=FIncludeTransactions, write=FSetIncludeTransactions };

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

MarginBalance Property (InvStatement Component)

Margin balance.

Syntax

__property String MarginBalance = { read=FMarginBalance };

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 Component)

Marketing information (at most one).

Syntax

__property String MarketingInfo = { read=FMarketingInfo };

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 Component)

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

Syntax

__property String OFXAccessKey = { read=FOFXAccessKey, write=FSetOFXAccessKey };

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 component 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 component 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 component). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (InvStatement Component)

OFX application identifier.

Syntax

__property String OFXAppId = { read=FOFXAppId, write=FSetOFXAppId };

Default Value

""

Remarks

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

Data Type

String

OFXAppVersion Property (InvStatement Component)

OFX application version.

Syntax

__property String OFXAppVersion = { read=FOFXAppVersion, write=FSetOFXAppVersion };

Default Value

""

Remarks

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

Data Type

String

OFXPassword Property (InvStatement Component)

User's password.

Syntax

__property String OFXPassword = { read=FOFXPassword, write=FSetOFXPassword };

Default Value

""

Remarks

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

Data Type

String

OFXRequest Property (InvStatement Component)

The current OFX request aggregate.

Syntax

__property String OFXRequest = { read=FOFXRequest };

Default Value

""

Remarks

Polling OFXRequest will cause the component 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 Component)

The current OFX response aggregate.

Syntax

__property String OFXResponse = { read=FOFXResponse, write=FSetOFXResponse };

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 Component)

User's id.

Syntax

__property String OFXUser = { read=FOFXUser, write=FSetOFXUser };

Default Value

""

Remarks

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

Data Type

String

OFXVersion Property (InvStatement Component)

OFX API version.

Syntax

__property String OFXVersion = { read=FOFXVersion, write=FSetOFXVersion };

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 Component)

The number of records in the OO arrays.

Syntax

__property int OOCount = { read=FOOCount };

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 Component)

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

Syntax

__property String OOAggregate[int OOIndex] = { read=FOOAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Type of purchase for this open order.

Syntax

__property String OOBuyType[int OOIndex] = { read=FOOBuyType };

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 Component)

Date-time the order was placed.

Syntax

__property String OODatePlaced[int OOIndex] = { read=FOODatePlaced };

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 Component)

Indicates how long the open order is good for.

Syntax

__property String OODuration[int OOIndex] = { read=FOODuration };

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 Component)

Transaction Id assigned by the financial institution.

Syntax

__property String OOFITID[int OOIndex] = { read=FOOFITID };

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 Component)

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

Syntax

__property String OOMemo[int OOIndex] = { read=FOOMemo };

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 Component)

Type for general open order aggregate.

Syntax

__property TiboInvStatementOOTypes OOType[int OOIndex] = { read=FOOType };

enum TiboInvStatementOOTypes {
  ootOOBUYDEBT=0,
  ootOOBUYMF=1,
  ootOOBUYOPT=2,
  ootOOBUYOTHER=3,
  ootOOBUYSTOCK=4,
  ootOOSELLDEBT=5,
  ootOOSELLMF=6,
  ootOOSELLOPT=7,
  ootOOSELLOTHER=8,
  ootOOSELLSTOCK=9,
  ootSWITCHMF=10,
  ootOTHER=255
};

Default Value

ootOOBUYDEBT

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 Component)

Special restriction on the open order.

Syntax

__property String OORestriction[int OOIndex] = { read=FOORestriction };

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 Component)

Security ID for this open order.

Syntax

__property String OOSecurityId[int OOIndex] = { read=FOOSecurityId };

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 Component)

Type of sale.

Syntax

__property String OOSellType[int OOIndex] = { read=FOOSellType };

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 Component)

This identifies the type of a sub-account.

Syntax

__property String OOSubAccountType[int OOIndex] = { read=FOOSubAccountType };

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 Component)

A description of the open order type.

Syntax

__property String OOTypeDescription[int OOIndex] = { read=FOOTypeDescription };

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 Component)

Quantity of the security the open order is for.

Syntax

__property String OOUnits[int OOIndex] = { read=FOOUnits };

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 Component)

What the units represent.

Syntax

__property String OOUnitType[int OOIndex] = { read=FOOUnitType };

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 Component)

The number of records in the Pos arrays.

Syntax

__property int PosCount = { read=FPosCount };

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 Component)

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

Syntax

__property String PosAccount[int PosIndex] = { read=FPosAccount };

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 Component)

Wrapper for a position information.

Syntax

__property String PosAggregate[int PosIndex] = { read=FPosAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Date and time of unit price and market value.

Syntax

__property String PosDatePriceAsOf[int PosIndex] = { read=FPosDatePriceAsOf };

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 Component)

Current market value of this position.

Syntax

__property String PosMarketValue[int PosIndex] = { read=FPosMarketValue };

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 Component)

Memo regarding this position.

Syntax

__property String PosMemo[int PosIndex] = { read=FPosMemo };

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 Component)

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

Syntax

__property String PosOption[int PosIndex] = { read=FPosOption };

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 Component)

Type for general position aggregate.

Syntax

__property TiboInvStatementPosTypes PosType[int PosIndex] = { read=FPosType };

enum TiboInvStatementPosTypes {
  ptPOSDEBT=0,
  ptPOSMF=1,
  ptPOSOPT=2,
  ptPOSOTHER=3,
  ptPOSSTOCK=4,
  ptOTHER=255
};

Default Value

ptPOSDEBT

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 Component)

The security ID for this position.

Syntax

__property String PosSecurityId[int PosIndex] = { read=FPosSecurityId };

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 Component)

A description of the position type.

Syntax

__property String PosTypeDescription[int PosIndex] = { read=FPosTypeDescription };

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 Component)

Unit price.

Syntax

__property String PosUnitPrice[int PosIndex] = { read=FPosUnitPrice };

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 Component)

Quantity of positions.

Syntax

__property String PosUnits[int PosIndex] = { read=FPosUnits };

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 Component)

The number of records in the Sec arrays.

Syntax

__property int SecCount = { read=FSecCount };

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 Component)

Wrapper for security information.

Syntax

__property String SecAggregate[int SecIndex] = { read=FSecAggregate };

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 component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 Component)

Asset Class for the security (at most one).

Syntax

__property String SecAssetClass[int SecIndex] = { read=FSecAssetClass };

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 Component)

Transaction Id assigned by the financial institution.

Syntax

__property String SecFITID[int SecIndex] = { read=FSecFITID };

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 Component)

Memo regarding this security.

Syntax

__property String SecMemo[int SecIndex] = { read=FSecMemo };

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 Component)

Full name of the security.

Syntax

__property String SecName[int SecIndex] = { read=FSecName };

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 Component)

The type of security.

Syntax

__property TiboInvStatementSecTypes SecType[int SecIndex] = { read=FSecType };

enum TiboInvStatementSecTypes {
  stDEBTINFO=0,
  stMFINFO=1,
  stOPTINFO=2,
  stOTHERINFO=3,
  stSTOCKINFO=4,
  stOTHER=255
};

Default Value

stDEBTINFO

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 Component)

Security identifier.

Syntax

__property String SecSecurityId[int SecIndex] = { read=FSecSecurityId };

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 Component)

Ticker symbol of the security.

Syntax

__property String SecTicker[int SecIndex] = { read=FSecTicker };

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 Component)

A description of the security type.

Syntax

__property String SecTypeDescription[int SecIndex] = { read=FSecTypeDescription };

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 Component)

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

Syntax

__property String SecUnitPrice[int SecIndex] = { read=FSecUnitPrice };

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 Component)

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

Syntax

__property String SecYield[int SecIndex] = { read=FSecYield };

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 Component)

Market value of all short positions.

Syntax

__property String ShortBalance = { read=FShortBalance };

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 Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (InvStatement Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (InvStatement Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (InvStatement Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 Component)

This is the type of certificate store for this certificate.

Syntax

__property TiboInvStatementSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TiboInvStatementSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (InvStatement Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (InvStatement Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TiboInvStatementSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TiboInvStatementSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (InvStatement Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

StartDate Property (InvStatement Component)

Start date of requested transaction list.

Syntax

__property String StartDate = { read=FStartDate, write=FSetStartDate };

Default Value

""

Remarks

This is a string representing the date at which to start listing transactions on the statement. Use this property and EndDate to constrain the list of transactions retrieved when calling GetStatement. When provided in the request, StartDate value will be echoed in the server's response.

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.

Note: This property is optional and can be specified when IncludeTransactions property is set to True.

Data Type

String

StatementDate Property (InvStatement Component)

Date and time for the statement download.

Syntax

__property String StatementDate = { read=FStatementDate };

Default Value

""

Remarks

This property is always returned in the server's response 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.

This property is read-only.

Data Type

String

Timeout Property (InvStatement Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TxCount Property (InvStatement Component)

The number of records in the Tx arrays.

Syntax

__property int TxCount = { read=FTxCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TxAggregate
• TxDate
• TxDateSettle
• TxFITID
• TxMemo
• TxName
• TxSecurityId
• TxSubAccountFund
• TxSubAccountSec
• TxTotal
• TxType
• TxTypeDescription
• TxUnitPrice
• TxUnits

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

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

Data Type

Integer

TxAggregate Property (InvStatement Component)

Wrapper for an investment statement transaction.

Syntax

__property String TxAggregate[int TxIndex] = { read=FTxAggregate };

Default Value

""

Remarks

Wrapper for an investment statement transaction.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the component's properties. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxDate Property (InvStatement Component)

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.

Syntax

__property String TxDate[int TxIndex] = { read=FTxDate };

Default Value

""

Remarks

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.

For banking transactions, this is the date the transaction was posted to the financial institution.

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 transaction information if such an information is requested to be included (IncludeTransactions was set to True) in the investment statement download request (when calling the GetStatement method).

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxDateSettle Property (InvStatement Component)

For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.

Syntax

__property String TxDateSettle[int TxIndex] = { read=FTxDateSettle };

Default Value

""

Remarks

For other than banking transactions, this is the date when settlement occurred, and for stock splits, this is the execution date.

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 transaction information if such an information is requested to be included (IncludeTransactions was set to True) in the investment statement download request (when calling the GetStatement method).

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxFITID Property (InvStatement Component)

Transaction Id assigned by the financial institution.

Syntax

__property String TxFITID[int TxIndex] = { read=FTxFITID };

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 transaction information if such an information is requested to be included (IncludeTransactions was set to True) in the investment statement download request (when calling the GetStatement method).

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxMemo Property (InvStatement Component)

Other information (memo) regarding this transaction.

Syntax

__property String TxMemo[int TxIndex] = { read=FTxMemo };

Default Value

""

Remarks

Other information (memo) regarding this transaction. The memo property stores a notice from the broker to the customer as a string.

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 TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxName Property (InvStatement Component)

Name for this bank transaction.

Syntax

__property String TxName[int TxIndex] = { read=FTxName };

Default Value

""

Remarks

Name for this bank transaction. When there are bank transactions returned in the statement download (i.e. TxType returned is ttINVBANKTRAN), the TxName stores the name of the financial institution or a name assigned by the institution to this transaction, such as 'Customer deposit'.

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 TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxSecurityId Property (InvStatement Component)

Security ID for this investment transaction.

Syntax

__property String TxSecurityId[int TxIndex] = { read=FTxSecurityId };

Default Value

""

Remarks

Security ID for this investment transaction.

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 transaction information if such an information is requested to be included (IncludeTransactions was set to True) in the investment statement download request (when calling the GetStatement method).

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxSubAccountFund Property (InvStatement Component)

The sub-account associated with the funds for the transaction.

Syntax

__property String TxSubAccountFund[int TxIndex] = { read=FTxSubAccountFund };

Default Value

""

Remarks

The sub-account associated with the funds for the transaction. Where did the money for the transaction come from or go to. The possible values are : CASH, MARGIN, SHORT, OTHER.

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

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxSubAccountSec Property (InvStatement Component)

Sub-account type for the security.

Syntax

__property String TxSubAccountSec[int TxIndex] = { read=FTxSubAccountSec };

Default Value

""

Remarks

Sub-account type for the security. The possible values are: CASH, MARGIN, SHORT, OTHER.

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

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxTotal Property (InvStatement Component)

Transaction amount.

Syntax

__property String TxTotal[int TxIndex] = { read=FTxTotal };

Default Value

""

Remarks

Transaction amount. For other than banking transactions (buys, sells, etc.) this is the transaction total: ((quantity * (price +/- markup/markdown)) +/- (commission + fees + load + taxes)).

Distributions, interest, margin interest, misc. expense, etc.: amount.

Return of cap: cost basis.

Banking transactions: this is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the component will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the component will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

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

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxType Property (InvStatement Component)

This is the type of transaction that was made on the account.

Syntax

__property TiboInvStatementTxTypes TxType[int TxIndex] = { read=FTxType };

enum TiboInvStatementTxTypes {
  ittBUYDEBT=0,
  ittBUYMF=1,
  ittBUYOPT=2,
  ittBUYOTHER=3,
  ittBUYSTOCK=4,
  ittCLOSUREOPT=5,
  ittINCOME=6,
  ittINVEXPENSE=7,
  ittJRNLFUND=8,
  ittJRNLSEC=9,
  ittMARGININTEREST=10,
  ittREINVEST=11,
  ittRETOFCAP=12,
  ittSELLDEBT=13,
  ittSELLMF=14,
  ittSELLOPT=15,
  ittSELLOTHER=16,
  ittSELLSTOCK=17,
  ittSPLIT=18,
  ittTRANSFERS=19,
  ittINVBANKTRAN=20,
  ittOTHER=255
};

Default Value

ittBUYDEBT

Remarks

This is the type of transaction that was made on the account. Checks, electronic funds transfers, and ATM transactions associated with CMA or money market sweep accounts are always represented with a bank transaction record.

Investment actions that involve securities (buy, sell, stock split, reinvest, etc.) are always represented with an investment record. Actions that are cash-only but are directly associated with a security are also investment actions (for example, dividends).

Other cash-only actions require careful analysis by the FI. Those that affect investment performance analysis should be sent using the appropriate investment action (investment income - miscellaneous, investment expense). Those that are completely unrelated to investment should be sent as a bank record.

The types and their meanings are as follows:

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

Integer

TxTypeDescription Property (InvStatement Component)

A description of the transaction type.

Syntax

__property String TxTypeDescription[int TxIndex] = { read=FTxTypeDescription };

Default Value

""

Remarks

A description of the transaction type. This is a string representation of the value returned by the TxType property.

The types and their meanings are as follows:

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxUnitPrice Property (InvStatement Component)

Price per commonly-quoted unit, excluding markup/markdown.

Syntax

__property String TxUnitPrice[int TxIndex] = { read=FTxUnitPrice };

Default Value

""

Remarks

Price per commonly-quoted unit, excluding markup/markdown.

It indicates:

• share price for stocks, mutual funds, and others.
• percentage of par for bonds.
• per share (not contract) for options.

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

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

TxUnits Property (InvStatement Component)

The quantity for security-based actions other than stock splits.

Syntax

__property String TxUnits[int TxIndex] = { read=FTxUnits };

Default Value

""

Remarks

The quantity for security-based actions other than stock splits. The TxUnits differ for each type of security.

Depending on the type of the security, the TxUnits indicates the following:

• Stocks, Mutual Funds and Other : number of shares.
• Bonds : face value. For example, a $25,000 bond trading at $88 would use 25000 as the units and 88 as the unit price.
• Options : number of contracts (not shares).

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

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

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

Data Type

String

Config Method (InvStatement Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetClosingInfo Method (InvStatement Component)

Download a statement closing information for an investment account.

Syntax

void __fastcall GetClosingInfo();

Remarks

This is applicable and supported in OFX 2.1.1 version only (i.e., when this method is called, the OFXVersion should be set to '211').

This function generates the Signon and Investment Statement Closing Information request page, submits it to the financial institution via secure HTTPS Post, receives and parses the closing statement information.

The server response includes the FI transaction unique Id and image data information (when available).

The following properties should be set when this method is called:

• FIId (required)
• FIOrganization (required)
• FIUrl (required)
• OFXAppId (required)
• OFXAppVersion (required)
• OFXVersion (required if 2.x OFX version is the one supported by your FI)
• OFXUser (required)
• OFXPassword (required)
• BrokerId (required)
• AccountId (required)

The client can also specify a date range (by setting the StartDate and EndDate properties) to limit the number of closing information aggregates that the server returns. If the client does not specify a date range, the server returns as many closing information aggregates as it can (which will be stored in ClosingDetails).

If you want the server to return an image reference for each statement closing information, and if the server supports this service, you will have to set the IncludeImages to True.

The following read-only properties are populated as a result of parsing the statement response:

• CurrencyCode
• ClosingDetails

GetImage Method (InvStatement Component)

Request and retrieve a check or statement image (if available).

Syntax

DynamicArray<Byte> __fastcall GetImage(String ImageRef, String ImageRefType);

Remarks

This function generates the Signon and Download Image request page, submits it to the financial institution via secure HTTPS Post.

The requested image of a check or statement closing information is identified by ImageRef parameter. The type of this image reference should be specified by ImageRefType parameter.

Possible values and their meanings for the ImageRefType parameter are:

If you want the server to return image references for each transaction or statement closing information, and if the server supports image download service via OFX, you will have to set the IncludeImages to True when either GetStatement or GetClosingInfo method is called.

If available, then you can access that particular image by calling the GetImage method, where ImageRef parameter value is set to the image reference stored in TxImageRef (or ClosingDetailImageRef) and the ImageRefType parameter is set to the respective TxImageRefType (or ClosingDetailImageRefType) corresponding to the requested check or statement.

Upon successful response, the image content will be returned by this method. If you want the image to be saved to a file, you can set the ImageFileName to a desired 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.

Otherwise, the component will throw an error.

Image download is available only for OFX version 2.1.1. When this method is called, the OFXVersion is automatically 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 component) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

GetStatement Method (InvStatement Component)

Downloads statement for an investment account.

Syntax

void __fastcall GetStatement();

Remarks

This function generates the Signon and Investment Statement request page, submits it to the financial institution via secure HTTPS Post, receives and parses the investment statement.

This allows a customer to receive investment transactions, positions, open orders, balances and list of securities that are typically part of a regular paper statement. By using the transaction IDs supplied by FIs, OFX makes it possible that each transaction is downloaded only once. Calling of this method requires to designate an account for the download and to indicate what type of data should be downloaded.

The following properties should be set when this method is called:

• FIId (required)
• FIOrganization (required)
• FIUrl (required)
• OFXAppId (required)
• OFXAppVersion (required)
• OFXVersion (required if 2.x OFX version is the one supported by your FI)
• OFXUser (required)
• OFXPassword (required)
• BrokerId (required)
• AccountId (required)
• IncludeTransactions (required if the user does not want to include bank transactions in the current statement download - True by default)
• IncludePositions (required if the user does not want to include positions as well in the current statement download - True by default)
• IncludeOpenOrders (required if the user does not want to include open orders as well in the current statement download - True by default)
• IncludeBalances (required if the user does not want to include balances as well in the current statement download - True by default)

If the user wants to download investment bank transactions (i.e., IncludeTransactions is set to True), a date range (that the transactions fall within) can be specified by setting the StartDate and EndDate. Otherwise, the server will use default values if no dates are supplied.

The following information is returned in server's response:

For a full list of all read-only properties that are populated as a result of parsing the statement response, please look at OFXDataFile method remarks.

ReadOFXDataFile Method (InvStatement Component)

Reads an OFX response from a file.

Syntax

void __fastcall ReadOFXDataFile(String FileName);

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

• CurrencyCode
• MarketingInfo
• StatementDate
• AvailableCash
• BuyingPower
• MarginBalance
• ShortBalance
• Balances
• OpenOrders
• Positions
• Securities
• Transactions
• ClosingDetails

Reset Method (InvStatement Component)

Reset the internal state of the component and all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

WriteOFXDataFile Method (InvStatement Component)

Writes the OFX response sent by the server to a file.

Syntax

void __fastcall WriteOFXDataFile(String FileName);

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the ReadOFXDataFile method as though it were a live response.

ConnectionStatus Event (InvStatement Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TiboInvStatementConnectionStatusEventParams;
typedef void __fastcall (__closure *TiboInvStatementConnectionStatusEvent)(System::TObject* Sender, TiboInvStatementConnectionStatusEventParams *e);
__property TiboInvStatementConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Error Event (InvStatement Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiboInvStatementErrorEventParams;
typedef void __fastcall (__closure *TiboInvStatementErrorEvent)(System::TObject* Sender, TiboInvStatementErrorEventParams *e);
__property TiboInvStatementErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (InvStatement Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiboInvStatementSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiboInvStatementSSLServerAuthenticationEvent)(System::TObject* Sender, TiboInvStatementSSLServerAuthenticationEventParams *e);
__property TiboInvStatementSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (InvStatement Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TiboInvStatementSSLStatusEventParams;
typedef void __fastcall (__closure *TiboInvStatementSSLStatusEvent)(System::TObject* Sender, TiboInvStatementSSLStatusEventParams *e);
__property TiboInvStatementSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (InvStatement Component)

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----