Balances represent amounts on Balance Sheet accounts carried over from previous reporting periods. Consequently there can only be Balance Sheet account balances. Balances provide a way of decoupling reports between different reporting periods from each other.
entity
: The Entity associated with the balance. Defaults to the entity of the logged in user.exchangeRate
: The Exchange Rate of the Transaction object that originated the balance amount. Defaults to associated entity’s default exchange rate.currency
: The Currency of the Transaction object that originated the balance amount. Defaults to the entity’s reporting currency.account
: The Account associated with the balance.reportingPeriod
: The Reporting Period the balance pertains to.transaction_no
: The transaction number from the Transaction object that originated the balance amount.type
: The string representation of the Balance model balance_type
attribute.transaction_date
: The date of the Transaction object that originated the balance amount.transaction_type
: The type of the Transaction object that originated the balance amount. Defaults to Transaction::JN
.reference
: More information about the Transaction object that originated the balance amount.balance_type
: The side of the double entry the balance should be posted. Defaults to Balance::DEBIT
.amount
: The balance amount. This may or may not be the amount of the originating Transaction depending on its clearance in its reporting period.is_posted
: A boolean to mirror the Transaction model isPosted attribute because like some Transactions Balances are Clearable.is_credited
: A boolean to mirror the Transaction model isCredited attribute because like some Transactions Balances are Clearable.cleared_type
: The string representation of the Balance model because like some Transactions Balances are Clearable.Balance::DEBIT
: The debit side of the double entry in the sense of the balance of an asset.Balance::CREDIT
: The credit side of the double entry in the sense of the balance of an liability.Balance::getType($type):
The human readable type name of the given balance type.Balance::getTypes($types):
The human readable type names of the balance types in the given array.$balance->toString():
The string representation of the Balance object instance.$balance->attributes():
Presents the balance’s attributes as an object. Useful for debugging.NegativeAmount
: Balance amounts cannot be negative.InvalidBalanceTransaction
: Transaction type must be one of Transaction::IN
, Transaction::BL
or Transaction::JN
. See Transactions for details of Transaction Types.InvalidBalanceType
: Balance type must be one of Balance::DEBIT
or Balance::CREDIT
.InvalidAccountClassBalance
: Income Statement Account cannot have balances.InvalidCurrency
: Account type can only accept balances of the same currency as their own.InvalidBalanceDate
: Balance transaction date must be earlier than the first day of the balance’s reporting period unless the entity has the mid year flag set to true.