Bericht erzeugen und abholen
bb_reports_runRun a BWA or sum-and-balance report for a date range, wait for calculation, and get the result immediately—replacing any prior report of the same type.
Instructions
Erzeugt eine BWA oder eine Summen- und Saldenliste für einen Zeitraum, wartet auf die serverseitige Berechnung und liefert die fertige Auswertung im selben Aufruf zurück. Dabei wird geschrieben: /reports/create/bwa beziehungsweise /reports/create/sums ersetzt den zuvor erzeugten Bericht desselben Typs im ganzen Mandanten, und ein gleichzeitig arbeitender zweiter Nutzer verliert damit seinen Bericht. Ersetzt die zuvor in BuchhaltungsButler erzeugte Auswertung desselben Typs. Buchungsdaten ändern sich dabei nicht, und die Auswertung lässt sich jederzeit neu erzeugen. Viele Clients brechen den Aufruf nach rund 60 Sekunden ab; erzeugt und ersetzt ist der Bericht dann trotzdem und nur noch mit bb_reports_get_bwa oder bb_reports_get_sums abzuholen. Bei aktivem BB_MCP_READ_ONLY gesperrt; lesend bleiben diese beiden und bb_reports_get_ledger. Dateien wie PDF oder CSV liefert es nie.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | Datum der Periodenzuordnung, NUR bei report_type 'sums'. 'date' ist das Buchungs- oder Rechnungsdatum, 'date_delivery_else_date' das Leistungsdatum und ersatzweise das Buchungsdatum. Ohne Angabe 'date'. Bei report_type 'bwa' wird das Feld abgelehnt, bevor etwas hinausgeht: /reports/create/bwa kennt es nicht. | |
| date_to | Yes | Letzter Tag des Auswertungszeitraums als YYYY-MM-DD, zum Beispiel 2026-03-31. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. Der Zeitraum schließt diesen Tag ein; für ein vollständiges erstes Quartal also 2026-03-31 und nicht 2026-04-01. | |
| date_from | Yes | Erster Tag des Auswertungszeitraums als YYYY-MM-DD, zum Beispiel 2026-01-01. Ein leerer String wird abgelehnt; das Feld stattdessen weglassen. Der Zeitraum schließt diesen Tag ein. | |
| report_type | Yes | Welche Auswertung erzeugt wird. 'bwa' ist die Betriebswirtschaftliche Auswertung, also Erträge und Aufwendungen im Zeitraum. 'sums' ist die Summen- und Saldenliste, also je Konto die Bewegungen und der Saldo. Der Wert geht nicht an die API, er entscheidet, welcher Endpunkt aufgerufen wird. Beide Arten blockieren sich gegenseitig nicht. | |
| 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 |
| max_wait_seconds | No | Wie lange dieser Aufruf höchstens auf die Berechnung wartet, in Sekunden. Ohne Angabe 60, erlaubt 10 bis 240. Läuft die Zeit ab, ist der Bericht trotzdem erzeugt und der vorherige trotzdem ersetzt; die Antwort nennt dann die Kennung, mit der bb_reports_get_bwa beziehungsweise bb_reports_get_sums ihn nachholt. Dasselbe gilt, wenn der Client vorher abbricht: Viele tun das nach etwa 60 Sekunden, verifiziert ist das nicht für jeden. Dann kommt gar keine Antwort an, und die Kennung steht nur noch im stderr-Protokoll dieses Servers. Wer die Frist seines Clients nicht kennt, wählt deshalb höchstens 30. Das Feld ist serverseitig und geht nicht an die API. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| bundle | Yes | ||
| period | No | ||
| status | Yes | ||
| success | Yes | ||
| wait_ms | No | ||
| attempts | No | ||
| report_type | Yes | ||
| integrity_error | No | ||
| report_id_by_customer | Yes | ||
| uncompletedPostingsCount | No |