FiscalResponse-object "fiscalResponse" – RetailForce Software GmbH

This Article describes the FiscalResponse object ("positions") within the Document object.
(Document object).

A complete description of the RetailForce DOM (Document Object Model), as well as a description of the individual elements, can be found in the downloads area of the RetailForce website (Object model documentation.pdf) in the respective version directory.

The fiscalRsponse object is returned to the upstream system (cash register, electronic recording system) as a response to a successful document transmission (createDocument and storeDocument).

The FiscalResponse object consists of:

Standard information - information independent of the respective (fiscal) country (the same for each country)
Country-specific information - certain information that must be printed on a receipt in the corresponding country or stored in the journal. This information is returned in the array "AdditionalFields" of the fiscalResponse.

fiscalResponse object

The following object contains sample data.

{
   "fiscalCountry": "[0] = Germany",
   "fiscalisationDocumentNumber": 52,
   "fiscalisationDocumentRevision": 2,
   "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",
   "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="
   }
}

The FiscalResponse object contains the following information.

Information in "Type" column:

M ... mandatory / requird
M* ... mandatory / requird in certain countries or under certain conditions
R ... recommended
O... optional

Elements		Type	Description
fiscalCountry			Indicator for the respective fiscal country. 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 [18] = Spain [99999] = NoFiscalisation
fiscalisationDocumentNumber			Fiscal document number (is assigned by the respective fiscal system - e.g. TSE in DE).
fiscalisationDocumentRevision			Revision number of the fiscal document. (is assigned by the respective fiscal system - e.g. TSE in DE).
taxPositions			Indication of all VAT. positions of the document.
	vatIdentification		ID Indicator of the VAT rate of the VAT item. Item
	vatLabel
	vatPercent1		Tax rate in percent of this VAT position. Position (in this case VAT position 1)
	vatAmount		VAT amount of the VAT Position
	netAmount		Net amount (excl. VAT) of the VAT. Position
	grossAmount		Gross amount (incl. VAT) of the VAT. Position
fiscalDocumentStartTime			Time of creation of the fiscal document (is assigned by the respective fiscal system - e.g. TSE in DE).
processStartTime			Creation time of the first document within the entire process (e.g. Germany: Creation time of the first customer order in connection with the present payment document - see also "characeristics gastronomy").
errorDescription			Error description if the fiscalisation process failed. Empty if no error has occurred.
cashRegisterId			Returns the cash register number under which the fiscal document was registered / processed.
signature			Document signature, created by the respective fiscalisation system (e.g. signature creation device in AT, TSE in DE...)
userMessage			Notification which must be displayed to the user of the POS system.
printMessage			Must be printed on the document (e.g. "cash voucher"), otherwise there is a risk that the implementation will not comply with the legal requirements in the respective country. Also note "printMessage".
requestTime			Returns the request time
requestCompletionTime			Returns the time when the request was completed by the fiscal system
additionalFields			Country-specific information
	{...}		fiscalResponseAustria fiscalResponseBulgaria fiscalResponseCroatia fiscalResponseDenmark fiscalResponseFrance fiscalResponseGermany fiscalResponseItaly fiscalResponseLithuania fiscalResponsePoland fiscalResponseRomania fiscalResponseSerbia fiscalResponseSlovenia fiscalResponseSpain fiscalResponseSweden

fiscalResponse object

Related articles