DELETE /api/v1/management/germany/ {clientId}/tse/listTransactions – RetailForce Software GmbH

Der Endpunkt

DELETE /api/v1/management/germany/{clientId}/tse/listTransactions

kann verwendet werden, um offene TSE Transaktionen zu schließen.

Grundsätzlich sollten Transaktionen nicht offen bleiben. Wir empfehlen, alle offenen Transaktionen, vor einem Tagesabschluss entweder mit

POST /api/v1/transactions/storeDocument - wenn ein Verkauf stattgefunden hat, oder
POST /api/v1/transactions/cancelDocument - wenn kein Verkauf stattgefunden hat

abzuschließen.

Achtung: bitte beachten Sie, dass auch Belegabbrüche in der TSE aufgezeichnet werden (müssen). Daher ist es auch notwendig, jede mit PUT /api/v1/transactions/createDocument gestartete Transaktion auch mit "storeDocument" oder "cancelDocument" zu beenden. Bei häufigen Belegabbrüchen können wir nicht ausschließen, dass es im Rahmen einer Kassen-Nachschau durch die Organe der Finanzverwaltung zu Rückfragen hinsichtlich der Gründe der Abbrüche kommen kann.

Ergebnis

Offene TSE Transaktionen werden mit einem POST /api/v1/transactions/cancelDocument gesammelte geschlossen, ohne die Notwendigkeit diese einzeln schließen zu müssen.

Verwendung

Wir empfehlen den Einsatz dieses Endpunkts mit Vorsicht und nur im Fehlerfall.

Der Aufruf erzeugt zuerst eine Abfrage an die TSE, welche Transaktionen offen sind. Die unterschiedlichen TSE-Typen (Cloud TSE, Hardware TSE) geben keine vollständige Liste an offenen Transaktionen zurück, sondern nur "paketweise":

swissbit Hardware TSE: jeweils 8 Transaktionen
fiskal Cloud TSE: jeweils 100 Transaktionen

Nachdem die TSE das Paket an offenen Transaktionen zurückgegeben hat, werden die enthaltenen Transaktionen über ein leeres Dokument, mit den folgenden Angaben, geschlossen:

DocumentId: vom Service generierte Guid
DocumentNr: vom Service generierte Guid
DocumentGuid: vom Service genrierte Guid
DocumentType: Receipt
DocumentTypeCaption: CancelTransaction

Sind mehr als die oben angegebenen Transaktionen offen, muss der Endpunkt entsprechen öfter aufgerufen werden.

Alle geschlossenen Transaktionen werden auch entsprechend in den DSFinV-K Daten gespeichert.

Voraussetzung

Es sind offene (gestartete), also nicht geschlossene Transaktionen auf der TSE vorhanden.

Wird eine bestimmte Anzahl an offenen Transaktionen erreicht, können keine weiteren Transaktionen mehr auf der gestartet werden und die TSE meldet einen Fehler zurück. Mehr Informationen dazu finden Sie auch im Artikel Tse connection error.

Die Anzahl offener Transaktionen können Sie über den Endpunkt:

GET /api/v1/management/germany/{clientId}/tse/listTransactions

abrufen.

Beispiel:

TSE gibt im Feld "startedTransactions" die Anzahl der gestarteten Transaktionen aus.

{
   ...
   "startedTransactions": 512,
   "maxStartedTransactions": 512,
   ...
}

Hinweis: funktioniert nur bei Hardware-TSEs. Das Limit an gleichzeitig offenen Transaktionen der fiskaly Cloud TSE ist 2.000.

Formularfelder

Folgende Informationen müssen übermittelt werden:

Bezeichnung	Beschreibung	Beispiele
clientId	Die uniqueClientId der Registrierkasse (aus RetailForce System)	c1062c55-57c4-4ed2-9c53-aff1762326a4

Antwort

Mögliche Antworten:

Code	Beschreibung	Beispiel
200	fiscalResponse - die offenen Transaktionen wurden erfolgreich geschlossen (cancelDocument)	-
400	"Tse not connected". Es ist keine TSE mit dem System verbunden, bzw. dem entsprechenden Client zugeordnet. Fehlerbehebung: Prüfung ob TSE mit dem System verbunden ist z.B: mit GET /api/v1/management/germany/tse	-
404	"Client was not found" - unter der angegebenen clientId existiert keine Konfiguration auf diesem System Fehlerbehebung: Prüfung der angegebenen clientId Prüfung ob die angegebene clientId in der Middleware konfiguriert ist (in Datei fiscalService.config.json unter C:\Program Files\RetailForce\Fiscal Webservice\Config)	-
422	"clientId was set to Guid.Empty" Fehlerbehebung:	-
500	"Internal server error" - sonstiger Fehler. Fehlerbehebung: wiederholen Sie den Aufruf, starten Sie den Dienst ggf. neu, führen Sie ein cloudConnect aus.	-

Achtung: unabhängig davon, wie die Fehlerbehebung erfolgt ist, empfehlen wir Ihnen, die Ursache warum, TSE-Transaktionen offen bleiben genauestens zu analysieren. Im regelmäßigen Kassenprozess sollten alle offenen Transaktionen vor einem Tagesabschluss geschlossen sein.

Ergebnis

Verwendung

Voraussetzung

Formularfelder

Antwort

Verwandte Beiträge