bimetricsEntwickler
Ausgangsrechnungen

Rechnungs- oder Angebotsentwurf anlegen

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/draft/

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

Legt einen Rechnungsentwurf in EUR an. externalRef verbindet ihn mit der externen Bestellung. Die endgültige Rechnungsnummer entsteht erst beim Abschließen. Mit invoiceKind SalesProposal und ohne typeCode entsteht ein Angebot als Entwurf, wie in der App und über MCP; finalizeDraft stellt es aus, deriveSalesDocument macht daraus eine Rechnung.

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

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

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
  1. body

Neuer Rechnungs- oder Angebotsentwurf in EUR.

currency?string

Währung; ausschließlich EUR.

externalRef?string

Externe Bestellreferenz, höchstens 200 Zeichen.

invoiceDraftBody?

Vollständiger Entwurfsinhalt.

invoiceKind?string

ZUGFeRD für Rechnungen, auch für eine XRechnung (Format über einvoiceProfile); SalesProposal ohne typeCode für ein Angebot. Auftragsbestätigungen über deriveSalesDocument erzeugen.

Wert in"ZUGFeRD""SalesProposal"
originalInvoiceId?|

Für serverseitige Stornovorlagen reserviert.

Formatuuid
sourceSalesProposalId?|

Im Company-API-Create nicht unterstützt; nicht mitsenden. Folgedokumente ausschließlich über deriveSalesDocument erzeugen.

Formatuuid
typeCode?|

Rechnungstyp, regulär 380; bei Angeboten weglassen. Storno über cancelInvoice erzeugen.

Antworten

Erfolg.

application/json
  1. response

Offener oder abgeschlossener Rechnungsentwurf mit Version und Referenz zum ausgestellten Beleg.

billing?

Nur getDraft eines ausgestellten Angebots oder einer ausgestellten Auftragsbestätigung: Abrechnung des Auftrags mit Abschlägen, abschließender Rechnung und Summen.

billingSummary?

Nur filterDrafts, an ausgestelltem Angebot und ausgestellter Auftragsbestätigung: Kurzform von billing.

companyId?string

ID der Firma.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
creatorUserCompanyId?string

ID der erstellenden Mitgliedschaft.

Formatuuid
deductedBy?

Nur ausgestellter Abschlag: die ausgestellte, nicht stornierte Schlussrechnung, die ihn abzieht.

deletedAt?|

Gilt als gelöscht seit diesem Zeitpunkt; null, solange nicht gelöscht. Gesetzt ist es nur in der Antwort von deleteDraft und deleteOrderConfirmationDraft; gelöschte Entwürfe liefert keine andere Route, auch filterDrafts mit includeDeleted nicht.

Formatdate-time
documentId?|

ID des ausgestellten Rechnungsbelegs; null bei offenem Entwurf.

Formatuuid
documentMail?

Nur in den Antworten von getDraft und filterDrafts. Die neueste Mail, mit der dieses Dokument über bimetrics gesendet wurde (aus der App, per API oder per MCP), samt Versandstand. Fehlt, wenn noch keine gesendet wurde.

documentMatched?boolean

Der ausgestellte Beleg ist bereits einer Zuordnung zugeordnet.

downPaymentOrdinal?integer

Nur Abschlag: seine Ordnungszahl im Auftrag, wie ordinal in billing.

draftBody?

Gespeicherter Rechnungsinhalt.

externalRef?string

Externe Bestellreferenz.

finalTotal?integer

Bruttosumme des ausgestellten Belegs in Cent.

id?string

ID des Entwurfs.

Formatuuid
invoiceCorrection?

Quellgebundener Grund und Bruttokorrekturbeträge je Position.

invoiceNumber?string

Arbeitsnummer; nach Abschluss endgültige Rechnungsnummer.

invoiceRole?string

Rolle der Rechnung im Auftrag: down_payment (Abschlag) oder final (Schlussrechnung), fest ab dem Ableiten; fehlt bei allen anderen Entwürfen. Filterbar in filterDrafts.

Wert in"down_payment""final"
kind?string

Dokumentart invoice, proposal, order_confirmation, cancellation, invoice_correction oder correction_reversal.

legacyProposalTotal?boolean

Angebot vor dem 21.09.2026 ausgestellt: Summe je Zeile gerundet wie sein PDF.

orderChanges?string

