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 |
|---|---|---|---|
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
application/json
curl -X POST "https://app.bimetrics.de/api/contact/filter" \ -H "Content-Type: application/json" \ -d '{}'{ "items": [ { "addresses": [ { "city": "string", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "country": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "postalCode": "string", "street": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "companyName": "string", "contactInfo": { "contactPersonName": "string", "email": "string", "notes": "string", "phone": "string", "website": "string" }, "createdAt": "2019-08-24T14:15:22Z", "customerKind": "business", "customerNumber": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "paymentInfo": { "bic": "string", "iban": "string", "leitwegId": "string", "vatId": "string" }, "type": "customer", "updatedAt": "2019-08-24T14:15:22Z", "vatCheck": { "checkedAt": "2019-08-24T14:15:22Z", "requestId": "string", "valid": true, "vatId": "string" } } ], "limit": 0, "offset": 0, "total": 0}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`.