Objet FiscalResponse « fiscalResponse » – RetailForce

Cet article décrit l’objet fiscalResponse (« positions ») au sein de l’objet Document (
objet Document).

Une description complète du RetailForce DOM (Document Object Model), ainsi qu’une description des différents éléments, est disponible dans la section « Téléchargements » du RetailForce website (Documentation sur le modèle d’objet.pdf) dans le répertoire correspondant à la version concernée.

L’objet FiscalResponse est renvoyé au système en amont (caisse enregistreuse, système d’enregistrement électronique) en réponse à une transmission de document réussie (createDocument et storeDocument).

L’objet FiscalResponse se compose :

Des informations standard : informations indépendantes du pays (fiscal) concerné (identiques pour chaque pays)
Informations spécifiques au pays : données qui doivent être imprimées sur un ticket de caisse dans le pays concerné ou enregistrées dans le journal. Ces informations sont renvoyées dans le tableau « AdditionalFields » de l’objet fiscalResponse.

Objet fiscalResponse

L’objet suivant contient des exemples de données.

{
   "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",    /// only for 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
   }
}

L’objet fiscalResponse contient les informations suivantes.

Informations dans la colonne « Type » :

M … obligatoire / requis
M* … obligatoire / requis dans certains pays ou sous certaines conditions
R ... recommandé
O... facultatif

Éléments		Type	Description
fiscalCountry			Indicateur du pays fiscal correspondant. Enum : [0] = Allemagne [1] = Autriche [2] = France [3] = Bulgarie [4] = Danemark [5] = Suède [6] = Slovénie [7] = Pologne [8] = Serbie [9] = Italie [10] = Croatie [12] = Roumanie [15] = Lituanie [16] = Hongrie [18] = Espagne [99999] = Pas de fiscalisation
fiscalisationDocumentNumber			Numéro du document fiscal (attribué par le système fiscal concerné – par exemple, TSE en Allemagne). Valeur entière Remarque : obsolète, sera remplacé par la propriété de type string « fiscalDocumentNumber » dans les prochaines versions.
fiscalDocumentNumber			Numéro de document fiscal (attribué par le système fiscal concerné – par exemple, TSE en Allemagne). Informations par pays : Allemagne : la propriété fiscalDocumentNumber (et sa valeur) de la fiscalResponse obtenue après l’appel de la méthode createDocument doit être incluse dans le document JSON destiné à être envoyé à la méthode storeDocument . Remarque : Introduit avec la version 1.7.7. Contrairement à « fiscalisationDocumentNumber », « fiscalDocumentNumber » est un élément de type « string ».
~~fiscalisationDocumentRevision~~			Numéro de révision du document fiscal. (Attribué par le système fiscal concerné – TSE en Allemagne). Attention : la propriété « fiscalisationDocumentRevision » a été supprimée de l’en-tête de l’objet fiscalResponse à partir de la release 1.7.7. Elle a été renommée « fiscalDocumentRevision » et n’est désormais renvoyée que dans les AdditionalFields de la fiscalResponse-Allemagne .
TaxPositions			Indication de toutes les positions de TVA du document.
	VatIdentification		ID indiquant le taux de TVA de la ligne de TVA. Ligne
	VatLabel
	VatPercent1		Taux d'imposition en pourcentage de cette ligne de Vat. Ligne (dans ce cas, la ligne de Vat n° 1)
	VatAmount		Montant de la TVA de la ligne de TVA
	NetAmount		Montant net (hors Vat) de la ligne de Vat
	GrossAmount		Montant brut (TVA comprise) de la ligne de TVA
fiscalDocumentStartTime			Heure de création du document fiscal – horodatage Unix (attribué par le système fiscal concerné – par exemple, TSE en Allemagne).
processStartTime			Heure de création du premier document au sein de l’ensemble du processus (par exemple, en Allemagne : heure de création de la première commande client liée au présent document de paiement – voir également « caractéristiques de la restauration »).
ErrorDescription			Description de l’erreur si le processus de fiscalisation a échoué. Champ vide si aucune erreur ne s’est produite.
cashRegisterId			Renvoie le numéro de caisse sous lequel le document fiscal a été enregistré/traité.
signature			Signature du document, générée par le système de fiscalisation correspondant (par exemple, dispositif de création de signature en Autriche, TSE en Allemagne…)
UserMessage			Notification devant être affichée à l’utilisateur du système de point de vente. Attention : dans certains pays, un message utilisateur éventuel doit être affiché à l’intention du caissier. Nous vous recommandons de mettre en œuvre cette procédure pour chaque pays soumis à la fiscalisation.
PrintMessage			Doit être imprimé sur le document (par exemple « ticket de caisse »), faute de quoi la mise en œuvre risque de ne pas être conforme aux exigences légales du pays concerné. Veuillez également tenir compte de « PrintMessage ». Attention : dans certains pays, les informations renvoyées via l’élément PrintMessage doivent être imprimées sur le ticket de caisse. Nous vous recommandons de mettre en œuvre cette procédure pour chaque pays fiscal.
requestTime			Renvoie l’heure de la demande
requestCompletionTime			Renvoie l’heure à laquelle la demande a été traitée par le système fiscal
retailForceReceiptId			Identifiant de document unique à l’échelle mondiale attribué par le système RetailForce. Il n’est renvoyé dans la réponse « fiscalResponse » que lors de l’appel de la méthode PUT /api/v1/transactions/createDocument. Remarque : pour que le retailForceReceiptId soit généré, il doit être activé une fois pour le client concerné en appelant la fonction POST /api/v1/management/clients/{clientId}/GlobalShortId . Pour de plus amples informations, veuillez consulter l’article « ID global de caisse et ID global de document ».
AdditionalFields			Informations spécifiques au pays
	{...}		fiscalResponseAustria fiscalResponseBulgaria fiscalResponseCanada fiscalResponseCroatie fiscalResponseDanemark Réponse budgétaire de la France Réponse budgétaire en Allemagne fiscalResponseGrèce Réponse budgétaire de la Hongrie Réponse budgétaire de l'Italie réponse budgétaire en Lituanie Réponse budgétaire de la Pologne mesures_budgétaires_Roumanie Réponse budgétaire de la Serbie Réponse budgétaire en Slovaquie Réponse budgétaire en Slovénie mesures_budgétaires_Espagne fiscalResponseSuède

Cet article a été traduit automatiquement.

Objet fiscalResponse

Articles associés