POST /api/v1/transactions/cancelDocument

Za pomocą metody

• POST /api/v1/transactions/cancelDocument

przesyłane jest do serwisu fiskalnego i tam zapisywane anulowanie transakcji. Służy to do przerwania transakcji przed jej zakończeniem. Na przykład:

• klient pragnie dokonać zakupu kilku produktów w sklepie
• kasjer rozpoczyna skanowanie produktów (system POS wysyła żądanie PUT /api/v1/transactions/createDocument)
• klient zauważa, że zgubił portfel i nie może dokonać zakupu
• kasjer przerywa transakcję i usuwa wszystkie zeskanowane produkty (system POS wysyła żądanie POST /api/v1/transactions/cancelDocument w celu zamknięcia transakcji, która została otwarta przy użyciu żądania PUT /api/v1/transactions/createDocument)

Wynik

Jeśli przetwarzanie zakończy się powodzeniem (200), odpowiedni klient serwisu fiskalnego odpowiada komunikatem fiscalResponse i rejestruje przerwanie transakcji.

Sposób użycia

• Za każdym razem, gdy dokument jest zamykany w systemie ewidencji elektronicznej (kasie) poprzez jego anulowanie.

Wymagania wstępne

• Wywołanie funkcji `cancelDocument` musi być poprzedzone wywołaniem punktu końcowego PUT /api/v1/transactions/createDocument
  • Dane z odpowiedzi funkcji createDocument muszą zostać włączone do struktury JSON funkcji cancelDocument. Proszę zapoznać się z poniższą sekcją.

Proces przesyłania

Jak opisano powyżej, wywołanie metody `cancelDocument` wymaga uprzedniego wywołania metody `createDocument`. Odpowiedź `fiscalResponse` zwracana przez metodę `createDocument` zawiera następujące pola:

"fiscalisationDocumentNumber": 0,
"fiscalisationDocumentRevision": 0,
"fiscalDocumentStartTime": 0,

Informacje zawarte w tych polach muszą znajdować się w strukturze JSON przesyłanej wraz z metodą `cancelDocument`. Pola te zawierają wartości generowane przez wymagane urządzenie fiskalne (techniczne urządzenie zabezpieczające „TSE” w Niemczech) i służą do łączenia transakcji.

"fiscalDocumentNumber": 24,
"fiscalDocumentRevision": 1,

Przykład:

Poniższy przykład przedstawia prosty paragon dla Niemiec (documentType = [0] = paragon), który jest wysyłany do punktu końcowego POST /api/v1/transactions/cancelDocument.

{
   "uniqueClientId": "c1062c55-57c4-4ed2-9c53-aff1762326a4",
   "documentGuid": "7d4a7761-e9e9-4759-8591-ed147a581da4",
   "documentId": "HAM01-00010329",
   "documentNumber": "00010329",
   "createDate": "2023-04-18T21:34:45",
   "bookDate": "2023-04-18T21:34:46",
   "cancellationDocument": false,
   "isTraining": false,
   "documentType": 0,
   "user": {
      "id": "1234",
      "caption": "1234"
   },
   "fiscalDocumentNumber": 2853,
   "fiscalDocumentStartTime": 1681803100,
   "fiscalDocumentRevision": 1,
   "Positions": [
      {
         "positionNumber": 0,
         "netValue": 10.66,
         "grossvalue": 12.90,
         "taxValue": 2.24,
         "quantity": 1,
         "itemId": "1101202930050",
         "itemCaption": "Pizza Margherita",
         "cancellationPosition": "false",
         "type": "0",
         "businessTransactionType": 0,
         "vatPercent": 19,
         "vatIdentification": 1,
      }
   ],
   "Payments": [
      {
         "Amount": 12.90,
         "paymentType": "cash",
         "uniqueReadablePaymentIdentifier": "Cash",
         "caption": "Bar+Euro",
         "currencyIsoCode": "EUR"
      }
   ]
}

Przykład minimalnych informacji w żądaniu `cancelDocument`:

