GetStatement Method
Download a bank statement.
Syntax
ANSI (Cross Platform) int GetStatement(); Unicode (Windows) INT GetStatement();
- (void)getStatement;
#define MID_BANKSTATEMENT_GETSTATEMENT 5 IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BankStatement_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This function generates the Signon and Bank Statement request page, submits it to the financial institution via secure HTTPS Post, receives and parses the bank statement. Individual transactions are downloaded with the statement.
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)
- BankId (required)
- AccountId (required)
- AccountType (required)
You may constrain this transaction list by setting the StartDate and EndDate properties. The server will use default values if no dates are supplied.
If you want the server to return image references for each transaction, 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:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)