GetClosingInfo Method

Download a statement closing information for an investment account.

Syntax

invstatement.getClosingInfo([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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