Account balance
banana_balanceRetrieve current accounting balances for accounts, groups, or balance classes, with support for periods, frequencies, and transaction filters.
Instructions
Return the current accounting balance figure for an account, group or balance class. Use _p1/_p2 doc suffixes for previous years. Supports period, frequency and filter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc | No | Accounting document name as opened in Banana (e.g. "accounting.ac2"). Append "_p1", "_p2" for previous years. Defaults to BANANA_DEFAULT_DOC if set. | |
| type | Yes | Amount type to return (opening, credit, debit, total, balance, *currency, rowcount). | |
| filter | No | JavaScript expression to filter transactions, e.g. filter=row.value("Date")==="2024-01-15". Available: row, rowNr, table. | |
| period | No | Period filter: an abbreviation like "Q1"/"3M"/"1Y" or a date range "2024-01-01/2024-03-31". | |
| account | Yes | Account/group/class selector: an account id ("1000"), group ("Gr=6"), balance class ("BClass=1"), or pipe-separated accounts ("1000|1010|1020"). | |
| frequency | No | Frequency: D=daily, W=weekly, M=monthly, Q=quarterly, S=semesterly, Y=yearly. |