POST /api/v1/transactions/AuditLog – RetailForce

Punkt końcowy POST /api/v1/transactions/AuditLog umożliwia dodanie wpisu zdarzenia dla danego klienta fiskalnego, co ma istotne znaczenie dla identyfikowalności transakcji i procesów wewnętrznych systemu, a w niektórych krajach jest wymagane przepisami prawa.

Uwaga: Zdarzenia muszą być wysyłane we właściwym czasie i we właściwej kolejności. Podobnie jak w przypadku dokumentów, zdarzenia (audyty) nie mogą być wysyłane zbiorczo (w pakiecie)!

Wynik

Pomyślne wywołanie punktu końcowego (200)

powoduje dodanie wpisu do dziennika audytowego w technicznym dzienniku zdarzeń.

Zastosowanie

Ten punkt końcowy służy do rejestrowania zdarzeń, które system kasowy ma obowiązek rejestrować.

Mapowanie kodów zdarzeń

Informacje dotyczące mapowania kodów zdarzeń RetailForce na kody zdarzeń obowiązujące w poszczególnych krajach można znaleźć w przeglądzie „Dziennik zdarzeń technicznych / Dziennik zdarzeń”.

Wymagania

Fiskalny client musi być zainicjowany i gotowy do pracy.

Proces transmisji

Żądanie należy przesłać jako obiekt 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"
}

Pola formularza

Informacje w kolumnie „Typ”:

M ... obowiązkowe / wymagane
M* ... obowiązkowe / wymagane w niektórych krajach lub pod pewnymi warunkami
R … zalecane
O... opcjonalne

Element		Typ	Opis
RecordId			unikalny identyfikator wpisu.
uniqueClientId		M	Identyfikator uniqueClientId kasy fiskalnej (z RetailForce systemu), do której odnosi się wpis w dzienniku audytowym.
LogEntryType			Typ wpisu w dzienniku audytowym.
message			Komunikat wpisu w dzienniku audytowym.
DocumentGuid			Ewentualne powiązanie z dokumentem, do którego odnosi się wpis w dzienniku audytowym
user			Użytkownik (jeśli dotyczy) wpisu w dzienniku audytowym.
	{...}
kwota			Łączna kwota dokumentu
identyfikator			Ewentualny identyfikator wpisu w dzienniku audytowym.
recordDateTime		M	data i godzina utworzenia wpisu w dzienniku audytowym.
podpis

Przykład:

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

Odpowiedź

Możliwe odpowiedzi:

Kod	Opis
200	OK
202	Rekord był duplikatem
422	Parametr AuditLog ma wartość null lub ustawiono sygnaturę wpisu.

Ten artykuł został przetłumaczony automatycznie.