Nur getDraft einer offenen Schlussrechnung, Rechnung über den ganzen Auftrag oder eines Abschlags: was sich am Auftrag seit dem Anlegen der Rechnung bzw. seit der letzten Berechnung des Abschlags geändert hat, etwa „Nachtrag 3 ist beauftragt, Nachtrag 1 ist nicht mehr beauftragt“ oder „Es gibt eine neue Auftragsbestätigung AB-2026-1004“. Fehlt, solange sich nichts geändert hat. Bis dahin lehnt finalizeDraft mit 409 ClosingInvoiceAddendaChanged bzw. 409 DownPaymentOrderValueChanged ab: Die Rechnung legst du mit replaceDraftId und replaceExpectedUpdatedAt neu an, den Abschlag speicherst du mit downPayment neu. Ein Auftrag ohne Nachtrag, auch ohne Entwurf eines Nachtrags, wird abgerechnet wie bisher.

orderConfirmationId?|

Ausgestellte Auftragsbestätigung; null bei offenem Entwurf.

Formatuuid
originalInvoiceId?|

Originalentwurf für eine Stornorechnung; sonst null.

Formatuuid
originalTotal?integer

Bruttosumme des Storno-Originals in Cent.

payment?

Zahlstand einer ausgestellten Rechnung (Typ 380); fehlt bei allen anderen Entwürfen.

proposal?

Ergebnis eines ausgestellten Angebots; fehlt bei allen anderen Entwürfen.

proposalAddendum?

Nur an einem Nachtrag (ausgestellt oder Entwurf): seine Nummer im Auftrag und der Auftrag.

proposalVersion?

Versionen eines Angebots: am Entwurf einer neuen Version und an jedem ausgestellten Angebot mit mehr als einer Version; versions nur in getDraft.

reversesCorrectionDocumentId?string

Ausgestellte Korrektur, die dieser Gegenbeleg aufhebt.

Formatuuid
salesProposalId?|

ID eines erstellten Angebots, falls vorhanden.

Formatuuid
settledByFinalDraftId?string

Nur Storno oder Korrektur eines Abschlags: die Schlussrechnung, deren Ausstellen diesen Beleg erzeugt hat.

Formatuuid
source?string

Zugang bei Anlage: web, api, mcp oder series für erzeugte Serienrechnungen.

sourceInvoiceDocumentId?string

Unverändertes Original einer Rechnungskorrektur.

Formatuuid
sourceOrderConfirmationId?|

Ausdrücklich gewählte finale AB als Rechnungsquelle; sonst null.

Formatuuid
sourceSalesProposalId?|

Ursprüngliches Angebot, falls vorhanden.

Formatuuid
taxCase?

Beim Abschluss eingefrorener Steuerfall.

typeCode?string

EN-16931-Dokumenttyp: Rechnung 380, Rechnungskorrektur 381, Vollstorno oder Korrektur-Gegenbeleg 384.

updatedAt?string

Letzte Änderung.

Formatdate-time
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/draft/" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-09-01T08:00:00Z",  "creatorUserCompanyId": "53cd10a9-c864-4dc3-a777-9860d59efe6c",  "deletedAt": null,  "documentId": null,  "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  },  "externalRef": "order-2026-1042",  "id": "821c3664-640a-4e10-b120-a4ff713532f8",  "invoiceNumber": "Entwurf 1042",  "kind": "invoice",  "orderConfirmationId": null,  "originalInvoiceId": null,  "salesProposalId": null,  "source": "api",  "sourceOrderConfirmationId": null,  "sourceSalesProposalId": null,  "typeCode": "380",  "updatedAt": "2026-09-01T08:01:02.123456Z"}

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

Rechnungsentwürfe suchen POST

Sucht offene und abgeschlossene Rechnungsentwürfe der Firma einschließlich externalRef. Gelöschte Entwürfe liefert die Route nicht, auch nicht mit `includeDeleted`. Die Zahlstand-Felder (`paymentStates`, `partiallyPaid`, `reminded`, `reminderLevels`, `reminderHold`, `dueFrom`/`dueTo`, `lastPaymentFrom`/`lastPaymentTo`, `costCenterId`) finden ausgestellte Rechnungen wie die Reiter der Rechnungsliste in der App. Sie gehen nur zusammen mit einem Filter auf `kind` `invoice`, sonst `400`. Jede ausgestellte Rechnung trägt ihren Zahlstand in `payment`; countDrafts zählt die Reiter. Mit `proposalStates` findest du ausgestellte Angebote nach ihrem Ergebnis, wie die Reiter der Angebotsliste: `open`, `expired`, `accepted` oder `rejected`. Das Feld geht nur zusammen mit einem Filter auf `kind` `proposal`, sonst `400`. Jedes ausgestellte Angebot trägt sein Ergebnis in `proposal`. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.