bimetricsEntwickler
Ausgangsrechnungen

Rechnungsentwürfe suchen

Als Markdown ansehen

Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)

POST
/api/draft/filter

Sucht offene und abgeschlossene Rechnungsentwürfe der Firma einschließlich externalRef.

Benötigt einen Schlüssel mit der Berechtigung sales:read oder read.

Authentifizierung

AuthentifizierungBearer <token>

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.

AttributTypSortierbarBeschreibung
iduuidjaID des Entwurfs.
deletedAtdate-timejaLöschzeitpunkt; nur bei includeDeleted sichtbar.
invoiceNumberstringjaArbeits- oder Rechnungsnummer.
externalRefstringjaExterne Bestell- oder Integrationsreferenz.
updatedAtdate-timejaLetzte Änderung; als expectedUpdatedAt für einen Schreibaufruf verwenden.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/draft/filter" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{"direction":["desc","asc"],"limit":100,"offset":0,"sort":["updatedAt","id"]}'
{  "items": [    {      "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",      "createdAt": "2026-09-01T08:00:00Z",      "creatorUserCompanyId": "53cd10a9-c864-4dc3-a777-9860d59efe6c",      "deletedAt": null,      "documentId": null,      "draftBody": {        "buyer": {          "address": {            "city": "Hamburg",            "countryId": "DE",            "line1": "Am Hafen 12",            "postcode": "20457"          },          "contactId": "b17e8812-eae4-49b6-b5dc-30510635cb07",          "customerNumber": 1004,          "email": "",          "name": "Brauhaus Elbwiese GmbH",          "vatId": ""        },        "dueDate": {          "day": 15,          "month": 9,          "year": 2026        },        "issueDate": {          "day": 1,          "month": 9,          "year": 2026        },        "items": [          {            "description": "Gestaltung einer Geschäftsausstattung",            "discount": "0",            "name": "Gestaltung",            "position": "1",            "quantity": "1",            "taxRate": "19",            "unit": "C62",            "unitPrice": "100"          }        ],        "notes": "",        "performancePeriodFrom": {          "day": 1,          "month": 9,          "year": 2026        },        "priceType": "net",        "remark": "",        "showQRCode": false,        "strict": false,        "taxRateReason": "none",        "validUntil": null      },      "externalRef": "order-2026-1042",      "id": "821c3664-640a-4e10-b120-a4ff713532f8",      "invoiceNumber": "Entwurf 1042",      "kind": "ZUGFeRD",      "originalInvoiceId": null,      "salesProposalId": null,      "source": "api",      "sourceSalesProposalId": null,      "typeCode": "380",      "updatedAt": "2026-09-01T08:01:02.123456Z"    }  ],  "limit": 100,  "offset": 0,  "total": 1}

Rechnungsentwurf anlegen POST

Legt einen Rechnungsentwurf in EUR an. externalRef verbindet ihn mit der externen Bestellung. Die endgültige Rechnungsnummer entsteht erst beim Abschließen. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.

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