FiscalResponse-Objekt "fiscalResponse" – RetailForce Software GmbH

Dieser Artikel behandelt das FiskalResponse-Objekt ("positions") innerhalb des Dokumenten-Objekts
(Document object).

Eine vollständige Beschreibung des RetailForce DOM (Document Object Model), sowie eine Beschreibung der einzelnen Elemente, finden sie im Downloads-Bereich der RetailForce Website (Object model documentation.pdf) im jeweilige Versions-Verzeichnis.

Das Objekt fiscalRsponse wird anschließend an eine erfolgreiche Dokumenten-Übermittlung (createDocument und storeDocument) an das Vorsystem (Registrierkasse, elektronisches Aufzeichnungssystem) als Antwort zurückgegeben.

Das FiscalResponse-Objekt besteht aus:

Standard Informationen - vom jeweiligen (Fiskal-) Land unabhängige Informationen (gleich für jedes Land)
Landesspezifische Informationen - bestimmte Informationen, welche etwa auf einem Beleg im entsprechenden Land anzudrucken sind oder im Journal gespeichert werden müssen. Diese Informationen werden im Array "AdditionalFields" des fiscalResponse zurückgegeben.

fiscalResponse Objekt

Das nachfolgende Objekt enthält Beispieldaten.

{
   "fiscalCountry": "[0] = Germany",
   "fiscalisationDocumentNumber": 52,
   "fiscalDocumentNumber": "52",
   "fiscalDocumentStartTime": 1674819139,
   "processStartTime": 0,
   "errorDescription": null,
   "cashRegisterId": "00345-00345",
   "signature": "pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==",
   "userMessage": null,
   "printMessage": "***Test***",
   "requestTime": "2023-01-27T12:34:21.3088836+01:00",
   "requestCompletionTime": "2023-01-27T12:34:22.4379009+01:00",
   "retailForceReceiptId": "0p4j0001",     /// nur bei createDocument
   "AdditionalFields": {
      "QrCodeDataString": "V0;00345-00345;Kassenbeleg-V1;Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar;52;197;2023-01-27T11:32:19.000Z;2023-01-27T11:34:20.000Z;ecdsa-plain-SHA256;unixTime;pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==;BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TransactionStartTime": 1674819139,
      "TransactionEndTime": 1674819260,
      "ProcessData": "Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar",
      "ProcessType": "Kassenbeleg-V1",
      "TseSerial": "e5f5836a57c50c526d4bed37f18823608f2f44e2c98cab73278a7676c5ea0885",
      "TseTimeFormat": "unixTime",
      "TseHashAlgorithm": "ecdsa-plain-SHA256",
      "TsePublicKey": "BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TseSignatureCounter": 197,
      "TseCertificate": "MIIB0jCCAVmgAwIBAgIhAOX1g2pXxQxSbUvtN/GII2CPL0TiyYyrcyeKdnbF6giFMAoGCCqGSM49BAMDMDExFTATBgNVBAoTDGZpc2thbHkgR21iSDEYMBYGA1UEAxMPZmlza2FseSBUZXN0IENBMB4XDTIyMTAzMDEyMjgzMloXDTIzMTAzMDEyMjgzMlowMjEVMBMGA1UEChMMZmlza2FseSBHbWJIMRkwFwYDVQQDExBmaXNrYWx5IFRlc3QgVFNFMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE0dyQK5cXZ8SS0inyrC2cwsuC+kkNfrAQ6oUQ2Uddml6QEfEeeJCH2BuKCNZL1RsLBlKs5MlMwrtaJXmjAB9eSaNBMD8wDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUlllBymQBup6ldKGojZVpZtWG5tQwCgYIKoZIzj0EAwMDZwAwZAIwEFsoSON9cIBqA5d9vsGI2jSjDlZxHokDvJ4yBmayvigrDbdhMYe3hw3HyQbO2B/FAjBXSVNbYR6Wg2TVzL9BhCla+tewRDGcs6vnetJ4i3VRtya1+ejt+vRjWnb/RUyo0Uw=",
      "fiscalDocumentRevision": 2
   }
}

Das FiscalResponse-Objekt beinhaltet nachfolgende Angaben.

