IPWorks OFX 2020 Android Edition

Questions / Feedback?

BalanceDetail Type

This type corresponds to a single investment balance in the list of balances.

Remarks

BalanceDetail objects are used when listing balances (if any) returned by the FI OFX server when the GetStatement, ReadOFXDataFile, or WriteOFXDataFile methods are called.

Fields

Aggregate
String

Wrapper for an investment balance.

This allows an FI to send any number of balances to the user, complete with description and Help text. The intent is to capture the same type of balance information present on the first page of many FI brokerage statements. This aggregate can also be used to send margin call information.

This property is an optional field. When calling the GetStatement method, if the server's response does not contain this value, querying the property will return an empty 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.

Amount
String

The value of the current balance. Interpretation of this depends on the value of BalType field:

Value of BalTypeFormat of Amount
DOLLARFormatted as DDDD.cc
PERCENTFormatted as XXXX.YYYY
NUMBERFormatted as is

If a balance list is present in the server response, the Amount is always present in the response for each balance listed.

BalType
int

The type of balance. Possible values for balance types and their meanings are as follows:

btDOLLAR (0)Dollar (Value formatted as DDDD.cc)
btPERCENT (1)percentage (Value formatted as XXXX.YYYY)
btNUMBER (2)number (Value formatted as is)
ptOTHER (255)Other

If a balance list is present in the server response, the BalType is always present in the response for each balance listed.

Description
String

A description of the current balance. If a balance list is present in the server response, the Description is always present in the response for each balance listed.

Name
String

The name for the current balance. If a balance list is present in the server response, the Name is always present in the response for each balance listed.

TypeDescription
String

A description of the balance type. This is a string representation of the value returned by the BalType field.

The corresponding description for each balance type are as follows:

btDOLLAR (0)Dollar
btPERCENT (1)Dollar
btNUMBER (2)Number
btOTHER (255)Other

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Android Edition - Version 20.0 [Build 7941]