RetailForce Fiskalservice - API Beschreibung – RetailForce Software GmbH

Dieser Artikel bietet einen Überblick über API-Funktionen des RetailForce Fiskalservices (Stand: Release 1.6.3). Die erforderlichen Parameter jedes Endpunkts können nach der Installation der Fiskal Middleware über den Swagger (z. B. http://localhost:7678/swagger/index.html) eingesehen werden.

Die API ist in unterschiedliche Bereiche eingeteilt, welche für verschiedene Zwecke und Produkte verwendet werden.

Informationen in der Spalte "Typ":

O ... optional
M ... erforderlich / obligatorisch
M* ... erforderlich / obligatorisch in bestimmten Ländern oder unter bestimmten Voraussetzungen
R ... empfohlen

Die Überschriften beziehen sich auf den jeweiligen Abschnitt im Swagger. Bei manchen Endpunkten finden Sie weiterführende Informationen verlinkt.

Backup

Kurzbeschreibung: Archivierungsfunktion für beliebige Kassen-Daten.

Endpunkte in diesem Abschnitt dienen dazu, beliebige Daten in das Cloud-Archiv hochzuladen - für Dienst/Produkt: "POS-Archiv". Backup-Lizenz erforderlich, um diesen Dienst zu nutzen.

Endpunkt	Typ	Beschreibung
POST /api/v1/backup/{clientId}	O	Mit dieser Methode wird ein bestimmter Ordner im Cloud-Archiv gesichert.
POST /api/v1/backup/{clientId}/restore	O	Stellt eine zuvor archivierte Datei (Backup) an einem bestimmten Ort wieder her.
GET /api/v1/backup/{clientId}/restore	O	Gibt eine Download-URL zurück, mit der die angeforderte Sicherungsdatei aus dem Cloud-Archiv heruntergeladen werden kann.

Closing

Kurzbeschreibung: Funktionen für den Tagesabschluss einer Kasse

Dieser Abschnitt enthält verschiedene Verbuchungsfunktionen für die Registrierkasse. Weiterführende Informationen zu Tagesabschlussbuchungen finden Sie im Artikel: Tagesabschluss der Kasse

Endpunkt	Typ	Beschreibung
POST /api/v1/closing/{clientId}/book/ openingStock	O	Bucht den Anfangsbestand für einen Kassenabschluss. Verbucht nur eine Einzahlung, setzt den Kassenbestand nicht neu fest. Alternativ: Alternativ kann die Kasse auch einen Beleg buchen: documentType [11] = PayIn.
PUT /api/v1/closing/{clientId}/book/ cashDifference	O	Übermittelt eine Kassendifferenzbuchung an die Middleware. Alternativ: Als Alternative kann die Kasse auch einen Beleg mit BusinessTransactionType [91] = CashDifference buchen.
PUT /api/v1/closing/{clientId}/book/ cashLift	O	Bucht einen Geldtransfer (money transfer) vom Kassensystem zur Bank (oder einem anderen Ziel).
GET /api/v1/closing/{clientId}/ actualStock	O	Liefert den aktuellen Zahlungsmittelbestand zurück. Dieser wird auf Basis der übermittelten Dokumenten (neben Verkaufs- und Retourenbelege auch Ein- und Auszahlungen, etc.) berechnet.
POST /api/v1/closing/{clientId}/ cashpointCheck	O	Prüft den tatsächlichen Zahlungsmittel Bestand für diese Kasse und gibt eine Liste der Zahlungsmittel mit Differenz zurück (oder eine leere Liste, wenn es keine Differenz gibt).
POST /api/v1/closing/{clientId}/ cashpointClose	O	Schließt den aktuellen Tag mit einem Tagesabschlussbericht ab.
GET /api/v1/closing/{clientId}/ endofdayDocument	O	Gibt das Tagesabschlussdokument für den aktuellen Tag zurück. Das zurückgegebene Dokument muss gespeichert werden (storeDocument > documentType: 99).
GET /api/v1/closing/{clientId}/ lastClosing	O	Liefert Datum und Uhrzeit der letzten Schließung eines bestimmten Mandanten (Client/Terminal).
GET /api/v1/closing/{clientId}/ closingNecessary	O	Gibt Auskunft darüber, ob für ein bestimmtes Terminal ein Tagesabschluss durchgeführt werden muss oder nicht. (Abhängig von RetailForce.Fiscalisation.Implementation. IFiscalCountryProperties. MaximumHourIntervalForClosing.)

Information

Kurzbeschreibung: für die Abfrage spezieller Informationen

Endpunkt	Typ	Beschreibung
GET /api/v1/information/version	O	Gibt die aktuelle Software Version (SW) Fiskal-Middleware zurück.
GET /api/v1/information/version/{clientId}	O	Gibt die Version des Ländermoduls des angegebenen Clients zurück.
GET /api/v1/information/countryProperties	O	Gibt die fiscalCountryProperties für das angeforderte Land zurück.
GET /api/v1/information/client/{clientId}/ countryProperties	O	Gibt die fiscalCountryProperties für einen bestimmten Client zurück.
GET /api/v1/information/client/{clientId}/ uniqueCashRegisterId	O	Gibt die eindeutige Kassennummer zurück (Filialnummer/Kassennummer).
GET /api/v1/information/client/{clientId}/ status	O	Gibt den Status des angeforderten Fiskalclients zurück.
GET /api/v1/information/client/{clientId}/ accessLicenses	O	Gibt eine Liste der Lizenzen für den angeforderten Client zurück.
GET /api/v1/information/client/{clientId}/ licenses	O	Gibt den Lizenzanspruch für den angeforderten Client zurück.
GET /api/v1/information/client/{clientId}/ getVatIdentification	R	Gibt die entsprechende Umsatzsteuer-Identifikation für den angeforderten Prozentsatz zurück.
GET /api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName}	O	Gibt die Pflichtfelder für den durch typeName angegebenen Typ für die angegebene Länderimplementierung zurück.
POST /api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk	R	Wenn diese Option auf true gesetzt ist, wird jedes Fehlerdokument im Verzeichnis des Fiskalclients gespeichert.
GET /api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk	R	Gibt zurück, ob die Option RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk aktiviert ist.
GET /api/v1/information/performance/ {clientId}	O	Gibt alle Leistungsindikator-IDs (performance counter IDs) für den angegebenen Client zurück
DELETE /api/v1/information/performance/ {clientId}	O	Setzt alle Durchschnittsdaten (Performance) für den angegebenen Client zurück.
GET /api/v1/information/performance {clientId}/{performanceCounterId}	O	Gibt die Durchschnittsdaten der angeforderten Leistungsindikator-ID zurück.
DELETE /api/v1/information/performance/ {clientId}/{performanceCounterId}	O	Setzt die Durchschnittsdaten für den angegebenen Client und den angegebenen Leistungsindikator zurück.
PUT /api/v1/information/performance/ {clientId}/file	O	Aktiviert oder deaktiviert die Aufzeichnung von Leistungsdaten (Performance data). Die Aufzeichnung von Leistungsdaten ist standardmäßig deaktiviert.
GET /api/v1/information/progress/ {clientId}	O	Gibt alle Fortschrittsinformationen (progress information label) für den angegebenen Client zurück.
GET /api/v1/information/progress/{clientId}/ {label}	O	Gibt alle Fortschrittsinformationen (progress information) für den angegebenen Client und das jeweilige Label (Bezeichnung) zurück.

