POST /api/v1/transactions/AuditLog – RetailForce

L’endpoint POST /api/v1/transactions/AuditLog consente l’aggiunta di una voce di evento per il rispettivo client fiscale; ciò è importante ai fini della tracciabilità delle transazioni e dei processi interni al sistema ed è obbligatorio per legge in alcuni paesi.

Attenzione: gli eventi devono essere inviati al momento corretto e nell’ordine corretto. Come per i documenti, gli eventi (audit) non devono essere inviati in batch (pacchetto)!

Risultato

Una chiamata riuscita all’endpoint (200)

aggiunge una voce di registro di audit nel giornale degli eventi tecnici.

Utilizzo

Questo endpoint viene utilizzato per registrare gli eventi che il sistema di cassa è tenuto a registrare.

Mappatura dei codici evento

Le informazioni relative alla mappatura dei codici evento di RetailForce ai codici evento in paesi specifici sono disponibili nella panoramica “Registro tecnico degli eventi / Registro degli eventi”.

Requisiti

Il client fiscale deve essere inizializzato e operativo.

Processo di trasmissione

La richiesta deve essere inviata come oggetto 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"
}

Campi del modulo

Informazioni nella colonna «Tipo»:

M ... obbligatorio / richiesto
M* ... obbligatorio / richiesto in determinati paesi o a determinate condizioni
R ... consigliato
O... facoltativo

Elemento		Tipo	Descrizione
RecordId			identificatore univoco della voce.
uniqueClientId		M	L'uniqueClientId del registratore di cassa (dal RetailForce system) a cui appartiene la voce del registro di audit.
LogEntryType			Il tipo della voce del registro di audit.
message			Messaggio associato alla voce di audit.
DocumentGuid			Un possibile riferimento a un documento associato alla voce del registro di audit
utente			L’utente (se applicabile) della voce del registro di audit.
	{...}
importo			Importo totale del documento
identificatore			Un possibile identificatore della voce del registro di audit.
dataOraRegistrazione		M	La data e l'ora di registrazione della voce del registro di audit.
firma

Esempio:

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

Risposta

Risposte possibili:

Codice	Descrizione
200	OK
202	Il record era un duplicato
422	Il parametro AuditLog è nullo oppure è stata impostata la firma della voce.

Questo articolo è stato tradotto automaticamente.