POST /api/v1/transactions/AuditLog – RetailForce

Le point de terminaison POST /api/v1/transactions/AuditLog permet d’ajouter une entrée d’événement pour le client fiscal concerné, ce qui est important pour la traçabilité des transactions et des processus internes au système, et est légalement obligatoire dans certains pays.

Attention : les événements doivent être envoyés au moment opportun et dans le bon ordre. Tout comme pour les documents, les événements (audits) ne doivent pas être envoyés en lot (paquet) !

Résultat

Un appel réussi du point de terminaison (200)

ajoute une entrée de journal d’audit dans le journal des événements techniques.

Utilisation

Ce point de terminaison sert à consigner les événements que le système de caisse est tenu d’enregistrer.

Mappage des codes d’événement

Vous trouverez des informations concernant le mappage des codes d’événement RetailForce vers les codes d’événement de pays spécifiques dans la vue d’ensemble « Journal des événements techniques / Journal des événements ».

Conditions préalables

Le client fiscal doit être initialisé et opérationnel.

Processus de transmission

La requête doit être envoyée sous forme d’objet JSON :

{
  "recordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uniqueClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "logEntryType": "100",
  "message": "string",
  "documentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": {
    "id": "string",
    "caption": "string",
    "firstName": "string",
    "lastName": "string",
    "taxNumber": "string",
    "dateOfEntry": "2022-01-01T00:00:00+01:00"
  },
  "amount": 0,
  "identifier": "string",
  "recordDateTime": "2023-12-07T10:14:19.859+01:00",
  "signature": "string"
}

Champs du formulaire

Informations dans la colonne « Type » :

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

Élément		Type	Description
RecordId			identifiant unique de l'entrée.
uniqueClientId		M	L’identifiant unique client (uniqueClientId) de la caisse (issu du RetailForce system) à laquelle appartient l’entrée du journal d’audit.
LogEntryType			Le type d'entrée du journal d'audit.
message			Message de l'entrée du journal d'audit.
DocumentGuid			Identifiant unique du document éventuellement associé à l’entrée du journal d’audit
utilisateur			L'utilisateur (le cas échéant) de l'entrée du journal d'audit.
	{...}
montant			Montant total du document
identifiant			Identifiant éventuel de l'entrée du journal d'audit.
dateHeure		M	Date et heure d'enregistrement de l'entrée du journal d'audit.
signature

Exemple :

// Saving the transaction
{
  "recordId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "uniqueClientId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "LogEntryType": 100,
  "Message": "DocumentTypeSales",
  "documentGuid": "215c2395-ab4a-4132-858d-86459a9e883a",
  "user": {
    "id": "1234",
    "caption": "Max Thomas"
  },
  "amount": 12.5,
  "identifier": "0000001",
  "recordDateTime": "2023-12-07T10:15:45+01:00"
}
// Closing the cash drawer
{
  "recordDateTime": "2023-12-07T10:15:46+01:00",
  "UniqueClientId": "58b55595-2796-4d65-b90f-4b2e1549db44",
  "LogEntryType": 201,
  "Message": "DrawerClose",
  "DocumentGuid": null,
  "user": {
    "id": "1234",
    "caption": "Max Thomas"
  }
}

Réponse

Réponses possibles :

Code	Description
200	OK
202	L'enregistrement était un doublon
422	Le paramètre AuditLog est nul ou la signature de l'entrée a été définie.

Cet article a été traduit automatiquement.