Management

Kurzbeschreibung: Managementfunktionen, Inbetrieb- und Außerbetriebnahme, etc.

Endpunkt	Typ	Beschreibung
PUT /api/v1/management/clients	O/M	Legt einen neuen Client im Konfigurationsspeicher an. Das Konfigurationsobjekt muss vom POS-System vorbereitet werden. Die Konfiguration eines Clients ist für den Betrieb des Systems erforderlich. Verwenden Sie entweder diesen Endpunkt, oder: PUT /api/v1/management/clients, oder PUT /api/v1/management/clients/ byCloud/id.
POST /api/v1/management/clients	O	Aktualisiert eine vom Kassensystem erstellte Client-Konfiguration im Konfigurationsspeicher.
GET /api/v1/management/clients	O	Gibt alle im Konfigurationsspeicher aufgeführten Clients zurück. Kann auch bei Verwendung der Cloud-Konfiguration eingesetzt werden.
PUT /api/v1/management/clients/ byCloud	O/M	Erzeugt einen neuen Client mit einer in der Cloud vorbereiteten Konfiguration / oder lädt einen bestehenden Client. Die Konfiguration eines Clients ist für den Betrieb jedenfalls erforderlich. Verwenden Sie entweder diesen Endpunkt, oder PUT /api/v1/management/clients, oder PUT /api/v1/management/clients/ byCloud/id.
PUT /api/v1/management/clients/ byCloud/id	O	Erzeugt einen Client, mit Konfigurationsdaten aus der Cloud (siehe oben). Alternativ: alternativer Endpunkt zu PUT /api/v1/management/clients und PUT /api/v1/management/clients/byCloud.
PUT /api/v1/management/clients/ byCloud/{clientId}	R	Aktualisiert die Client-Konfiguration, indem diese aus der Cloud geladen wird. Wird verwendet, wenn die in der Cloud vorbereitete Konfiguration aktualisiert wurde und vom Fiskal-Client neu heruntergeladen werden soll (Update).
POST /api/v1/management/clients/ withCloud	O/M	Erstellt einen neuen Client (lokal) und fügt diesen Client zur Cloud-Konfiguration hinzu. Der Mandant wird im lokalen Konfigurationsspeicher erstellt und das Konfigurationsobjekt wird anschließend in das Cloud-System hochgeladen. Hinweis: Der Distrobutor muss in den Client-Informationen festgelegt werden und der Distributor muss berechtigt sein, neue Clients zu erstellen.
POST /api/v1/management/cloud/ connect	M*	Stellt die Cloud-Verbindung des betreffenden Clients her und lädt das Fiskalmodul in den Cache. Erforderlich für Systeme, die Cloud-Funktionen nutzen. Erforderlich nach jedem Neustart des POS-Systems.
POST /api/v1/management/cloud/ updateLicense	O	Aktualisiert den aktuellen Lizenzschlüssel in der Fiskal-Client-Konfiguration (auch auf der Festplatte). Erforderlich, wenn Lizenzen in der Cloud-Konfiguration geändert wurden.
HEAD /api/v1/management/cloud/queue	R	Methode zum Starten oder Stoppen des Cloud-Uploads (Warteschlange) für alle Clients. Der Befehl "stop" stoppt den Upload nach Verarbeitung der aktuellen Datei. "Start" startet die Verarbeitung der Warteschlange sofort. Wenn die Verarbeitung in der Cloud-Warteschlange angehalten wird, müssen Sie sie neu starten, es sei denn, der Dienst wird neu gestartet (dann wird die Cloud-Verarbeitung wieder aktiviert).
GET /api/v1/management/clients/ {clientId}	O	Gibt die Client-Konfiguration eines bestimmten Clients zurück.
DELETE /api/v1/management/clients/ {clientId}	O	Löscht einen bestimmten Client Achtung: mit Vorsicht verwenden!
GET /api/v1/management/clients/id	O	Gibt die eindeutige Client-ID für die angeforderten Parameter zurück. Für die Abfrage der uniqueClientId können verschiedene Parameter verwendet werden.
GET /api/v1/management/clients/ licenseConsumerId	O	Liefert die License Consumer-ID anhand der angegebenen Parameter. Es werden nur licenseConsumerId's zurückgegeben, die bereits im config store gespeichert sind.
GET /api/v1/management/clients/ validate	O	Validiert die angegebenen Client-Informationen, um die erforderliche länderspezifische Konfiguration zu erfüllen. Wird verwendet, um eine vom Kassensystem erstellte Konfiguration vor der Verwendung von /api/v1/management/clients zu validieren. Die Validierung der Cloud-Konfiguration wird im Cloud-System bereitgestellt (bei Cloud-Konfiguration).
POST /api/v1/management/clients/ initialize	M	Initialisiert die Fiskalisierungseinheit (und eventuelle Hardware und führt eventuelle Meldung an die Finanzbehörden durch). Die Initialisierung erfolgt über den Startbeleg, der entweder über den Endpunkt GET /api/v1/transactions/document/{clientId}/start abgefragt werden kann, oder durch das Kassensystem erstellt wird.
POST /api/v1/management/clients/ migrate/{clientId}	O	Migriert einen Client von einem anderen Fiskalisierungsanbieter. Wird beim Wechsel von einem anderen Fiskal-Middleware-Anbieter zu RetailForce verwendet. Bitte beachten Sie die dabei unterstützten Systeme.
POST /api/v1/management/clients/ migrate/{clientId}/file	O	Migriert einen Mandanten von einem anderen Fiskalisierungsanbieter und führt einen Datei-Import durch. Bitte beachten Sie die dabei unterstützten Systeme!
POST /api/v1/management/clients/ decommission	R	Außerbetriebnahme des Clients (und eventuelle Hardware und führt eventuelle Abmeldung bei den Finanzbehörden durch).
PUT /api/v1/management/clients/ {clientId}/supportPackage	R	Lädt ein Support-Paket (Log-Dateien) für den angegebenen Client in die Cloud hoch. Dieser Endpunkt ist erforderlich, um die Funktion "Upload support package" im Cloud-System zu nutzen
GET /api/v1/management/clients/ recovery/{clientId}/backup	R	Sichert einen Client unter dem angegebenen Dateinamen (Zip-Datei-Backup). Wenn der Cloud-Upload in Gebrauch ist, wird die Verarbeitung der Cloud-Warteschlange gestoppt und gestartet (und die Cloud-Warteschlange wird neu initialisiert). Achtung! Bitte beachten Sie, dass der Cloud-Upload nach dem Backup wieder aufgenommen wird, wenn der Client nicht entfernt (gelöscht) wird. Wenn Dateien vor der Sicherung noch nicht in die Cloud geladen wurden, sind sie ebenfalls Teil der Sicherung und werden möglicherweise zweimal hochgeladen, falls der Client wiederhergestellt wird.
POST /api/v1/management/clients/ recovery/restore	R	Stellt einen Client (mit allen Daten) aus der angegebenen Backup-Zip-Datei wieder her.
POST /api/v1/management/clients/ recovery/restoreByCloud	R	Erzeugt einen neuen Client mit der Konfiguration aus der Cloud / oder lädt einen bestehenden Client.
POST /api/v1/management/clients/ recovery/restoreByCloud/id	O	Erzeugt einen neuen Client mit der Konfiguration aus der Cloud / oder lädt einen bestehenden Client.
POST /api/v1/management/clients/ {clientId}/globalShortId	O	Generiert eine neue, oder gibt eine bereits existierende, global eindeutige ID für den jeweiligen Client zurück. Weiters wird die Ausstellung der retailForceReceiptId für den jeweiligen Client aktiviert.
POST /api/v1/management/clients/ {clientId}/certificate	O/M	Speichert ein externes Zertifikat im Zertifikatspeicher des Fiskalmoduls. Erforderlich für Systeme, die NICHT die RetailForce Cloud-Funktionen in Fiskalländern nutzen, in denen Softwarezertifikate im Rahmen der Fiskalisierung verwendet werden (Slowenien, Kroatien, Spanien,...)
GET /api/v1/management/clients/ {clientId}/licenses/accessLicense	O	Gibt zurück, ob der angeforderte Client die angeforderte Zugriffslizenz besitzt.
GET /api/v1/management/clients/ {clientId}/licenses/license	O	Gibt zurück, ob der angeforderte Client die angeforderte Lizenz besitzt.

