Kontostand und Kontenblatt
bb_balances_getRetrieves an account ledger with running balance to answer questions like 'does my cash balance match' and 'how much is on PayPal right now'. The final row shows the current balance.
Instructions
Liefert das Kontenblatt eines Kontos mit fortgeschriebenem Saldo und beantwortet damit 'stimmt mein Kassenbestand' und 'wie viel ist gerade auf PayPal'. account nimmt eine Kontonummer oder den Namen eines Zahlungskontos; die Nummer eines Sachkontos liefert bb_masterdata_search. Der Saldo steht in der letzten Zeile und enthält gemessen auch den Bestand vor date_from; gekürzt wird deshalb in der Mitte und nie am Ende. Ersetzt bb_reports_get_ledger für die Frage nach dem Kontostand; alle 24 Felder je Buchungszeile liefert weiterhin nur dieses Einzelwerkzeug. Ein leeres Kontenblatt ist kein Saldo von 0,00. Höchstens 2 Aufrufe an die API.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | Datumsgrundlage. 'date' ist das Buchungs- oder Rechnungsdatum, 'date_delivery_else_date' das Leistungsdatum und hilfsweise das Buchungsdatum. Vorgabe ist 'date'. | |
| account | Yes | Das Konto. Kontonummer ODER Name eines Zahlungskontos, zum Beispiel 1200 oder PayPal. Eine rein numerische Angabe wird unverändert als Kontonummer gesendet; ein Name wird über die Liste der Zahlungskonten aufgelöst und bei mehreren oder keinem Treffer abgelehnt, statt geraten. Sachkonten stehen nicht in dieser Liste: Ihre Nummer zuerst mit bb_masterdata_search nachschlagen und hier als Zahl eintragen. Entspricht postingaccount_number in bb_reports_get_ledger. | |
| date_to | Yes | Letzter Tag des Zeitraums, eingeschlossen, als YYYY-MM-DD. Für den heutigen Bestand das heutige Datum setzen. | |
| max_rows | No | Höchstzahl der angezeigten Buchungszeilen, 1 bis 200, Vorgabe 50. Gekürzt wird in der MITTE: Die letzten fünf Zeilen bleiben immer stehen, weil in der letzten der Saldo steht. Der Wert wirkt serverseitig und geht nicht an die API. | |
| date_from | Yes | Erster Tag des Zeitraums, eingeschlossen, als YYYY-MM-DD. Der Zeitraum darf eng sein: Der Saldo der letzten Zeile enthält gemessen auch den Bestand vor date_from. | |
| response_format | No | 'concise' liefert nur die Felder, die einen Datensatz erkennbar machen und den nächsten Schritt erlauben. 'detailed' liefert den Datensatz so, wie die BuchhaltungsButler-API ihn ausgibt. Mit 'concise' beginnen und nur für die wenigen Datensätze auf 'detailed' wechseln, die wirklich geprüft werden müssen. Dieses Feld ist serverseitig und geht nicht an die API. | concise |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | ||
| bundle | Yes | ||
| period | No | ||
| account | Yes | ||
| success | Yes | ||
| rows_shown | No | ||
| balance_end | Yes | ||
| rows_omitted | No | ||
| posting_count | No | ||
| standard_chart | No | ||
| integrity_error | No | ||
| account_candidates | No |