LedgerBalance Property

Amount of the ledger balance.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetLedgerBalance();

Unicode (Windows)
LPWSTR GetLedgerBalance();

@property (nonatomic,readonly,assign,getter=ledgerBalance) NSString* ledgerBalance;
- (NSString*)ledgerBalance;

#define PID_BANKSTATEMENT_LEDGERBALANCE 34

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_BankStatement_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

Default Value

""

Remarks

This value reflects the account balance as posted in the financial institution's records.

For bank accounts, LedgerBalance represents the last balance recorded in official documents. AvailableBalance represents the value in the ledger balance once all temporary authorizations, such as ATM withdrawals, have posted to the ledger. Any positive value means that funds are available while negative values mean that the account is overdrawn.

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 class 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 class 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 property is read-only.

Data Type

String