bimetricsEntwickler
Wiederkehrende Rechnungen

Serienvorlage ändern

Als Markdown ansehen

Benötigte Berechtigung:invoices:draft(Rechnungsentwürfe verwalten)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
put/api/recurringinvoice/{id}

Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.

Ersetzt Inhalt und Kalenderplan mit expectedUpdatedAt und erhöht revision. Ohne generationMode bleibt der bestehende Modus erhalten. Ist der bisherige oder neue Modus issue, ist zusätzlich invoices:finalize erforderlich. Ohne activate=true wird die bisherige Automationsfreigabe widerrufen und die Vorlage pausiert. activate=true autorisiert ausdrücklich die neue Revision samt Modus. Bereits erzeugte Entwürfe und Belege bleiben unverändert; ein Moduswechsel stellt frühere Entwürfe nicht nachträglich aus.

Benötigt einen Schlüssel mit der Berechtigung invoices:draft.

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

Pfadparameter

id*string

ID des Objekts dieser Firma (UUID); bei Forderungsständen und neuen Korrekturen die Quellentwurfs-ID.

Formatuuid

Header-Parameter

Idempotency-Key*string

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

Muster^[!-~]+$
Länge1 <= length <= 128

Request-Body

application/json

TypeScript-Typen

Typ request body für TypeScript.

Serienvorlage erstellen oder vollständig ändern; generationMode bestimmt Entwurfserzeugung oder automatische Ausstellung.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/recurringinvoice/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "authorizationId": null,  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-10-08T09:00:00Z",  "draftBody": {    "buyer": {      "address": {        "city": "Hamburg",        "countryId": "DE",        "line1": "Am Hafen 12",        "postcode": "20457"      },      "contactId": "b17e8812-eae4-49b6-b5dc-30510635cb07",      "customerNumber": 1004,      "email": "",      "name": "Brauhaus Elbwiese GmbH",      "vatId": ""    },    "dueDate": {      "day": 15,      "month": 9,      "year": 2026    },    "issueDate": {      "day": 1,      "month": 9,      "year": 2026    },    "items": [      {        "description": "Gestaltung einer Geschäftsausstattung",        "discount": "0",        "name": "Gestaltung",        "position": "1",        "quantity": "1",        "taxRate": "19",        "unit": "C62",        "unitPrice": "100"      }    ],    "notes": "",    "performancePeriodFrom": {      "day": 1,      "month": 9,      "year": 2026    },    "priceType": "net",    "remark": "",    "showQRCode": false,    "strict": false,    "taxRateReason": "none",    "validUntil": null  },  "dueDays": 14,  "generationMode": "draft",  "id": "f40c8342-a98f-4bb3-b9ba-2c34a746db05",  "lastAttemptAt": null,  "lastErrorCode": "",  "name": "Monatliche Betreuung",  "nextDate": "2026-10-31",  "performancePeriodPolicy": "period",  "revision": 1,  "schedule": {    "anchorDay": 31,    "intervalMonths": 1,    "intervalWeeks": 0,    "startDate": "2026-10-31",    "timeZone": "Europe/Berlin"  },  "status": "paused",  "updatedAt": "2026-10-08T09:00:00Z"}

Serienvorlage und Periodenverlauf lesen GET

Liefert template und erfolgreich vorbereitete runs. Der Periodenverlauf bleibt auch nach dem Löschen eines erzeugten Entwurfs erhalten. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Serienvorlage aktivieren POST

Autorisiert die aktuelle Vorlage im gespeicherten generationMode. draft bereitet Entwürfe vor; issue stellt Rechnungen mit Nummer, Originaldatei und Buchungen aus und benötigt zusätzlich invoices:finalize. Berechtigungen und Tarif werden bei jedem Lauf erneut geprüft. Pro Vorlage und Periode höchstens ein Lauf, unabhängig von Wiederholungen und Vorlagenrevisionen. Kein Versand. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.