ManagementController_Austria

Kurzbeschreibung: Managementfunktionen für die Österreichische Fiskalisierung.

Endpunkt	Typ	Beschreibung
POST /api/v1/management/austria/ {clientId}/aes	O	Erzeugt einen AES-Benutzerschlüssel für diesen Client und gibt ihn zurück. Der AES-Schlüssel wird auch in der Client-Konfiguration gespeichert. Hinweis: Der AES-Benutzerschlüssel wird automatisch vom Fiskal-Client erstellt. Der Endpunkt ist nur erforderlich, wenn die Erstellung des AES-Schlüssels manuell ausgelöst werden soll.
GET /api/v1/management/austria/ {clientId}/aes	O	Gibt den AES-Benutzerschlüssel für den angegebenen Client zurück.
GET /api/v1/management/austria/ {clientId}/dep	O/M	Exportiert alle Belegzeilen des lokalen Datenerfassungsprotokolls (DEP §7 RKSV). Erforderlich für Offline-Systeme (Systeme, die KEINE Cloud-Archivierung von Fiskaldaten verwenden)
GET /api/v1/management/austria/ {clientId}/dep131	O	Exportiert alle für das DEP131 (DEP §131 BAO) Protokoll angeforderten Daten aus den lokal gespeicherten Daten.
GET /api/v1/management/austria/ {clientId}/dep/startReceipt	R	Gibt den Startbeleg dieses Mandanten zurück. Das Kassensystem muss in der Lage sein, bei Finanzprüfungen auf Anfrage den Startbeleg auszugeben. Wenn das Kassensystem den Startbeleg nicht gespeichert hat, kann er über diesen Endpunkt angefordert werden.
GET /api/v1/management/austria/ {clientId}/dep/monthReceipts	R	Gibt alle Monatsbelege im angeforderten Datumsrahmen zurück. Das Kassensystem muss in der Lage sein, im Zuge einer Prüfung durch die Finanzpolizei auf Anfrage Monatsbelege bereitzustellen. Wenn das Kassensystem diese Dokumente nicht gespeichert hat, können sie über diesen Endpunkt angefordert werden.
GET /api/v1/management/austria/ {clientId}/fon/certificate	O	Liefert alle Signaturerstellungseinheiten und ob diese bei FinanzOnline (FON) aktiviert sind oder nicht.
POST /api/v1/management/austria/ {clientId}/fon/certificate	O	Registriert die konfigurierte oder die mit certificateSerial identifizierte Signaturerstellungseinheit in FinanzOnline. Hinweis: Wenn RetailForce Cloud Services verwendet werden, werden die Zertifikate automatisch im FinanzOnline Portal (FON) registriert (credentials für Kassen-Webservice-Benutzer notwendig!); Endpunkt nur notwendig, wenn die Registrierung manuell erfolgen soll.
DELETE /api/v1/management/austria/ {clientId}/fon/certificate	O	Melde die Außerbetriebnahme einer konfigurierten oder der mit certificateSerial identifizierten Signaturerstellungseinheit in FinanzOnline. Achtung: mit Vorsicht verwenden!
GET /api/v1/management/austria/ {clientId}/fon/document	R	Validiert das letzte signierte Dokument in DEP (Datenerfassungsprotokoll) über FinanzOnline (FON).
GET /api/v1/management/austria/ {clientId}/fon/document/{depDocument}	R	Validiert das angegebene Dokument (qr code) über FON.
GET /api/v1/management/austria/ {clientId}/fon/cashregister	O	Gibt zurück, ob die Registrierkasse des aktuellen Clients in FON registriert ist. Erforderlich für Offline-Systeme.
POST /api/v1/management/austria/ {clientId}/fon/cashregister	O	Register die KassenId des aktuellen Clients in FON. Erforderlich für Offline-Systeme.
DELETE /api/v1/management/austria/ {clientId}/fon/cashregister	O	Meldet die Außerbetriebnahme der KassenId des aktuellen Clients in FON. Erforderlich für Offline-Systeme. Achtung: mit Vorsicht verwenden!

