bimetricsEntwickler
Buchhaltung

Buchungen suchen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

POST
/api/accounting/booking/filter

Sucht Buchungen der Firma mit einem Filter und liefert eine Seite der Treffer, je Buchung mit Buchungsart, Stand gegenüber DATEV und Herkunft.

Benötigt einen Schlüssel mit der Berechtigung 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 Seiten. Der Filterausdruck steht auf oberster Ebene; {} liefert alle Einträge.

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.

direction?|array<>

Richtung je Eintrag in sort; Standard asc.

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

Bereich0 <= value <= 1000000
Standard0
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 der Buchung.
bookingDatedatejaBuchungsdatum.
accountintegerjaKonto.
accountContraintegerjaGegenkonto.
amountdecimaljaBetrag.
refDocumentIduuidjaID des gebuchten Belegs.
refBankTransactionIduuidjaID des gebuchten Umsatzes.
costCenterIduuidjaKostenstelle oder Verteilung der Buchung; nur Buchungen mit Aufwands- oder Erlöskonto tragen sie. Als Filter findet nur die ID der Verteilung eine Buchung mit Verteilung, nicht die ID einer ihrer Kostenstellen; die Beträge je Kostenstelle nennt `costCenterParts`.
finalizeddate-timejaZeitpunkt der Festschreibung; `null` bei nicht festgeschriebenen Buchungen.
updatedAtdate-timejaZeitpunkt der letzten Änderung.
deletedAtdate-timejaZeitpunkt, seit dem der Eintrag als gelöscht gilt; `null`, solange er nicht gelöscht ist. Gelöschte Einträge liefert die Suche nur mit `includeDeleted`. Für Abgleiche per Polling: `includeDeleted` und `range` mit `lower` = `deletedAt` des zuletzt gelesenen gelöschten Eintrags minus 5 Minuten Überlappung, sortiert nach `deletedAt`.

Antworten

Eine Seite der Treffer.

application/json
  1. response

Eine Seite gefundener Buchungen.

items?array<>|

Die Treffer dieser Seite.

limit?|

Verwendetes limit.

offset?integer

Verwendetes offset.

total?integer

Anzahl aller Treffer des Filters.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/accounting/booking/filter" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{"direction":["desc","asc"],"limit":100,"offset":0,"sort":["bookingDate","id"]}'
Beispielantwort
{  "items": [    {      "account": 1201,      "accountContra": 11004,      "accountingModel": "SKR03",      "amount": "1785",      "bookingDate": {        "day": 12,        "month": 9,        "year": 2026      },      "bookingFlags": "",      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-09-12T07:30:19Z",      "deletedAt": null,      "export": {        "addendum": false,        "exported": false      },      "finalized": null,      "id": "a91d68ff-83b1-43a7-b373-91eb6adcebc6",      "kind": "payment",      "label": "Zahlung, Brauhaus Elbwiese GmbH, RE-2026-0142",      "origin": {        "matchId": "e21b3d18-17ea-4318-810c-919ec0a94dcb",        "transactionId": "a1ba4b85-5bd8-4cef-bbbd-16eaa2c46033"      },      "performanceFrom": null,      "performanceTo": null,      "refBankTransactionId": "a1ba4b85-5bd8-4cef-bbbd-16eaa2c46033",      "refDocumentId": null,      "refMatch": "e21b3d18-17ea-4318-810c-919ec0a94dcb",      "revertsAccountBookingId": null,      "status": "open",      "updatedAt": "2026-09-12T07:30:19Z"    },    {      "account": 1201,      "accountContra": 71007,      "accountingModel": "SKR03",      "amount": "-43.89",      "bookingDate": {        "day": 3,        "month": 9,        "year": 2026      },      "bookingFlags": "",      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-09-04T08:02:40Z",      "deletedAt": null,      "export": {        "addendum": false,        "exported": false      },      "finalized": null,      "id": "2f279ef2-0219-4b84-b04f-4d73e4ce6812",      "kind": "payment",      "label": "Zahlung, Papierhaus Wendt KG, 2026-5531",      "origin": {        "matchId": "d00419ed-ecab-4800-ad69-d482b73a6961",        "transactionId": "78c4ff15-f2a0-4eae-945d-73a969adab4b"      },      "performanceFrom": null,      "performanceTo": null,      "refBankTransactionId": "78c4ff15-f2a0-4eae-945d-73a969adab4b",      "refDocumentId": null,      "refMatch": "d00419ed-ecab-4800-ad69-d482b73a6961",      "revertsAccountBookingId": null,      "status": "open",      "updatedAt": "2026-09-04T08:02:40Z"    },    {      "account": 8400,      "accountContra": 11004,      "accountingModel": "SKR03",      "amount": "-1785",      "bookingDate": {        "day": 1,        "month": 9,        "year": 2026      },      "bookingFlags": "ust19%",      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-09-12T07:30:19Z",      "deletedAt": null,      "export": {        "addendum": false,        "exported": false      },      "finalized": null,      "id": "743f74e5-29fb-46ba-b919-21e48af483be",      "kind": "sales_invoice",      "label": "Brauhaus Elbwiese GmbH, Fassadenbeschriftung Entwurf und Montage",      "origin": {        "documentId": "3026096b-614f-40d3-8749-8acf9b529480",        "documentNumber": "RE-2026-0142",        "matchId": "e21b3d18-17ea-4318-810c-919ec0a94dcb"      },      "performanceFrom": {        "day": 1,        "month": 9,        "year": 2026      },      "performanceTo": {        "day": 1,        "month": 9,        "year": 2026      },      "refBankTransactionId": null,      "refDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",      "refMatch": "e21b3d18-17ea-4318-810c-919ec0a94dcb",      "revertsAccountBookingId": null,      "status": "open",      "updatedAt": "2026-09-12T07:30:19Z"    },    {      "account": 4930,      "accountContra": 71007,      "accountingModel": "SKR03",      "amount": "43.89",      "bookingDate": {        "day": 27,        "month": 8,        "year": 2026      },      "bookingFlags": "v19%",      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-09-04T08:02:40Z",      "deletedAt": null,      "export": {        "addendum": false,        "exportId": "6b0e3f52-9c1d-4a8e-b7f4-2d5a8c3e1f90",        "exported": true,        "exportedAt": "2026-09-05T10:41:09Z"      },      "finalized": "2026-09-05T10:41:09Z",      "finalizedBy": "export",      "id": "f00b48c7-6eb3-4082-aba2-917944ac5f93",      "kind": "purchase_invoice",      "label": "Papierhaus Wendt KG, Kopierpapier A4 10 Pakete",      "origin": {        "documentId": "a129ef0a-da5d-4204-804c-764d751bca95",        "documentNumber": "2026-5531",        "matchId": "d00419ed-ecab-4800-ad69-d482b73a6961"      },      "performanceFrom": {        "day": 27,        "month": 8,        "year": 2026      },      "performanceTo": {        "day": 27,        "month": 8,        "year": 2026      },      "refBankTransactionId": null,      "refDocumentId": "a129ef0a-da5d-4204-804c-764d751bca95",      "refMatch": "d00419ed-ecab-4800-ad69-d482b73a6961",      "revertsAccountBookingId": null,      "status": "finalized",      "updatedAt": "2026-09-05T10:41:09Z"    }  ],  "limit": 100,  "offset": 0,  "total": 4}