bimetricsEntwickler
Wiederkehrende Rechnungen

Serienvorlage und Periodenverlauf lesen

Als Markdown ansehen

Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)

GET
/api/recurringinvoice/{id}

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.

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

Antworten

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"
{  "runs": [    {      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-10-31T08:00:00Z",      "draftId": "821c3664-640a-4e10-b120-a4ff713532f8",      "generationMode": "draft",      "id": "36c7b932-c197-43cc-bc69-6c8a8aec5221",      "periodKey": "2026-10-31",      "templateId": "f40c8342-a98f-4bb3-b9ba-2c34a746db05",      "templateRevision": 1,      "updatedAt": "2026-10-31T08:00:00Z"    }  ],  "template": {    "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 anlegen POST

Speichert Rechnungsinhalt und Kalenderplan. generationMode ist draft (Standard) oder issue; issue benötigt zusätzlich invoices:finalize. Standardmäßig pausiert; activate=true autorisiert ausdrücklich automatische Läufe im gewählten Modus. Die Anlage selbst vergibt keine Rechnungsnummer, bucht nicht und verschickt keine Nachricht. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.

Serienvorlage ändern PUT

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