# Serienvorlage pausieren (https://developer.bimetrics.de/reference/recurring-invoices/pause-recurring-invoice)

`POST https://app.bimetrics.de/api/recurringinvoice/{id}/pause`

operationId: `pauseRecurringInvoice` · Berechtigung (Scope): `invoices:draft` · Bereich: Wiederkehrende Rechnungen

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

> **Achtung:** Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
>
> KI-Agenten fragen vor diesem Aufruf beim Nutzer nach.

### Authentifizierung

`Authorization: Bearer bm_…` (alternativ `X-API-KEY: bm_…`, nie beide zugleich).

### Parameter

| Name | Ort | Pflicht | Typ | Beschreibung |
| --- | --- | --- | --- | --- |
| `id` | path | ja | string (uuid) | ID des Objekts dieser Firma (UUID); bei Forderungsständen und neuen Korrekturen die Quellentwurfs-ID. |
| `Idempotency-Key` | header | ja | 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. |

### Request-Body (`application/json`)

 

Schema `RecurringInvoiceVersion`.

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `expectedUpdatedAt` | string (date-time), kann null sein | Exakter gelesener updatedAt-Wert der Serienvorlage. |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/recurringinvoice/{id}/pause" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY" \
  -H "Idempotency-Key: rechnung-2026-001" \
  -H "Content-Type: application/json" \
  -d '{"kind":"and","children":[],"limit":50,"offset":0}'
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: RecurringInvoice |
| 400 | Ungültige Anfrage, z. B. ein Parameter mit ungültigem Wert wie eine ID, die keine UUID ist; korrigieren statt wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |
| 401 | Kein gültiger Schlüssel: fehlt (`Unauthorized`), ist unbekannt, abgelaufen oder widerrufen oder wurde nicht in genau einem Header gesendet (`InvalidAPIKey`). Schlüssel prüfen, nicht wiederholen. Auch eine ID, die zu einer anderen Firma gehört, ergibt `401 Unauthorized`. | `application/json`: Error |
| 403 | Dem Schlüssel fehlt die Berechtigung für diese Route (`APIKeyPermissionDenied`), oder die Firma hat keinen aktiven Tarif mit API-Zugang, etwa in der Testphase oder nach Ende des Abos (`APIUnavailable`). | `application/json`: Error |
| 404 | Nicht gefunden (`NotFound`). | `application/json`: Error |
| 409 | Versionskonflikt (VersionConflict), abweichender Inhalt für denselben Idempotency-Key (IdempotencyConflict), Dublette (ContactDuplicate) oder fachlich gesperrte Änderung. Aktuellen Zustand laden und prüfen; keinen anderen Schlüssel verwenden, um einen Konflikt zu umgehen. | `application/json`: Error |
| 413 | Die Anfrage ist zu groß (`APIRequestTooLarge`), siehe `x-bimetrics-limits`. | `application/json`: Error |
| 429 | Zu viele Anfragen; nach `Retry-After` Sekunden erneut senden. Mehr unter [Fehler](https://developer.bimetrics.de/errors). (Header: Retry-After) | `application/json`: Error |
| 500 | Serverfehler; die Anfrage später wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |

#### Felder der Antwort 200 (`RecurringInvoice`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `authorizationId` | string (uuid), kann null sein | ID der expliziten Automationsfreigabe; kein Zugangstoken. |
| `companyId` | string (uuid) | ID der Firma. |
| `createdAt` | string (date-time) | Anlage in bimetrics. |
| `draftBody` | DraftBody | Vollständiger Rechnungsinhalt; Datum, Frist und Leistungszeitraum werden für die Periode gesetzt. |
| `dueDays` | integer | Zahlungsfrist in Tagen von 0 bis 365; bei Anlage Standard 14. |
| `generationMode` | string | draft bereitet Entwürfe vor; issue stellt Rechnungen mit endgültiger Nummer, Originaldatei und Buchungen aus. Kein Versand. Ohne Angabe bei Anlage draft, bei Änderung bestehender Modus. issue benötigt zusätzlich invoices:finalize; über MCP nicht freigebbar. |
| `id` | string (uuid) | ID der Serienvorlage. |
| `lastAttemptAt` | string (date-time), kann null sein | Zeitpunkt des letzten automatischen Vorbereitungsversuchs; sonst null. |
| `lastErrorCode` | string | Sicherer Fehlercode des letzten gescheiterten automatischen Versuchs; leer nach Erfolg. |
| `name` | string | Name der Serienvorlage, höchstens 160 Zeichen. |
| `nextDate` | string | Nächster noch vorzubereitender Kalendertermin YYYY-MM-DD. |
| `performancePeriodPolicy` | string | period für aktuelle Periode oder previous_period für die vorherige Periode. |
| `revision` | integer | Steigende Inhaltsrevision der Vorlage. |
| `schedule` | RecurringInvoiceSchedule | Kalenderplan der Vorlage. |
| `status` | string | paused, active oder ended. Bei wiederholten dauerhaften Fehlern automatischer Läufe pausiert eine aktive Vorlage automatisch; die Freigabe erlischt und lastErrorCode nennt den letzten Fehler. ended kann nicht erneut aktiviert werden. |
| `updatedAt` | string (date-time) | Letzte Änderung. |

Verschachtelte Schemas stehen vollständig in der OpenAPI-Beschreibung: https://app.bimetrics.de/api/openapi.json