bimetricsEntwickler
Vorlagen und Dauerbuchungen

Buchungsvorlage lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/document/collection/series/{id}

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.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Pfadparameter

id*string

ID des Objekts in dieser Firma (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. 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?string

Nummer der Buchungsvorlage; wird zur Rechnungsnummer (invoiceNumber) der erzeugten Belege. Ist sie leer, entsteht die Rechnungsnummer aus der Bezeichnung.

companyId?string

ID der Firma.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
friendlyName?string

Bezeichnung.

id?string

ID der Buchungsvorlage.

Formatuuid
issuer?

Aussteller der erzeugten Belege.

kind?string

Belegart der erzeugten Belege: invoice oder receipt.

Wert in"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.

Formatuuid
updatedAt?string

Letzte Änderung.

Formatdate-time
uploadDocument?|

Die hinterlegte Datei; null ohne Datei.

uploadDocumentId?|

ID einer hinterlegten Datei; null ohne Datei.

Formatuuid
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/document/collection/series/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "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 anlegen POST

Legt eine eigene Buchungsvorlage an, wie in der App. Es wird nichts gebucht: Die Vorlage wirkt erst, wenn ihr eine Zahlung zugeordnet wird (`documentSeriesIds` von `createMatch`). Eine Zeile hat einen festen Betrag (`totalFixed`) oder einen Anteil am Rest der Zahlung (`totalRatio`). 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. Eine Wiederholung mit gleichem Idempotency-Key wirkt nicht doppelt. Benötigt einen Schlüssel mit der Berechtigung `collections:write`.

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`.