Buchungsvorlage ändern
Benötigte Berechtigung:collections:write(Vorlagen und Dauerbuchungen ändern)
Echte Wirkung
/api/document/collection/series/{id}Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.
Ändert eine eigene Buchungsvorlage, wie in der App. Die Änderung gilt ab der nächsten Anwendung, schon erzeugte Belege bleiben, wie sie sind. PUT ändert nur die mitgeschickten Felder. expectedUpdatedAt ist Pflicht; hat sich das Objekt seitdem geändert, antwortet die Route mit 409 VersionConflict. Geprüft wird wie im Formular der App: Bezeichnung, Art invoice oder receipt, 1 bis 100 Zeilen mit Betrag oder Anteil, Kategorie passend zu Art, Verwendung und Kontenrahmen, Steuersatz 19, 7 oder 0 %, auf Eingangsbelegen auch 9 oder 5,5 %, soweit die Kategorie ihn zulässt, Steuerfall bei 0 % auf Eingangsbelegen und die Gegenpartei der Art, außer alle Kategorien werden direkt gebucht. Verstöße ergeben 400 InvalidBookkeepingChange mit context.field. Bezeichnung, Kategorie und Steuersatz werden nur geprüft, wenn sie neu sind. Standardvorlagen von bimetrics (systemTemplateId gesetzt) lassen sich per API lesen und zuordnen, aber nur in der App ändern oder löschen (403 DocumentTemplateSystemLocked). Gelöschte und zur Rechtsform unpassende Vorlagen ergeben 409 DocumentTemplateUnavailable. Eine Wiederholung mit gleichem Idempotency-Key wirkt nicht doppelt.
Benötigt einen Schlüssel mit der Berechtigung collections:write.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
id*stringID des Objekts in dieser Firma (UUID).
uuidIdempotency-Key*stringStabiler Schlüssel für genau diese Änderung: 1–128 druckbare ASCII-Zeichen ohne Leerzeichen. Bei Wiederholungen denselben Schlüssel und unveränderten Inhalt senden; das Ergebnis wird nicht nochmals erzeugt.
^[!-~]+$1 <= length <= 128application/json- body
Felder einer Buchungsvorlage oder Dauerbuchung.
collectionNumber?|Nummer; wird zur Rechnungsnummer der erzeugten Belege.
costCenterId?stringKostenstelle oder Verteilung aller Belege der Dauerbuchung als ID, ein leerer String entfernt sie. Eine Änderung gilt für künftige Belege und für alle, die noch nicht festgeschrieben, zugeordnet oder bezahlt sind. Ohne Angabe bleibt sie.
documentContractRepetitionFixed?Nur bei Dauerbuchungen: Beginn, ausschließliches Ende und Rhythmus.
expectedUpdatedAt?stringupdatedAt des gelesenen Objekts, beim Ändern Pflicht.
date-timefriendlyName?|Bezeichnung.
issuer?|Aussteller: die Gegenpartei bei receipt.
kind?|invoice (Ausgangsrechnung) oder receipt (Eingangsbeleg), ohne Angabe beim Anlegen receipt.
positionTemplate?array<>|Die Zeilen, 1 bis 100. Ersetzt beim Ändern alle Zeilen.
recipient?|Empfänger: die Gegenpartei bei invoice.
Erfolg.
application/json- response
Buchungsvorlage, aus der der Beleg beim Zuordnen eines Umsatzes entstand, z. B. für Bankgebühren oder Gewerbesteuer. Der Betrag richtet sich nach dem Umsatz.
collectionNumber?stringNummer der Buchungsvorlage; wird zur Rechnungsnummer (invoiceNumber) der erzeugten Belege. Ist sie leer, entsteht die Rechnungsnummer aus der Bezeichnung.
companyId?stringID der Firma.
uuidcreatedAt?stringAnlage in bimetrics.
date-timefriendlyName?stringBezeichnung.
id?stringID der Buchungsvorlage.
uuidissuer?Aussteller der erzeugten Belege.
kind?stringBelegart der erzeugten Belege: invoice oder receipt.
"invoice""receipt"positionTemplate?array<>|Vorlagen der Positionen der erzeugten Belege.
recipient?Empfänger der erzeugten Belege.
systemTemplateId?|ID der Standardvorlage von bimetrics, aus der die Buchungsvorlage entstand, z. B. für Gewerbesteuer oder die Gebühren einer Bank; null bei eigenen Vorlagen.
uuidupdatedAt?stringLetzte Änderung.
date-timeuploadDocument?|Die hinterlegte Datei; null ohne Datei.
uploadDocumentId?|ID einer hinterlegten Datei; null ohne Datei.
uuidcurl --fail-with-body "https://app.bimetrics.de/api/document/collection/series/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Idempotency-Key: rechnung-2026-001" \ -H "Content-Type: application/json" \ -d '{}'{ "collectionNumber": "", "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "createdAt": "2026-01-05T09:00:00Z", "friendlyName": "Bürobedarf", "id": "daadb3cc-c785-41c7-83df-078d3688aae9", "issuer": { "address": "", "customerNumber": null, "iban": "", "name": "Musterbedarf GmbH", "taxId": "" }, "kind": "receipt", "positionTemplate": [ { "additionalInfo": { "freeOfVat": false, "reverseCharge": false }, "category": "office_supplies", "label": "Bürobedarf", "totalFixed": 0, "totalRatio": "100", "vatPercentage": "19" } ], "recipient": { "address": "", "customerNumber": null, "iban": "", "name": "", "taxId": "" }, "systemTemplateId": null, "updatedAt": "2026-01-05T09:00:00Z", "uploadDocument": null, "uploadDocumentId": null}Buchungsvorlage löschen DELETE
Löscht eine eigene Buchungsvorlage, wie in der App, solange keine Zahlung damit gebucht ist (sonst `409 DocumentSeriesInUse`). Der Body nennt `expectedUpdatedAt`. Standardvorlagen von bimetrics (`systemTemplateId` gesetzt) lassen sich per API lesen und zuordnen, aber nur in der App ändern oder löschen (`403 DocumentTemplateSystemLocked`). Gelöschte und zur Rechtsform unpassende Vorlagen ergeben `409 DocumentTemplateUnavailable`. Eine Wiederholung mit gleichem Idempotency-Key wirkt nicht doppelt. Benötigt einen Schlüssel mit der Berechtigung `collections:write`.
Belege einer Buchungsvorlage lesen GET
Listet die Belege, die aus dieser Buchungsvorlage entstanden sind. Benötigt einen Schlüssel mit der Berechtigung `read`.