{
   "uniqueClientId": "c1062c55-57c4-4ed2-9c53-aff1762326a4",
   "documentGuid": "{bdf8b5e9-5634-4c02-afad-543a7c480111}",
   "documentId": "100001",
   "documentNumber": "00002",
   "createDate": "2022-12-22T10:06:03",
   "bookDate": "2022-12-22T10:06:03",
   "user": {
      "id": "1234",
      "caption": "1234"
   },
   "fiscalDocumentNumber": 2938,
   "fiscalDocumentStartTime": "1671699962",
   "fiscalDocumentRevision": 1
   }
}

fiscalResponse

Odpowiedź fiscalResponse dla operacji cancelDocument powinna zostać zapisana w bazie danych POS w celach referencyjnych.

FiscalResponse zawiera:

• informacje ogólne
• informacje specyficzne dla danego kraju

Przykładowa odpowiedź fiscalResponse:

{
   "fiscalCountry": "[0] = Germany",
   "fiscalisationDocumentNumber": 52,
   "fiscalisationDocumentRevision": 2,
   "fiscalDocumentStartTime": 1674819139,
   "processStartTime": 0,
   "errorDescription": null,
   "cashRegisterId": "00345-00345",
   "signature": "pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==",
   "userMessage": null,
   "printMessage": "***Test***",
   "requestTime": "2023-01-27T12:34:21.3088836+01:00",
   "requestCompletionTime": "2023-01-27T12:34:22.4379009+01:00",
   "AdditionalFields": {
      "QrCodeDataString": "V0;00345-00345;Kassenbeleg-V1;Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar;52;197;2023-01-27T11:32:19.000Z;2023-01-27T11:34:20.000Z;ecdsa-plain-SHA256;unixTime;pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==;BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TransactionStartTime": 1674819139,
      "TransactionEndTime": 1674819260,
      "ProcessData": "Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar",
      "ProcessType": "Kassenbeleg-V1",
      "TseSerial": "e5f5836a57c50c526d4bed37f18823608f2f44e2c98cab73278a7676c5ea0885",
      "TseTimeFormat": "unixTime",
      "TseHashAlgorithm": "ecdsa-plain-SHA256",
      "TsePublicKey": "BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TseSignatureCounter": 197,
      "TseCertificate": "MIIB0jCCAVmgAwIBAgIhAOX1g2pXxQxSbUvtN/GII2CPL0TiyYyrcyeKdnbF6giFMAoGCCqGSM49BAMDMDExFTATBgNVBAoTDGZpc2thbHkgR21iSDEYMBYGA1UEAxMPZmlza2FseSBUZXN0IENBMB4XDTIyMTAzMDEyMjgzMloXDTIzMTAzMDEyMjgzMlowMjEVMBMGA1UEChMMZmlza2FseSBHbWJIMRkwFwYDVQQDExBmaXNrYWx5IFRlc3QgVFNFMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE0dyQK5cXZ8SS0inyrC2cwsuC+kkNfrAQ6oUQ2Uddml6QEfEeeJCH2BuKCNZL1RsLBlKs5MlMwrtaJXmjAB9eSaNBMD8wDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUlllBymQBup6ldKGojZVpZtWG5tQwCgYIKoZIzj0EAwMDZwAwZAIwEFsoSON9cIBqA5d9vsGI2jSjDlZxHokDvJ4yBmayvigrDbdhMYe3hw3HyQbO2B/FAjBXSVNbYR6Wg2TVzL9BhCla+tewRDGcs6vnetJ4i3VRtya1+ejt+vRjWnb/RUyo0Uw="
   }
}

Informacje ogólne

Znajdują się one w obszarze header fiskalResponse.

Uwaga:

• Treść pola „fiscalisationDocumentNumber” musi zostać wydrukowana na dokumencie (DE).
• Treść pola „PrintMessage” musi zostać wydrukowana na paragonie.

Informacje specyficzne dla danego kraju

Informacje specyficzne dla danego kraju znajdują się w obszarze „AdditionalFields” i zawierają dane, które muszą zostać wydrukowane na paragonie (np. kod QR lub, alternatywnie, dane TSE w Niemczech).

Prosimy zapoznać się z przykładowymi dokumentami dla danego kraju.

"fiscalDocumentNumber": -1,

Odpowiedź

Możliwe odpowiedzi:

Ten artykuł został przetłumaczony automatycznie.