Bestand zählen und summieren
bb_records_collectCount and sum receipts, payments, or postings across all pages to return totals instead of full row lists. Answers questions like how many open invoices exist or what ran through PayPal in March.
Instructions
Läuft serverseitig über alle Seiten von Belegen, Zahlungen oder Buchungen und liefert Anzahl und Summe statt aller Zeilen; Einzelzeilen erst ab max_rows. Beantwortet 'wie viele offenen Eingangsrechnungen gibt es', 'was ist im März über PayPal gelaufen' und 'finde Rechnung 4711 in beiden Richtungen'. Ersetzt für Zählen und Summieren bb_receipts_search, bb_transactions_search und bb_postings_search; für einzelne Felder, Sortierung oder weitere Filter bleiben diese Werkzeuge zuständig. Summen erscheinen nur, wenn der Bestand vollständig gelesen wurde. Höchstens 10 Aufrufe an die API, list_direction 'both' verdoppelt sie; der Token-Eimer ist prozesslokal, zwei Clients auf demselben Mandanten teilen ihn nicht.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Zahlungskonto, nur bei resource 'transactions'. Kontoname ODER Kontonummer, zum Beispiel PayPal oder 1201. Ein Name wird über die Kontenliste aufgelöst; bei mehreren oder keinem Treffer bricht der Aufruf vor dem ersten Listenabruf ab und nennt die Kandidaten, statt zu raten. Entspricht payment_account_number in bb_transactions_search, nimmt aber zusätzlich einen Namen entgegen. | |
| date_to | No | Spätestes Datum, eingeschlossen, als YYYY-MM-DD, zum Beispiel 2026-01-31. Bei resource 'postings' Pflicht, sonst dringend empfohlen. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. | |
| group_by | No | Serverseitige Gruppierung der gelesenen Zeilen. 'month' fasst nach Kalendermonat zusammen, 'counterparty' nach Gegenpartei (nicht bei 'postings'), 'none' liefert keine Gruppen. Vorgabe ist 'month'. Gruppen und Summen erscheinen nur, wenn der Bestand vollständig gelesen wurde. | |
| max_rows | No | Höchstzahl der Einzelzeilen in der Antwort, 0 bis 200, VORGABE 0. Null heißt: nur Kennzahlen, keine Einzelzeilen. Für eine Kontoauszugsansicht auf 50 setzen. Der Wert wirkt serverseitig; gelesen und ausgewertet werden immer alle Seiten bis zur Aufrufobergrenze. | |
| resource | Yes | Was gezählt wird. 'receipts' sind Belege, also Eingangs- und Ausgangsrechnungen; 'transactions' sind Zahlungen, also Kontoumsätze; 'postings' sind Buchungssätze. Pflichtangabe. Bei 'postings' sind date_from und date_to ebenfalls Pflicht. | |
| date_from | No | Frühestes Datum, eingeschlossen, als YYYY-MM-DD, zum Beispiel 2026-01-01. Bei resource 'postings' Pflicht, sonst dringend empfohlen: Ohne Zeitraum läuft das Blättern gegen die Aufrufobergrenze. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. | |
| counterparty | No | Gegenpartei als Filter, nur bei resource 'receipts'. Bei Eingangsbelegen der Rechnungssteller, bei Ausgangsbelegen der Empfänger. Freitext des Belegs; die Schreibweise kann von der des Kontonamens abweichen. | |
| invoicenumber | No | Rechnungsnummer als Filter, nur bei resource 'receipts'. Zusammen mit list_direction 'both' ist das der Weg, eine Rechnung zu finden, ohne ihre Richtung zu kennen. | |
| list_direction | No | Richtung der Belegliste, nur bei resource 'receipts'. 'inbound' sind Eingangsbelege, also Rechnungen, die der Mandant erhalten hat; 'outbound' sind Ausgangsbelege, also Rechnungen, die der Mandant stellt; 'both' läuft über beide Richtungen und verdoppelt dabei die Zahl der Aufrufe. Vorgabe ist 'both'. Die API kennt nur die beiden Einzelwerte; 'both' ist eine Zutat dieses Servers und wird in zwei getrennten Läufen abgebildet. | |
| payment_status | No | Zahlungsstand als Filter, nur bei resource 'receipts'. 'unpaid' ist die Antwort auf die Frage nach den offenen Belegen, 'paid' auf die nach den bezahlten. Der Filter arbeitet auf dem Server von BuchhaltungsButler. Ein offener Betrag wird daraus NICHT abgeleitet: Die Felder amount_paid und amount_paid_fixed sind in diesem Mandanten gemessen auch bei bezahlten Belegen 0.00, und Teilzahlungen sind in der Belegliste nicht erkennbar. | |
| 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 | No | ||
| notes | No | ||
| bundle | Yes | ||
| filter | No | ||
| groups | No | ||
| account | No | ||
| success | Yes | ||
| resource | Yes | ||
| rows_read | Yes | ||
| directions | No | ||
| sum_of_rows_read | No | ||
| account_candidates | No | ||
| duplicates_discarded | No | ||
| sum_of_rows_read_cents | No |