bimetricsEntwickler
Wiederkehrende Rechnungen

Serienvorlage pausieren

Als Markdown ansehen

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

Echte Wirkung

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

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

Pausiert künftige automatische Läufe und widerruft die bisherige Automationsfreigabe in beiden Erzeugungsmodi. Bestehende Entwürfe und Belege bleiben erhalten. Zum Widerrufen ist kein invoices:finalize erforderlich.

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.

Versionsbedingung für eine Serienvorlage.

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/pause" \  -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"}

Nächste Serientermine prüfen GET

Liefert kommende Kalendertermine der gespeicherten Vorlage. Der Ankertag bleibt über kurze Monate erhalten, zum Beispiel 31. Oktober, 30. November, 31. Dezember. Termine gelten in der gespeicherten IANA-Zeitzone (Standard Europe/Berlin); keine Entwurfserzeugung. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Genau eine Rechnungsperiode erzeugen POST

Manueller Aufruf für eine gültige Periode, auch bei pausierter Vorlage oder einem zukünftigen Termin. Im gespeicherten Modus draft entsteht ein Entwurf ohne finale Nummer oder Buchung. issue benötigt zusätzlich invoices:finalize und stellt die Rechnung mit Originaldatei und Buchungen aus. run.documentId verweist dann auf den ausgestellten Beleg; draft enthält den finalen Rechnungsstand. Wiederholungen liefern denselben ursprünglichen run, auch nach Moduswechsel. Wurde ein ursprünglicher Entwurf gelöscht, fehlt draft; kein Ersatz und keine nachträgliche Ausstellung. Eine gescheiterte Rechnungsprüfung antwortet mit 422; die Periode bleibt dann unverbraucht. Kein Versand. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.