KYRIBA.GETBANKBALANCE
Overview
Returns account bank balance.
Syntax
KYRIBA.GETBANKBALANCE(accounts; [fields]; [date]; [type])
Note❗ The list separator (e.g., comma or semicolon) may differ depending on your Region settings.
| Parameter | Required/Optional | Description | Details |
|---|---|---|---|
| Accounts | ✅ Required | One or a range of account codes. | |
| Fields | 🟨 Optional | Specify fields to return. If omitted or equal to empty space, default fields are returned. |
Default fields: Bank balance amount; Currency code; Balance date. Enter “EXCEL” or “EXCELH” to return all the existing fields horizontally. Enter “EXCELV” to return all the existing fields vertically. Enter “JSON” to return the API response body. |
| Date | 🟨 Optional | Specify bank balance date. If omitted, the date is today. |
When passing a date as text to the custom function, make sure to either use the “YYYY-MM-DD” date format (e.g. "2024-01-31") or the DATEVALUE function to ensure Excel recognizes it correctly, such as DATEVALUE("23/12/2025"). |
| Type | 🟨 Optional | Specify bank balance type: END_OF_DAY or INTRADAY. If omitted, the type is END_OF_DAY. |
Examples
1. Bank balance of the account ORS_ACC01 for today. The requested fields are account.code and default ones.
Formula:
=KYRIBA.GETBANKBALANCE(“ORS_ACC01”;”account.code;”)
Result:
2. Bank balance of the account ORS_ACC01 for yesterday. All fields are requested to be returned vertically.
Formula:
=KYRIBA.GETBANKBALANCE("ORS_ACC01";"EXCELV";TODAY()-1)
Result:
