Belegdatei hochladen
bb_receipts_uploadUpload a receipt file to BuchhaltungsButler, create the receipt, and trigger text recognition; only the file and receipt type are required, with other fields read from the file.
Instructions
Lädt eine Belegdatei nach BuchhaltungsButler, legt daraus einen Beleg an und stößt die Texterkennung an; Pflicht sind nur die Datei und die Belegart, alles Weitere liest BuchhaltungsButler aus der Datei. Beispiel: eine Eingangsrechnung als PDF übergeben und die erkannten Felder danach mit bb_receipts_get prüfen. Für einen Beleg ohne Datei bb_receipts_create, für viele davon bb_receipts_create_batch. Einen Stapelupload gibt es nicht, und an einen bestehenden Beleg lässt sich nachträglich keine Datei hängen. Bei einer E-Rechnung ignoriert die API alle mitgegebenen Metadaten. Eigenes Limit: zehn Aufrufe je Minute. Schreibt in die echten Buchhaltungsdaten von BuchhaltungsButler. Rückgängig nur mit bb_receipts_delete, das den Beleg lediglich als gelöscht markiert; die API kennt keinen Endpunkt, der einen Beleg endgültig entfernt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Belegdatum, also das Ausstellungsdatum, als YYYY-MM-DD, zum Beispiel 2026-04-26. Ohne Angabe wird es aus der Datei gelesen. | |
| file | Yes | Die Belegdatei in einer von drei Formen: als base64-Zeichenkette, was immer geht, als https-Adresse oder als file-Adresse. Die beiden Adressformen nimmt der Server nur an, wenn der Betreiber sie freigegeben hat; sonst lehnt er den Aufruf ab, bevor etwas hinausgeht. Angenommene Dateiarten sind PDF, XML, JPEG, PNG, BMP und TIFF; der Typ wird am Inhalt bestimmt und nicht am Namen. Bei der base64-Form gehört der Dateiname in file_name. | |
| amount | No | Bruttobetrag des Belegs. Dezimalpunkt, kein Tausendertrennzeichen, zum Beispiel 123.99. 0.00 ist kein gültiger Betrag; ein negativer Betrag kennzeichnet eine Rückabwicklung. Ohne Angabe wird er aus der Datei gelesen. | |
| currency | No | Die Spezifikation sagt hier „Has to be 'EUR' if specified“ und widerspricht damit dem Vorrat von /receipts/add mit USD, GBP und CHF. Dass nur 'EUR' gilt, ist nicht verifiziert; dieses Werkzeug prüft den Wert deshalb nicht vorab. | |
| vat_rate | No | Umsatzsteuersatz des Belegs in Prozent als Zahl, zum Beispiel 19 oder 0. Weglassen, wenn der Beleg keinen oder mehrere Steuersätze trägt. | |
| file_name | No | Dateiname einschließlich Endung, zum Beispiel rechnung-2026-0001.pdf. Bei der base64-Form verlangt die API ihn; fehlt er, kann der Server einen Namen aus dem erkannten Dateityp bilden. Pfadanteile und Steuerzeichen werden entfernt. | |
| counterparty | No | Gegenpartei des Belegs: bei einer Eingangsrechnung der Rechnungssteller, bei einer Ausgangsrechnung der Empfänger. Ohne Angabe liest BuchhaltungsButler sie aus der Datei. | |
| receipt_type | Yes | Belegart, kleingeschrieben und mit Leerzeichen. 'invoice inbound' ist eine Eingangsrechnung, 'invoice outbound' eine Ausgangsrechnung, 'credit inbound' eine Eingangsgutschrift nach § 14 UStG, 'credit outbound' eine Ausgangsgutschrift nach § 14 UStG. Der Parameter heißt in der API type; dieser Name ist dort siebenfach mit verschiedener Bedeutung belegt, deshalb der eindeutige Werkzeugname. | |
| date_delivery | No | Leistungs- oder Lieferdatum als YYYY-MM-DD, zum Beispiel 2026-04-26. Wegen der DATEV-Kompatibilität nimmt BuchhaltungsButler kein Leistungsdatum nach dem Belegdatum an. | |
| invoice_number | No | Rechnungsnummer des Belegs, zum Beispiel ER-2026-0001, höchstens 60 Zeichen. Ohne Angabe wird sie aus der Datei gelesen. | |
| creditor_debtor | No | Nummer des Personenkontos, dem der Beleg zugeordnet wird: bei Eingangsbelegen ein Kreditor, bei Ausgangsbelegen ein Debitor, zum Beispiel 70001. Nachschlagen mit bb_postingaccounts_search, das Sachkonten, Zahlungskonten, Debitoren und Kreditoren gemeinsam führt. Nutzbar nur, wenn Debitoren und Kreditoren beim Mandanten aktiviert sind, und passend zur Belegart. | |
| date_payment_due | No | Fälligkeitsdatum als YYYY-MM-DD, zum Beispiel 2026-05-26. In der Antwort der Suche heißt das Feld due_date. | |
| payment_reference | No | Technische Zahlungsreferenz, zum Beispiel eine Amazon-Bestellnummer oder eine Vorgangsnummer von PayPal oder Stripe. Kein Verwendungszweck als Freitext. Stimmt sie, findet BuchhaltungsButler die passende Zahlung von selbst. | |
| payment_account_number | No | Sachkontonummer, die ein Zahlungskonto bezeichnet, zum Beispiel '1200'. Nicht das Sachkonto, auf das gebucht wird. Zahlungskonten auflisten mit bb_payment_accounts_list. Der Beleg wird damit unmittelbar diesem Zahlungskonto zugeordnet. Der Parameter heißt in der API account. | |
| link_to_receipt_id_by_customer | No | Die mandantenbezogene Nummer eines anderen Belegs, zu finden über bb_receipts_search. Keine globale Kennung; hier ohne Anführungszeichen übergeben. Beide Belege werden gemeinsam einer Zahlung zugeordnet, sobald einer von ihnen von Hand zugeordnet wird. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| created | No | ||
| message | No | ||
| success | Yes | ||
| endpoint | No | ||
| reversal | No | ||
| _contract_warnings | No | ||
| fields_not_returned | No |