RetailForce Fiscal Service - Descrizione dell’API

Registra le giacenze iniziali per un rendiconto di chiusura del registratore di cassa. Registra solo un versamento, senza aggiornare le giacenze di cassa.

Alternativa: in alternativa, il registratore di cassa può registrare un documento: documentType [11] = PayIn.

Registra una differenza di cassa nel sistema di fiscalizzazione.

Alternativa: in alternativa, il registratore di cassa può registrare un documento con BusinessTransactionType [91] = CashDifference.

Registra un trasferimento di denaro dal sistema del registratore di cassa alla banca (o a qualsiasi altra destinazione).

Restituisce lo stato attuale dei pagamenti di un client specifico. Tale dato viene calcolato sulla base dei documenti trasmessi (oltre alle ricevute di vendita e di reso, ai versamenti e ai prelievi, ecc.).

Verifica lo stato effettivo dei pagamenti relativi a questo registratore di cassa e restituisce un elenco dei pagamenti con differenza (oppure un elenco vuoto se non vi è alcuna differenza).

Chiude la giornata corrente con un rendiconto di chiusura.

La chiusura viene effettuata sulla base dei documenti inviati al client dall’ultima chiusura. Il sistema del registratore di cassa non riceve in restituzione alcun rendiconto di chiusura.

Restituisce il documento di fine giornata relativo alla giornata corrente.

Il documento restituito deve essere archiviato (storeDocument > documentType 99).

Restituisce la data e l’ora dell’ultima chiusura relativa a un cliente specifico (terminal)

Restituisce informazioni relative alla necessità di effettuare una chiusura giornaliera su un determinato terminal, in funzione dei parametri definiti in RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing.

Crea un nuovo client nell'archivio delle configurazioni. L'oggetto di configurazione deve essere preparato dal sistema POS.

La configurazione di un client è necessaria per il funzionamento. Utilizzi questo endpoint oppure:

• PUT /api/v1/management/clients, oppure
• 
  PUT /api/v1/management/clients/byCloud/ID.

Aggiorna una configurazione del client creata dal sistema di cassa nell’archivio delle configurazioni.

Restituisce tutti i client elencati nell'archivio delle configurazioni.

Può essere utilizzato anche in caso di configurazione Cloud.

Crea un nuovo client con una configurazione preparata nella Cloud / oppure carica un client esistente.

Per il funzionamento è necessaria la configurazione di un client. Utilizzi uno dei seguenti:

• questo endpoint oppure
• PUT /api/v1/management/clients, oppure
• 
  PUT /api/v1/management/clients/byCloud/ID.

Crea un client caricando i dati di configurazione dal Cloud.

Alternativa: endpoint alternativo a PUT /api/v1/management/clients e PUT /api/v1/management/clients/byCloud.

Aggiorna la configurazione del client recuperandola dal Cloud.

Viene utilizzato quando la configurazione preparata nel Cloud è stata aggiornata e deve essere scaricata nuovamente dal client fiscale (aggiornamento).

Crea un nuovo client nella gestione del modulo fiscale e lo aggiunge alla configurazione del Cloud.

Il client viene creato nell’archivio di configurazione locale e l’oggetto di configurazione viene quindi caricato sul sistema Cloud.

Nota: il distributor deve essere specificato nei dati del client e deve essere autorizzato a creare nuovi clients.

Stabilisce la connessione Cloud del client specifico e carica il modulo fiscale attendibile nella cache.

Obbligatorio per i sistemi che utilizzano le funzioni Cloud.

Operazione necessaria dopo ogni riavvio del sistema POS.

Aggiorna la chiave di licenza corrente nella configurazione del client fiscale (anche su disco). Obbligatorio se le licenze nella configurazione Cloud sono state modificate.

Metodo per avviare o interrompere l’elaborazione della coda Cloud (per tutti i client).

Il comando «Stop» interrompe l’elaborazione al termine dell’upload in corso.

