Rechnungen oder Angebote je Reiter zählen
Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)
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.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
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.
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 mehrere Treffer dieselben Werte in sort, ist ihre Reihenfolge nicht festgelegt, und sie können zwischen zwei Seiten doppelt kommen oder fehlen; id als letztes Attribut in sort oder ein Abgleich mit Überlappung (Delta-Sync) hilft dagegen.
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.
Erfolg.
application/json- response
Anzahl je Reiter der Rechnungs- oder Angebotsliste.
counts?Die Reiter. Sie schließen sich aus, nur overdue ist ein Teil von open.
extra?Zusatzfilter der Rechnungsliste, die sich mit den Reitern überschneiden; fehlt bei Angeboten.
curl --fail-with-body "https://app.bimetrics.de/api/draft/list/count" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'{ "counts": { "all": { "count": 42 }, "cancelled": { "count": 2 }, "draft": { "count": 3 }, "open": { "count": 9, "sumMinor": 1234500 }, "overdue": { "count": 4, "sumMinor": 456700 }, "paid": { "count": 27, "sumMinor": 3890000 }, "unknown": { "count": 1, "sumMinor": 11900 } }, "extra": { "partiallyPaid": { "count": 2 }, "reminded": { "count": 3 } }}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`) 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`.
Rechnungsentwurf lesen GET
Liefert einen offenen oder abgeschlossenen Entwurf mit seiner aktuellen Version und gegebenenfalls dem ausgestellten Beleg. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.