Αυτό το άρθρο παρέχει μια επισκόπηση των λειτουργιών API της υπηρεσίας RetailForce Fiscal Service (κατάσταση: release 1.6.3). Οι απαιτούμενες παράμετροι κάθε τελικού σημείου μπορούν να προβληθούν μέσω του swagger (π.χ. http://localhost:7678/swagger/index.html) μετά την εγκατάσταση του Fiscal Middleware.
Το api χωρίζεται σε διαφορετικές ενότητες, οι οποίες χρησιμοποιούνται για διαφορετικούς σκοπούς και προϊόντα.
Πληροφορίες στη στήλη «Τύπος»:
- O ... προαιρετικό
- M ... υποχρεωτικό / απαιτείται
- M* ... υποχρεωτικό / απαιτείται σε ορισμένες χώρες ή υπό ορισμένες προϋποθέσεις
- R ... συνιστάται
Οι επικεφαλίδες αναφέρονται στην αντίστοιχη ενότητα στο swagger. Για ορισμένα endpoints θα βρείτε συνδέσμους προς περαιτέρω πληροφορίες.
Αρχείο
Σύντομη περιγραφή: Λειτουργία αρχειοθέτησης δεδομένων που έχουν ήδη υποβληθεί σε φορολογική επεξεργασία.
Τα σημεία τερματισμού σε αυτή την ενότητα χρησιμοποιούνται για τη μεταφορά δεδομένων στο Secure RetailForce Archive.
| Τερματικό | Τύπος | Περιγραφή |
| POST /api/v1/archive/de/{clientId} | O | Αυτή η μέθοδος χρησιμοποιείται για τη μεταφόρτωση πολλών αρχείων στο αρχείο Cloud. |
| GET /api/v1/archive/de/{clientId} | O | Χρησιμοποιείται για τη λήψη δεδομένων (αρχείων) που έχουν αρχειοθετηθεί προηγουμένως από το αρχείο στο Cloud. |
Δημιουργία αντιγράφων ασφαλείας
Σύντομη περιγραφή: Λειτουργία αρχειοθέτησης για δεδομένα POS οποιουδήποτε είδους
Τα σημεία τερματισμού σε αυτήν την ενότητα προορίζονται για τη μεταφόρτωση οποιωνδήποτε δεδομένων στο Αρχείο Cloud – για την υπηρεσία/το προϊόν: «Αρχείο POS». Απαιτείται άδεια δημιουργίας αντιγράφων ασφαλείας για τη χρήση αυτής της υπηρεσίας.
| Τερματικό | Τύπος | Περιγραφή |
| POST /api/v1/backup/{clientId} | O | Αυτή η μέθοδος δημιουργεί αντίγραφο ασφαλείας ενός συγκεκριμένου φακέλου στο αρχείο του Cloud. |
| POST /api/v1/backup/{clientId}/restore | O | Επαναφέρει ένα αρχείο που είχε αρχειοθετηθεί (αντίγραφο ασφαλείας) προηγουμένως σε μια συγκεκριμένη θέση. |
| GET /api/v1/backup/{clientId}/restore | O | Επιστρέφει μια διεύθυνση URL λήψης, η οποία μπορεί να χρησιμοποιηθεί για τη λήψη του ζητούμενου αρχείου αντιγράφου ασφαλείας από το αρχείο στο Cloud. |
Κλείσιμο
Σύντομη περιγραφή: Λειτουργίες κλεισίματος για τα ταμεία.
Αυτή η ενότητα παρέχει διάφορες διοικητικές λειτουργίες για τη λογιστική καταγραφή ενός ταμείου. Για περισσότερες πληροφορίες σχετικά με τις εγγραφές κλεισίματος στο τέλος της ημέρας, ανατρέξτε στο άρθρο: Καθημερινό κλείσιμο του ταμείου,
| Τερματικό | Τύπος | Περιγραφή |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
Καταχωρεί το αρχικό απόθεμα για μια κατάσταση κλεισίματος ταμειακής μηχανής. Καταχωρεί μόνο μια εισπραγμένη πληρωμή, δεν αναπροσαρμόζει το ταμειακό απόθεμα. Εναλλακτική λύση: Εναλλακτικά, το ταμείο μπορεί επίσης να καταχωρίσει ένα έγγραφο: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Καταχωρεί μια διαφορά μετρητών στο σύστημα φορολογικής καταγραφής. Εναλλακτική λύση: Εναλλακτικά, το ταμείο μπορεί επίσης να καταχωρίσει ένα έγγραφο με BusinessTransactionType [91] = CashDifference. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Καταχωρεί μια μεταφορά χρημάτων από το σύστημα ταμειακής μηχανής προς την τράπεζα (ή οποιονδήποτε άλλο προορισμό). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Επιστρέφει το πραγματικό υπόλοιπο πληρωμών ενός συγκεκριμένου πελάτη. Αυτό υπολογίζεται με βάση τα έγγραφα που έχουν διαβιβαστεί (εκτός από τις αποδείξεις πωλήσεων και επιστροφών, τις καταθέσεις και τις αναλήψεις κ.λπ.). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Ελέγχει το πραγματικό υπόλοιπο των πληρωμών για αυτό το ταμείο και επιστρέφει μια λίστα πληρωμών με διαφορά (ή μια κενή λίστα αν δεν υπάρχει διαφορά). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Κλείνει την τρέχουσα ημέρα με μια κατάσταση κλεισίματος. Το κλείσιμο πραγματοποιείται με βάση τα έγγραφα που έχουν αποσταλεί στον πελάτη από το τελευταίο κλείσιμο. Το σύστημα ταμειακής μηχανής δεν λαμβάνει κατάλογο κλεισίματος ως απόκριση! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Επιστρέφει το έγγραφο λήξης ημέρας για την τρέχουσα ημέρα. Το έγγραφο που επιστρέφεται πρέπει να αποθηκευτεί (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Επιστρέφει την ημερομηνία και την ώρα του τελευταίου κλεισίματος ενός συγκεκριμένου πελάτη (terminal) |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Επιστρέφει πληροφορίες σχετικά με το αν πρέπει να πραγματοποιηθεί η ημερήσια κλείσιμο σε ένα συγκεκριμένο terminal. (Ανάλογα με το RetailForce.Fiscalisation.Implementation. |
Πληροφορίες
Σύντομη περιγραφή: χρησιμοποιείται για την αναζήτηση ειδικών πληροφοριών
| Τερματικό σημείο | Τύπος | Περιγραφή |
| GET /api/v1/information/version | O | Επιστρέφει την τρέχουσα έκδοση (SW) του λογισμικού (fiscal middleware). |
| GET /api/v1/information/version/{clientId} | O | Επιστρέφει την έκδοση της ενότητας χώρας του συγκεκριμένου πελάτη. |
| GET /api/v1/information/countryProperties | O | Επιστρέφει τις ιδιότητες fiscalCountryProperties για τη ζητούμενη χώρα. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Επιστρέφει τις fiscalCountryProperties για τον συγκεκριμένο πελάτη. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Επιστρέφει το μοναδικό ID ταμειακής μηχανής (storeNumber/terminalNumber). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Επιστρέφει την κατάσταση του ζητούμενου φορολογικού πελάτη. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Επιστρέφει μια λίστα αδειών πρόσβασης για τον ζητούμενο πελάτη. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Επιστρέφει την αίτηση άδειας για τον ζητούμενο πελάτη. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Επιστρέφει τον κατάλληλο αριθμό Vat για το ζητούμενο ποσοστό και την ημερομηνία/ώρα. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Επιστρέφει τα υποχρεωτικά πεδία για τον τύπο που καθορίζεται από το typeName για τη συγκεκριμένη εφαρμογή ανά χώρα. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Εάν οριστεί σε true, οποιοδήποτε έγγραφο σφάλματος θα αποθηκευτεί στον κατάλογο του φορολογικού πελάτη. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Επιστρέφει εάν η επιλογή RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk είναι ενεργοποιημένη. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Επιστρέφει όλους τους ID αναγνωριστικούς μετρητών απόδοσης για τον συγκεκριμένο client |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Επαναφέρει όλα τα δεδομένα μέσου όρου για τον συγκεκριμένο πελάτη. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Επιστρέφει τα δεδομένα μέσου όρου για το ID του ζητούμενου μετρητή απόδοσης. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Επαναφέρει τα δεδομένα μέσου όρου για τον συγκεκριμένο πελάτη και τον συγκεκριμένο μετρητή απόδοσης. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Ενεργοποιεί ή απενεργοποιεί την παρακολούθηση αρχείων απόδοσης. Η παρακολούθηση αρχείων απόδοσης είναι απενεργοποιημένη από προεπιλογή. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Επιστρέφει όλες τις ετικέτες πληροφοριών προόδου για τον συγκεκριμένο client. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Επιστρέφει τις πληροφορίες προόδου για τον συγκεκριμένο πελάτη και την ετικέτα. |
Διαχείριση
Σύντομη περιγραφή: Λειτουργίες διαχείρισης, θέση σε λειτουργία και απόσυρση από τη λειτουργία
| Τερματικό σημείο | Τύπος | Περιγραφή |
| PUT /api/v1/management/clients | O/M |
Δημιουργεί έναν νέο client στο αποθετήριο διαμόρφωσης. Το αντικείμενο διαμόρφωσης πρέπει να έχει προετοιμαστεί από το σύστημα POS. Η διαμόρφωση ενός client είναι απαραίτητη για τη λειτουργία. Χρησιμοποιήστε είτε αυτό το endpoint, είτε:
|
| POST /api/v1/management/clients | O |
Ενημερώνει μια διαμόρφωση πελάτη που δημιουργήθηκε από το σύστημα ταμειακής μηχανής στο αποθετήριο διαμορφώσεων. |
| GET /api/v1/management/clients | O |
Επιστρέφει όλους τους πελάτες που αναφέρονται στο αποθετήριο διαμόρφωσης. Μπορεί επίσης να χρησιμοποιηθεί όταν χρησιμοποιείται διαμόρφωση Cloud. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Δημιουργεί έναν νέο client με διαμόρφωση που έχει προετοιμαστεί στο Cloud / ή φορτώνει έναν υπάρχοντα client. Για τη λειτουργία απαιτείται η διαμόρφωση ενός client. Χρησιμοποιήστε είτε:
|
|
PUT
/api/v1/management/clients/ byCloud/ID |
O |
Δημιουργεί έναν client φορτώνοντας τα δεδομένα διαμόρφωσης από το Cloud. Εναλλακτική λύση: εναλλακτικό σημείο τερματισμού για τις εντολές PUT /api/v1/management/clients και PUT /api/v1/management/clients/byCloud. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Ενημερώνει τη διαμόρφωση του πελάτη, λαμβάνοντας τη διαμόρφωση του πελάτη από το Cloud. Χρησιμοποιείται όταν η διαμόρφωση που έχει προετοιμαστεί στο Cloud έχει ενημερωθεί και πρέπει να μεταφορτωθεί εκ νέου από τον πελάτη (ενημέρωση). |
|
POST
/api/v1/management/clients/ withCloud |
O/M |
Δημιουργεί έναν νέο πελάτη στη διαχείριση της φορολογικής ενότητας και προσθέτει αυτόν τον πελάτη στη διαμόρφωση του Cloud. Ο πελάτης δημιουργείται στο τοπικό αποθετήριο διαμόρφωσης και στη συνέχεια το αντικείμενο διαμόρφωσης μεταφορτώνεται στο σύστημα Cloud. Σημείωση: Ο distributor πρέπει να έχει οριστεί στα δεδομένα του πελάτη και πρέπει να έχει το δικαίωμα να δημιουργεί νέους πελάτες. |
|
POST /api/v1/management/cloud/ connect |
M* |
Δημιουργεί σύνδεση στο Cloud για τον συγκεκριμένο πελάτη και φορτώνει τη διαπιστευμένη φορολογική ενότητα στην προσωρινή μνήμη. Απαιτείται για συστήματα που χρησιμοποιούν λειτουργίες Cloud. Απαιτείται μετά από κάθε επανεκκίνηση του συστήματος POS. |
|
POST
/api/v1/management/cloud/ updateLicense |
O |
Ενημερώνει τον τρέχοντα κωδικό άδειας χρήσης στη διαμόρφωση του φορολογικού πελάτη (επίσης στον δίσκο). Απαιτείται, εάν έχουν αλλάξει οι άδειες χρήσης στη διαμόρφωση του Cloud. |
| HEAD /api/v1/management/cloud/queue | R |
Μέθοδος για την έναρξη ή τη διακοπή της επεξεργασίας της ουράς στο Cloud (για όλους τους clients). Η εντολή διακοπής σταματά την επεξεργασία μετά την ολοκλήρωση της τρέχουσας μεταφόρτωσης. Η εντολή «Start» ξεκινά αμέσως την επεξεργασία της ουράς. Εάν η επεξεργασία της ουράς στο Cloud διακοπεί, πρέπει να την επανεκκινήσετε, εκτός εάν επανεκκινηθεί η υπηρεσία (στην περίπτωση αυτή, η επεξεργασία στο Cloud ενεργοποιείται ξανά). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Επιστρέφει τη διαμόρφωση ενός συγκεκριμένου πελάτη. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Διαγράφει έναν συγκεκριμένο client Προσοχή: να χρησιμοποιείται με προσοχή! |
| GET /api/v1/management/clients/ID | O |
Επιστρέφει το μοναδικό ID του πελάτη για τις ζητούμενες παραμέτρους. Μπορούν να χρησιμοποιηθούν διαφορετικές παράμετροι για την αίτηση του uniqueClientId. |
|
GET
/api/v1/management/clients/ LicenseConsumerId |
O |
Επιστρέφει το ID χρήστη άδειας χρήσης για τον συγκεκριμένο κωδικό εταιρείας. Επιστρέφονται μόνο τα LicenseConsumerId που έχουν ήδη αποθηκευτεί στο config store. |
|
GET
/api/v1/management/clients/ validate |
O |
Επαληθεύει τις δεδομένες πληροφορίες πελάτη ώστε να πληρούν τις απαραίτητες απαιτήσεις διαμόρφωσης ανά χώρα. Χρησιμοποιείται για την επικύρωση μιας διαμόρφωσης που δημιουργήθηκε από το σύστημα ταμειακής μηχανής πριν από τη χρήση του /api/v1/management/clients. Η επικύρωση της διαμόρφωσης στο Cloud παρέχεται στο σύστημα Cloud. |
|
POST /api/v1/management/clients/ initialize |
M |
Εκκινεί τη μονάδα φορολογικής καταγραφής (καθώς και το ενδεχόμενο υλικό και την ενδεχόμενη δήλωση προς τις φορολογικές αρχές). Η αρχικοποίηση πραγματοποιείται μέσω της απόδειξης έναρξης (αρχική απόδειξη), η οποία μπορεί είτε να αναζητηθεί χρησιμοποιώντας το σημείο τερματισμού GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
Μεταφέρει έναν πελάτη από διαφορετικό πάροχο φορολογικής διαχείρισης. Χρησιμοποιείται κατά τη μετάβαση από διαφορετικό πάροχο φορολογικού middleware στο RetailForce Παρακαλώ σημειώστε τα υποστηριζόμενα συστήματα. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
Μεταφέρει έναν πελάτη από διαφορετικό πάροχο φορολογικών υπηρεσιών και πραγματοποιεί εισαγωγή αρχείου. Παρακαλώ σημειώστε τα υποστηριζόμενα συστήματα! |
|
POST
/api/v1/management/clients/ decommission |
R |
Απόσυρση πελάτη φορολογικής παρακολούθησης (και ενδεχόμενου υλικού, καθώς και ενδεχόμενης δήλωσης προς τις φορολογικές αρχές). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Ανεβάζει ένα Support Package (αρχεία καταγραφής) στο Cloud για τον συγκεκριμένο πελάτη. Αυτό το endpoint είναι απαραίτητο για τη χρήση της λειτουργίας «Ανεβάστε Support Package» στο σύστημα Cloud. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Δημιουργεί αντίγραφο ασφαλείας ενός πελάτη με το συγκεκριμένο filename (αντίγραφο ασφαλείας σε αρχείο zip). Εάν χρησιμοποιείται η μεταφόρτωση στο Cloud, η επεξεργασία της ουράς του Cloud θα διακοπεί και θα ξεκινήσει εκ νέου (και η ουρά του Cloud θα επανεκκινηθεί). Προσοχή: Λάβετε υπόψη ότι, εάν ο πελάτης δεν έχει αφαιρεθεί, η διαδικασία της ουράς του cloud θα συνεχιστεί μετά τη δημιουργία αντιγράφου ασφαλείας. Εάν υπάρχουν αρχεία που δεν είχαν δημιουργηθεί πριν από τη δημιουργία αντιγράφου ασφαλείας, αυτά περιλαμβάνονται επίσης στο αντίγραφο ασφαλείας και ενδέχεται να μεταφορτωθούν δύο φορές σε περίπτωση επαναφοράς του πελάτη. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Επαναφέρει έναν πελάτη (με όλα τα δεδομένα) από το δεδομένο αρχείο zip αντιγράφου ασφαλείας. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Δημιουργεί έναν νέο client με ρυθμίσεις από το Cloud ή φορτώνει έναν υπάρχοντα client. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/ID |
O |
Δημιουργεί έναν νέο client με ρυθμίσεις από το Cloud ή φορτώνει έναν υπάρχοντα client. |
| POST /api/v1/management/clients/ {clientId}/GlobalShortId | O |
Δημιουργεί ένα νέο ή επιστρέφει ένα υπάρχον, παγκοσμίως μοναδικό ID για τον αντίστοιχο πελάτη. Επιπλέον, ενεργοποιείται η έκδοση του retailForceReceiptId για τον αντίστοιχο πελάτη. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Αποθηκεύει ένα εξωτερικό πιστοποιητικό στο αποθετήριο πιστοποιητικών της φορολογικής ενότητας. Απαιτείται για συστήματα που ΔΕΝ χρησιμοποιούν τις λειτουργίες του RetailForce Cloud σε χώρες όπου ισχύει η φορολογική υποχρέωση και χρησιμοποιούνται πιστοποιητικά λογισμικού στο πλαίσιο της φορολογικής καταγραφής (Σλοβενία, Κροατία, Ισπανία,…) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Επιστρέφει αν ο ζητούμενος πελάτης διαθέτει την απαιτούμενη άδεια πρόσβασης. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Επιστρέφει αν ο ζητούμενος πελάτης διαθέτει την ζητούμενη άδεια. |
ManagementController_Austria
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για την αυστριακή φορολογική καταγραφή.
| Τερματικό σημείο | Τύπος | Περιγραφή |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
Δημιουργεί ένα κλειδί χρήστη AES για αυτόν τον πελάτη και το επιστρέφει. Το κλειδί AES θα αποθηκευτεί επίσης στις ρυθμίσεις του πελάτη. Σημείωση: Το κλειδί χρήστη AES θα δημιουργηθεί αυτόματα από τον φορολογικό πελάτη. Το σημείο τερματισμού είναι απαραίτητο μόνο εάν το κλειδί AES πρέπει να δημιουργηθεί χειροκίνητα. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Επιστρέφει το κλειδί AES για τον συγκεκριμένο client. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Εξάγει όλες τις γραμμές αποδείξεων των δεδομένων αποθήκευσης του τοπικού Μητρώου Συλλογής Δεδομένων (DEP §7 RKSV). Απαιτείται για συστήματα εκτός σύνδεσης (συστήματα που ΔΕΝ χρησιμοποιούν αρχειοθέτηση φορολογικών δεδομένων στο Cloud). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
Εξάγει όλα τα δεδομένα που απαιτούνται για το πρωτόκολλο DEP131 (DEP §131 BAO) από τα τοπικά αποθηκευμένα δεδομένα. |
|
GET
/api/v1/management/austria/ {clientId}/dep/startReceipt |
R |
Επιστρέφει την αρχική απόδειξη για αυτόν τον πελάτη. Το σύστημα ταμειακής μηχανής πρέπει να είναι σε θέση να παρέχει την αρχική απόδειξη (απόδειξη έναρξης) κατόπιν αιτήματος κατά τη διάρκεια ενός φορολογικού ελέγχου. Εάν το σύστημα POS δεν έχει αποθηκεύσει την αρχική απόδειξη, αυτή μπορεί να ζητηθεί χρησιμοποιώντας αυτό το endpoint. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/monthReceipts |
R |
Επιστρέφει όλες τις μηνιαίες αποδείξεις για το ζητούμενο χρονικό διάστημα. Το σύστημα ταμειακής μηχανής πρέπει να είναι σε θέση να παρέχει μηνιαίες αποδείξεις κατόπιν αιτήματος κατά τη διάρκεια ενός φορολογικού ελέγχου. Εάν το σύστημα POS δεν έχει αποθηκεύσει αυτά τα έγγραφα, μπορούν να ζητηθούν χρησιμοποιώντας αυτό το endpoint. |
|
GET
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Επιστρέφει όλες τις συσκευές υπογραφής και αν είναι ενεργοποιημένες στο FinanzOnline (Fon) ή όχι. |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Καταχωρεί τη διαμορφωμένη συσκευή υπογραφής στο Fon (εάν έχει διαμορφωθεί κάποια) ή τη συσκευή υπογραφής που προσδιορίζεται με το certificateSerial. Σημείωση: Εάν χρησιμοποιούνται οι υπηρεσίες RetailForce Cloud, τα πιστοποιητικά καταχωρίζονται αυτόματα στην πύλη FinanzOnline (Fon) (à απαιτούνται διαπιστευτήρια για τον χρήστη της διαδικτυακής υπηρεσίας ταμειακής μηχανής!); το σημείο τερματισμού απαιτείται μόνο εάν η καταχώριση πρέπει να γίνει χειροκίνητα. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Αποεγγραφή της διαμορφωμένης συσκευής υπογραφής στο Fon (εάν έχει διαμορφωθεί κάποια) ή της συσκευής υπογραφής που προσδιορίζεται με το certificateSerial. Προσοχή: να χρησιμοποιείται με προσοχή! |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document |
R |
Επαληθεύει το τελευταίο υπογεγραμμένο έγγραφο στο DEP στο FinanzOnline (Fon). |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document/{depDocument} |
R |
Επαληθεύει το συγκεκριμένο έγγραφο DEP (κωδικός QR) στο Fon. |
|
GET
/api/v1/management/austria/ {clientId}/Fon/cashregister |
O |
Επιστρέφει αν το ταμείο του συγκεκριμένου πελάτη είναι ενεργοποιημένο στο Fon. Απαιτείται για συστήματα εκτός σύνδεσης. |
|
POST
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Εγγραφή του συστήματος ταμειακής μηχανής στο Fon για τον συγκεκριμένο πελάτη. Απαιτείται για συστήματα εκτός σύνδεσης. |
|
DELETE
/api/v1/management/austria/ {clientId}/Fon/cashregister |
O |
Ακύρωση εγγραφής ταμειακού συστήματος στο Fon για τον συγκεκριμένο πελάτη. Απαιτείται για συστήματα εκτός σύνδεσης. Προσοχή: να χρησιμοποιείται με προσοχή! |
ManagementController_Bulgaria
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για τη φορολογική καταγραφή στη Βουλγαρία.
| Τερματικό σημείο | Τύπος | Περιγραφή |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Αποστέλλει εντολή κλεισίματος (Z) στον φορολογικό εκτυπωτή. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Αποστέλλει εντολή συγχρονισμού ώρας (L) στον φορολογικό εκτυπωτή. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/KLEN | R |
Αυτή η λειτουργία μπορεί να χρησιμοποιηθεί για τη δημιουργία της λεγόμενης αναφοράς KLEN. (από την έκδοση v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Αυτή η συνάρτηση χρησιμοποιείται για την εκτύπωση
(από την έκδοση v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Αυτή η συνάρτηση χρησιμοποιείται για την εκτύπωση μιας λεγόμενης αναφοράς BLOCK. (από την έκδοση v1.8.3) |
ManagementController_Denmark
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για τη δανική φορολογική καταγραφή.
| Τερματικό σημείο | Τύπος | Περιγραφή |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
Εξάγει τη μορφή SAF-T της Δανίας στο δεδομένο stream. |
ManagementController_France
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για τη γαλλική φορολογική καταγραφή.
| Τερματικό σημείο | Τύπος | Περιγραφή |
|
GET
/api/v1/management/france/ eventlog/{clientId} |
M |
Επιστρέφει όλες τις καταχωρήσεις του αρχείου καταγραφής ελέγχου που ζητήθηκαν, ταξινομημένες κατά ημερομηνία. |
|
GET
/api/v1/management/france/ archive/{clientId} |
M |
Επιστρέφει τα τοπικά αποθηκευμένα αρχεία προς κλείσιμο. |
|
POST
/api/v1/management/france/ archive/{clientId}/verify |
M |
Μέθοδος για την επαλήθευση του γαλλικού αρχείου. |
ManagementController_Germany
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για τη γερμανική φορολογική καταχώριση.
| Τερματικό σημείο | Τύπος | Περιγραφή |
| GET /api/v1/management/germany/TSE | R |
Επιστρέφει έναν πίνακα με τις συνδεδεμένες τοπικές συσκευές TSE και την κατάστασή τους. |
|
POST
/api/v1/management/germany/ TSE/{TseSerial}/selftest |
R |
Εκτελεί μια σύγχρονη αυτοδιάγνωση για το συγκεκριμένο ταμείο στο TSE (το ταμείο είναι προαιρετικό). |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/connectTest |
R |
Πραγματοποιεί δοκιμαστική σύνδεση με το συγκεκριμένο TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/listClients |
O |
Επιστρέφει όλους τους πελάτες που αναφέρονται στο TSE του συγκεκριμένου πελάτη. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/status |
R |
Επιστρέφει την κατάσταση του TSE. Εάν δεν εντοπιστεί κανένα φορολογικό module, επιστρέφεται η κατάσταση RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/updateTime |
M |
Ενημερώνει την ώρα στο TSE σύμφωνα με την πραγματική ώρα του υπολογιστή. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/tar |
O |
Εξάγει τα αρχεία tar από το κύριο TSE. Απαιτείται για συστήματα εκτός σύνδεσης. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Εξάγει την ταξινόμηση (DSFinV-K export) και την επιστρέφει ως αρχείο λήψης (μορφή αρχείου zip). Απαιτείται για συστήματα εκτός σύνδεσης. |
|
GET /api/v1/management/germany/ {clientId}/TSE/listTransactions |
R |
Επιστρέφει όλες τις ενεργές (ξεκινήσες) συναλλαγές στο TSE. Συνιστάται για την παρακολούθηση των ανοιχτών συναλλαγών (όλες οι συναλλαγές που έχουν ξεκινήσει πρέπει να αποθηκευτούν ή να ακυρωθούν). |
| DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions | O |
Ακυρώνει τις ενεργές (ξεκινήσες) συναλλαγές στο TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures/count |
O |
Επιστρέφει τον αριθμό των συναλλαγών εκτός σύνδεσης (= συναλλαγές που δεν έχουν σταλεί στο TSE λόγω εκτός σύνδεσης TSE – βλάβη, μη διαθεσιμότητα). |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Επιστρέφει όλες τις ανοιχτές υπογραφές εκτός σύνδεσης που έχουν αποθηκευτεί για το συγκεκριμένο TSE. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Επεξεργασία ανοιχτών υπογραφών εκτός σύνδεσης. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/replace |
R |
Αντικαθιστά ένα τρέχον TSE για τον συγκεκριμένο πελάτη με ένα νέο (για παράδειγμα, εάν το παλιό TSE έχει υποστεί βλάβη ή το πιστοποιητικό έχει λήξει). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/selftest |
R |
Εκτελεί μια σύγχρονη αυτοδιάγνωση για το συγκεκριμένο ταμειακό μηχάνημα στο TSE (το ταμειακό μηχάνημα είναι προαιρετικό). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/updateFirmware |
R |
Ενημερώνει το υλικολογισμικό στη συσκευή SWISSBIT HARDWARE TSE. |
ManagementController_Spain
Σύντομη περιγραφή: Λειτουργίες διαχείρισης για την ισπανική φορολογική καταγραφή.
| Τερματικό σημείο | Τύπος | Περιγραφή |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI |
R |
Επιστρέφει τα αποθηκευμένα αρχεία TicketBAI (αρχεία αποστολής, αρχεία απαντήσεων, αρχεία σφαλμάτων) ως αρχείο zip. |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI/{DocumentNumber} |
R |
Επιστρέφει τα αποθηκευμένα αρχεία TicketBAI για τον αριθμό εγγράφου που ζητήθηκε (αρχεία αποστολής, αρχεία απαντήσεων, αρχεία σφαλμάτων) ως αρχείο zip. |
Αποδείξεις
Σύντομη περιγραφή: Χρησιμοποιείται για την αποστολή ψηφιακών αποδείξεων στο RetailForce Cloud μέσω του middleware.
Τα σημεία τερματισμού σε αυτήν την ενότητα χρησιμοποιούνται για την αποστολή ψηφιακών αποδείξεων στο σύστημα Cloud (απαιτούνται άδειες χρήσης ψηφιακών αποδείξεων για τη χρήση αυτής της υπηρεσίας!).
| Τερματικό | Τύπος | Περιγραφή |
| POST /api/v1/receipts/{clientId} | O/M |
Ανεβάζει ένα αρχείο ψηφιακής απόδειξης στο σύστημα Cloud. Εναλλακτική λύση: Χρησιμοποιήστε είτε αυτό είτε το εναλλακτικό τελικό σημείο εντός αυτής της ενότητας για την αποστολή δεδομένων ψηφιακών αποδείξεων. |
|
POST
/api/v1/receipts/ {clientId}/{DocumentGuid} |
O/M |
Ανεβάζει ένα ψηφιακό αρχείο στο σύστημα Cloud. Χρησιμοποιώντας Metadata φορολογικής καταχώρησης. Εναλλακτική λύση: Χρησιμοποιήστε είτε αυτό είτε το εναλλακτικό endpoint εντός αυτής της ενότητας για την αποστολή δεδομένων ψηφιακών αποδείξεων. |
Συναλλαγές
Σύντομη περιγραφή: χρησιμοποιείται για την αποστολή εγγράφων στο middleware στο πλαίσιο της φορολογικής καταγραφής.
| Τερματικό | Τύπος | Περιγραφή |
| PUT /api/v1/transactions/createDocument | M |
Δημιουργεί ένα έγγραφο στη μονάδα φορολογικής καταχώρισης. Αυτή η μέθοδος δεν δημιουργεί το ίδιο το έγγραφο, αλλά απλώς ξεκινά τη διαδικασία, για παράδειγμα στο TSE. |
| POST /api/v1/transactions/storeDocument | M |
Αποθηκεύει ένα έγγραφο στη μονάδα φορολογικής καταχώρησης. |
| POST /api/v1/transactions/cancelDocument | M |
Ακυρώνει ένα έγγραφο στη μονάδα φορολογικής καταχώρησης. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid} |
M* |
Μέθοδος για την αποθήκευση του αριθμού επανεκτυπώσεων ενός εγγράφου χρησιμοποιώντας το αποθηκευμένο έγγραφο (αναφορά: DocumentGuid). Εναλλακτικά: χρησιμοποιήστε την εντολή PUT /api/v1/transactions/reprintDocument |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Μέθοδος αποθήκευσης του αριθμού επανεκτυπώσεων ενός εγγράφου μέσω της εκ νέου αποστολής του εγγράφου. Ο χρήστης του μεταφερόμενου εγγράφου πρέπει να είναι ο χρήστης που πραγματοποιεί την επανεκτύπωση (όχι ο χρήστης του αρχικού εγγράφου). Εναλλακτική λύση: εναλλακτικά, χρησιμοποιήστε PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Επαναφέρει ένα έγγραφο (μετατρέπει όλες τις τιμές σε αρνητικές). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Επαληθεύει το έγγραφο και επιστρέφει όλα τα σφάλματα επαλήθευσης (και κενή λίστα αν δεν υπάρχει σφάλμα επαλήθευσης). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Αποστολή του εγγράφου σε μορφή JSON στην υπηρεσία για επικύρωση. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Επιστρέφει ένα αρχικό έγγραφο για τον συγκεκριμένο πελάτη. Το αρχικό έγγραφο χρησιμοποιείται για την αρχικοποίηση του πελάτη καθώς και της φορολογικής μονάδας (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Εμφάνιση κειμένου στην οθόνη του φορολογικού πελάτη. Υποστηρίζεται μόνο σε χώρες που χρησιμοποιούν φορολογική οθόνη πελάτη. Σε άλλες χώρες, αυτή η κλήση δεν έχει κανένα αποτέλεσμα (αλλά μπορεί να πραγματοποιηθεί). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Ανοίγει το συρτάρι, εφόσον αυτό είναι συνδεδεμένο με τον φορολογικό εκτυπωτή. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Επιστρέφει δεδομένα κωδικού QR ως string κωδικοποιημένη σε βάση 64 από τα δεδομένα. |
| POST /api/v1/transactions/AuditLog | M* |
Προσθέτει ένα αρχείο καταγραφής ελέγχου στον φορολογικό πελάτη. |
| GET /api/v1/transactions/AuditLog/{clientId} | M* |
Επιστρέφει όλες τις εγγραφές ελέγχου που αναζητήθηκαν με βάση τις ημερομηνίες fromDate/tillDate. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
R |
Επιστρέφει το ζητούμενο έγγραφο, εφόσον είναι αποθηκευμένο στον εσωτερικό χώρο αποθήκευσης. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
O |
Επιστρέφει αν το ζητούμενο έγγραφο υπάρχει στον εσωτερικό χώρο αποθήκευσης εγγράφων. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Επιστρέφει το ζητούμενο έγγραφο, εφόσον είναι αποθηκευμένο στην εσωτερική αποθήκη. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Επιστρέφει αν το ζητούμενο έγγραφο υπάρχει στον εσωτερικό χώρο αποθήκευσης εγγράφων. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Επιστρέφει το τελευταίο αποθηκευμένο έγγραφο από το αρχείο εγγράφων. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Επιστρέφει το ζητούμενο έγγραφο, εφόσον είναι αποθηκευμένο στον εσωτερικό χώρο αποθήκευσης. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid}/response |
R |
Επιστρέφει την απάντηση του ζητούμενου εγγράφου, εφόσον αυτό είναι αποθηκευμένο στον εσωτερικό χώρο αποθήκευσης. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId}/response |
O |
Επιστρέφει την απάντηση του ζητούμενου εγγράφου, εφόσον αυτό είναι αποθηκευμένο στον εσωτερικό χώρο αποθήκευσης. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Επιστρέφει το ζητούμενο έγγραφο, εφόσον είναι αποθηκευμένο στον εσωτερικό χώρο αποθήκευσης. |
Αυτό το άρθρο μεταφράστηκε αυτόματα.
Σχόλια
0 σχόλια
Πραγματοποιήστε είσοδο για να αφήσετε ένα σχόλιο.