Ez a cikk áttekintést nyújt a RetailForce Fiscal Service api-funkcióiról (állapot: 1.6.3-as release). Az egyes végpontokhoz szükséges paraméterek a RetailForce Middleware telepítése után a swaggeren keresztül tekinthetők meg (pl. http://localhost:7678/swagger/index.html).
Az api különböző területekre van felosztva, amelyek különböző célokra és termékekhez használhatók.
A „Type” oszlopban szereplő információk:
- O … opcionális
- M ... kötelező / előírt
- M* ... kötelező / bizonyos országokban vagy bizonyos feltételek mellett kötelező
- R ... ajánlott
A fejlécek a swagger megfelelő szakaszára utalnak. Egyes végpontokhoz további információkat tartalmazó linkek is tartoznak.
Archívum
Rövid leírás: A már adóügyi feldolgozáson átesett adatok archiválási funkciója.
Az ebben a szakaszban szereplő végpontok az adatok átvitelére szolgálnak a Secure RetailForce Archive-ba.
| Végpont | Típus | Leírás |
| POST /api/v1/archive/de/{clientId} | O | Ez a módszer több fájl feltöltésére szolgál a Cloud archívumba. |
| GET /api/v1/archive/de/{clientId} | O | A korábban archivált adatok (fájlok) letöltésére szolgál a Cloud-alapú archívumból. |
Biztonsági mentés
Rövid leírás: Tetszőleges POS-adatok archiválási funkciója
Az ebben a szakaszban található végpontok tetszőleges adatok feltöltésére szolgálnak a Cloud-alapú archívumba – szolgáltatás/termék: „POS-archívum”. A szolgáltatás használatához biztonsági mentési licenc szükséges.
| Végpont | Típus | Leírás |
| POST /api/v1/backup/{clientId} | O | Ez a módszer egy adott mappát ment a Cloud archívumba. |
| POST /api/v1/backup/{clientId}/restore | O | Visszaállít egy korábban archivált (biztonsági másolatként mentett) fájlt egy meghatározott helyre. |
| GET /api/v1/backup/{clientId}/restore | O | Visszaad egy letöltési URL-t, amely segítségével letölthető a kért biztonsági másolat a Cloud-alapú archívumból. |
Zárás
Rövid leírás: Pénztárgépek zárási funkciói.
Ez a szakasz a pénztárgép elszámolásához szükséges különböző adminisztratív funkciókat tartalmazza. A napzárási könyvelési tételekről további információkat a következő cikkben talál: A pénztárgép napi zárása,
| Végpont | Típus | Leírás |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
A pénztárgép zárókimutatásához rögzíti a nyitó készletet. Csak a befizetést rögzíti, a készpénzkészletet nem állítja vissza. Alternatíva: Alternatívaként a pénztárgép dokumentumot is könyvelhet: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Könyveli a készpénzkülönbözetet a fiskalizációs rendszerbe. Alternatíva: Alternatívaként a pénztárgép BusinessTransactionType [91] = CashDifference értékkel is könyvelhet egy dokumentumot. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Könyveli a pénzátutalást a pénztárgép-rendszerből a bankba (vagy bármely más célállomásra). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Visszaadja egy adott ügyfél fizetéseinek tényleges állományát. Ezt a továbbított dokumentumok alapján számítja ki (az értékesítési és visszavételi bizonylatok, befizetések és kifizetések stb. mellett). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Ellenőrzi az adott pénztárgép fizetéseinek tényleges állományát, és visszaadja az eltéréssel rendelkező fizetések listáját (vagy üres listát, ha nincs eltérés). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Zárja le a napot egy zárókimutatással. A zárás az utolsó zárás óta a clientnek elküldött dokumentumok alapján történik. A pénztárgép-rendszer nem kap vissza zárókimutatást! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Visszaadja az aktuális napra vonatkozó napzárási dokumentumot. A visszaküldött dokumentumot el kell menteni (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Visszaadja egy adott client (terminal) legutóbbi zárásának dátumát és időpontját |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Visszaadja, hogy egy adott terminálon naponta zárást kell-e végrehajtani. (A RetailForce.Fiscalisation.Implementation. |
Információ
Rövid leírás: speciális információk lekérdezésére szolgál
| Végpont | Típus | Leírás |
| GET /api/v1/information/version | O | Visszaadja a szoftver (pénzügyi middleware) aktuális verzióját (SW). |
| GET /api/v1/information/version/{clientId} | O | Visszaadja a megadott client országmoduljának verzióját. |
| GET /api/v1/information/countryProperties | O | Visszaadja a kért ország fiscalCountryProperties tulajdonságait. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Visszaadja a megadott client fiscalCountryProperties tulajdonságait. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Visszaadja az egyedi pénztárgép-ID-t (storeNumber/terminalNumber). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Visszaadja a kért adóügyi client állapotát. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Visszaadja a kért client hozzáférési engedélyeinek listáját. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Visszaadja a kért client licencigényét. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Visszaadja a kért százalékos arányhoz és dátumhoz/időponthoz tartozó megfelelő Vat-azonosítót. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Visszaadja a typeName által megadott típus kötelező mezőit az adott ország implementációja szerint. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Ha true értékre van állítva, akkor minden hibaüzenetet a fiskális client könyvtárban tárol. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Visszaadja, hogy a RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk opció engedélyezve van-e. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Visszaadja az adott client összes teljesítménymutató-ID-jét |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Visszaállítja az adott client összes átlagos adatát. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Visszaadja a kért teljesítménymérő-ID átlagos adatait. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Visszaállítja az adott client és a megadott teljesítménymérő átlagos adatait. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Engedélyezi vagy letiltja a teljesítményfájl-nyomkövetést. A teljesítményfájl-nyomkövetés alapértelmezés szerint letiltva van. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Visszaadja az adott client összes előrehaladási információs címkéjét. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Visszaadja a megadott clienthez és címkéhez tartozó előrehaladási információkat. |
Kezelés
Rövid leírás: Kezelési funkciók, üzembe helyezés és leszerelés
| Végpont | Típus | Leírás |
| PUT /api/v1/management/clients | O/M |
Új clientet hoz létre a konfigurációs adattárban. A konfigurációs objektumot a POS-rendszernek kell előkészítenie. A client konfigurációja a működéshez szükséges. Használja ezt a végpontot, vagy a következőt:
|
| POST /api/v1/management/clients | O |
Frissíti a pénztárgép-rendszer által létrehozott client-konfigurációt a konfigurációs adattárban. |
| GET /api/v1/management/clients | O |
Visszaadja a konfigurációs adattárban szereplő összes clientet. Cloud-alapú konfiguráció használata esetén is alkalmazható. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Létrehoz egy új client-t a Cloud-ban előkészített konfigurációval, vagy betölti egy meglévő client-t. A működéshez a client konfigurációja szükséges. Használja az alábbiak egyikét:
|
|
PUT
/api/v1/management/clients/ byCloud/ID |
O |
Létrehoz egy clientet, amely a konfigurációs adatokat a Cloudból tölti be. Alternatíva: alternatív végpont a PUT /api/v1/management/clients és a PUT /api/v1/management/clients/byCloud parancsokhoz. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Frissíti az ügyfél konfigurációját azáltal, hogy letölti azt a Cloudból. Akkor használható, ha a Cloudban előkészített konfiguráció frissült, és azt a pénzügyi kliensnek újra le kell töltenie (frissítés). |
|
POST /api/v1/management/clients/withCloud |
O/M |
Új client-t hoz létre az adóügyi modul kezelőfelületén, és hozzáadja ezt a client-t a Cloud konfigurációhoz. A client a helyi konfigurációs tárolóban jön létre, majd a konfigurációs objektumot feltöltik a Cloud-rendszerbe. Megjegyzés: Az ügyféladatokban meg kell adni a distributort, és a distributornak engedélyeznie kell az új clients létrehozását. |
|
POST /api/v1/management/cloud/ connect |
M* |
Létrehozza a Cloud-kapcsolatot az adott client számára, és betölti a megbízható pénzügyi modult a gyorsítótárba. Cloud-funkciókat használó rendszerek esetében kötelező. A POS-rendszer minden újraindítása után szükséges. |
|
POST
/api/v1/management/cloud/ updateLicense |
O |
Frissíti az aktuális licenckulcsot a pénzügyi client konfigurációjában (a lemezen is). Szükséges, ha a Cloud konfigurációban lévő licencek megváltoztak. |
| HEAD /api/v1/management/cloud/queue | R |
A Cloud-alapú sor feldolgozásának elindítására vagy leállítására szolgáló módszer (minden client esetében). A Stop parancs a tényleges feltöltés befejezése után leállítja a feldolgozást. A Start parancs azonnal elindítja a sor feldolgozását. Ha a Cloud-alapú sor feldolgozása leáll, újra kell indítania, kivéve, ha a szolgáltatást újraindítja (ebben az esetben a Cloud-alapú feldolgozás újra aktiválódik). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Visszaadja egy adott client konfigurációját. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Törli egy adott client-t Figyelem: óvatosan használja! |
| GET /api/v1/management/clients/ID | O |
Visszaadja a kért paraméterekhez tartozó egyedi client-ID-t. Az uniqueClientId lekéréséhez különböző paraméterek használhatók. |
|
GET
/api/v1/management/clients/ LicenseConsumerId |
O |
Visszaadja a megadott vállalati ID-hez tartozó licencfelhasználói ID-t. Csak azok a LicenseConsumerId-k kerülnek visszaadásra, amelyek már tárolva vannak a konfigurációs adattárban. |
|
GET
/api/v1/management/clients/ validate |
O |
Ellenőrzi, hogy a megadott client-adatok megfelelnek-e az országspecifikus konfigurációs követelményeknek. A /api/v1/management/clients használata előtt a pénztárgép-rendszer által létrehozott konfiguráció érvényesítésére szolgál. A Cloud-alapú konfiguráció érvényesítését a Cloud-rendszer biztosítja. |
|
POST /api/v1/management/clients/ initialize |
M |
Inicializálja az adóügyi egységet (valamint az esetleges hardvert és az adóhatóságok felé benyújtandó esetleges bejelentést). Az inicializálás a kezdő nyugta (kezdő bizonylat) segítségével történik, amely lekérdezhető a GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
A client áttelepítése egy másik adóügyi szolgáltatótól. Akkor használható, ha egy másik adóügyi middleware szolgáltatótól a RetailForce-ra váltanak. Kérjük, vegye figyelembe a támogatott rendszereket. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
A client áttelepítése egy másik adóügyi szolgáltatótól, valamint fájlimport végrehajtása. Kérjük, vegye figyelembe a támogatott rendszereket! |
|
POST
/api/v1/management/clients/ decommission |
R |
Az adóügyi client leszerelése (és adott esetben a hardver leszerelése, valamint a pénzügyi hatóságok felé történő bejelentés). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Support Package (naplófájlok) feltöltése a Cloudba az adott client számára. Ez a végpont szükséges a Cloud-rendszerben található „Support Package feltöltése” funkció használatához. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Biztonsági másolatot készít a clientről a megadott filename alatt (zip-fájl formátumban). Ha a Cloud-ba történő feltöltés aktív, a Cloud-i sor feldolgozása leáll, majd újraindul (és a Cloud-i sor újraindul). Figyelem: Kérjük, vegye figyelembe, hogy ha a clientet nem távolítják el, a Cloud sor feldolgozása a biztonsági mentés után folytatódik. Ha bármely fájl nem volt mentve a biztonsági mentés előtt, azok is a biztonsági mentés részét képezik, és előfordulhat, hogy kétszer kerülnek feltöltésre, amennyiben a clientet visszaállítják. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Visszaállít egy clientet (az összes adattal együtt) a megadott biztonsági másolat zip-fájlból. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Új client-t hoz létre a Cloud-ból származó konfigurációval, vagy betölti egy meglévő client-t. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/ID |
O |
Új client-t hoz létre a Cloud-ból származó konfigurációval, vagy betölti egy meglévő client-t. |
| POST /api/v1/management/clients/ {clientId}/GlobalShortId | O |
Új, globálisan egyedi ID-t generál az adott client számára, vagy visszaad egy meglévőt. Ezen felül aktiválja a retailForceReceiptId kiadását az adott client számára. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Külső tanúsítványt tárol a pénzügyi modul tanúsítványtárában. Szükséges azoknál a rendszereknél, amelyek NEM használják a RetailForce Cloud funkcióit olyan adóügyi országokban, ahol a szoftveres tanúsítványokat az adóügyi nyilvántartás keretében használják (Szlovénia, Horvátország, Spanyolország,…) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Visszaadja, hogy a kért client rendelkezik-e a kért hozzáférési engedéllyel. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Visszaadja, hogy a kért client rendelkezik-e a kért licenccel. |
ManagementController_Austria
Rövid leírás: Az osztrák adóügyi nyilvántartáshoz kapcsolódó felügyeleti funkciók.
| Végpont | Típus | Leírás |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
AES felhasználói kulcsot hoz létre ehhez a clienthez, és visszaadja azt. Az AES kulcs a client konfigurációjában is tárolásra kerül. Megjegyzés: Az AES felhasználói kulcsot a fiskális client automatikusan létrehozza. A végpont csak akkor szükséges, ha az AES kulcsot manuálisan kell létrehozni. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Visszaadja a megadott client AES-kulcsát. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Exportálja a helyi adatgyűjtési napló (DEP §7 RKSV) tárolt adatainak összes bizonylat-sorát. Szükséges az offline rendszerek számára (azok számára, amelyek NEM használnak Cloud-alapú adóügyi adatarchiválást). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
A DEP131 (DEP §131 BAO) protokollhoz kért összes adatot exportálja a helyi tárolt adatokból. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/startReceipt |
R |
Visszaadja az adott client kezdő nyugtáját. A pénztárgép-rendszernek képesnek kell lennie arra, hogy pénzügyi ellenőrzés során kérésre kiadja a kezdő nyugtát (start receipt); amennyiben a POS-rendszer nem tárolta a kezdő nyugtát, az ezen végponton keresztül kérhető. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/monthReceipts |
R |
Visszaadja az összes havi nyugtát a kért időtartományban. A pénztárgép-rendszernek képesnek kell lennie arra, hogy pénzügyi ellenőrzés során kérésre rendelkezésre bocsássa a havi nyugtákat; amennyiben a POS-rendszer nem tárolta ezeket a dokumentumokat, azok ezen végponton keresztül kérhetők. |
|
GET
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Visszaadja az összes aláírási eszközt, valamint azt, hogy azok aktiválva vannak-e a FinanzOnline (Fon) rendszerben vagy sem. |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Regisztrálja a Fon-on a konfigurált aláírási eszközt (ha van ilyen), vagy a certificateSerial azonosítóval rendelkező aláírási eszközt. Megjegyzés: A RetailForce Cloud Services használata esetén a tanúsítványok automatikusan regisztrálódnak a FinanzOnline portálon (Fon) (ehhez a pénztárgép-webszolgáltatás felhasználójának hitelesítő adatai szükségesek!); az endpoint csak akkor szükséges, ha a regisztrációt manuálisan kell elvégezni. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Törli a beállított aláírási eszköz regisztrációját a Fon-on (ha van ilyen beállítva) vagy a certificateSerial azonosítóval rendelkező aláírási eszközét. Figyelem: óvatosan használja! |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document |
R |
Ellenőrzi a DEP-ben található, legutóbb aláírt dokumentum érvényességét a FinanzOnline (Fon) rendszerben. |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document/{depDocument} |
R |
Ellenőrzi a megadott DEP dokumentumot (QR-kód) a Fon-on. |
|
GET
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Visszaadja, hogy az aktuális ügyfél pénztárgépe aktiválva van-e a Fon-nál. Offline rendszerekhez szükséges. |
|
POST
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
A jelenlegi ügyfél pénztárgép-rendszerének regisztrációja a Fon-on. Offline rendszerekhez szükséges. |
|
DELETE
/api/v1/management/austria/ {clientId}/Fon/cashregister |
O |
At Fon, the registration of the client's cash register is deleted. Offline rendszerek esetén szükséges. Figyelem: óvatosan használja! |
ManagementController_Bulgaria
Rövid leírás: Kezelési funkciók a bolgár adóügyi előírásokhoz.
| Végpont | Típus | Leírás |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Zárási parancsot (Z) küld a pénzügyi nyomtatóhoz. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Időszinkronizálási parancsot (L) küld a pénzügyi nyomtatóhoz. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/KLEN | R |
Ez a funkció az úgynevezett KLEN-jelentés létrehozására használható. (v1.8.3-tól) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Ez a funkció a
(v1.8.3-tól) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Ez a funkció az úgynevezett BLOCK-jelentés kinyomtatására szolgál. (v1.8.3-tól) |
ManagementController_Denmark
Rövid leírás: A dán fiskalizációhoz kapcsolódó felügyeleti funkciók.
| Végpont | Típus | Leírás |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
A dán SAF-T formátumot exportálja a megadott streambe. |
ManagementController_France
Rövid leírás: A francia adóügyi előírásokhoz kapcsolódó kezelési funkciók.
| Végpont | Típus | Leírás |
|
GET
/api/v1/management/france/ eventlog/{clientId} |
M |
Visszaadja az összes kért auditnapló-bejegyzést dátum szerint. |
|
GET
/api/v1/management/france/ archive/{clientId} |
M |
Visszaadja a lezárásra váró, helyileg tárolt archívumokat. |
|
POST
/api/v1/management/france/ archive/{clientId}/verify |
M |
A francia archívum ellenőrzésére szolgáló módszer. |
ManagementController_Germany
Rövid leírás: A német adóügyi nyilvántartáshoz kapcsolódó kezelési funkciók.
| Végpont | Típus | Leírás |
| GET /api/v1/management/germany/TSE | R |
Visszaadja a csatlakoztatott helyi TSE-eszközök tömbjét és azok állapotát. |
|
POST
/api/v1/management/germany/ TSE/{TseSerial}/selftest |
R |
Szinkron önellenőrzést futtat a megadott pénztárgépre a TSE-n (a pénztárgép megadása opcionális). |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/connectTest |
R |
Kapcsolatot tesztel a megadott TSE-vel. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/listClients |
O |
Visszaadja az adott client TSE-jén szereplő összes clientet. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/status |
R |
Visszaadja a TSE állapotát. Ha nem található adóügyi modul, akkor a RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/updateTime |
M |
Frissíti a TSE-n szereplő időt a számítógép aktuális idejére. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/tar |
O |
Exportálja a tar fájlokat az elsődleges TSE-ről. Offline rendszerekhez szükséges. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Exportálja a taxonómiát (DSFinV-K export), és letölthető fájlként (zip formátumban) adja vissza. Offline rendszerekhez szükséges. |
|
GET /api/v1/management/germany/ {clientId}/TSE/listTransactions |
R |
Visszaadja az összes aktív (elindított) tranzakciót a TSE-n. Ajánlott a nyitott tranzakciók nyomon követéséhez (minden megkezdett tranzakciót tárolni vagy törölni kell). |
| DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions | O |
A TSE-n lévő aktív (elindított) tranzakciók törlése. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures/count |
O |
Visszaadja az offline tranzakciók számát (= olyan tranzakciók, amelyeket a TSE offline állapota miatt – meghibásodás, elérhetetlenség – nem küldtek el a TSE-nek). |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Visszaadja az aktuális TSE-hez tárolt összes nyitott offline aláírást. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Feldolgozza a nyitott offline aláírásokat. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/replace |
R |
A megadott client jelenlegi TSE-jét újjal cseréli ki (például ha a régi TSE megsérült vagy a tanúsítvány lejárt). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/selftest |
R |
Szinkron önellenőrzést futtat a megadott pénztárgép TSE-jén (a pénztárgép megadása opcionális). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/updateFirmware |
R |
Frissíti a SWISSBIT HARDWARE TSE firmware-jét. |
ManagementController_Spain
Rövid leírás: Kezelési funkciók a spanyol adóügyi előírásokhoz.
| Végpont | Típus | Leírás |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI |
R |
A tárolt TicketBAI fájlokat (elküldött fájlok, válaszfájlok, hibaüzenetek) ZIP-fájlként adja vissza. |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI/{DocumentNumber} |
R |
A kért dokumentumszámhoz tartozó tárolt TicketBAI fájlokat (elküldött fájlok, válaszfájlok, hibaüzenetek) ZIP-fájlként adja vissza. |
Nyugták
Rövid leírás: digitális nyugták küldésére szolgál a RetailForce Cloud-ba a Middleware-en keresztül.
Az ebben a szakaszban található végpontok a digitális nyugtadokumentumok Cloud-rendszerbe történő elküldésére szolgálnak (a szolgáltatás használatához digitális nyugta licenc szükséges!).
| Végpont | Típus | Leírás |
| POST /api/v1/receipts/{clientId} | O/M |
Digitális nyugtafájlt tölt fel a Cloud-rendszerbe. Alternatíva: A digitális nyugták adatainak elküldéséhez használja ezt vagy a szakaszban szereplő alternatív végpontot. |
|
POST
/api/v1/receipts/ {clientId}/{DocumentGuid} |
O/M |
Digitális fájlt tölt fel a Cloud-rendszerbe. A fiskalizáció Metadata-jait használja. Alternatíva: A digitális nyugták adatainak elküldéséhez használja ezt vagy a szakaszban szereplő alternatív végpontot. |
Tranzakciók
Rövid leírás: dokumentumok küldésére szolgál a middleware-hez a fiskalizáció keretében.
| Végpont | Típus | Leírás |
| PUT /api/v1/transactions/createDocument | M |
Dokumentumot hoz létre a fiskalizációs egységnél. Ez a módszer nem hoz létre dokumentumot, csupán elindítja a folyamatot például a TSE-n. |
| POST /api/v1/transactions/storeDocument | M |
Dokumentumot tárol az adóügyi egységben. |
| POST /api/v1/transactions/cancelDocument | M |
Visszavon egy dokumentumot a fiskalizációs egységből. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid} |
M* |
Módszer egy dokumentum újranyomtatási számának tárolására a tárolt dokumentum (hivatkozás: DocumentGuid) felhasználásával. Alternatíva: alternatívaként használja a PUT /api/v1/transactions/reprintDocument parancsot |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Módszer egy dokumentum újranyomtatási számának tárolására a dokumentum újbóli elküldésével. Az átvitt dokumentum felhasználójának az újranyomtató felhasználónak kell lennie (nem az eredeti dokumentum felhasználójának). Alternatíva: alternatívaként használja a PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Visszaállítja a dokumentumot (minden értéket negatívvá tesz). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Ellenőrzi a dokumentumot, és visszaadja az összes érvényesítési hibát (ha nincs érvényesítési hiba, akkor egy üres listát ad vissza). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Elküldi a dokumentum JSON-ját a szolgáltatásnak a dokumentum érvényesítéséhez. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Visszaad egy kezdő dokumentumot a megadott client számára. A kezdő dokumentumot az ügyfél és a pénzügyi egység inicializálásához használják (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Szöveg megjelenítése a pénzügyi ügyfélkijelzőn. Csak azokban az országokban támogatott, ahol pénzügyi ügyfélkijelzőt használnak. Más országokban ez a hívás nem hajt végre semmilyen műveletet (de meghívható). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Megnyitja a fiókot, ha az a pénzügyi nyomtatóhoz van csatlakoztatva. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Visszaadja a QR-kód adatait a data-ból származó, base64-kódolású string-ként. |
| POST /api/v1/transactions/AuditLog | M* |
Auditnaplót ad hozzá a pénzügyi clienthez. |
| GET /api/v1/transactions/AuditLog/{clientId} | M* |
Visszaadja az összes, a fromDate/tillDate feltételekkel lekért audit-bejegyzést. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
R |
Visszaadja a kért dokumentumot, ha az a belső tárolóban található. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
O |
Visszaadja, hogy a kért dokumentum létezik-e a belső dokumentumtárban. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Visszaadja a kért dokumentumot, ha az a belső tárolóban található. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Visszaadja, hogy a kért dokumentum létezik-e a belső dokumentumtárban. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Visszaadja a dokumentumtárból az utoljára tárolt dokumentumot. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Visszaadja a kért dokumentumot, ha az a belső tárolóban található. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid}/response |
R |
Visszaadja a kért dokumentumra vonatkozó választ, ha az a belső tárolóban található. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{DocumentId}/response |
O |
Visszaadja a kért dokumentum válaszát, ha az a belső tárolóban található. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Visszaadja a kért dokumentumot, ha az a belső tárolóban található. |
Ezt a cikket automatikusan lefordították.
Hozzászólások
0 hozzászólás
Hozzászólások írásához jelentkezzen be.