bimetricsEntwickler
Ausgangsrechnungen

Folgedokument aus gewählter Quelle erstellen

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/{id}/derive

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

Mit targetKind order_confirmation entsteht aus einem finalisierten Angebot eine optionale Auftragsbestätigung als Entwurf. Mit targetKind invoice entsteht ausdrücklich aus dem finalisierten Angebot oder der finalisierten Auftragsbestätigung eine Rechnung. expectedUpdatedAt bezeichnet den gelesenen Quellentwurf. Das Original bleibt unverändert. Je Auftrag höchstens eine gültige Rechnung über den ganzen Auftrag oder eine Schlussrechnung; nach einem Storno ist wieder eine möglich. Davor beliebig viele Abschläge (invoiceRole). Sperren: 409 FinalInvoiceExists, 409 DownPaymentsExist, 422 DownPaymentTaxCaseUnsupported, aus einem Nachtrag 409 ProposalAddendumNotConvertible, eine Auftragsbestätigung nach einem ausgestellten Nachtrag 409 OrderConfirmationAfterAddendum. Kein Versand und keine Buchung beim Ableiten. Setzt ein Angebot automatisch auf angenommen, auch nach einer Ablehnung.

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.

Pfadparameter

id*string

ID des Objekts in dieser Firma (UUID).

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

Bewusst gewählte Ableitung aus einem finalisierten Quellentwurf.

amountMinor?integer

Nur Abschlag: Betrag in Cent in der Preisart des Auftrags (netto oder brutto, priceType der Quelle), über 0.

expectedPerformance?

Nur Abschlag: wann der ganze Auftrag voraussichtlich fertig ist, am Bau die Abnahme, auch wenn Teile schon erledigt sind. from und to als Tag, ein Monat vom ersten bis letzten Tag. Weglassen, wenn es noch nicht feststeht; aus einer Auftragsbestätigung belegt bimetrics den vereinbarten Zeitraum vor, außer er ist vorbei.

expectedUpdatedAt?|

Unverändert gelesener updatedAt-Wert des Quellentwurfs.

Formatdate-time
invoiceRole?string

down_payment für eine Abschlagsrechnung, final für die Schlussrechnung, nur mit targetKind invoice. Ohne: Rechnung über den ganzen Auftrag.

Wert in"down_payment""final"
percent?string

Nur Abschlag: Prozent der festen Positionen des Auftrags und seiner beauftragten Nachträge ohne Auslagen, über 0 bis 100, höchstens zwei Nachkommastellen, als Zeichenfolge. Genau eins von percent und amountMinor.

Muster^-?[0-9]+(\.[0-9]+)?$
Formatdecimal
replaceDraftId?string

Nur Schlussrechnung und Rechnung über den ganzen Auftrag: die offene Rechnung desselben Auftrags und derselben Art, die die neue ersetzt, etwa nach 409 ClosingInvoiceAddendaChanged. bimetrics löscht sie im selben Schritt; scheitert das Ableiten, bleibt sie. Änderungen an ihr gehen verloren; der Verlauf der neuen nennt die ersetzte. Sonst 400 mit context.field replaceDraftId.

Formatuuid
replaceExpectedUpdatedAt?string

Pflicht mit replaceDraftId: ihr zuletzt gelesener updatedAt. Hat sie sich seitdem geändert, 409 VersionConflict, und nichts geschieht.

Formatdate-time
selectedLines?array<integer>

Die beauftragten optionalen Positionen als Index in items der Quelle, ab 0. Sie werden normale Positionen, eine gewählte Alternative ersetzt ihre feste Position, je feste Position höchstens eine. Ohne Angabe kommen nur die festen Positionen mit.

targetKind?string

order_confirmation aus finalem Angebot oder invoice aus finalem Angebot oder finaler Auftragsbestätigung.

Wert in"order_confirmation""invoice"

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/derive" \  -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": "order_confirmation",  "orderConfirmationId": null,  "originalInvoiceId": null,  "salesProposalId": null,  "source": "api",  "sourceOrderConfirmationId": null,  "sourceSalesProposalId": "821c3664-640a-4e10-b120-a4ff713532f8",  "typeCode": "380",  "updatedAt": "2026-09-01T08:01:02.123456Z"}