Buchungsvorlage löschen
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.
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.
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 <= 128Mit API-Schlüssel: die gelesene Version
application/json- body
Der Stand, auf dem das Löschen aufbaut.
expectedUpdatedAt?|updatedAt des gelesenen Objekts.
date-timeErfolg.
application/json- response
Was gelöscht wurde.
id?stringID des Objekts.
uuidreplayed?booleanTrue bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs.
curl --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 '{}'{ "id": "daadb3cc-c785-41c7-83df-078d3688aae9", "replayed": false}Buchungsvorlage lesen GET
Liefert eine Buchungsvorlage mit ihren Zeilen. `updatedAt` kommt beim Ändern als `expectedUpdatedAt` zurück. Gelöschte und zur Rechtsform unpassende Vorlagen antworten mit `404`. Benötigt einen Schlüssel mit der Berechtigung `read`.
Buchungsvorlage ändern PUT
Ä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`.