ManagementController_Bulgaria

Kurzbeschreibung: Managementfunktionen für die Bulgarische Fiskalisierung.

Endpunkt	Typ	Beschreibung
POST /api/v1/management/bulgaria/ {clientId}/commands/closing	M	Sendet den Tagesabschlussbefehl (Z) an den Fiskaldrucker.
POST /api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime	M	Sendet den Befehl zur Zeitsynchronisation (L) an den Fiskaldrucker.
GET /api/v1/management/bulgaria/ {clientId}/reports/klen	R	Mit dieser Funktion kann ein s.g. KLEN-Bericht erzeugt werden. (ab v1.8.3)
GET /api/v1/management/bulgaria/ {clientId}/reports/zreport	R	Über diese Funktion werden detaillierte und zusammenfassende Periodenberichte ausgedruckt. (ab v.1.8.3)
GET /api/v1/management/bulgaria/ {clientId}/reports/block	R	Über diese Funktion wird ein s.g. BLOCK-Bericht ausgedruckt. (ab v1.8.3)

ManagementController_Denmark

Kurzbeschreibung: Managementfunktionen für die Dänische Fiskalisierung.

Endpunkt	Typ	Beschreibung
GET /api/v1/management/denmark/ {clientId}/saft	M	Exportiert das dänische SAF-T-Format in den angegebenen Stream.

