Verfügbare Ressourcen

Diese Seite gibt einen thematischen Überblick über die Ressourcen der Public API. Die vollständige Endpunkt-Referenz mit allen Feldern finden angemeldete Token-Inhaber unter https://api.diekasse.app/v1/public/docs/. Alle Pfade sind relativ zur Basis-URL https://api.diekasse.app/v1/public/.

Stammdaten (lesen)

• users – Benutzer

• companies – Unternehmen

• venues – Standorte

• sales-points – Kassen

• vat – Steuersätze

• payment-methods – Zahlarten

• articles – Artikel

• article-groups – Artikelgruppen

• printing-groups – Druckgruppen

• course-groups – Gänge

• order-areas, order-area-items – Bestellbereiche und deren Elemente

• order-groups, open-order-groups – Bestellgruppen (z. B. Tische), inklusive offener Gruppen

Stammdaten (schreiben)

• customers – Kunden lesen (GET), anlegen (POST) und ändern (PUT, PATCH). Dies ist die einzige Ressource, die synchron geschrieben werden kann.

Vorgänge und Belege (lesen)

• orders – Bestellungen inklusive Positionen

• payments – Zahlungen bzw. Rechnungen inklusive Zahlpositionen

• shifts – Kassenabschlüsse (Schichten)

• reports/shift/<id> – Kassenabschluss-Bericht als PDF-Datei

• stock-transactions/latest – jeweils jüngste Lagerbewegung je Artikel und Lager, inklusive Menge und Bewegungsart

Lager

• warehouse/stockup – aktueller Bestand aller Lager als CSV-Datei (GET), filterbar nach warehouse, article, article_group und show_only_stock_ups

Einspielen (asynchron)

Diese Endpunkte nehmen per POST einen Auftrag entgegen, den die Kassa anschließend verarbeitet:

• requests/orders – Bestellungen einspielen

• requests/payment – Zahlungen einspielen

• requests/payment-cancel – Zahlungen stornieren

• requests/print-jobs – Druckaufträge übergeben

Berichte (lesen)

Berichte erwarten in der Regel einen Zeitraum (start, end) und eine Kassa (sales_point):

• reports/turnover/... – Umsatzberichte, u. a. nach Standort, Artikel, Artikelgruppe, Steuer, Zahlart, Benutzer sowie nach Zeit, Tag und Datum

• reports/customer/... – Kundenbezogene Auswertungen

• reports/article/... – Artikel- und Verarbeitungsberichte

Die meisten Umsatz- und Artikelberichte liefern wahlweise JSON oder CSV; steuern lässt sich das über den Accept-Header (application/json bzw. text/csv).

Konkrete Anfragen und Antworten zu den wichtigsten Ressourcen zeigt die Seite Beispiele.