Kontakte suchen
Benötigte Berechtigung:read(Daten lesen)
Sucht Kontakte (Kunden und Lieferanten) der Firma mit einem Filter und liefert eine Seite der Treffer.
Benötigt einen Schlüssel mit der Berechtigung read.
Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
In: header
Request-Body
application/json
Filter, Sortierung und Seite. Dokumentierte Filterattribute: x-bimetrics-filter.
TypeScript-Typen
Typ request body für TypeScript.
Suche mit Filter, Sortierung und Seiten. Der Filterausdruck steht auf oberster Ebene; {} liefert alle Einträge.
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 Kontakts. |
companyName | string | ja | Name des Kontakts. |
customerNumber | integer | ja | Kunden- bzw. Lieferantennummer. |
type | string | ja | Art: `customer` (Kunde), `supplier` (Lieferant) oder `partner`. |
customerKind | string | ja | Steuerlich: `business` (Unternehmen) oder `private` (Privatperson); leer, wenn unbekannt. |
contactInfo.email | string | ja | E-Mail-Adresse. |
paymentInfo.iban | string | ja | IBAN. |
paymentInfo.vatId | string | ja | USt-IdNr. |
updatedAt | date-time | ja | Zeitpunkt der letzten Änderung. |
Antworten
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl --fail-with-body "https://app.bimetrics.de/api/contact/filter" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"direction":["asc","asc"],"limit":100,"offset":0,"sort":["companyName","id"]}'{ "items": [ { "addresses": [ { "city": "Hamburg", "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "country": "DE", "createdAt": "2026-03-18T10:02:51Z", "id": "181e7601-21c2-47fa-bffa-008d1113c6d8", "postalCode": "20457", "street": "Am Sandtorkai 12", "updatedAt": "2026-03-18T10:02:51Z" } ], "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "companyName": "Brauhaus Elbwiese GmbH", "contactInfo": { "contactPersonName": "Erika Mustermann", "email": "buchhaltung@brauhaus-elbwiese.de" }, "createdAt": "2026-03-18T10:02:51Z", "customerKind": "business", "customerNumber": 1004, "id": "b17e8812-eae4-49b6-b5dc-30510635cb07", "paymentInfo": { "bic": "BYLADEM1001", "iban": "DE02120300000000202051", "vatId": "DE987654321" }, "type": "customer", "updatedAt": "2026-09-01T09:13:02Z", "vatCheck": { "checkedAt": "2026-03-18T10:02:53Z", "valid": true, "vatId": "DE987654321" } }, { "addresses": [ { "city": "Kiel", "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "country": "DE", "createdAt": "2026-08-28T06:15:21Z", "id": "4b6951dc-e603-4bf5-9135-ef5a7d9a417c", "postalCode": "24103", "street": "Bahnhofstraße 8", "updatedAt": "2026-08-28T06:15:21Z" } ], "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "companyName": "Papierhaus Wendt KG", "contactInfo": {}, "createdAt": "2026-08-28T06:15:21Z", "customerNumber": 1007, "id": "fd493c80-9d79-4bb1-aab5-09992633dce0", "paymentInfo": { "iban": "DE02500105170137075030", "vatId": "DE246813579" }, "type": "supplier", "updatedAt": "2026-08-28T06:15:21Z" } ], "limit": 100, "offset": 0, "total": 2}Originaldatei eines Belegs laden GET
Liefert die hochgeladene Originaldatei als Binärdaten. PDFs und Bilder kommen mit ihrem Typ (`application/pdf`, `image/png`, `image/jpeg`), alles andere, etwa XML-E-Rechnungen, als `application/octet-stream`. Der `ETag` ist der SHA-256 der Datei (Hex, ohne Anführungszeichen); mit genau diesem Wert in `If-None-Match` antwortet die Route mit `304` ohne Inhalt. `404`, wenn der Beleg keine Originaldatei hat. Benötigt einen Schlüssel mit der Berechtigung `read`.
Kontakt lesen GET
Liefert einen Kontakt mit Anschriften, Kontakt- und Zahlungsdaten. Benötigt einen Schlüssel mit der Berechtigung `read`.