InvStatement Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

InEBank_InvStatement

Procedural Interface

 inebank_invstatement_open();
 inebank_invstatement_close($res);
 inebank_invstatement_register_callback($res, $id, $function);
 inebank_invstatement_get_last_error($res);
 inebank_invstatement_get_last_error_code($res);
 inebank_invstatement_set($res, $id, $index, $value);
 inebank_invstatement_get($res, $id, $index);
 inebank_invstatement_do_config($res, $configurationstring);
 inebank_invstatement_do_getclosinginfo($res);
 inebank_invstatement_do_getimage($res, $imageref, $imagereftype);
 inebank_invstatement_do_getstatement($res);
 inebank_invstatement_do_readofxdatafile($res, $filename);
 inebank_invstatement_do_reset($res);
 inebank_invstatement_do_writeofxdatafile($res, $filename);

Remarks

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

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

The following properties provide additional control over the request:

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AccountId Property (InEBank_InvStatement Class)

The account number used for the next statement download.

Object Oriented Interface

public function getAccountId();


public function setAccountId($value);

Procedural Interface

inebank_invstatement_get($res, 1 );


inebank_invstatement_set($res, 1, $value );

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 (InEBank_InvStatement Class)

Date for returned list of positions.

Object Oriented Interface

public function getAsOfDate();


public function setAsOfDate($value);

Procedural Interface

inebank_invstatement_get($res, 2 );


inebank_invstatement_set($res, 2, $value );

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 (InEBank_InvStatement Class)

Cash balance across all sub-accounts.

Object Oriented Interface

public function getAvailableCash();

Procedural Interface

inebank_invstatement_get($res, 3 );

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 (InEBank_InvStatement Class)

The number of records in the Bal arrays.

Object Oriented Interface

public function getBalCount();

Procedural Interface

inebank_invstatement_get($res, 4 );

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 (InEBank_InvStatement Class)

Wrapper for an investment balance.

Object Oriented Interface

public function getBalAggregate($balindex);

Procedural Interface

inebank_invstatement_get($res, 5 , $balindex);

Default Value

''

Remarks

Wrapper for an investment balance.

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

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

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

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

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

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

Data Type

String

BalAmount Property (InEBank_InvStatement Class)

The value of the current balance.

Object Oriented Interface

public function getBalAmount($balindex);

Procedural Interface

inebank_invstatement_get($res, 6 , $balindex);

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 (InEBank_InvStatement Class)

The type of balance.

Object Oriented Interface

public function getBalType($balindex);

Procedural Interface

inebank_invstatement_get($res, 7 , $balindex);

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

BalDescription Property (InEBank_InvStatement Class)

A description of the current balance.

Object Oriented Interface

public function getBalDescription($balindex);

Procedural Interface

inebank_invstatement_get($res, 8 , $balindex);

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 (InEBank_InvStatement Class)

The name for the current balance.

Object Oriented Interface

public function getBalName($balindex);

Procedural Interface

inebank_invstatement_get($res, 9 , $balindex);

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 (InEBank_InvStatement Class)

A description of the balance type.

Object Oriented Interface

public function getBalTypeDescription($balindex);

Procedural Interface

inebank_invstatement_get($res, 10 , $balindex);

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 (InEBank_InvStatement Class)

Unique identifier for the FI.

Object Oriented Interface

public function getBrokerId();


public function setBrokerId($value);

Procedural Interface

inebank_invstatement_get($res, 11 );


inebank_invstatement_set($res, 11, $value );

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 (InEBank_InvStatement Class)

Buying power.

Object Oriented Interface

public function getBuyingPower();

Procedural Interface

inebank_invstatement_get($res, 12 );

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 (InEBank_InvStatement Class)

The number of records in the ClosingDetail arrays.

Object Oriented Interface

public function getClosingDetailCount();

Procedural Interface

inebank_invstatement_get($res, 13 );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getClosingDetailAggregate($closingdetailindex);

Procedural Interface

inebank_invstatement_get($res, 14 , $closingdetailindex);

Default Value

''

Remarks

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

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

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

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

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

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

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

Data Type

String