Il comando "Start" avvia immediatamente l’elaborazione della coda.

Se l’elaborazione della coda Cloud viene interrotta, è necessario riavviarla a meno che non venga riavviato il servizio (nel qual caso l’elaborazione Cloud viene riattivata automaticamente).

Restituisce la configurazione di un client specifico.

Elimina un client specifico

Attenzione: utilizzare con cautela!

Restituisce l'ID univoco del cliente corrispondente ai parametri richiesti.

È possibile utilizzare diversi parametri per richiedere l’uniqueClientId.

Restituisce l’ID del consumatore della licenza per l’identificativo aziendale specificato.

Vengono restituiti solo gli LicenseConsumerId già memorizzati nell’archivio di configurazione.

Verifica la validità delle informazioni relative al client specificato per garantire la conformità alla configurazione specifica del Paese.

Viene utilizzato per convalidare una configurazione creata dal sistema di registrazione delle vendite prima di utilizzare /api/v1/management/clients.

La convalida della configurazione cloud è fornita dal sistema cloud.

Inizializza l’unità di fiscalizzazione (e l’eventuale hardware, nonché l’eventuale dichiarazione alle autorità fiscali).

L’inizializzazione avviene tramite lo scontrino di avvio (scontrino iniziale), che può essere richiesto utilizzando l’endpoint GET /api/v1/transactions/document/
{clientId}/start oppure generato dal sistema di cassa.

Esegue la migrazione di un client da un altro fornitore di servizi di fiscalizzazione.

Viene utilizzato in caso di passaggio da un altro fornitore di middleware fiscale a RetailForce.

Si prega di prendere nota dei sistemi supportati.

Esegue la migrazione di un client da un altro fornitore di servizi di fiscalizzazione ed effettua l’importazione di un file.

Si prega di prendere nota dei sistemi supportati.

Disattivazione del client fiscalizzato (eventualmente con relativo hardware e eventuale dichiarazione alle autorità fiscali).

Carica un Support Package (file di log) sul Cloud per il client specificato.

Questo endpoint è necessario per poter utilizzare la funzione “Carica Support Package” nel sistema Cloud.

Esegue il backup del client con il nome file specificato (archivio in formato zip).

Se è in corso un caricamento sul Cloud, l’elaborazione della coda Cloud verrà interrotta e riavviata (e la coda Cloud verrà reinizializzata).

Attenzione: si prega di notare che, se il client non viene rimosso, l’elaborazione della coda Cloud riprenderà dopo il backup. Se alcuni file non erano presenti prima del backup, questi saranno inclusi nel backup e potrebbero essere caricati due volte nel caso in cui il client venga ripristinato.

Ripristina un client (con tutti i dati) dal file ZIP di backup specificato.

Crea un nuovo client con la configurazione dal Cloud o carica un client esistente.

Crea un nuovo client con la configurazione proveniente dal Cloud o carica un client esistente.

Genera un nuovo ID univoco a livello globale per il rispettivo client oppure restituisce quello esistente. Inoltre, per il rispettivo client viene attivata l’emissione del retailForceReceiptId.

Archivia un certificato esterno nell’archivio certificati del modulo fiscale.

Obbligatorio per i sistemi che NON utilizzano le funzioni RetailForce Cloud nei paesi soggetti a fiscalizzazione in cui vengono utilizzati certificati software nell’ambito della fiscalizzazione (Slovenia, Croazia, Spagna,…)

Restituisce se il client richiesto dispone della licenza di accesso richiesta.

Indica se il client specificato dispone della licenza richiesta.

Crea una chiave utente AES per questo client e la restituisce. La chiave AES verrà inoltre memorizzata nella configurazione del client.

Nota: la chiave utente AES viene generata automaticamente dal client fiscale. L’endpoint è necessario solo se la chiave AES deve essere creata manualmente.

Restituisce la chiave AES per il client specificato.

