RetailForce Fiscal Service - Description de l'API

Enregistre le solde d'ouverture pour un état de clôture de caisse. Enregistre uniquement un versement, sans réajuster le solde de caisse.

Alternative : la caisse peut également enregistrer un document : documentType [11] = PayIn.

Enregistre un écart de caisse dans le système de fiscalisation.

Alternative : la caisse peut également enregistrer un document avec BusinessTransactionType [91] = CashDifference.

Enregistre un virement de fonds du système de caisse vers une banque (ou toute autre destination).

Renvoie l’état réel des paiements d’un client spécifique. Celui-ci est calculé sur la base des documents transmis (notamment les tickets de caisse, les retours, les dépôts et les retraits, etc.).

Vérifie l'état réel des paiements pour cette caisse et renvoie une liste des paiements présentant un écart (ou une liste vide s'il n'y a pas d'écart).

Clôture la journée en cours à l'aide d'un relevé de clôture.

La clôture s’effectue sur la base des documents envoyés au client depuis la dernière clôture. Le système de caisse ne reçoit pas de relevé de clôture en retour.

Renvoie le document de fin de journée correspondant à la journée en cours.

Le document renvoyé doit être persisté (storeDocument > documentType 99)

Renvoie la date et l’heure de la dernière clôture pour un client donné (terminal)

Renvoie des informations indiquant si une clôture journalière doit être effectuée ou non sur un terminal donné. (En fonction de RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing).

Crée un nouveau client dans le référentiel de configuration. L'objet de configuration doit être préparé par le système TPV.

La configuration d’un client est nécessaire au fonctionnement du système. Utilisez soit ce point de terminaison, soit :

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

Met à jour une configuration de client créée par le système de caisse dans le magasin de configurations.

Renvoie tous les clients répertoriés dans le référentiel de configuration.

Peut également être utilisé dans le cadre d’une configuration Cloud.

Crée un nouveau client à partir d’une configuration préparée dans le cloud, ou charge un client existant.

La configuration d’un client est requise pour le fonctionnement. Utilisez soit :

• ce point de terminaison, ou
• PUT /api/v1/management/clients, ou
• 
  PUT /api/v1/management/clients/byCloud/ID.

Crée un client en chargeant les données de configuration depuis le Cloud.

Alternative : point de terminaison alternatif aux requêtes PUT /api/v1/management/clients et PUT /api/v1/management/clients/byCloud.

Met à jour la configuration du client en récupérant celle-ci depuis le Cloud.

Cette méthode est utilisée lorsque la configuration préparée dans le Cloud a été mise à jour et doit être téléchargée à nouveau par le client fiscal (mise à jour).

Crée un nouveau client dans la gestion du module fiscal et l’ajoute à la configuration du Cloud.

Le client est créé dans le magasin de configuration local, puis l’objet de configuration est téléchargé vers le système Cloud.

Remarque : le distributor doit être défini dans les données du client et doit être autorisé à créer de nouveaux clients.

Établit la connexion au Cloud pour le client spécifié et charge le module fiscal de confiance dans le cache.

Requis pour les systèmes exploitant les fonctions Cloud.

Opération nécessaire après chaque redémarrage du système de point de vente.

Met à jour la clé de licence actuelle dans la configuration du client fiscal (également sur le disque). Obligatoire si les licences de la configuration Cloud ont été modifiées.

Méthode permettant de démarrer ou d’arrêter le traitement de la file d’attente Cloud (pour tous les clients).

La commande « Stop » interrompt le traitement après finalisation du téléchargement en cours.

La commande « Start » lance immédiatement le traitement de la file d’attente.

Si le traitement de la file d'attente Cloud est arrêté, vous devez le redémarrer, sauf si le service est redémarré (auquel cas le traitement Cloud est réactivé).

Renvoie la configuration d’un client spécifique.

Supprime un client spécifique

Attention : à utiliser avec précaution.

Renvoie l'ID unique du client correspondant aux paramètres demandés.

Différents paramètres peuvent être utilisés pour récupérer l’uniqueClientId.

Renvoie l'ID du consommateur de licence correspondant à l'ID d'entreprise fourni.

Seuls les identifiants « LicenseConsumerId » déjà enregistrés dans le magasin de configuration sont renvoyés.

Vérifie que les informations du client fournies sont conformes à la configuration spécifique au pays requise.

Cette méthode sert à valider une configuration créée par le système de caisse avant d’utiliser /api/v1/management/clients.

La validation de la configuration cloud est assurée par le système Cloud.

Initialise l’unité de fiscalisation (ainsi que, le cas échéant, le matériel et la déclaration éventuelle aux autorités fiscales).

L’initialisation s’effectue via un ticket de démarrage (premier ticket) qui peut soit être interrogé à l’aide du point de terminaison GET /api/v1/transactions/document/
{clientId}/start, soit être créé par le système de caisse.

Permet de migrer un client depuis un autre fournisseur de services de fiscalisation.

Cette opération est utilisée lors du passage d’un autre fournisseur de middleware fiscal à RetailForce

Veuillez noter les systèmes pris en charge.

