Zahlungen suchen
bb_transactions_searchSearch bank transactions in BuchhaltungsButler by date range, amount, or counterparty, and page through results with limit and offset to locate the matching receipt for a document.
Instructions
Sucht Zahlungen, also Kontoumsätze, in BuchhaltungsButler und liefert sie seitenweise. Zu nehmen, um den Umsatz zu einem Beleg zu finden, zum Beispiel alle Zahlungen eines Zahlungskontos zwischen date_from 2026-01-01 und date_to 2026-01-31. Eine einzelne, schon bekannte Zahlung holt bb_transactions_get kürzer; die zugeordneten Belege liefert bb_transactions_list_receipts. Diese Liste führt sechs Felder und darunter kein account: Auf welchem Zahlungskonto eine Zahlung liegt, zeigt erst bb_transactions_get. Höchstens 500 Zeilen je Aufruf, danach mit offset weiterblättern; eine Gesamttrefferzahl nennt die API zu keinem Zeitpunkt. date_from und date_to schließen den genannten Tag ein, id_by_customer_from und id_by_customer_to den genannten Wert dagegen nicht.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Zeilen je Aufruf. Harte Obergrenze 500. Größere Werte lehnt die API ab, sie kappt sie nicht. | |
| offset | No | Zahl der zu überspringenden Zeilen. Die zweite Seite einer Suche mit limit=100 holt offset=100. | |
| date_to | No | Spätestes Buchungsdatum der gesuchten Zahlungen als YYYY-MM-DD, zum Beispiel 2026-04-26. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. | |
| to_from | No | Nur Zahlungen dieses Zahlenden oder Empfängers, zum Beispiel 'Muster GmbH'. Ob die API dabei auf Teilwörter vergleicht, sagt die Spezifikation nicht. | |
| date_from | No | Frühestes Buchungsdatum der gesuchten Zahlungen als YYYY-MM-DD, zum Beispiel 2026-04-26. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. | |
| 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 |
| id_by_customer_to | No | Obere Grenze der mandantenbezogenen Nummer id_by_customer. Geliefert werden Zahlungen mit kleinerer Nummer; die Zahlung mit genau diesem Wert nicht. Setzt die Sortierung auf id_by_customer ASC, auch in Kombination mit date_from und date_to. In Suchergebnissen erscheint sie als String; hier ohne Anführungszeichen übergeben. | |
| id_by_customer_from | No | Untere Grenze der mandantenbezogenen Nummer id_by_customer. Geliefert werden Zahlungen mit größerer Nummer; die Zahlung mit genau diesem Wert nicht. Setzt die Sortierung auf id_by_customer ASC, auch in Kombination mit date_from und date_to. In Suchergebnissen erscheint sie als String; hier ohne Anführungszeichen übergeben. | |
| payment_account_number | No | Nur Zahlungen dieses Zahlungskontos. Sachkontonummer, die ein Zahlungskonto bezeichnet, zum Beispiel '1200'. Nicht das Sachkonto, auf das gebucht wird. Zahlungskonten auflisten mit bb_payment_accounts_list. Der Body-Parameter der API heißt account. | |
| date_since_last_modified | No | Untere Grenze für date_updated der Zahlung als YYYY-MM-DD HH:MM:SS, zum Beispiel 2026-04-26 13:45:00. Ein reines Datum YYYY-MM-DD gilt als 23:59:59 dieses Tages. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. Geliefert werden nur Zahlungen, die danach geändert wurden. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| message | No | ||
| success | Yes | ||
| endpoint | No | ||
| limit_used | No | ||
| offset_used | No | ||
| more_possible | No | ||
| rows_returned | No | ||
| _contract_warnings | No |