Esporta tutte le righe delle ricevute contenute nei dati di archivio del Registro di raccolta dati locale (DEP §7 RKSV).

Necessario per i sistemi offline (sistemi che NON utilizzano l’archiviazione Cloud dei dati fiscali).

Esporta tutti i dati richiesti per il protocollo DEP131 (DEP §131 BAO) dai dati memorizzati localmente.

Restituisce la ricevuta iniziale relativa a questo client.

Il sistema di cassa deve essere in grado di fornire la ricevuta iniziale (ricevuta di avvio) su richiesta durante una verifica fiscale; qualora il sistema POS non abbia memorizzato la ricevuta iniziale, è possibile richiederla tramite questo endpoint.

Restituisce tutte le ricevute mensili relative all’intervallo di date richiesto.

Il sistema di cassa deve essere in grado di fornire le ricevute mensili su richiesta durante una verifica fiscale; qualora il sistema POS non abbia archiviato tali documenti, è possibile richiederli tramite questo endpoint.

Restituisce tutti i dispositivi di firma e indica se sono attivati su FinanzOnline (Fon) oppure no.

Registra il dispositivo di firma configurato su FON (se ne è stato configurato uno) oppure il dispositivo di firma identificato tramite certificateSerial.

Nota: se si utilizzano i servizi RetailForce Cloud, i certificati vengono registrati automaticamente nel portale FinanzOnline (Fon) (à sono necessarie le credenziali dell’utente del servizio web del registratore di cassa!); l’endpoint è necessario solo se la registrazione deve essere effettuata manualmente.

Annulla la registrazione del dispositivo di firma configurato su FON (se ne è stato configurato uno) o del dispositivo di firma identificato tramite certificateSerial.

Attenzione: utilizzare con cautela!

Convalida l’ultimo documento firmato in DEP su FinanzOnline (Fon).

Convalida il documento DEP specificato (codice QR) su Fon.

Indica se il registratore di cassa del cliente in questione è attivato su Fon.

Necessario per i sistemi offline.

Registrazione del sistema di cassa presso FON per il client specificato.

Obbligatorio per i sistemi offline.

Cancellazione della registrazione del sistema di cassa presso Fon per il client in questione.

Necessario per i sistemi offline.

Attenzione: utilizzare con cautela.

Invia il comando di chiusura (Z) alla stampante fiscale.

Invia il comando di sincronizzazione dell’ora (L) alla stampante fiscale.

Questa funzione può essere utilizzata per generare il cosiddetto rapporto KLEN.

(a partire dalla versione 1.8.3)

Questa funzione viene utilizzata per stampare

• rapporti dettagliati e
• sintetici.

(a partire dalla versione 1.8.3)

Questa funzione viene utilizzata per generare un cosiddetto rapporto BLOCK.

(a partire dalla v1.8.3)

Esporta il formato SAF-T della Danimarca nel stream specificato.

Restituisce tutte le voci del registro di audit richieste in base alla data.

Restituisce gli archivi memorizzati localmente da chiudere.

Metodo per la verifica dell’archivio francese.

Restituisce un array dei dispositivi TSE locali collegati e del loro stato.

Esegue un autotest sincrono per il registratore di cassa specificato sul TSE (il registratore di cassa è facoltativo).

Esegue un test di connessione al TSE specificato.

Restituisce tutti i clienti presenti nel TSE del cliente specificato.

Restituisce lo stato del TSE. Se non viene individuato alcun modulo fiscale, viene restituito lo stato RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical.

Aggiorna l’ora sul TSE all’ora effettiva del computer.

Esporta i file tar dal TSE primario.

Necessario per i sistemi offline.

Esporta la tassonomia (DSFinV-K export) e la restituisce come file scaricabile (formato zip).

Necessario per i sistemi offline.

Restituisce tutte le transazioni attive (avviate) sul TSE.

Si consiglia di tenere traccia delle transazioni aperte (tutte le transazioni avviate devono essere archiviate o annullate).