Permet de migrer un client depuis un autre fournisseur de services de fiscalisation et d'effectuer une importation de fichiers.

Veuillez noter les systèmes pris en charge.

Mise hors service d’un client fiscal (et, le cas échéant, du matériel, ainsi que déclaration éventuelle aux autorités fiscales).

Permet de télécharger un Support Package (fichiers journaux) vers le cloud pour le client indiqué.

Ce point de terminaison est nécessaire pour utiliser la fonction « Télécharger le Support Package » dans le système Cloud.

Effectue une sauvegarde du client dans le fichier indiqué (archivage au format ZIP).

Si le transfert vers le Cloud est activé, le traitement de la file d’attente du Cloud sera interrompu puis relancé (et la file d’attente du Cloud sera réinitialisée).

Attention : si l’instance client n’est pas supprimée, le traitement de la file d’attente Cloud reprendra après la sauvegarde. Si certains fichiers n’existaient pas avant la sauvegarde, ils seront également inclus dans l’archive et risquent d’être téléchargés deux fois en cas de restauration de l’instance client.

Restaure un client (avec l’ensemble de ses données) à partir du fichier ZIP de sauvegarde indiqué.

Crée un nouveau client à partir d’une configuration provenant du Cloud ou charge un client existant.

Crée un nouveau client à partir de la configuration du Cloud ou charge un client existant.

Génère un nouvel ID globalement unique pour le client concerné, ou renvoie un ID existant. De plus, l’émission du « retailForceReceiptId » est activée pour le client concerné.

Enregistre un certificat externe dans le magasin de certificats du module fiscal.

Obligatoire pour les systèmes n’utilisant PAS les fonctions RetailForce Cloud dans les pays soumis à la fiscalisation où des certificats logiciels sont utilisés dans le cadre de la fiscalisation (Slovénie, Croatie, Espagne,…)

Indique si le client demandé dispose de la licence d'accès demandée.

Indique si le client demandé dispose de la licence demandée.

Crée une clé utilisateur AES pour ce client et la renvoie. La clé AES sera également enregistrée dans la configuration du client.

Remarque : la clé utilisateur AES sera créée automatiquement par le client fiscal. Ce point de terminaison n’est nécessaire que si la clé AES doit être créée manuellement.

Renvoie la clé AES du client indiqué.

Exporte toutes les lignes de reçu issues des données de magasin enregistrées dans le journal de collecte des données local (DEP §7 RKSV).

Obligatoire pour les systèmes hors ligne (systèmes n’utilisant PAS l’archivage dans le Cloud des données fiscales).

Exporte toutes les données requises pour le protocole DEP131 (DEP §131 BAO) à partir des données stockées localement.

Renvoie le ticket de caisse initial pour ce client.

Le système de caisse doit être en mesure de fournir le ticket de départ (ticket initial) sur demande lors d’un contrôle fiscal ; si le système de caisse n’a pas enregistré ce ticket, il est possible de le demander via ce point de terminaison.

Renvoie tous les reçus mensuels correspondant à la période demandée.

Le système de caisse doit être en mesure de fournir les reçus mensuels sur demande lors d’un contrôle fiscal ; si le système de point de vente n’a pas enregistré ces documents, ceux-ci peuvent être demandés via ce point de terminaison.

Renvoie tous les dispositifs de signature et indique s’ils sont activés ou non sur FinanzOnline (Fon).

Enregistre le dispositif de signature configuré sur FON (si un dispositif est configuré) ou le dispositif de signature identifié par le numéro de série du certificat (certificateSerial).

Remarque : si vous utilisez les services RetailForce Cloud, les certificats sont automatiquement enregistrés sur le portail FinanzOnline (Fon) (à noter : les identifiants de l’utilisateur du service web de la caisse enregistreuse sont nécessaires !) ; ce point de terminaison n’est nécessaire que si l’enregistrement doit être effectué manuellement.

Désenregistre le dispositif de signature configuré auprès de Fon (si un tel dispositif est configuré) ou le dispositif de signature identifié par certificateSerial.

Attention : à utiliser avec précaution !

Vérifie la validité du dernier document signé dans « DEP » sur FinanzOnline (Fon).

Vérifie la validité du document DEP (code QR) fourni sur Fon.

Indique si la caisse du client en question est activée chez Fon.

Requis pour les systèmes hors ligne.

Enregistrement du système de caisse chez FON pour le client courant.

Requis pour les systèmes hors ligne.

Désenregistrer la caisse enregistreuse chez Fon pour le client concerné.

Requis pour les systèmes hors ligne.

Attention : à utiliser avec précaution.

Envoie la commande de clôture (Z) à l’imprimante fiscale.

Envoie la commande de synchronisation de l'heure (L) à l'imprimante fiscale.

Cette fonction permet de générer ce que l'on appelle un rapport KLEN.

(à partir de la version 1.8.3)

Cette fonction permet d’imprimer

• des rapports détaillés et
• résumés.

(à partir de la version 1.8.3)

Cette fonction permet d’imprimer ce que l’on appelle un rapport BLOCK.

(à partir de la v1.8.3)

Exporte le format SAF-T du Danemark vers le stream indiqué.

