LoanStatement Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

InEBank_LoanStatement

Procedural Interface

 inebank_loanstatement_open();
 inebank_loanstatement_close($res);
 inebank_loanstatement_register_callback($res, $id, $function);
 inebank_loanstatement_get_last_error($res);
 inebank_loanstatement_get_last_error_code($res);
 inebank_loanstatement_set($res, $id, $index, $value);
 inebank_loanstatement_get($res, $id, $index);
 inebank_loanstatement_do_config($res, $configurationstring);
 inebank_loanstatement_do_getclosinginfo($res);
 inebank_loanstatement_do_getimage($res, $imageref, $imagereftype);
 inebank_loanstatement_do_getstatement($res);
 inebank_loanstatement_do_readofxdatafile($res, $filename);
 inebank_loanstatement_do_reset($res);
 inebank_loanstatement_do_writeofxdatafile($res, $filename);

Remarks

The LoanStatement class adds loan statement download functionality to your desktop application, or allows your web application to fetch a user's loan 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 class receives the secure response and parses the response into its properties.

To use the LoanStatement 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 AccountId and AccountType properties to the appropriate values to identify the account for which you wish to download a loan statement. You may also set StartDate and EndDate properties to constrain the transaction list.

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 properties will be populated automatically, as well as the StartDate, EndDate, AvailableBalance, PrincipalBalance, and any other data the loan statement includes.

The transaction properties (TxAmount, TxCheckNumber TxDatePosted, TxFITID, TxMemo, TxPayeeName, and TxType, etc.) may be imagined as arrays, so that the getter function for each property takes as its argument the index of a transaction in the list.

For example, TxAmount(0) gives the amount of the first transaction for the last statement downloaded.

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.

Note: Loan Statement Download is supported only in OFX Versions 2.1.0 and 2.1.1. If your FI does not support this OFX version, then you will not be able to use this class.