ClosingDetailFITID Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getClosingDetailFITID($closingdetailindex);

Procedural Interface

inebank_invstatement_get($res, 23 , $closingdetailindex);

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 (InEBank_InvStatement Class)

Server specified unique identifier for the statement closing image.

Object Oriented Interface

public function getClosingDetailImageRef($closingdetailindex);

Procedural Interface

inebank_invstatement_get($res, 24 , $closingdetailindex);

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 (InEBank_InvStatement Class)

Type of retrieval method for actual statement closing image.

Object Oriented Interface

public function getClosingDetailImageRefType($closingdetailindex);

Procedural Interface

inebank_invstatement_get($res, 25 , $closingdetailindex);

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 (InEBank_InvStatement Class)

Default currency code for this statement.

Object Oriented Interface

public function getCurrencyCode();

Procedural Interface

inebank_invstatement_get($res, 33 );

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 (InEBank_InvStatement Class)

End date of requested transaction list.

Object Oriented Interface

public function getEndDate();


public function setEndDate($value);

Procedural Interface

inebank_invstatement_get($res, 34 );


inebank_invstatement_set($res, 34, $value );

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 (InEBank_InvStatement Class)

Financial institution identifier.

Object Oriented Interface

public function getFIId();


public function setFIId($value);

Procedural Interface

inebank_invstatement_get($res, 35 );


inebank_invstatement_set($res, 35, $value );

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 (InEBank_InvStatement Class)

Financial institution organization name.

Object Oriented Interface

public function getFIOrganization();


public function setFIOrganization($value);

Procedural Interface

inebank_invstatement_get($res, 36 );


inebank_invstatement_set($res, 36, $value );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

inebank_invstatement_get($res, 37 );


