Rechnungsentwürfe suchen
Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)
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.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
Filter, Sortierung und Seite. Dokumentierte Filterattribute: x-bimetrics-filter.
application/json- body
Suche mit Filter, Sortierung und Seite wie bei den übrigen Suchrouten, dazu der Zahlstand. Jedes Zahlstand-Feld beschränkt die Treffer auf ausgestellte Rechnungen.
attribute?stringFilterattribut für eq, in, range und oneof, siehe x-bimetrics-filter der Operation. Groß-/Kleinschreibung und Punkte werden ignoriert.
children?array<>Teilfilter für and, or und not.
costCenterId?stringID einer Kostenstelle oder Verteilung: Rechnungen, deren Beleg sie trägt. none: Rechnungen ohne Kostenstelle, wie der Filter „Ohne Kostenstelle“ der Rechnungsliste.
direction?|array<>Richtung je Eintrag in sort; Standard asc.
dueFrom?stringFällig ab diesem Tag (YYYY-MM-DD). Rechnungen ohne gültige Fälligkeit fallen heraus.
dueTo?stringFällig bis zu diesem Tag (YYYY-MM-DD), einschließlich.
includeDeleted?booleantrue liefert auch gelöschte Einträge, erkennbar an deletedAt, aber nur bei Belegen, Kontakten, Bankkonten, Umsätzen und Buchungen; die übrigen Suchrouten ignorieren das Feld. Ohne das Feld oder mit false nur Einträge, die nicht gelöscht sind. Für Abgleiche von Löschungen mit range auf deletedAt, siehe Delta-Sync.
falsekind?stringArt des Filters: and/or verknüpfen children, not verneint children, eq vergleicht attribute mit value (null prüft auf leer), in sucht value als Text im Attribut (enthält, ohne Groß-/Kleinschreibung), range prüft lower ≤ Attribut ≤ upper (eine Grenze genügt), oneof prüft, ob das Attribut einem Wert der Liste value entspricht. Leer: alle Einträge.
"""and""or""eq""not""in""range""oneof"lastPaymentFrom?stringLetzte Zahlung ab diesem Tag (YYYY-MM-DD). Bei Teilzahlungen zählt nur die letzte.
lastPaymentTo?stringLetzte Zahlung bis zu diesem Tag (YYYY-MM-DD), einschließlich.
limit?integerTreffer je Seite. Standard und Höchstwert 1000; größere Werte werden auf 1000 begrenzt.
0 <= value1000lower?unknownUntergrenze für range, einschließlich.
offset?integerAnzahl übersprungener Treffer. Haben Einträge in den Sortierfeldern denselben Wert, entscheidet zuletzt id; ohne sort kommen sie in der Reihenfolge, in der sie angelegt wurden. Kommt mit sort zwischen zwei Abrufen ein Eintrag dazu, kann ein Eintrag zweimal kommen; Doppelte erkennst du an der id, ein Abgleich mit Überlappung (Delta-Sync) hilft ebenso.
0 <= value <= 10000000partiallyPaid?booleantrue: offen und schon teilweise bezahlt. false: alle anderen.
paymentStates?array<string>Zahlstände, von denen einer zutrifft: open (offen, also unbezahlt, auch überfällig, wie der Reiter „Offen“), overdue (davon die überfälligen), unknown (ungeklärt), paid (bezahlt) oder cancelled (storniert).
proposalStates?array<string>Ergebnisse ausgestellter Angebote, von denen eins zutrifft: open (offen, gültig bis heute oder später), expired (abgelaufen), accepted (angenommen) oder rejected (abgelehnt). Nur mit einem Filter auf kind proposal.
reminded?booleantrue: mit ausgestellter Zahlungserinnerung oder Mahnung; zurückgezogene zählen nicht. false: ohne.
reminderHold?booleantrue: mit Mahnsperre, die heute gilt, oder Kontakt „Nicht mahnen“. false: ohne.
reminderLevels?array<integer>Die höchste ausgestellte Stufe ist eine davon: 0 Zahlungserinnerung, 1 bis 3 Mahnung.
sort?|array<string>Attribute, nach denen sortiert wird; nur sortierbare Attribute (sortable in x-bimetrics-filter). Ein Attribut mit sortable: false ergibt 400.
upper?unknownObergrenze für range, einschließlich.
value?unknownVergleichswert: für eq ein Wert oder null, für in ein Text, für oneof eine Liste.
Filterattribute
Dokumentiert sind diese Attribute für attribute; für sort nur die als sortierbar markierten. Aufbau des Filters: Filtern und Paginieren.
| Attribut | Typ | Sortierbar | Beschreibung |
|---|---|---|---|
id | uuid | ja | ID des Entwurfs. |
deletedAt | date-time | ja | Immer `null`: Gelöschte Entwürfe liefert die Suche nicht, auch nicht mit `includeDeleted`. |
invoiceNumber | string | ja | Arbeits- oder Rechnungsnummer. |
externalRef | string | ja | Externe Bestell- oder Integrationsreferenz. |
kind | string | ja | invoice, proposal, order_confirmation, cancellation, invoice_correction oder correction_reversal. |
sourceSalesProposalId | uuid | ja | Ursprüngliches Angebot. |
sourceOrderConfirmationId | uuid | ja | Ausdrücklich gewählte finale AB als Rechnungsquelle. |
updatedAt | date-time | ja | Letzte Änderung; als expectedUpdatedAt für einen Schreibaufruf verwenden. |
invoiceRole | string | ja | Rolle im Auftrag: `down_payment` (Abschlag) oder `final` (Schlussrechnung); leer bei allen anderen Entwürfen. |
Eine Seite der Treffer.
application/json- response
Eine Seite gefundener Rechnungsentwürfe.
items?array<>|Entwürfe dieser Seite.
limit?|Verwendetes Seitenlimit.
offset?integerVerwendeter Versatz.
total?integerAnzahl aller Treffer.
curl --fail-with-body "https://app.bimetrics.de/api/draft/filter" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"direction":["desc","asc"],"limit":100,"offset":0,"sort":["updatedAt","id"]}'{ "items": [ { "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "createdAt": "2026-09-01T08:00:00Z", "creatorUserCompanyId": "53cd10a9-c864-4dc3-a777-9860d59efe6c", "deletedAt": null, "documentId": "3026096b-614f-40d3-8749-8acf9b529480", "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", "finalTotal": 11900, "id": "821c3664-640a-4e10-b120-a4ff713532f8", "invoiceNumber": "RE-2026-1042", "kind": "invoice", "orderConfirmationId": null, "originalInvoiceId": null, "payment": { "openMinor": 11900, "overdue": true, "refundDueMinor": 0, "reminderHold": false, "reminderLevel": 1, "state": "open" }, "salesProposalId": null, "source": "api", "sourceOrderConfirmationId": null, "sourceSalesProposalId": null, "typeCode": "380", "updatedAt": "2026-09-01T08:01:02.123456Z" } ], "limit": 100, "offset": 0, "total": 1}Rechnungs- oder Angebotsentwurf anlegen POST
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`.
Rechnungen oder Angebote je Reiter zählen POST
Zählt wie die Reiter der Rechnungsliste in der App: Rechnungen und offene Storno-Entwürfe (`all`), Entwürfe (`draft`), offene (`open`, darin die überfälligen `overdue`), ungeklärte (`unknown`), bezahlte (`paid`) und stornierte (`cancelled`), dazu teilbezahlte und gemahnte (`extra`). Der Anfrageinhalt ist der von filterDrafts; Seite, Sortierung, `paymentStates` und `proposalStates` zählen nicht, alle anderen Felder schon. Mit einem Filter auf `kind` `proposal` zählt die Route die Reiter der Angebotsliste: alle Angebote (`all`), Entwürfe (`draft`), offene (`open`), abgelaufene (`expired`), angenommene (`accepted`) und abgelehnte (`rejected`), je mit dem Bruttobetrag. Die Zahlstand-Felder gehen dann nicht (`400`). Verändert nichts. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.