GET /api/v1/transactions/document/ {clientId}/start – RetailForce Software GmbH

Mit Hilfe des Endpunktes

GET /api/v1/transactions/document/{clientId}/start

wird ein so-genanntes Start-Dokument vom Fiskalservice erzeugt und an das Vorsystem zurückgegeben.

Startdokumente sind länderspezifische Dokumente, welche verwendet werden, um die Fiskaleinheit zu initialisieren (in Betrieb zu nehmen).

Manche Länder schreiben ein derartiges Startdokument gesetzlich vor, wie in der nachfolgenden Tabelle dargestellt.

Land	Bezeichnung	DocumentTyp
Litauen	initial report (Z)	[99] = EndOfDay
Österreich	Startbeleg	[1000] = NullReceipt

GET /api/v1/transactions/document/{clientId}/start erzeugt immer das im jeweiligen Land benötigte Start-Dokument.

Wichtig: Im Sinne der standardisierten Schnittstelle, erfolgt die Initialisierung eines Fiskal Clients immer über den im verlinkten Artikel beschriebenen Prozess. Ein Start-Dokument muss somit in jedem Land an den Fiskalservice übermittelt werden.

Hinweis: alternativ zur Verwendung des Endpunktes GET /api/v1/transactions/document/{clientId}/start kann das jeweilige Start-Dokument auch vom Vorsystem (elektronisches Aufzeichnungssystem) selbst erzeugt werden.

Ergebnis

Bei einer erfolgreichen Verarbeitung (200) gibt der jeweilige Fiskal Client ein Start-Dokument an das Vorsystem zurück.

Verwendung

Einmalige, im Rahmen der Inbetriebnahme eines Fiskal Clients.

Voraussetzungen

Fiskal Middleware installiert,
Fiskal Client erzeugt und konfiguriert, entweder über
- PUT /api/v1/management/clients oder
- PUT /api/v1/management/clients/byCloud
cloudConnect erfolgreich ausgeführt (nur bei Systemen, welche mit der RetailForce Cloud verbunden sind).

Formularfelder

Folgende Informationen müssen übermittelt werden:

Bezeichnung	Beschreibung	Beispiele
clientId	Die uniqueClientId der Registrierkasse (aus RetailForce System)	c1062c55-57c4-4ed2-9c53-aff1762326a4
bookDate	Optional: der Buchungszeitpunkt des Start-Dokuments	2023-05-19T10:30:04.297Z

Antwort

Mögliche Antworten:

Code	Beschreibung	Beispiel
200	Landesspezifisches Startdokument	-