bimetricsEntwickler
Ausgangsrechnungen

Rechnungsentwürfe suchen

Als Markdown ansehen

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

POST
/api/draft/filter

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.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Request-Body

Filter, Sortierung und Seite. Dokumentierte Filterattribute: x-bimetrics-filter.

application/json
  1. 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?string

Filterattribut 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?string

ID 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?string

Fällig ab diesem Tag (YYYY-MM-DD). Rechnungen ohne gültige Fälligkeit fallen heraus.

dueTo?string

Fällig bis zu diesem Tag (YYYY-MM-DD), einschließlich.

includeDeleted?boolean

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

Standardfalse
kind?string

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

Wert in"""and""or""eq""not""in""range""oneof"
lastPaymentFrom?string

Letzte Zahlung ab diesem Tag (YYYY-MM-DD). Bei Teilzahlungen zählt nur die letzte.

lastPaymentTo?string

Letzte Zahlung bis zu diesem Tag (YYYY-MM-DD), einschließlich.

limit?integer

Treffer je Seite. Standard und Höchstwert 1000; größere Werte werden auf 1000 begrenzt.

Bereich0 <= value
Standard1000
lower?unknown

Untergrenze für range, einschließlich.

offset?integer

Anzahl ü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.

Bereich0 <= value <= 1000000
Standard0
partiallyPaid?boolean

true: 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?boolean

true: mit ausgestellter Zahlungserinnerung oder Mahnung; zurückgezogene zählen nicht. false: ohne.

reminderHold?boolean

true: 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?unknown

Obergrenze für range, einschließlich.

value?unknown

Vergleichswert: 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.

AttributTypSortierbarBeschreibung
iduuidjaID des Entwurfs.
deletedAtdate-timejaImmer `null`: Gelöschte Entwürfe liefert die Suche nicht, auch nicht mit `includeDeleted`.
invoiceNumberstringjaArbeits- oder Rechnungsnummer.
externalRefstringjaExterne Bestell- oder Integrationsreferenz.
kindstringjainvoice, proposal, order_confirmation, cancellation, invoice_correction oder correction_reversal.
sourceSalesProposalIduuidjaUrsprüngliches Angebot.
sourceOrderConfirmationIduuidjaAusdrücklich gewählte finale AB als Rechnungsquelle.
updatedAtdate-timejaLetzte Änderung; als expectedUpdatedAt für einen Schreibaufruf verwenden.
invoiceRolestringjaRolle im Auftrag: `down_payment` (Abschlag) oder `final` (Schlussrechnung); leer bei allen anderen Entwürfen.

Antworten

Eine Seite der Treffer.

application/json
  1. response

Eine Seite gefundener Rechnungsentwürfe.

items?array<>|

Entwürfe dieser Seite.

limit?|

Verwendetes Seitenlimit.

offset?integer

Verwendeter Versatz.

total?integer

Anzahl aller Treffer.

Beispielanfrage
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"]}'
Beispielantwort
{  "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}