Niniejszy artykuł zawiera przegląd funkcji api usługi RetailForce Fiscal Service (stan na release 1.6.3). Wymagane parametry każdego punktu końcowego można sprawdzić za pośrednictwem serwisu swagger (np. http://localhost:7678/swagger/index.html) po zainstalowaniu oprogramowania pośredniczącego Fiscal Middleware.
Interfejs api jest podzielony na różne obszary, które służą do różnych celów i są przeznaczone dla różnych produktów.
Informacje w kolumnie „Typ”:
- O … opcjonalne
- M … obowiązkowe / wymagane
- M* ... obowiązkowe / wymagane w niektórych krajach lub pod pewnymi warunkami
- R ... zalecane
Nagłówki odnoszą się do odpowiednich sekcji w swaggerze. W przypadku niektórych punktów końcowych dostępne są linki do dodatkowych informacji.
Archiwizacja
Krótki opis: Funkcja archiwizacji danych, które zostały już poddane fiskalizacji.
Punkty końcowe w tej sekcji służą do przesyłania danych do archiwum RetailForce.
| Punkt końcowy | Typ | Opis |
| POST /api/v1/archive/de/{clientId} | O | Metoda ta służy do przesyłania kilku plików do archiwum w Cloud. |
| GET /api/v1/archive/de/{clientId} | O | Służy do pobierania wcześniej zarchiwizowanych danych (plików) z archiwum w Cloud. |
Kopia zapasowa
Krótki opis: Funkcja archiwizacji dowolnych danych z punktów sprzedaży
Punkty końcowe w tej sekcji służą do przesyłania dowolnych danych do archiwum w Cloud – w ramach usługi/produktu: „Archiwum POS”. Do korzystania z tej usługi wymagana jest licencja na tworzenie kopii zapasowych.
| Punkt końcowy | Typ | Opis |
| POST /api/v1/backup/{clientId} | O | Ta metoda służy do tworzenia kopii zapasowej określonego folderu w archiwum w Cloud. |
| POST /api/v1/backup/{clientId}/restore | O | Przywraca wcześniej zarchiwizowany (kopię zapasową) plik do określonej lokalizacji. |
| GET /api/v1/backup/{clientId}/restore | O | Zwraca adres URL do pobrania, który można wykorzystać do pobrania żądanego pliku kopii zapasowej z archiwum w Cloud. |
Zamknięcie
Krótki opis: Funkcje związane z zamknięciem kasy fiskalnej.
W tej sekcji przedstawiono różne funkcje administracyjne służące do rozliczania kasy fiskalnej. Więcej informacji na temat zapisów związanych z zamknięciem dnia można znaleźć w artykule: Codzienne zamknięcie kasy fiskalnej,
| Punkt końcowy | Typ | Opis |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
Rejestruje stan początkowy na potrzeby rozliczenia zamknięcia kasy. Rejestruje jedynie wpłatę, nie dokonuje ponownego rozliczenia stanu gotówki. Alternatywa: Alternatywnie kasa może również zaksięgować dokument o typie: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Księguje różnicę gotówkową w systemie rozliczeń podatkowych. Alternatywa: Alternatywnie kasa fiskalna może również zaksięgować dokument o typie BusinessTransactionType [91] = CashDifference. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Rejestruje przelew środków z systemu kasowego do banku (lub innego miejsca docelowego). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Zwraca aktualny stan płatności konkretnego klienta. Jest on obliczany na podstawie przesłanych dokumentów (w tym paragonów sprzedaży i zwrotów, wpłat i wypłat itp.). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Sprawdza rzeczywisty stan płatności dla danej kasy i zwraca listę płatności z rozbieżnością (lub pustą listę, jeśli nie ma rozbieżności). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Zamyka bieżący dzień za pomocą raportu rozliczeniowego. Zamknięcie odbywa się na podstawie dokumentów przesłanych do klienta od czasu ostatniego zamknięcia. System kasowy nie otrzymuje w odpowiedzi zestawienia zamknięcia! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Zwraca dokument podsumowujący bieżący dzień. Zwrócony dokument należy zapisać (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Zwraca datę i godzinę ostatniego zamknięcia dla określonego klienta (terminala) |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Zwraca informację, czy na danym terminalu ma zostać przeprowadzone dzienne zamknięcie. (W zależności od RetailForce.Fiscalisation.Implementation. |
Informacje
Krótki opis: służy do wysyłania zapytań o informacje specjalne
| Punkt końcowy | Typ | Opis |
| GET /api/v1/information/version | O | Zwraca aktualną wersję (SW) oprogramowania (middleware do celów podatkowych). |
| GET /api/v1/information/version/{clientId} | O | Zwraca wersję modułu krajowego dla danego klienta. |
| GET /api/v1/information/countryProperties | O | Zwraca właściwości fiscalCountryProperties dla żądanego kraju. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Zwraca właściwości fiscalCountryProperties dla podanego klienta. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Zwraca unikalny ID kasy fiskalnej (storeNumber/terminalNumber). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Zwraca status żądanego klienta fiskalnego. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Zwraca listę licencji dostępowych dla wskazanego klienta. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Zwraca oświadczenie dotyczące licencji dla wskazanego klienta. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Zwraca odpowiedni numer identyfikacyjny Vat dla podanej wartości procentowej oraz daty i godziny. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Zwraca pola obowiązkowe dla typu określonego przez typeName w ramach danej implementacji krajowej. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | W przypadku ustawienia wartości „true” wszelkie dokumenty błędów będą zapisywane w katalogu klienta podatkowego. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Zwraca informację, czy opcja RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk jest włączona. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Zwraca wszystkie ID liczników wydajności dla danego klienta |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Resetuje wszystkie dane średnie dla danego klienta. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Zwraca dane średnie dla żądanego ID licznika wydajności. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Resetuje dane średnie dla danego klienta i danego licznika wydajności. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Włącza lub wyłącza śledzenie plików wydajności. Śledzenie plików wydajności jest domyślnie wyłączone. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Zwraca wszystkie etykiety informacji o postępie dla danego klienta. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Zwraca informacje o postępach dla danego klienta i etykiety. |
Zarządzanie
Krótki opis: Funkcje zarządzania, uruchamianie i wycofywanie z eksploatacji
| Punkt końcowy | Typ | Opis |
| PUT /api/v1/management/clients | O/M |
Tworzy nowego klienta w magazynie konfiguracji. Obiekt konfiguracyjny musi zostać przygotowany przez system POS. Konfiguracja klienta jest wymagana do działania. Proszę skorzystać z tego punktu końcowego lub z:
|
| POST /api/v1/management/clients | O |
Aktualizuje konfigurację klienta utworzoną przez system kasowy w magazynie konfiguracji. |
| GET /api/v1/management/clients | O |
Zwraca wszystkich klientów wymienionych w magazynie konfiguracji. Można z niej również skorzystać w przypadku korzystania z konfiguracji w Cloud. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Tworzy nowego klienta na podstawie konfiguracji przygotowanej w Cloud / lub wczytuje istniejącego klienta. Do działania wymagana jest konfiguracja klienta. Należy skorzystać z:
|
|
PUT
/api/v1/management/clients/ byCloud/ID |
O |
Tworzy klienta, pobierając dane konfiguracyjne z Cloud. Alternatywa: alternatywny punkt końcowy dla poleceń PUT /api/v1/management/clients oraz PUT /api/v1/management/clients/byCloud. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Aktualizuje konfigurację klienta poprzez pobranie jej z Cloud. Funkcja ta jest wykorzystywana, gdy konfiguracja przygotowana w Cloud została zaktualizowana i powinna zostać ponownie pobrana przez klienta fiskalnego (aktualizacja). |
|
POST
/api/v1/management/clients/ withCloud |
O/M |
Tworzy nowego klienta w module zarządzania systemem fiskalnym i dodaje go do konfiguracji w Cloud. Client jest tworzony w lokalnym magazynie konfiguracji, a obiekt konfiguracyjny jest następnie przesyłany do systemu w Cloud. Uwaga: W danych klienta musi być ustawiony distributor, a distributor musi posiadać uprawnienia do tworzenia nowych klientów. |
|
POST /api/v1/management/cloud/ connect |
M* |
Nawiązuje połączenie z Cloud dla określonego klienta i ładuje zaufany moduł fiskalny do pamięci podręcznej. Wymagane w systemach korzystających z funkcji Cloud. Konieczne po każdym ponownym uruchomieniu systemu POS. |
|
POST
/api/v1/management/cloud/ updateLicense |
O |
Aktualizuje bieżący klucz licencyjny w konfiguracji klienta fiskalnego (również na dysku). Wymagane, jeśli zmieniono licencje w konfiguracji Cloud. |
| HEAD /api/v1/management/cloud/queue | R |
Metoda służąca do uruchamiania lub zatrzymywania przetwarzania kolejki w Cloud (dla wszystkich klientów). Polecenie „Stop” zatrzymuje przetwarzanie po zakończeniu bieżącego przesyłania danych. Polecenie „Start” natychmiast uruchamia przetwarzanie kolejki. Jeśli przetwarzanie kolejki w Cloud zostanie zatrzymane, należy je ponownie uruchomić, chyba że usługa zostanie ponownie uruchomiona (wówczas przetwarzanie w Cloud zostanie ponownie aktywowane). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Zwraca konfigurację konkretnego klienta. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Usuwa określonego klienta Uwaga: należy stosować z rozwagą! |
| GET /api/v1/management/clients/ID | O |
Zwraca unikalny ID klienta dla podanych parametrów. Do żądania uniqueClientId można użyć różnych parametrów. |
|
GET
/api/v1/management/clients/ LicenseConsumerId |
O |
Zwraca ID odbiorcy licencji dla podanego identyfikatora firmy. Zwracane są wyłącznie identyfikatory LicenseConsumerId, które zostały już zapisane w magazynie konfiguracji. |
|
GET
/api/v1/management/clients/ validate |
O |
Sprawdza poprawność podanych informacji o kliencie pod kątem zgodności z konfiguracją wymaganą dla danego kraju. Służy do weryfikacji konfiguracji utworzonej przez system kasowy przed użyciem interfejsu /api/v1/management/clients. Weryfikacja konfiguracji w Cloud odbywa się w systemie Cloud. |
|
POST /api/v1/management/clients/ initialize |
M |
Inicjuje jednostkę fiskalną (oraz ewentualny sprzęt i ewentualne zgłoszenie do organów finansowych). Inicjalizacja odbywa się za pomocą paragonu początkowego (paragonu początkowego), który można uzyskać za pomocą punktu końcowego GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
Przenosi klienta z innego dostawcy usług fiskalnych. Funkcja ta jest wykorzystywana w przypadku przejścia z innego dostawcy middleware do RetailForce Proszę zwrócić uwagę na listę obsługiwanych systemów. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
Przenosi klienta z innego dostawcy usług fiskalnych i przeprowadza import pliku. Proszę zwrócić uwagę na obsługiwane systemy! |
|
POST
/api/v1/management/clients/ decommission |
R |
Wycofanie klienta z systemu kontroli fiskalnej (wraz z ewentualnym sprzętem oraz ewentualnym zgłoszeniem do organów finansowych). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Przesyła Support Package (pliki dziennika) do Cloud dla danego klienta. Ten punkt końcowy jest niezbędny do korzystania z funkcji „Prześlij Support Package” w systemie Cloud. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Tworzy kopię zapasową klienta pod podaną nazwą filename (kopia zapasowa w formacie ZIP). Jeśli korzysta się z funkcji przesyłania do Cloud, przetwarzanie kolejki w Cloud zostanie zatrzymane, a następnie wznowione (a kolejka w Cloud zostanie ponownie zainicjowana). Uwaga: Należy pamiętać, że jeśli klient nie zostanie usunięty, przetwarzanie kolejki w chmurze zostanie wznowione po utworzeniu kopii zapasowej. Jeśli jakiekolwiek pliki nie zostały skopiowane przed utworzeniem kopii zapasowej, zostaną one również uwzględnione w kopii zapasowej i mogą zostać przesłane dwukrotnie w przypadku przywrócenia klienta. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Przywraca klienta (wraz ze wszystkimi danymi) z podanego pliku ZIP kopii zapasowej. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Tworzy nowego klienta z konfiguracją z Cloud lub wczytuje istniejącego klienta. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/ID |
O |
Tworzy nowego klienta z konfiguracją z Cloud lub wczytuje istniejącego klienta. |
| POST /api/v1/management/clients/ {clientId}/GlobalShortId | O |
Generuje nowy lub zwraca istniejący, globalnie unikalny ID dla danego klienta. Ponadto dla danego klienta aktywowana zostaje funkcja generowania ID retailForceReceiptId. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Zapisuje certyfikat zewnętrzny w magazynie certyfikatów modułu fiskalnego. Wymagane w przypadku systemów NIEkorzystających z funkcji RetailForce Cloud w krajach objętych systemem fiskalnym, w których certyfikaty oprogramowania są wykorzystywane w kontekście fiskalizacji (Słowenia, Chorwacja, Hiszpania itp.) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Zwraca informację, czy żądany client posiada żądaną licencję dostępową. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Zwraca informację, czy wskazany client posiada żądaną licencję. |
ManagementController_Austria
Krótki opis: Funkcje zarządzania związane z austriacką fiskalizacją.
| Punkt końcowy | Typ | Opis |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
Tworzy klucz użytkownika AES dla tego klienta i zwraca go. Klucz AES zostanie również zapisany w konfiguracji klienta. Uwaga: Klucz użytkownika AES zostanie utworzony automatycznie przez klienta fiskalnego. Punkt końcowy jest niezbędny wyłącznie w przypadku, gdy klucz AES ma zostać utworzony ręcznie. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Zwraca klucz AES dla podanego klienta. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Eksportuje wszystkie pozycje paragonów z lokalnego rejestru gromadzenia danych (DEP §7 RKSV). Wymagane w przypadku systemów działających w trybie offline (systemów NIEkorzystających z archiwizacji danych fiskalnych w Cloud). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
Eksportuje wszystkie dane wymagane w ramach protokołu DEP131 (DEP §131 BAO) z lokalnie przechowywanych danych. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/startReceipt |
R |
Zwraca paragon początkowy dla tego klienta. System kasowy musi być w stanie dostarczyć paragon początkowy (paragon startowy) na żądanie podczas kontroli podatkowej; jeśli system kasowy nie zapisał paragonu początkowego, można go uzyskać za pomocą tego punktu końcowego. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/monthReceipts |
R |
Zwraca wszystkie paragony miesięczne z żądanego przedziału czasowego. System kasowy musi być w stanie udostępnić miesięczne paragony na żądanie podczas kontroli podatkowej; jeśli system POS nie zapisał tych dokumentów, można je uzyskać za pomocą tego punktu końcowego. |
|
GET
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Zwraca wszystkie urządzenia do podpisywania oraz informację, czy są one aktywowane w serwisie FinanzOnline (Fon), czy nie. |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Rejestruje skonfigurowane urządzenie do składania podpisów w serwisie Fon (o ile zostało skonfigurowane) lub urządzenie do składania podpisów zidentyfikowane za pomocą parametru certificateSerial. Uwaga: W przypadku korzystania z usług RetailForce Cloud Services certyfikaty są automatycznie rejestrowane w portalu FinanzOnline (Fon) (à konieczne są dane uwierzytelniające użytkownika serwisu internetowego kasy fiskalnej!); punkt końcowy jest niezbędny wyłącznie w przypadku konieczności ręcznej rejestracji. |
|
DELETE
/api/v1/management/austria/ {clientId}/Fon/certificate |
O |
Wyrejestruje skonfigurowane urządzenie do składania podpisów w serwisie Fon (o ile zostało skonfigurowane) lub urządzenie do składania podpisów zidentyfikowane za pomocą parametru certificateSerial. Uwaga: należy stosować z zachowaniem ostrożności! |
|
GET
/api/v1/management/austria/ {clientId}/fon/document |
R |
Sprawdza poprawność ostatniego podpisanego dokumentu w DEP w serwisie FinanzOnline (FON). |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document/{depDocument} |
R |
Sprawdza poprawność podanego dokumentu DEP (kod QR) w serwisie Fon. |
|
GET
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Zwraca informację, czy kasa fiskalna danego klienta jest aktywna w systemie Fon. Wymagane w przypadku systemów działających w trybie offline. |
|
POST
/api/v1/management/austria/ {clientId}/Fon/cashregister |
O |
Rejestracja systemu kasowego w serwisie Fon dla danego klienta. Wymagane w przypadku systemów działających w trybie offline. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Wykreślenie rejestracji kasy fiskalnej w serwisie Fon dla danego klienta. Wymagane w przypadku systemów działających w trybie offline. Uwaga: należy stosować z ostrożnością! |
ManagementController_Bulgaria
Krótki opis: Funkcje zarządzania związane z bułgarską fiskalizacją.
| Punkt końcowy | Typ | Opis |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Wysyła polecenie zamknięcia (Z) do drukarki fiskalnej. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Wysyła polecenie synchronizacji czasu (L) do drukarki fiskalnej. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/KLEN | R |
Funkcja ta służy do generowania tzw. raportu KLEN. (od wersji 1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Funkcja ta służy do wygenerowania
(od wersji 1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Funkcja ta służy do wygenerowania tzw. raportu BLOCK. (od wersji 1.8.3) |
ManagementController_Denmark
Krótki opis: Funkcje zarządzania dla duńskiego systemu fiskalizacji.
| Punkt końcowy | Typ | Opis |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
Eksportuje dane w formacie SAF-T dla Danii do podanego streamu. |
ManagementController_France
Krótki opis: Funkcje zarządzania związane z francuską fiskalizacją.
| Punkt końcowy | Typ | Opis |
|
GET
/api/v1/management/france/eventlog/ {clientId} |
M |
Zwraca wszystkie wpisy dziennika audytowego zgodnie z podaną datą. |
|
GET
/api/v1/management/france/ archive/{clientId} |
M |
Zwraca lokalnie przechowywane archiwa przeznaczone do zamknięcia. |
|
POST
/api/v1/management/france/ archive/{clientId}/verify |
M |
Metoda służąca do weryfikacji archiwum francuskiego. |
ManagementController_Germany
Krótki opis: Funkcje zarządzania związane z niemiecką fiskalizacją.
| Punkt końcowy | Typ | Opis |
| GET /api/v1/management/germany/TSE | R |
Zwraca tablicę podłączonych lokalnych urządzeń TSE wraz z ich stanem. |
|
POST
/api/v1/management/germany/ TSE/{TseSerial}/selftest |
R |
Uruchamia synchroniczny autotest dla podanej kasy fiskalnej na urządzeniu TSE (podanie kasy fiskalnej jest opcjonalne). |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/connectTest |
R |
Przeprowadza test połączenia z podanym urządzeniem TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/listClients |
O |
Zwraca listę wszystkich klientów zarejestrowanych w systemie TSE danego klienta. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/status |
R |
Zwraca status TSE. Jeśli nie znaleziono modułu podatkowego, zwracany jest status RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/updateTime |
M |
Aktualizuje czas w urządzeniu TSE do aktualnego czasu systemowego. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/tar |
O |
Eksportuje pliki tar z głównego urządzenia TSE. Wymagane w przypadku systemów działających w trybie offline. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Eksportuje taksonomię (DSFinV-K export) i zwraca ją jako plik do pobrania (w formacie zip). Wymagane w przypadku systemów działających w trybie offline. |
|
GET /api/v1/management/germany/ {clientId}/TSE/listTransactions |
R |
Zwraca wszystkie aktywne (rozpoczęte) transakcje w systemie TSE. Zalecane w celu śledzenia otwartych transakcji (wszystkie rozpoczęte transakcje muszą zostać zapisane lub anulowane). |
| DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions | O |
Anuluje aktywne (rozpoczęte) transakcje w systemie TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures/count |
O |
Zwraca liczbę transakcji offline (= transakcji, które nie zostały wysłane do TSE z powodu awarii serwera TSE – niedostępność). |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Zwraca wszystkie otwarte podpisy offline zapisane dla aktualnego serwera TSE. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Przetwarza otwarte podpisy offline. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/replace |
R |
Zastępuje aktualny moduł TSE dla danego klienta nowym (na przykład w przypadku uszkodzenia starego modułu TSE lub wygaśnięcia certyfikatu). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/selftest |
R |
Uruchamia synchroniczny autotest dla danej kasy fiskalnej na module TSE (podanie kasy fiskalnej jest opcjonalne). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/updateFirmware |
R |
Aktualizuje oprogramowanie sprzętowe w urządzeniu SWISSBIT HARDWARE TSE. |
ManagementController_Spain
Krótki opis: Funkcje zarządzania związane z hiszpańską fiskalizacją.
| Punkt końcowy | Typ | Opis |
|
GET
/api/v1/management/spain/ {clientId}/ticketBai |
R |
Zwraca zapisane pliki TicketBAI (pliki wysłane, pliki odpowiedzi, pliki błędów) w postaci pliku ZIP. |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI/{DocumentNumber} |
R |
Zwraca zapisane pliki TicketBAI dla podanego numeru dokumentu (pliki wysłane, pliki odpowiedzi, pliki błędów) w postaci pliku zip. |
Potwierdzenia
Krótki opis: służy do wysyłania cyfrowych potwierdzeń do RetailForce Cloud za pośrednictwem middleware.
Punkty końcowe w tej sekcji służą do wysyłania dokumentów potwierdzeń cyfrowych do systemu w Cloud (do korzystania z tej usługi wymagane są licencje na potwierdzenia cyfrowe!).
| Punkt końcowy | Typ | Opis |
| POST /api/v1/receipts/{clientId} | O/M |
Przesyła plik cyfrowej faktury do systemu w Cloud. Alternatywa: W celu przesłania danych dotyczących cyfrowych paragonów należy skorzystać z tego punktu końcowego lub z alternatywnego punktu końcowego opisanego w niniejszej sekcji. |
|
POST
/api/v1/receipts/ {clientId}/{DocumentGuid} |
O/M |
Przesyła plik cyfrowy do systemu Cloud. Wykorzystuje Metadata dotyczące fiskalizacji. Alternatywa: W celu przesłania danych dotyczących cyfrowych paragonów należy skorzystać z tego punktu końcowego lub z alternatywnego punktu końcowego opisanego w niniejszej sekcji. |
Transakcje
Krótki opis: służy do wysyłania dokumentów do middleware w kontekście fiskalizacji.
| Punkt końcowy | Typ | Opis |
| PUT /api/v1/transactions/createDocument | M |
Tworzy dokument w jednostce rozliczeniowej. Metoda ta nie tworzy samego dokumentu, a jedynie uruchamia proces, na przykład w systemie TSE. |
| POST /api/v1/transactions/storeDocument | M |
Zapisuje dokument w jednostce fiskalnej. |
| POST /api/v1/transactions/cancelDocument | M |
Anuluje dokument w jednostce fiskalnej. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid} |
M* |
Metoda służąca do zapisania liczby ponownych wydruków dokumentu na podstawie zapisanego dokumentu (odniesienie: DocumentGuid). Alternatywnie: można również użyć PUT /api/v1/transactions/reprintDocument |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Metoda służąca do zapisania liczby ponownych wydruków dokumentu poprzez ponowne wysłanie dokumentu. Użytkownikiem przesłanego dokumentu musi być użytkownik dokonujący ponownego wydruku (a nie użytkownik dokumentu oryginalnego). Alternatywa: można również użyć metody PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Cofanie dokumentu (zmiana wszystkich wartości na ujemne). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Sprawdza poprawność dokumentu i zwraca wszystkie błędy walidacji (lub pustą listę, jeśli nie ma żadnych błędów). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Przesyła dokument w formacie JSON do serwisu w celu jego walidacji. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Zwraca dokument początkowy dla danego klienta. Dokument początkowy służy do zainicjowania zarówno klienta, jak i jednostki podatkowej (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Wyświetla tekst na ekranie klienta podatkowego. Obsługiwane wyłącznie w krajach, w których stosuje się fiskalny wyświetlacz klienta. W pozostałych krajach wywołanie to nie powoduje żadnego działania (można je jednak wykonać). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Otwiera szufladę, jeśli jest ona podłączona do drukarki fiskalnej. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Zwraca dane kodu QR w postaci stringa zakodowanego w systemie Base64 na podstawie podanych danych. |
| POST /api/v1/transactions/AuditLog | M* |
Dodaje wpis do dziennika audytowego klienta podatkowego. |
| GET /api/v1/transactions/AuditLog/{clientId} | M* |
Zwraca wszystkie rekordy audytowe wyszukane według zakresu dat fromDate/tillDate. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
R |
Zwraca żądany dokument, o ile jest on przechowywany w pamięci wewnętrznej. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
O |
Zwraca informację, czy żądany dokument istnieje w wewnętrznym magazynie dokumentów. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{DocumentId} |
O |
Zwraca żądany dokument, o ile jest on przechowywany w wewnętrznym magazynie. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Zwraca informację, czy żądany dokument istnieje w wewnętrznym magazynie dokumentów. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Zwraca ostatni zapisany dokument z magazynu dokumentów. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Zwraca żądany dokument, o ile jest on zapisany w pamięci wewnętrznej. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid}/response |
R |
Zwraca żądaną odpowiedź dotyczącą dokumentu, o ile znajduje się ona w pamięci wewnętrznej. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId}/response |
O |
Zwraca żądaną odpowiedź dotyczącą dokumentu, o ile jest on przechowywany w pamięci wewnętrznej. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Zwraca żądany dokument, o ile znajduje się on w pamięci wewnętrznej. |
Ten artykuł został przetłumaczony automatycznie.
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.