ManagementController_France

Kurzbeschreibung: Managementfunktionen für die Französische Fiskalisierung.

Endpunkt	Typ	Beschreibung
GET /api/v1/management/france/ eventlog/{clientId}	M	Gibt alle angeforderten Audit-Log-Einträge nach Datum zurück.
GET /api/v1/management/france/ archive/{clientId}	M	Gibt die lokal gespeicherten Archive zum Schließen zurück.
POST /api/v1/management/france/ archive/{clientId}/verify	M	Methode zum Verifizieren des französischen Archivs

ManagementController_Germany

Kurzbeschreibung: Managementfunktionen für die Deutsche Fiskalisierung.

Endpunkt	Typ	Beschreibung
GET /api/v1/management/germany/tse	R	Gibt ein Array der angeschlossenen lokalen TSE-Geräte und deren Status zurück.
POST /api/v1/management/germany/ tse/{tseSerial}/selftest	R	Führt einen synchronen Selbsttest für die angegebene Registrierkasse an der TSE durch (Registrierkasse ist optional).
PUT /api/v1/management/germany/ {clientId}/tse/connectTest	R	Stellt eine Testverbindung zu der angegebenen TSE her.
GET /api/v1/management/germany/ {clientId}/tse/listClients	O	Gibt alle Clients zurück, die in der TSE des angegebenen Clients aufgeführt sind.
GET /api/v1/management/germany/ {clientId}/tse/status	R	Gibt den Status der TSE zurück. Wenn kein Fiskalmodul gefunden wird, wird Status RetailForce.Fiscalisation.Implementation. Germany.Tse.TseStatus.Critical zurückgegeben.
PUT /api/v1/management/germany/ {clientId}/tse/updateTime	M	Aktualisiert die Zeit auf der TSE mit der aktuellen Computerzeit.
GET /api/v1/management/germany/ {clientId}/tse/tar	O	Exportiert die tar-Dateien aus der primärenTSE. Erforderlich für Offline-Systeme.
GET /api/v1/management/germany/ {clientId}/taxonomy	O	Exportiert die Taxonomie (DSFinV-K-Export) und liefert sie als Download-Datei (zip-Dateiformat) zurück. Erforderlich für Offline-Systeme.
GET /api/v1/management/germany/ {clientId}/tse/listTransactions	R	Gibt alle aktive (gestarteten) Transaktionen auf der TSE zurück. Empfohlen, um offene Transaktionen zu verfolgen (alle gestarteten Transaktionen müssen gespeichert oder storniert werden)
DELETE /api/v1/management/germany/ {clientId}/tse/listTransactions	O	Schließt gestartete TSE Transaktionen
GET /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures/count	O	Gibt die Anzahl der Offline-Transaktionen zurück (= Transaktionen, die nicht an die TSE gesendet wurden, weil die TSE offline ist - nicht verfügbar)
GET /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures	O	Gibt alle offenen Offline-Signaturen zurück, die für die aktuelle TSE gespeichert sind.
PUT /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures	O	Verarbeiten von noch offener Offline-Signaturen.
PUT /api/v1/management/germany/ {clientId}/tse/replace	R	Ersetzt eine aktuelle TSE für den angegebenen Client durch eine neue (z. B. wenn die alte TSE beschädigt oder das Zertifikat abgelaufen ist).
POST /api/v1/management/germany/ {clientId}/tse/selftest	R	Führt einen synchronen Selbsttest für die angegebene Registrierkasse an der TSE durch (Registrierkasse ist optional).
POST /api/v1/management/germany/ {clientId}/tse/updateFirmware	R	Aktualisiert die Firmware auf dem swissbit Hardware-TSE-Gerät.