Annulla le transazioni attive (avviate) sul TSE.

Restituisce il numero di transazioni offline (= transazioni che non sono state inviate al TSE a causa di un TSE offline – guasto o non disponibile).

Restituisce tutte le firme offline aperte memorizzate per il TSE attuale.

Elabora le firme offline aperte.

Sostituisce un TSE attuale per il client specificato con uno nuovo (ad esempio, se il vecchio TSE è danneggiato o il certificato è scaduto).

Esegue un autotest sincrono per il registratore di cassa specificato sul TSE (il registratore di cassa è facoltativo).

Aggiorna il firmware sul dispositivo SWISSBIT HARDWARE TSE.

Restituisce i file TicketBAI memorizzati (file inviati, file di risposta, file di errore) in un archivio zip.

Restituisce i file TicketBAI archiviati relativi al numero di documento specificato (file inviati, file di risposta, file di errore) in un archivio zip.

Carica un file di ricevuta digitale sul sistema Cloud.

Alternativa: utilizzare questo Endpoint o quello alternativo riportato in questa sezione per inviare i dati relativi alle ricevute digitali.

Carica un file digitale sul sistema Cloud. Utilizzando i Metadata di fiscalizzazione.

Alternativa: utilizzare questo endpoint o quello alternativo presente in questa sezione per inviare i dati relativi alle ricevute digitali.

Crea un documento a livello di unità di fiscalizzazione. Questo metodo non genera il documento in sé, ma avvia il processo, ad esempio sul TSE.

Archivia un documento nell’unità di fiscalizzazione.

Annulla un documento nell'unità di fiscalizzazione.

Metodo per memorizzare il conteggio delle ristampe di un documento utilizzando il documento archiviato (riferimento: DocumentGuid).

Alternativa: in alternativa, utilizzare PUT /api/v1/transactions/reprintDocument

Metodo per memorizzare il conteggio delle ristampe di un documento inviando nuovamente il documento stesso. L’utente del documento trasferito deve essere l’utente che effettua la ristampa (non l’utente del documento originale).

Alternativa: in alternativa, utilizzare PUT /api/v1/transactions/reprintDocument/
{clientId}/{DocumentGuid}.

Annulla un documento (trasforma tutti i valori in negativi).

Convalida il documento e restituisce tutti gli errori di convalida (o un elenco vuoto se non sono presenti errori).

Invia il documento in formato JSON al servizio per la convalida del documento.

Restituisce un documento iniziale per il client specificato.

Il documento di avvio viene utilizzato per inizializzare sia il client che l’unità fiscale (/api/v1/management/clients/initialize).

Visualizza il testo sul display fiscale del cliente.

Supportato esclusivamente nei Paesi in cui è in uso il display fiscale per i clienti. Negli altri Paesi questa chiamata non ha alcun effetto (ma può essere effettuata).

Apre il cassetto, qualora questo sia collegato alla stampante fiscale.

Restituisce i dati del codice QR sotto forma di stringa codificata in base 64 a partire dai dati forniti.

Aggiunge un record di audit al client fiscale.

Restituisce tutti i record di audit selezionati in base ai parametri fromDate/tillDate.

Restituisce il documento richiesto, qualora sia memorizzato nell’archivio interno.

Indica se il documento richiesto è presente nell’archivio interno dei documenti.

Restituisce il documento richiesto, se presente nell’archivio interno.

Indica se il documento richiesto è presente nell’archivio interno dei documenti.

Restituisce l’ultimo documento archiviato nell’archivio dei documenti.

Restituisce il documento richiesto, qualora sia memorizzato nell’archivio interno.

Restituisce la risposta relativa al documento richiesto, qualora sia memorizzata nell’archivio interno.

Restituisce la risposta relativa al documento richiesto, qualora sia memorizzata nell’archivio interno.

Restituisce il documento richiesto, qualora sia memorizzato nell’archivio interno.