POST /api/v1/transactions/auditlog – RetailForce Software GmbH

Der POST /api/v1/transactions/auditlog Endpunkt ermöglicht das Hinzufügen eines Ereignis-Eintrages (Event-Eintrag) für den jeweiligen Fiskal-Client, wichtig für die Nachverfolgbarkeit von Transaktionen und systeminternen Vorgängen und ist in einigen Ländern gesetzlich vorgeschrieben.

Achtung: Ereignisse müssen zeitlich richtig, in der korrekten Reihenfolge geschickt werden. Ebenso wie bei Dokumenten, dürfen Ereignisse (audits) nicht als Batch (Paket) geschickt werden!

Ergebnis

Ein erfolgreicher Aufruf des Endpunktes (200)

fügt einen Audit-Log-Eintrag im Technischen Ereignis Journal hinzu.

Verwendung

Dieser Endpunkt wird genutzt, um aufzeichnungspflichtige Ereignisse zu protokollieren.

EventCode Mapping

Informationen hinsichtlich der Zuordnung der RetailForce EventCodes zu den Ereigniss-Codes in bestimmten Ländern, finden Sie in der Übersicht zum "Technischen Ereignisprotokoll / Event Log".

Voraussetzungen

Fiskal-Client muss initialisiert und betriebsbereit sein.

Übertragungsprozess

Der Eintrag wird als JSON-Objekt gesendet:

{
  "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"
}

Formularfelder

Informationen in der Spalte "Typ":

M ... erforderlich ("mandatory)
M* ... erforderlich in bestimmten Ländern, oder unter bestimmten Voraussetzungen
R ... empfohlen ("recommended")
O ... optional

Element		Typ	Beschreibung
recordId			einzigartige Kennung des Eintrags.
uniqueClientId		M	Die uniqueClientId der Registrierkasse (aus RetailForce System)
logEntryType			Art des Audit-Protokolleintrags
message			Nachricht des Audit-Eintrags.
documentGuid			mögliche Verknüpfung zu einem Dokument.
user			Angaben zum Registrierkassenbenutzer.
	{...}
amount			Gesamtbetrag der Rechnung.
identifier			möglicher Kennzeichnung für den Auditeintrag.
recordDateTime		M	Datum und Uhrzeit des Eintrags.
signature

Beispiel:

//Speichern der Transaktion
{
"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",
}
//Schliesung der Kassenschublade
{
  "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", 
  },
}

Antwort

Mögliche Antworten:

Code	Beschreibung
200	OK
202	Record was a duplicate
422	AuditLog parameter is null or signature of entry was set.