ManagementController_Spain

Kurzbeschreibung: Managementfunktionen für die Spanische Fiskalisierung.

Endpunkt	Typ	Beschreibung
GET /api/v1/management/spain/ {clientId}/ticketBai	R	Gibt die gespeicherten TicketBai-Dateien (gesendete Dateien, Antwortdateien, Fehlerdateien) als Zip-Datei zurück.
GET /api/v1/management/spain/ {clientId}/ticketBai/{documentNumber}	R	Gibt die gespeicherten TicketBai-Dateien für die angeforderte Dokumentennummer (gesendete Dateien, Antwortdateien, Fehlerdateien) als Zip-Datei zurück.

Receipts

Kurzbeschreibung: wird verwendet, um digitale Belege über die Middleware an die RetailForce-Cloud zu senden.

Die Endpunkte in diesem Abschnitt werden verwendet, um digitale Kassenbelege an das Cloud-System zu senden (Lizenzen für digitale Belege erforderlich, um diesen Dienst nutzen zu können).

Endpunkt

Typ

Beschreibung

POST /api/v1/receipts/{clientId}

O/M

Lädt eine digitale Belegdatei in das Cloud-System hoch.

Alternativ: Verwenden Sie entweder diesen oder den alternativen Endpunkt in diesem Abschnitt, um digitale Belegdaten zu senden.

