POST /api/v1/transactions/AuditLog – RetailForce

A POST /api/v1/transactions/AuditLog végpont lehetővé teszi egy eseménybejegyzés hozzáadását az adott adóügyi clienthez, ami fontos a tranzakciók és a rendszeren belüli folyamatok nyomon követhetősége szempontjából, és egyes országokban jogilag is előírva van.

Figyelem: Az eseményeket a megfelelő időpontban és sorrendben kell elküldeni. A dokumentumokhoz hasonlóan az eseményeket (auditokat) sem szabad kötegben (csomagban) elküldeni!

Eredmény

A végpont sikeres meghívása (200)

egy auditnapló-bejegyzést ad hozzá a technikai eseménynaplóba.

Használat

Ezt a végpontot a pénztárgép-rendszer által kötelezően rögzítendő események naplózására használják.

Eseménykód-leképezés

A RetailForce eseménykódok és az egyes országok eseménykódjai közötti leképezéssel kapcsolatos információk a „Műszaki eseménynapló / Eseménynapló” áttekintésben találhatók.

Követelmények

A pénzügyi clientnek inicializálva és működőképes állapotban kell lennie.

Adatátviteli folyamat

A kérést JSON-objektumként kell elküldeni:

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

Űrlapmezők

A „Type” oszlopban szereplő információk:

M ... kötelező / előírt
M* ... kötelező / bizonyos országokban vagy bizonyos feltételek mellett kötelező
R ... ajánlott
O... opcionális

Elem		Típus	Leírás
RecordId			a bejegyzés egyedi azonosítója.
uniqueClientId		M	A pénztárgép (a RetailForce systemből származó) uniqueClientId-je, amelyhez az ellenőrzési naplóbejegyzés tartozik.
LogEntryType			Az ellenőrzési naplóbejegyzés típusa.
message			Az ellenőrzési bejegyzés üzenete.
DocumentGuid			Az auditnapló-bejegyzéshez tartozó dokumentumhoz való lehetséges kapcsolat
felhasználó			Az auditnapló-bejegyzés felhasználója (ha van ilyen).
	{...}
összeg			A dokumentum teljes összege
azonosító			Az ellenőrzési naplóbejegyzés lehetséges azonosítója.
rögzítés dátuma és időpontja		M	az auditnapló-bejegyzés rögzítési dátuma és ideje.
aláírás

Példa:

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

Válasz

Lehetséges válaszok:

Kód	Leírás
200	OK
202	A rekord duplikátum volt
422	Az AuditLog paraméter értéke null, vagy a bejegyzés aláírása be van állítva.

Ezt a cikket automatikusan lefordították.