BalAmount Property

The value of the current balance.

Object Oriented Interface

public function getBalAmount($balindex);

Procedural Interface

ipworksofx_invstatement_get($res, 6 , $balindex);

Default Value

''

Remarks

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

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

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

The $balindex parameter specifies the index of the item in the array. The size of the array is controlled by the BalCount property.

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

Data Type

String

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