POST /api/v1/receipts/
{clientId}/{documentGuid}

O/M

Lädt eine digitale Belegdatei in das Cloud-System hoch. Verwendet Metadaten der Fiskalisierung.

Alternativ: Verwenden Sie entweder diesen oder den alternativen Endpunkt in diesem Abschnitt, um Daten über digitale Quittungen zu senden

Transactions

Kurzbeschreibung: wird verwendet, um im Rahmen der Fiskalisierung Dokumente an die Middleware zu senden.

Endpunkt	Typ	Beschreibung
PUT /api/v1/transactions/createDocument	M	Erzeugt ein Dokument in der Fiskalisierungseinheit. Mit dieser Methode wird kein Dokument selbst erstellt, sondern nur der Prozess z.B. auf der TSE gestartet.
POST /api/v1/transactions/storeDocument	M	Speichert einen Beleg in der Fiskalisierungseinheit.
POST /api/v1/transactions/cancelDocument	M	Storniert einen Beleg in der Fiskalisierungseinheit.
PUT /api/v1/transactions/reprintDocument/ {clientId}/{documentGuid}	M*	Methode zum Speichern der Anzahl der Nachdrucke eines Dokuments unter Verwendung des gespeicherten Dokuments (Referenz: documentGuid). Alternative: Verwenden Sie alternativ PUT /api/v1/transactions/reprintDocument
PUT /api/v1/transactions/ reprintDocument	M*	Methode zur Speicherung der Anzahl der Nachdrucke eines Dokuments, welches erneut gesendet wurde. Der Benutzer im übertragenen Dokuments muss identisch sein mit dem reprintUser (nicht der Benutzer des Originaldokuments). Alternative: Verwenden Sie alternativ PUT /api/v1/transactions/reprintDocument/ {clientId}/{documentGuid}.
POST /api/v1/transactions/ revertDocument	R	Setzt alle Werte eines Dokuments negativ.
POST /api/v1/transactions/ validateDocument	O	Validiert das Dokument und gibt alle Validierungsfehler zur��ck (oder eine leere Liste, wenn es keinen Validierungsfehler gibt).
POST /api/v1/transactions/ validateDocumentString	O	Sendet einen Dokument JSON String zur Validierung an den Dienst.
GET /api/v1/transactions/document/ {clientId}/start	R	Gibt ein Startdokument für den angegebenen Client zurück. Das Startdokument wird zur Initialisierung des Mandanten und der Fiskaleinheit verwendet (/api/v1/management/clients/initialize)
POST /api/v1/transactions/display/{clientId}	M*	Zeigt einen Text im Kundendisplay an. Wird nur in Ländern unterstützt, in denen Kundendisplays verwendet werden. In anderen Ländern bewirkt dieser Aufruf nichts (kann aber aufgerufen werden).
PUT /api/v1/transactions/printer/ {clientId}/openDrawer	M*	Öffnet die Kassenlade, wenn die Kassenlade an den Fiskaldrucker angeschlossen ist.
GET /api/v1/transactions/getQrCodeBase64	O	Liefert QR-Code-Daten als Base-64-kodierten String aus Daten
POST /api/v1/transactions/auditlog	M*	Fügt dem Fiskal Client einen Audit-Log Eintrag hinzu.
GET /api/v1/transactions/auditlog/{clientId}	M*	Gibt alle Audit-Log Einträge zurück, die durch fromDate/tillDate abgefragt wurden.
GET /api/v1/transactions/document/ {clientId}/{documentGuid}	R	Gibt das angeforderte Dokument zurück, wenn es im internen Speicher abgelegt ist.
HEAD /api/v1/transactions/document/ {clientId}/{documentGuid}	O	Gibt zurück, ob das angeforderte Dokument im internen Dokumentenspeicher vorhanden ist.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}	O	Gibt das angeforderte Dokument zurück, wenn es im internen Speicher abgelegt ist.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}	O	Gibt zurück, ob das angeforderte Dokument in der internen Dokumentenablage vorhanden ist.
GET /api/v1/transactions/document/ {clientId}/last	O	Gibt das zuletzt gespeicherte Dokument aus dem Dokumentenspeicher zurück
GET /api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}	O	Gibt das angeforderte Dokument zurück, wenn es im internen Speicher abgelegt ist.
GET /api/v1/transactions/document/ {clientId}/{documentGuid}/response	R	Gibt die Antwort (fiscalResponse) auf das angeforderte Dokument zurück, wenn es im internen Speicher gespeichert ist.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}/response	O	Gibt die Antwort (fiscalResponse) auf das angeforderte Dokument zurück, wenn es im internen Speicher gespeichert ist.
GET /api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response	O	Gibt das angeforderte Dokument zurück, wenn es im internen Speicher abgelegt ist.

Endpunkt	Typ	Beschreibung
POST /api/v1/archive/de/{clientId}	O	Diese Methode wird verwendet, um verschiedenen Dateien an das Cloud-Archiv zu übertragen.
GET /api/v1/archive/de/{clientId}	O	Dient zum Herunterladen zuvor archivierter Daten (Dateien) aus dem Cloud-Archiv

Archive