Buchungsvorlagen suchen
Benötigte Berechtigung:read(Daten lesen)
Sucht die Buchungsvorlagen der Firma, etwa für Gewerbesteuer, Bankgebühren oder Privatentnahmen. Ihre IDs nimmt createMatch in documentSeriesIds: bimetrics legt beim Zuordnen eines Umsatzes aus der Vorlage einen Beleg an. Wie in der App fehlen Vorlagen, die zur Rechtsform nicht passen, und solche, die zum Löschen vorgemerkt sind.
Benötigt einen Schlüssel mit der Berechtigung 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 Seiten. Der Filterausdruck steht auf oberster Ebene; {} liefert alle Einträge.
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.
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"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 <= 10000000sort?|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 der Buchungsvorlage. |
friendlyName | string | ja | Bezeichnung. |
collectionNumber | string | ja | Nummer der Buchungsvorlage. |
kind | string | ja | Art der erzeugten Belege: `receipt` (Eingangsbeleg) oder `invoice` (Ausgangsrechnung). |
issuer.name | string | ja | Name des Ausstellers der erzeugten Belege. |
recipient.name | string | ja | Name des Empfängers der erzeugten Belege. |
systemTemplateId | uuid | ja | ID der Standardvorlage von bimetrics; `null` bei eigenen Vorlagen. |
updatedAt | date-time | ja | Zeitpunkt der letzten Änderung. |
Eine Seite der Treffer.
application/json- response
Eine Seite gefundener Buchungsvorlagen.
items?array<>|Die Treffer dieser Seite.
limit?|Verwendetes limit.
offset?integerVerwendetes offset.
total?integerAnzahl aller Treffer des Filters.
curl --fail-with-body "https://app.bimetrics.de/api/document/collection/series/filter" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"direction":["asc","asc"],"limit":100,"offset":0,"sort":["friendlyName","id"]}'{ "items": [ { "collectionNumber": "GewSt", "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "createdAt": "2026-01-05T09:00:00Z", "friendlyName": "Gewerbesteuer", "id": "daadb3cc-c785-41c7-83df-078d3688aae9", "issuer": { "address": "", "customerNumber": null, "iban": "", "name": "Stadtkasse Musterstadt", "taxId": "" }, "kind": "receipt", "positionTemplate": [ { "additionalInfo": { "freeOfVat": true, "reverseCharge": false }, "category": "tax_trade", "label": "Gewerbesteuer", "totalFixed": 0, "totalRatio": "100", "vatPercentage": "0" } ], "recipient": { "address": "Mühlenkamp 31, 22303 Hamburg", "customerNumber": null, "iban": "", "name": "Hansen & Kowalski Werbetechnik GmbH", "taxId": "DE123456789" }, "systemTemplateId": "14aec73f-3c7a-45ac-89cc-3ab77e8c0003", "updatedAt": "2026-01-05T09:00:00Z", "uploadDocument": null, "uploadDocumentId": null } ], "limit": 100, "offset": 0, "total": 1}Befreiungsgründe auflisten GET
Liefert die Befreiungsgründe, die die App unter „Steuerfall anpassen“ für „Steuerfrei nach § 4 UStG“ anbietet, in derselben Reihenfolge. `shortcut` ist der Wert für `taxException.reason` bei `kind` `exempt_4`. Der Grund steht im Pflichthinweis der Rechnung und entscheidet das Erlöskonto, das `account` nennt. Der letzte Eintrag, `§ 4 UStG` ohne genauen Grund, geht auch, die Prüfung meldet dann den Hinweis `exempt_reason_unspecific`. Die Liste ist für alle Firmen gleich. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.
Belege und Umsätze zuordnen POST
Ordnet vorhandene Belege und Bankumsätze zu. Alle IDs müssen zur Firma gehören; parallele oder bereits vorhandene Zuordnungen werden geprüft. Die Änderung erzeugt vorbereitete Buchungen. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.