bimetricsEntwickler
Vorlagen und Dauerbuchungen

Dauerbuchung lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

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

Liefert eine Dauerbuchung mit Zeitraum, Rhythmus und Zeilen. updatedAt kommt beim Ändern als expectedUpdatedAt zurück. Eine gelöschte antwortet 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

Dauerbuchung, aus der der Beleg entstand: ein fester Betrag im festen Rhythmus, z. B. Miete. Für jeden Zeitraum legt bimetrics einen Beleg an.

collectionNumber?string

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

companyId?string

ID der Firma.

Formatuuid
costCenterId?string

Kostenstelle oder Verteilung als ID; fehlt ohne.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
documentContractRepetitionFixed?

Zeitraum und Rhythmus der erzeugten Belege.

friendlyName?string

Bezeichnung.

id?string

ID der Dauerbuchung.

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.

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/contract/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "collectionNumber": "MIETE",  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-01-05T09:00:00Z",  "documentContractRepetitionFixed": {    "end": null,    "repetitionPeriodDays": 0,    "repetitionPeriodMonth": 1,    "start": {      "day": 1,      "month": 1,      "year": 2026    }  },  "friendlyName": "Büromiete",  "id": "6d0e3f52-81a4-4b7c-9f26-2a7e5c1d4b83",  "issuer": {    "address": "",    "customerNumber": null,    "iban": "",    "name": "Muster Immobilien GmbH",    "taxId": ""  },  "kind": "receipt",  "positionTemplate": [    {      "additionalInfo": {        "freeOfVat": false,        "reverseCharge": false      },      "category": "rent_payment",      "label": "Miete",      "totalFixed": 120000,      "totalRatio": null,      "vatPercentage": "19"    }  ],  "recipient": {    "address": "",    "customerNumber": null,    "iban": "",    "name": "",    "taxId": ""  },  "updatedAt": "2026-01-05T09:00:00Z",  "uploadDocument": null,  "uploadDocumentId": null}

Änderung einer Dauerbuchung prüfen POST

Sagt, was Anlegen, Ändern, Beenden oder Löschen mit den Periodenbelegen täte, und ändert nichts. Gerechnet wird wie beim Speichern, Ablehnungen sind dieselben. `action` ist `create`, `update`, `end` oder `delete`; außer bei `create` nennt `id` die Dauerbuchung. `end` nennt bei `action` `end` das neue Ende: Es darf nie verlängern (`422 DocumentContractEndExtends`). `pastDocuments` gilt bei `delete`. Benötigt einen Schlüssel mit der Berechtigung `collections:write`.

Dauerbuchung löschen DELETE

Löscht eine Dauerbuchung, wie in der App. Künftige Belege gehen mit, Belege bis heute nur mit `pastDocuments`. Solange ein Beleg zugeordnet ist, wird abgelehnt (`409 DocumentContractHasAssignedDocuments`). Der Body nennt `expectedUpdatedAt`. Eine Wiederholung mit gleichem Idempotency-Key wirkt nicht doppelt. Benötigt einen Schlüssel mit der Berechtigung `collections:write`.