inebank_invstatement_set($res, 37, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (InEBank_InvStatement Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

inebank_invstatement_get($res, 38 );


inebank_invstatement_set($res, 38, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

inebank_invstatement_get($res, 39 );


inebank_invstatement_set($res, 39, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

inebank_invstatement_get($res, 40 );


inebank_invstatement_set($res, 40, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

inebank_invstatement_get($res, 41 );


inebank_invstatement_set($res, 41, $value );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

inebank_invstatement_get($res, 42 );


inebank_invstatement_set($res, 42, $value );

Default Value

''

Remarks

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

Data Type

String

FIUrl Property (InEBank_InvStatement Class)

Financial institution URL.

Object Oriented Interface

public function getFIUrl();


public function setFIUrl($value);

Procedural Interface

inebank_invstatement_get($res, 43 );


inebank_invstatement_set($res, 43, $value );

Default Value

''

Remarks

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

Data Type

String

ImageFileName Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getImageFileName();


public function setImageFileName($value);

Procedural Interface

inebank_invstatement_get($res, 44 );


inebank_invstatement_set($res, 44, $value );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getIncludeBalances();


public function setIncludeBalances($value);

Procedural Interface

inebank_invstatement_get($res, 45 );


inebank_invstatement_set($res, 45, $value );

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeImages Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getIncludeImages();


public function setIncludeImages($value);

Procedural Interface

inebank_invstatement_get($res, 46 );


inebank_invstatement_set($res, 46, $value );

Default Value

false

Remarks

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

Otherwise, if the FI supports image download service :

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

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

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

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

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

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

Data Type

Boolean

IncludeOpenOrders Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getIncludeOpenOrders();


public function setIncludeOpenOrders($value);

Procedural Interface

inebank_invstatement_get($res, 47 );


inebank_invstatement_set($res, 47, $value );

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludePositions Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getIncludePositions();


public function setIncludePositions($value);

Procedural Interface

inebank_invstatement_get($res, 48 );


inebank_invstatement_set($res, 48, $value );

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

IncludeTransactions Property (InEBank_InvStatement Class)

Whether to include transactions in the statement download.

Object Oriented Interface

public function getIncludeTransactions();


public function setIncludeTransactions($value);

Procedural Interface

inebank_invstatement_get($res, 49 );


inebank_invstatement_set($res, 49, $value );

Default Value

true

Remarks

This property is required when the GetStatement method is called.

Data Type

Boolean

MarginBalance Property (InEBank_InvStatement Class)

Margin balance.

Object Oriented Interface

public function getMarginBalance();

Procedural Interface

inebank_invstatement_get($res, 50 );

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 (InEBank_InvStatement Class)

Marketing information (at most one).

Object Oriented Interface

public function getMarketingInfo();

Procedural Interface

inebank_invstatement_get($res, 51 );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getOFXAccessKey();


public function setOFXAccessKey($value);

Procedural Interface

inebank_invstatement_get($res, 52 );


inebank_invstatement_set($res, 52, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

OFXAppId Property (InEBank_InvStatement Class)

OFX application identifier.

Object Oriented Interface

public function getOFXAppId();


public function setOFXAppId($value);

Procedural Interface

inebank_invstatement_get($res, 53 );


inebank_invstatement_set($res, 53, $value );

Default Value

''

Remarks

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

Data Type

String

OFXAppVersion Property (InEBank_InvStatement Class)

OFX application version.

Object Oriented Interface

public function getOFXAppVersion();


public function setOFXAppVersion($value);

Procedural Interface

inebank_invstatement_get($res, 54 );


inebank_invstatement_set($res, 54, $value );

Default Value

''

Remarks

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

Data Type

String

OFXPassword Property (InEBank_InvStatement Class)

User's password.

Object Oriented Interface

public function getOFXPassword();


public function setOFXPassword($value);

Procedural Interface

inebank_invstatement_get($res, 55 );


inebank_invstatement_set($res, 55, $value );

Default Value

''

Remarks

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

Data Type

String

OFXRequest Property (InEBank_InvStatement Class)

The current OFX request aggregate.

Object Oriented Interface

public function getOFXRequest();

Procedural Interface

inebank_invstatement_get($res, 56 );

Default Value

''

Remarks

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

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

Data Type

String

OFXResponse Property (InEBank_InvStatement Class)

The current OFX response aggregate.

Object Oriented Interface

public function getOFXResponse();


public function setOFXResponse($value);

Procedural Interface

inebank_invstatement_get($res, 57 );


inebank_invstatement_set($res, 57, $value );

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 (InEBank_InvStatement Class)

User's id.

Object Oriented Interface

public function getOFXUser();


public function setOFXUser($value);

Procedural Interface

inebank_invstatement_get($res, 58 );


inebank_invstatement_set($res, 58, $value );

Default Value

''

Remarks

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

Data Type

String

OFXVersion Property (InEBank_InvStatement Class)

OFX API version.

Object Oriented Interface

public function getOFXVersion();


public function setOFXVersion($value);

Procedural Interface

inebank_invstatement_get($res, 59 );


inebank_invstatement_set($res, 59, $value );

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 (InEBank_InvStatement Class)

The number of records in the OO arrays.

Object Oriented Interface

public function getOOCount();

Procedural Interface

inebank_invstatement_get($res, 60 );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getOOAggregate($ooindex);

Procedural Interface

inebank_invstatement_get($res, 61 , $ooindex);

Default Value

''

Remarks

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

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

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

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

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

Data Type

String

OOBuyType Property (InEBank_InvStatement Class)

Type of purchase for this open order.

Object Oriented Interface

public function getOOBuyType($ooindex);

Procedural Interface

inebank_invstatement_get($res, 62 , $ooindex);

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 (InEBank_InvStatement Class)

Date-time the order was placed.

Object Oriented Interface

public function getOODatePlaced($ooindex);

Procedural Interface

inebank_invstatement_get($res, 63 , $ooindex);

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 (InEBank_InvStatement Class)

Indicates how long the open order is good for.

Object Oriented Interface

public function getOODuration($ooindex);

Procedural Interface

inebank_invstatement_get($res, 64 , $ooindex);

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 (InEBank_InvStatement Class)

Transaction Id assigned by the financial institution.

Object Oriented Interface

public function getOOFITID($ooindex);

Procedural Interface

inebank_invstatement_get($res, 65 , $ooindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getOOMemo($ooindex);

Procedural Interface

inebank_invstatement_get($res, 66 , $ooindex);

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 (InEBank_InvStatement Class)

Type for general open order aggregate.

Object Oriented Interface

public function getOOType($ooindex);

Procedural Interface

inebank_invstatement_get($res, 67 , $ooindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

OORestriction Property (InEBank_InvStatement Class)

Special restriction on the open order.

Object Oriented Interface

public function getOORestriction($ooindex);

Procedural Interface

inebank_invstatement_get($res, 68 , $ooindex);

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 (InEBank_InvStatement Class)

Security ID for this open order.

Object Oriented Interface

public function getOOSecurityId($ooindex);

Procedural Interface

inebank_invstatement_get($res, 69 , $ooindex);

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 (InEBank_InvStatement Class)

Type of sale.

Object Oriented Interface

public function getOOSellType($ooindex);

Procedural Interface

inebank_invstatement_get($res, 70 , $ooindex);

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 (InEBank_InvStatement Class)

This identifies the type of a sub-account.

Object Oriented Interface

public function getOOSubAccountType($ooindex);

Procedural Interface

inebank_invstatement_get($res, 71 , $ooindex);

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 (InEBank_InvStatement Class)

A description of the open order type.

Object Oriented Interface

public function getOOTypeDescription($ooindex);

Procedural Interface

inebank_invstatement_get($res, 72 , $ooindex);

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 (InEBank_InvStatement Class)

Quantity of the security the open order is for.

Object Oriented Interface

public function getOOUnits($ooindex);

Procedural Interface

inebank_invstatement_get($res, 73 , $ooindex);

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 (InEBank_InvStatement Class)

What the units represent.

Object Oriented Interface

public function getOOUnitType($ooindex);

Procedural Interface

inebank_invstatement_get($res, 74 , $ooindex);

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 (InEBank_InvStatement Class)

The number of records in the Pos arrays.

Object Oriented Interface

public function getPosCount();

Procedural Interface

inebank_invstatement_get($res, 75 );

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getPosAccount($posindex);

Procedural Interface

inebank_invstatement_get($res, 76 , $posindex);

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 (InEBank_InvStatement Class)

Wrapper for a position information.

Object Oriented Interface

public function getPosAggregate($posindex);

Procedural Interface

inebank_invstatement_get($res, 77 , $posindex);

Default Value

''

Remarks

Wrapper for a position information.

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

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

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

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

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

Data Type

String

PosDatePriceAsOf Property (InEBank_InvStatement Class)

Date and time of unit price and market value.

Object Oriented Interface

public function getPosDatePriceAsOf($posindex);

Procedural Interface

inebank_invstatement_get($res, 78 , $posindex);

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 (InEBank_InvStatement Class)

Current market value of this position.

Object Oriented Interface

public function getPosMarketValue($posindex);

Procedural Interface

inebank_invstatement_get($res, 79 , $posindex);

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 (InEBank_InvStatement Class)

Memo regarding this position.

Object Oriented Interface

public function getPosMemo($posindex);

Procedural Interface

inebank_invstatement_get($res, 80 , $posindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getPosOption($posindex);

Procedural Interface

inebank_invstatement_get($res, 81 , $posindex);

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 (InEBank_InvStatement Class)

Type for general position aggregate.

Object Oriented Interface

public function getPosType($posindex);

Procedural Interface

inebank_invstatement_get($res, 82 , $posindex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

PosSecurityId Property (InEBank_InvStatement Class)

The security ID for this position.

Object Oriented Interface

public function getPosSecurityId($posindex);

Procedural Interface

inebank_invstatement_get($res, 83 , $posindex);

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 (InEBank_InvStatement Class)

A description of the position type.

Object Oriented Interface

public function getPosTypeDescription($posindex);

Procedural Interface

inebank_invstatement_get($res, 84 , $posindex);

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 (InEBank_InvStatement Class)

Unit price.

Object Oriented Interface

public function getPosUnitPrice($posindex);

Procedural Interface

inebank_invstatement_get($res, 85 , $posindex);

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 (InEBank_InvStatement Class)

Quantity of positions.

Object Oriented Interface

public function getPosUnits($posindex);

Procedural Interface

inebank_invstatement_get($res, 86 , $posindex);

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 (InEBank_InvStatement Class)

The number of records in the Sec arrays.

Object Oriented Interface

public function getSecCount();

Procedural Interface

inebank_invstatement_get($res, 87 );

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 (InEBank_InvStatement Class)

Wrapper for security information.

Object Oriented Interface

public function getSecAggregate($secindex);

Procedural Interface

inebank_invstatement_get($res, 88 , $secindex);

Default Value

''

Remarks

Wrapper for security information.

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

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

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

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

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

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

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

Data Type

String

SecAssetClass Property (InEBank_InvStatement Class)

Asset Class for the security (at most one).

Object Oriented Interface

public function getSecAssetClass($secindex);

Procedural Interface

inebank_invstatement_get($res, 89 , $secindex);

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 (InEBank_InvStatement Class)

Transaction Id assigned by the financial institution.

Object Oriented Interface

public function getSecFITID($secindex);

Procedural Interface

inebank_invstatement_get($res, 90 , $secindex);

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 (InEBank_InvStatement Class)

Memo regarding this security.

Object Oriented Interface

public function getSecMemo($secindex);

Procedural Interface

inebank_invstatement_get($res, 91 , $secindex);

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 (InEBank_InvStatement Class)

Full name of the security.

Object Oriented Interface

public function getSecName($secindex);

Procedural Interface

inebank_invstatement_get($res, 92 , $secindex);

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 (InEBank_InvStatement Class)

The type of security.

Object Oriented Interface

public function getSecType($secindex);

Procedural Interface

inebank_invstatement_get($res, 93 , $secindex);

Default Value

0

Remarks

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

The security types and their meanings are as follows:

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

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

Data Type

Integer

SecSecurityId Property (InEBank_InvStatement Class)

Security identifier.

Object Oriented Interface

public function getSecSecurityId($secindex);

Procedural Interface

inebank_invstatement_get($res, 94 , $secindex);

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 (InEBank_InvStatement Class)

Ticker symbol of the security.

Object Oriented Interface

public function getSecTicker($secindex);

Procedural Interface

inebank_invstatement_get($res, 95 , $secindex);

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 (InEBank_InvStatement Class)

A description of the security type.

Object Oriented Interface

public function getSecTypeDescription($secindex);

Procedural Interface

inebank_invstatement_get($res, 96 , $secindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getSecUnitPrice($secindex);

Procedural Interface

inebank_invstatement_get($res, 97 , $secindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getSecYield($secindex);

Procedural Interface

inebank_invstatement_get($res, 98 , $secindex);

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 (InEBank_InvStatement Class)

Market value of all short positions.

Object Oriented Interface

public function getShortBalance();

Procedural Interface

inebank_invstatement_get($res, 99 );

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 (InEBank_InvStatement Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inebank_invstatement_get($res, 101 );


inebank_invstatement_set($res, 101, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InEBank_InvStatement Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

inebank_invstatement_get($res, 129 );


inebank_invstatement_set($res, 129, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

inebank_invstatement_get($res, 145 );


inebank_invstatement_set($res, 145, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

inebank_invstatement_get($res, 146 );


inebank_invstatement_set($res, 146, $value );

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 (InEBank_InvStatement Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

inebank_invstatement_get($res, 147 );


inebank_invstatement_set($res, 147, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

inebank_invstatement_get($res, 148 );


inebank_invstatement_set($res, 148, $value );

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 (InEBank_InvStatement Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

inebank_invstatement_get($res, 156 );


inebank_invstatement_set($res, 156, $value );

Default Value

0

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (InEBank_InvStatement Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inebank_invstatement_get($res, 158 );

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

Binary String

StartDate Property (InEBank_InvStatement Class)

Start date of requested transaction list.

Object Oriented Interface

public function getStartDate();


public function setStartDate($value);

Procedural Interface

inebank_invstatement_get($res, 185 );


inebank_invstatement_set($res, 185, $value );

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 (InEBank_InvStatement Class)

Date and time for the statement download.

Object Oriented Interface

public function getStatementDate();

Procedural Interface

inebank_invstatement_get($res, 186 );

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 (InEBank_InvStatement Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

inebank_invstatement_get($res, 187 );


inebank_invstatement_set($res, 187, $value );

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

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 (InEBank_InvStatement Class)

The number of records in the Tx arrays.

Object Oriented Interface

public function getTxCount();

Procedural Interface

inebank_invstatement_get($res, 188 );

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 (InEBank_InvStatement Class)

Wrapper for an investment statement transaction.

Object Oriented Interface

public function getTxAggregate($txindex);

Procedural Interface

inebank_invstatement_get($res, 189 , $txindex);

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

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

The $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 (InEBank_InvStatement Class)

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.

Object Oriented Interface

public function getTxDate($txindex);

Procedural Interface

inebank_invstatement_get($res, 190 , $txindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getTxDateSettle($txindex);

Procedural Interface

inebank_invstatement_get($res, 191 , $txindex);

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 (InEBank_InvStatement Class)

Transaction Id assigned by the financial institution.

Object Oriented Interface

public function getTxFITID($txindex);

Procedural Interface

inebank_invstatement_get($res, 192 , $txindex);

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 (InEBank_InvStatement Class)

Other information (memo) regarding this transaction.

Object Oriented Interface

public function getTxMemo($txindex);

Procedural Interface

inebank_invstatement_get($res, 193 , $txindex);

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 (InEBank_InvStatement Class)

Name for this bank transaction.

Object Oriented Interface

public function getTxName($txindex);

Procedural Interface

inebank_invstatement_get($res, 194 , $txindex);

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 (InEBank_InvStatement Class)

Security ID for this investment transaction.

Object Oriented Interface

public function getTxSecurityId($txindex);

Procedural Interface

inebank_invstatement_get($res, 195 , $txindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getTxSubAccountFund($txindex);

Procedural Interface

inebank_invstatement_get($res, 196 , $txindex);

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 (InEBank_InvStatement Class)

Sub-account type for the security.

Object Oriented Interface

public function getTxSubAccountSec($txindex);

Procedural Interface

inebank_invstatement_get($res, 197 , $txindex);

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 (InEBank_InvStatement Class)

Transaction amount.

Object Oriented Interface

public function getTxTotal($txindex);

Procedural Interface

inebank_invstatement_get($res, 198 , $txindex);

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 class 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 class 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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getTxType($txindex);

Procedural Interface

inebank_invstatement_get($res, 199 , $txindex);

Default Value

0

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 (InEBank_InvStatement Class)

A description of the transaction type.

Object Oriented Interface

public function getTxTypeDescription($txindex);

Procedural Interface

inebank_invstatement_get($res, 200 , $txindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getTxUnitPrice($txindex);

Procedural Interface

inebank_invstatement_get($res, 201 , $txindex);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function getTxUnits($txindex);

Procedural Interface

inebank_invstatement_get($res, 202 , $txindex);

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 (InEBank_InvStatement Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inebank_invstatement_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (InEBank_InvStatement Class)

Download a statement closing information for an investment account.

Object Oriented Interface

public function doGetClosingInfo();

Procedural Interface

inebank_invstatement_do_getclosinginfo($res);

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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function doGetImage($imageref, $imagereftype);

Procedural Interface

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

GetStatement Method (InEBank_InvStatement Class)

Downloads statement for an investment account.

Object Oriented Interface

public function doGetStatement();

Procedural Interface

inebank_invstatement_do_getstatement($res);

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 (InEBank_InvStatement Class)

Reads an OFX response from a file.

Object Oriented Interface

public function doReadOFXDataFile($filename);

Procedural Interface

inebank_invstatement_do_readofxdatafile($res, $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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

inebank_invstatement_do_reset($res);

Remarks

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

WriteOFXDataFile Method (InEBank_InvStatement Class)

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

Object Oriented Interface

public function doWriteOFXDataFile($filename);

Procedural Interface

inebank_invstatement_do_writeofxdatafile($res, $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 (InEBank_InvStatement Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

inebank_invstatement_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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 (InEBank_InvStatement Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inebank_invstatement_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (InEBank_InvStatement Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inebank_invstatement_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (InEBank_InvStatement Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inebank_invstatement_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (InvStatement Class)

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