OFXBatchItemRequestType Property

The type of OFX request included in the batch.

Syntax

 ofxbatch.getOFXBatchItemRequestType(index, [callback])

Default Value

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 the getOFXBatchItemRequestType([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setOFXBatchItemRequestType([callback]) 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

The type of OFX request included in the batch. Request types supported by OFXBatch component are: Account Info, Bank, Credit Card, Loan, and Investment statement download, Intrabank and Interbank Transfer, Bill Pay, and FI Profile. The support for these requests depend whether the FI OFX server supports that request type and whether they allow it to be part of a batch request.

Possible values and their meanings are as follows:


Value	Meaning
ACCTINFO	Account Information request
STMT	Bank Statement request
CCSTMT	Credit Card Statement request
LOANSTMT	Loan Statement request
INVSTMT	Investment Statement request
INTRA	Intrabank Transfer request (Note: This is subject to synchronization and should be followed by calling the SynchronizeTransfers; method in BankTransfer class, depending on what was requested as part of the batch.)
INTER	Interbank Transfer request (Note: This is subject to synchronization and should be followed by calling the SynchronizeTransfers; method in BankTransfer class, depending on what was requested as part of the batch.)
BILLPAY	Bill Payment request (Note: This is subject to synchronization and should be followed by calling the SynchronizePayments; and/or SynchronizePayees methods in BillPayment class, depending on what was requested as part of the batch.)
PROF	FI Profile request

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

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

Data Type