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

AvailableBalance Property

Amount of the available balance.

Object Oriented Interface

public function getAvailableBalance();

Procedural Interface

inebank_bankstatement_get($res, 3 );

Default Value

''

Remarks

This is the amount of money available from a given account.

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

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