E-Banking Integrator V4 - Online Help
E-Banking Integrator V4
Questions / Feedback?

ClosingDetail Type

This type corresponds to a single statement closing information in the list of statement closings.

Remarks

ClosingDetail objects are used when listing the banking, credit card or investment statement closings information when the GetClosingInfo method is called.

Fields

Aggregate
String

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the component's fields. However, some of these elements, and/or their potential values, may not be supported by the component. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate component 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 component 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 fields:

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

BalanceClosing
String

Closing statement balance.

This is not applicable for loan accounts.

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 component 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 component 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. .

BalanceOpening
String

Opening statement balance.

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 component 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 component 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. .

CreditLimit
String

Current credit limit.

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 component 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 component 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 is applicable for credit card accounts only.

DateClose
String

Closing statement 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.

DateDue
String

Next payment due date. This is applicable to credit card and loan accounts only.

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.

DateEnd
String

End date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

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.

DateOpen
String

Opening statement 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.

DateStart
String

Start date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

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.

FITID
String

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.

ImageRef
String

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 ImageRefType.

ImageRefType
String

Type of retrieval method for actual statement closing image.

If ImageRef 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 ImageRefType are:

Value Meaning
OPAQUE Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the GetImage method where ImageRef will be the parameter value for this method.
URL The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided.
FORMURL The image is accessed directly via an encoded URL. The client will send authentication to the server.

InterestRate
String

Current loan interest rate.

This is applicable for loan accounts only.

InterestRateType
String

Type of the current loan interest rate.

This is applicable for loan accounts only.

Possible values and their meanings are:

Value Meaning
FIXED Fixed rate for the life of the loan
FLOATING Floating interest rate
ARM Adjustable rate mortgage

MinimumPayment
String

Next minimum amount due. This is applicable to credit card and loan accounts only.

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 component 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 component 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. .

TotalCredit
String

Total credit posted on the account for this statement (period indicated by DateStart and DateEnd).

In a bank statement (checking, savings or money market account), this represents total of deposits and credits, including interest. In a credit card statement, this represents total of payments and credits.

TotalDebit
String

Total of debit posted on the account for this statement (period indicated by DateStart and DateEnd).

In a bank statement (checking, savings or money market account), this represents total of checks and debits, including fees. In a credit card statement, this represents total of payments and credits.

TotalFees
String

Total fees.

In a bank statement (checking, savings or money market account), this represents total of all fees. While in a credit card statement, this represents finance charge.

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 component 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 component 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. .

TotalInterest
String

Total interest.

For bank or investment accounts, this indicates total interest posted on the account for this statement (period indicated by DateStart and DateEnd).

For loan accounts, this indicates total interest paid year to date.

This is not applicable for credit card accounts.

Constructors

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0