# Ausgestellte Mahnung zurückziehen (https://developer.bimetrics.de/reference/receivables/withdraw-reminder)

`POST https://app.bimetrics.de/api/reminder/{id}/withdraw`

operationId: `withdrawReminder` · Berechtigung (Scope): `invoices:draft` · Bereich: Forderungen und Mahnungen

Kennzeichnet die Mahnung als zurückgezogen. Original-PDF und Verlauf bleiben erhalten. Rechnung, Zahlungen und Forderung werden nicht verändert.

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

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `expectedUpdatedAt` | string (date-time), kann null sein | Exakter zuletzt gelesener updatedAt-Wert einschließlich Sekundenbruchteilen. |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/reminder/{id}/withdraw" \
  -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`: PaymentReminder |
| 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 (`PaymentReminder`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `companyId` | string (uuid) | ID der Firma. |
| `createdAt` | string (date-time) | Anlage in bimetrics. |
| `customerName` | string | Empfänger der Originalrechnung. |
| `externalSentChannel` | string | Dokumentierter externer Weg email, post oder other. |
| `externalSentOn` | NaiveDate | Manuell dokumentiertes externes Versanddatum; kein automatischer Versand. |
| `id` | string (uuid) | ID der Mahnung oder ihres Entwurfs. |
| `issueDate` | NaiveDate | Ausstellungsdatum. |
| `kind` | string | payment_reminder für Zahlungserinnerung oder dunning für Mahnung. |
| `layoutId` | string | Dokumentlayout modern oder classic. Bei Anlage ohne Angabe wird das gespeicherte Layout der Originalrechnung übernommen. |
| `number` | string | Mahnungsnummer; bei offenem Entwurf leer. |
| `paymentDeadline` | NaiveDate | Zahlungsfrist nach dem Ausstellungsdatum. |
| `printFingerprint` | string | Fingerprint des bei Ausstellung verwendeten Druckstands. |
| `snapshot` | InvoiceReceivable | Bei Ausstellung eingefrorener Forderungsstand. |
| `sourceDocumentId` | string (uuid) | Ausgestellter Originalbeleg. |
| `sourceDraftId` | string (uuid) | Originalrechnungsentwurf. |
| `sourceInvoiceNumber` | string | Nummer der Originalrechnung. |
| `status` | string | draft, issued oder withdrawn. |
| `text` | string | Text im Dokument, ohne Versandwirkung. |
| `updatedAt` | string (date-time) | Letzte Änderung. |
| `withdrawnAt` | string (date-time) | Zeitpunkt des Zurückziehens; Original und Verlauf bleiben erhalten. |

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