This page gives a thematic overview of the Public API resources. The complete endpoint reference with all fields is available to authenticated token holders at https://api.diekasse.app/v1/public/docs/. All paths are relative to the base URL https://api.diekasse.app/v1/public/.
Master data (read)
-
users– users -
companies– companies -
venues– venues -
sales-points– Sales Points -
vat– tax rates -
payment-methods– payment methods -
articles– articles -
article-groups– article groups -
printing-groups– printing groups -
course-groups– courses -
order-areas,order-area-items– ordering areas and their elements -
order-groups,open-order-groups– order groups (e.g. tables), including open groups -
customers– customers
Transactions and receipts (read)
-
orders– orders including line items -
payments– payments and invoices including payment items -
shifts– Sales Point closings (shifts) -
stock-transactions/latest– current stock level per article and warehouse
Warehouse
-
warehouse/stockup– retrieve stock (GET) and submit delivered quantities (PUT, also as CSV)
Pushing (asynchronous)
These endpoints accept a job via POST that the Sales Point then processes:
-
requests/orders– push orders -
requests/payment– push payments -
requests/payment-cancel– cancel payments -
requests/print-jobs– submit print jobs
Reports (read)
Reports usually expect a period (start, end) and a Sales Point (sales_point):
-
reports/turnover/...– turnover reports, e.g. by venue, article, article group, tax, payment method, user, as well as by time, day and date -
reports/customer/...– customer-related analyses -
reports/article/...– article and processing reports
For concrete requests and responses on the most important resources, see Examples.