POST /api/v1/transactions/auditlog – RetailForce

Koncový bod POST /api/v1/transactions/auditlog umožňuje přidání záznamu události pro příslušného daňového klienta, což je důležité pro sledovatelnost transakcí a interních procesů systému a v některých zemích je to vyžadováno zákonem.

Upozornění: Události musí být odeslány ve správný čas a ve správném pořadí. Stejně jako u dokumentů nesmí být události (audity) odesílány hromadně (jako balíček)!

Výsledek

Úspěšné volání koncového bodu (200)

přidá záznam do auditního protokolu do technického deníku událostí.

Použití

Tento koncový bod se používá k zaznamenávání událostí, které je pokladní systém povinen zaznamenávat.

Mapování kódů událostí

Informace o přiřazení kódů událostí RetailForce ke kódům událostí v konkrétních zemích naleznete v přehledu „Technický protokol událostí / Protokol událostí“.

Požadavky

Fiskální klient musí být inicializován a funkční.

Proces přenosu

Žádost musí být odeslána jako objekt 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"
}

Pole formuláře

Informace ve sloupci „Typ“:

M ... povinné / vyžadované
M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
R ... doporučeno
O... volitelné

Prvek		Typ	Popis
RecordId			jedinečný identifikátor záznamu.
uniqueClientId		M	ID uniqueClientId pokladny (ze systému RetailForce), ke které záznam v auditovém protokolu patří.
logEntryType			Typ záznamu v auditním protokolu.
message			Zpráva záznamu v auditovém protokolu.
documentGuid			Možná souvislost se dokumentem záznamu v auditovém protokolu
user			Uživatel (pokud existuje) záznamu v auditovém protokolu.
	{...}
amount			Celková částka dokladu
identifikátor			Možný identifikátor záznamu v auditním protokolu.
recordDateTime		M	čas a datum záznamu položky v auditním protokolu.
signature

Příklad:

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

Odpověď

Možné odpovědi:

Kód	Popis
200	OK
202	Záznam byl duplicitní
422	Parametr AuditLog je nulový nebo byl nastaven podpis záznamu.

Tento článek byl přeložen automaticky.