Renvoie toutes les entrées du journal d'audit demandées par date.

Renvoie les archives stockées localement en vue de leur clôture.

Méthode permettant de vérifier l’archive française.

Renvoie un tableau des appareils TSE locaux connectés et de leur état.

Exécute un autotest synchrone pour la caisse enregistreuse indiquée sur le TSE (la caisse enregistreuse est facultative).

Effectue un test de connexion vers le TSE spécifié.

Renvoie tous les clients répertoriés sur le TSE du client spécifié.

Renvoie le statut du TSE. Si aucun module fiscal n’est détecté, le statut RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical est renvoyé.

Met à jour l'heure du TSE en fonction de l'heure réelle de l'ordinateur.

Exporte les fichiers tar depuis le TSE principal.

Requis pour les systèmes hors ligne.

Exporte la taxonomie (DSFinV-K export) et la renvoie sous forme de fichier à télécharger (format zip).

Requis pour les systèmes hors ligne.

Renvoie toutes les transactions actives (lancées) sur la plateforme TSE.

Recommandé pour le suivi des transactions en cours (toutes les transactions lancées doivent être enregistrées ou annulées).

Annule les transactions actives (lancées) sur le TSE.

Renvoie le nombre de transactions hors ligne (= transactions qui n’ont pas été envoyées au TSE en raison d’un TSE hors ligne – indisponible).

Renvoie toutes les signatures hors ligne en attente enregistrées pour le TSE actuel.

Traite les signatures hors ligne ouvertes.

Remplace le TSE actuel du client indiqué par un nouveau (par exemple, si l'ancien TSE est endommagé ou si le certificat a expiré).

Exécute un autotest synchrone pour la caisse enregistreuse indiquée sur le TSE (la caisse enregistreuse est facultative).

Met à jour le micrologiciel du périphérique hardware TSE de Swissbit.

Renvoie les fichiers TicketBAI enregistrés (fichiers envoyés, fichiers de réponse, fichiers d’erreur) sous forme d’archive ZIP.

Renvoie les fichiers TicketBAI enregistrés correspondant au numéro de document demandé (fichiers envoyés, fichiers de réponse, fichiers d’erreur) sous forme de fichier zip.

Permet de télécharger un fichier de reçus numériques vers le système Cloud.

Alternative : utilisez soit ce point de terminaison, soit le point de terminaison alternatif présenté dans cette section pour envoyer des données de reçus numériques.

Permet de télécharger un fichier numérique vers le système Cloud. Utilisation des Metadata de fiscalisation.

Alternative : utilisez soit ce point de terminaison, soit le point de terminaison alternatif présenté dans cette section pour envoyer des données de reçus numériques.

Crée un document au niveau de l'unité de fiscalisation. Cette méthode ne crée pas le document en soi ; elle se contente de lancer le processus, par exemple sur la TSE.

Enregistre un document au sein de l'unité de fiscalisation.

Annule un document au niveau de l'unité de fiscalisation.

Méthode permettant d’enregistrer le nombre de réimpressions d’un document à partir du document enregistré (référence : DocumentGuid).

Alternative : vous pouvez également utiliser PUT /api/v1/transactions/reprintDocument

Méthode permettant d'enregistrer le nombre de réimpressions d'un document en renvoyant ce dernier. L'utilisateur du document transféré doit être l'utilisateur qui effectue la réimpression (et non l'utilisateur du document d'origine).

Alternative : vous pouvez également utiliser la méthode PUT /api/v1/transactions/reprintDocument/
{clientId}/{DocumentGuid}.

Annule un document (rend toutes les valeurs négatives).

Valide le document et renvoie toutes les erreurs de validation (ainsi qu’une liste vide s’il n’y a pas d’erreur de validation).

Transmet le document au format JSON au service de validation.

Renvoie un document de démarrage pour le client indiqué.

Le document de démarrage sert à initialiser le client ainsi que l'unité fiscale (/api/v1/management/clients/initialize).

Affiche le texte sur l’écran client comptable.

Fonctionnalité prise en charge uniquement dans les pays équipés d’un affichage client fiscal. Dans les autres pays, cet appel n’a aucun effet (mais peut être effectué).

Ouvre un tiroir si celui-ci est connecté à une imprimante fiscale.

Renvoie les données du code QR sous forme de chaîne encodée en base 64 à partir des données fournies.

Ajoute un journal d'audit au client fiscal.

Renvoie tous les enregistrements d'audit correspondant aux dates « fromDate » et « tillDate ».

Renvoie le document demandé s’il est stocké dans le stockage interne.

Indique si le document demandé existe dans le magasin de documents interne.

Renvoie le document demandé s’il est stocké dans le stockage interne.

Indique si le document demandé existe dans le magasin de documents interne.

Renvoie le dernier document enregistré dans le référentiel de documents.

Renvoie le document demandé s’il est stocké dans le stockage interne.

Renvoie la réponse relative au document demandé s’il est stocké dans le stockage interne.

Renvoie la réponse relative au document demandé s’il est stocké dans la mémoire interne.

Renvoie le document demandé s’il est stocké dans la mémoire interne.