Element		Typ	Beschreibung
fiscalCountry			Indikator für das jeweilige Fiskalland. Enum: [0] = Germany [1] = Austria [2] = France [3] = Bulgaria [4] = Denmark [5] = Sweden [6] = Slovenia [7] = Poland [8] = Serbia [9] = Italy [10] = Croatia [12] = Romania [15] = Lithuania [16] = Hungary [18] = Spain [99999] = NoFiscalisation
fiscalisationDocumentNumber			Fiskal-Dokumentennummer (wird vom jeweiligen Fiskalsystem - z.B. TSE in DE vergeben) - integer-Value Hinweis: Obsolet, wird in zukünftigen Versionen durch die String-Eigenschaft fiscalDocumentNumber ersetzt.
fiscalDocumentNumber			Fiskal-Dokumentennummer (wird vom jeweiligen Fiskalsystem - z.B. TSE in DE vergeben) Länderinformation: Deutschland: die Eigenschaft fiscalDocumentNumber (sowie deren Wert) aus der fiscalResponse nach Aufruf von createDocument, muss in das JSON-Dokument, welches an storeDocument geschickt werden soll, mit aufgenommen werden. Hinweis: Eingeführt mit v.1.7.7. fiscalDocumentNumber ist, im Gegensatz zu fiscalisationDocumentNumber ein "string"-Element
~~fiscalisationDocumentRevision~~			Überarbeitungsnummer des Fiskal-Dokuments. (wird vom jeweiligen Fiskalsystem - z.B. TSE in DE vergeben) Achtung: die Eigenschaft "fiscalisationDocumentRevision" wurde mit Release 1.7.7 aus dem Header des fiscalResponse-Objektes entfernt. Die Eigenschaft wurde in "fiscalDocumentRevision" umbenannt und wird künftig nur mehr als Teil der additionalFields der fiscalRespones-Germany zurückgegeben!
taxPositions			Angabe aller MwSt. Positionen des Dokuments.
	vatIdentification		ID Kennzeichen des MwSt.-Satzes der MwSt. Position
	vatLabel
	vatPercent1		Steuersatz in Prozent dieser MwSt. Position (in diesem Fall MwSt. Position 1)
	vatAmount		MwSt.-Betrag der MwSt. Position
	netAmount		Nettobetrag (exkl. MwSt.) der MwSt. Position
	grossAmount		Bruttobetrag (inkl. MwSt.) der MwSt. Position
fiscalDocumentStartTime			Zeitpunkt der Erstellung des Fiskal-Dokumentes - Unix Time Stamp (wird vom jeweiligen Fiskalsystem - z.B. TSE in DE vergeben)
processStartTime			Erstellungszeitpunkt des ersten Beleges innerhalb des gesamten Prozesses (z.B. Deutschland: Erstellungszeitpunkt der ersten Kundenbestellung im Zusammenhang mit dem vorliegenden Zahlungsbeleg - siehe auch "Besonderheiten Gastronomie")
errorDescription			Fehlerbeschreibung, wenn der Fiskalisierungsprozess fehlgeschlagen ist. Leer, wenn kein Fehler aufgetreten ist.
cashRegisterId			Gibt die Registrierkassennummer zurück unter welcher das Fiskaldokument registriert / verarbeitet wurde
signature			Belegsignatur, erstellt vom jeweiligen Fiskalisierungssystem (z.B. Signaturerstellungseinheit in AT, TSE in DE...)
userMessage			Benachrichtigung, welche dem Benutzer des Kassensystems angezeigt werden muss. Achtung: in manchen Ländern, muss eine eventuelle User-Message dem Kassenbediener angezeigt werden. Wir empfehlen diese Vorgehensweise für jedes Fiskalland umzusetzen.
printMessage			Muss am Dokument (z.B. "Kassenbeleg") angedruckt werden, andernfalls besteht Gefahr, dass die Implementierung nicht den gesetzlichen Anforderungen im jeweiligen Land entspricht. Beachten Sie auch "printMessage". Achtung: in manchen Ländern, müssen Hinweise , welche über das printMessage-Element zurückgegeben werden, verpflichtend am Beleg angedruckt werden. Wir empfehlen diese Vorgehensweise für jedes Fiskalland umzusetzen.
requestTime			gibt den Anfragezeitpunkt zurück
requestCompletionTime			gibt den Zeitpunkt zurück, an dem die Anfrage vom Fiskalsystem fertiggestellt wurde
retailForceReceiptId			Vom RetailForce System vergebene, global eindeutige Dokumenten-ID. Wir nur in der fiscalResponse beim Aufruf von PUT /api/v1/transactions/createDocument zurückgegeben. Hinweis: damit die RetailForceReceiptId erzeugt wird, muss dies für den jeweiligen Client, einmalig, durch Aufruf der Funktion POST /api/v1/management/clients/ {clientId}/globalShortId aktiviert werden. Weitere Informationen finden Sie im Artikel "Globale Kassen-ID und globale Dokumenten-ID".
additionalFields			Landesspezifische Informationen
	{...}		fiscalResponseAustria - Österreich fiscalResponseBulgaria - Bulgarien fiscalResponseCroatia - Kroatien fiscalResponseDenmark - Dänemark fiscalResponseFrance - Frankreich fiscalResponseGermany - Deutschland fiscalResponseHungary - Ungarn fiscalResponseItaly - Italien fiscalResponseLithuania - Litauen fiscalResponsePoland - Polen fiscalResponseRomania - Rumänien fiscalResponseSerbia - Serbien fiscalResponseSlovenia - Slowenien fiscalResponseSpain - Spanien fiscalResponseSweden - Schweden

fiscalResponse Objekt

Verwandte Beiträge