Validateur VIES du module complémentaire Google Sheets™

Validateur VIES du module complémentaire Google Sheets™

API Google SheetsLe module complémentaire Google Sheets™ vous permet de vérifier rapidement et automatiquement le statut actuel des entités (entrepreneurs) à l'aide de la feuille de calcul Google Sheets™. Système VIES.

Cette documentation contient des instructions sur la manière d'intégrer l'application Google Sheets™ au système API VIES.

 

 

Installation et configuration

Installation

Après avoir accédé au site web Google Workspace Marketplace https://workspace.google.com/marketplace/app/vies_api_eu_vat_validation/1043052728267, clique le Install bouton.

installation du module complémentaire Google Sheets API Vies

Sélection du compte Google pour lequel le module complémentaire VIES Validator pour Google Sheets doit être installé et disponible :

installer le module complémentaire Google Sheets API Vies

Sur l'écran suivant, vous pouvez lire le Politique de confidentialité et les applicables Conditions d'utilisationainsi que l'étendue des données que nous traiterons. Pour passer à l'étape suivante de l'installation, appuyez sur Continue bouton.

Autorisations d'installation du module complémentaire Google Sheets de l'API Vies

Vérifiez que vous avez accordé les autorisations nécessaires au bon fonctionnement de l'extension et appuyez sur le bouton. Allow bouton:

Autorisations d'installation du module complémentaire Google Sheets API Vies

Le module complémentaire de validation VIES a été installé avec succès sur votre compte et sera disponible après le lancement de Google Sheets dans l'onglet Extensions. Pour continuer, veuillez cliquer Next:

Extension d'installation du module complémentaire Google Sheets API Vies

L'écran final du programme d'installation vous invitera à configurer l'extension. Cliquez sur «Complete additional setup nowLe lien ouvrira une nouvelle fenêtre de navigateur affichant la page de documentation actuelle. Cliquez sur le Done Cliquez sur le bouton et commencez à configurer l'extension comme décrit dans la section Configuration.

Module complémentaire Google Sheets API Vies installé

Configuration

Après l'installation, le plugin est défini par défaut sur l'environnement de test (plus de détails sur Tester l'API Pour pouvoir appeler des fonctions en production, il est nécessaire de configurer l'accès au site viesapi.eu une fois. Pour cela, accédez à une feuille de calcul Google Sheets™ et exécutez la fonction :

=VIESAPI_CONNECT_PRODUCTION("identifier";"key")

où les paramètres de la fonction sont :

  • identifier – le paramètre doit contenir l'identifiant (ID) généré sur le compte sur le site viesapi.eu,
  • key – le paramètre doit contenir la Clé générée sur le compte sur le site viesapi.eu.

Les détails sur la génération de l'identifiant et de la clé sont décrits sur le Documentation site Internet.

Afin de vérifier l'exactitude de la connexion avec une API donnée (test ou production), la fonction suivante doit être exécutée :

=VIESAPI_CONNECT_STATUS()

Qui peut renvoyer des valeurs :

  • SUCCESS: Production – si le complément est correctement configuré pour fonctionner avec l'environnement de production,
  • SUCCESS: Test – si le complément est correctement configuré pour fonctionner avec le environnement d'essai,
  • ERROR: Connection requires configuration – en cas de mauvaise configuration.

Si vous préférez une configuration avec barre latérale, cliquez sur Extensions onglet, puis sélectionnez VIES API - EU VAT Validation et enfin cliquez Show sidebar pour activer la barre latérale :

barre latérale de configuration de l'extension Google Sheets API Vies

Ensuite, allez au ID and Key onglet pour entrer ID et Key dans les champs de texte appropriés, qui sont disponibles après s'être connecté à votre compte API VIES : https://viesapi.eu/sign-in/

ID et clé de configuration du module complémentaire Google Sheets de l'API Vies

Usage

Avant d'utiliser le module complémentaire, vous devez vous familiariser avec les spécificités de son fonctionnement :

  • Tous les appels de fonction sont exécutés en mode asynchrone, ce qui ne provoque pas l'effet de gel (aucune réponse) de l'application Google Sheets™.
  • L'ajout (insertion) d'une ligne ou d'une colonne n'actualise pas tous les appels de fonction définis.
  • La copie ou le déplacement de cellules contenant des fonctions n'actualise pas les appels de fonction définis.
  • La suppression d'une ligne ou d'une colonne actualisera tous les appels de fonction définis et enverra les requêtes à viesApi.eu (uniquement avec les paramètres par défaut de Google Sheets™). La modification des paramètres par défaut est décrite dans le chapitre « Configuration ».
  • Attention ! Il est déconseillé d'exécuter plus de 500 requêtes parallèles, car Google Sheets™ rencontre des difficultés à gérer un grand nombre d'appels asynchrones.

Obtenir les données de l'entreprise de VIES

VIESAPI_VIES_DATA() – La fonction récupère toutes les données d'entreprise disponibles directement à partir du système VIES. Les paramètres doivent être :

  • Numéro d'identification fiscale européen (TVA UE),
  • (optionnel) FORMAT des données retournées (voir : Balises pouvant être utilisées comme FORMAT paramètre).

=VIESAPI_VIES_DATA("PL7171642051")

Si vous n'avez besoin que du statut d'entreprise dans VIES, veuillez utiliser la requête suivante :

=VIESAPI_VIES_DATA("PL7171642051";"$(Valid)")

Si le statut renvoyé est Oui, cela signifie que l'entreprise a un numéro de TVA intracommunautaire valide.

Balises disponibles dans le VIESAPI_VIES_DATA fonction qui peut être utilisée comme FORMAT paramètre:

  • $(UID) – identifiant unique généré par le service viesApi.eu
  • $(CountryCode) – indicatif du pays
  • $(VATNumber) – numéro de TVA européen
  • $(Valid) – réponse du service VIES, informant du statut actuel de TVA UE de l’entreprise contrôlée (Yes/No)
  • $(TraderName) – nom d’enregistrement de l’entreprise
  • $(TraderCompanyType) – type d’entreprise
  • $(TraderAddress) – adresse du commerçant où la société est enregistrée
  • $(ID) – identifiant unique généré par le système VIES (numéro de consultation)
  • $(Date) – la date à laquelle la réponse a été générée
  • $(Source) – la source des données

Format par défaut : "$(TraderName), $(TraderAddress)"

Si la chaîne "JSON" est donné comme le FORMAT paramètre, la fonction renverra le résultat complet sous la forme d'une chaîne JSON, qui peut être librement analysée et traitée ultérieurement :

=VIESAPI_VIES_DATA("PL7171642051";"JSON")

Obtenez des données d'entreprise analysées à partir de VIES

VIESAPI_VIES_DATA_PARSED() – La fonction récupère toutes les données d'entreprise disponibles directement depuis le système VIES. De plus, le nom et l'adresse de l'entreprise sont renvoyés sous forme de données analysées, divisées en attributs distincts. Les paramètres doivent être :

  • Numéro d'identification fiscale européen (TVA UE),
  • (optionnel) FORMAT des données retournées (voir : Balises pouvant être utilisées comme FORMAT paramètre).

=VIESAPI_VIES_DATA_PARSED("PL7171642051")

Si vous n'avez besoin que du statut d'entreprise dans VIES, veuillez utiliser la requête suivante :

=VIESAPI_VIES_DATA_PARSED("PL7171642051";"$(Valid)")

Si le statut renvoyé est Oui, cela signifie que l'entreprise a un numéro de TVA intracommunautaire valide.

Balises disponibles dans le VIESAPI_VIES_DATA_PARSED fonction qui peut être utilisée comme FORMAT paramètre:

  • $(UID) – identifiant unique généré par le service viesApi.eu
  • $(CountryCode) – indicatif du pays
  • $(VATNumber) – numéro de TVA européen
  • $(Valid) – réponse du service VIES, informant du statut actuel de TVA UE de l’entreprise contrôlée (Yes/No)
  • $(TraderName) – nom d’enregistrement de l’entreprise
  • $(TraderNameComponents.Name) – nom de l'entreprise de traderName (sans forme juridique)
  • $(TraderNameComponents.LegalForm) – nom de la forme juridique extrait de traderName (sans raison sociale)
  • $(TraderNameComponents.LegalFormCanonicalId) – identifiant du dictionnaire de la forme juridique
  • $(TraderNameComponents.LegalFormCanonicalName) – nom du dictionnaire de la forme juridique
  • $(TraderCompanyType) – type d’entreprise
  • $(TraderAddress) – adresse du commerçant où la société est enregistrée
  • $(TraderAddressComponents.Country) – nom du pays commerçant dans sa langue nationale
  • $(TraderAddressComponents.PostalCode) – code postal de l'adresse du commerçant
  • $(TraderAddressComponents.City) – ville de l'adresse du commerçant
  • $(TraderAddressComponents.Street) – rue de l'adresse du commerçant
  • $(TraderAddressComponents.StreetNumber) – numéro de rue du bâtiment de l'adresse du commerçant
  • $(TraderAddressComponents.HouseNumber) – numéro d'appartement/bureau de l'adresse du commerçant
  • $(TraderAddressComponents.Other) – autres détails d’adresse (nom de la zone, nom du bâtiment, numéro d’étage, etc.)
  • $(ID) – identifiant unique généré par le système VIES (numéro de consultation)
  • $(Date) – la date à laquelle la réponse a été générée
  • $(Source) – la source des données

Format par défaut : "$(TraderName), $(TraderAddress)"

Si la chaîne "JSON" est donné comme le FORMAT paramètre, la fonction renverra le résultat complet sous la forme d'une chaîne JSON, qui peut être librement analysée et traitée ultérieurement :

=VIESAPI_VIES_DATA_PARSED("PL7171642051";"JSON")

Vérification de l'état du compte utilisateur (gratuit)

VIESAPI_ACCOUNT_STATUS() – La fonction renvoie des informations de base sur le plan actuellement utilisé par l'utilisateur. Les paramètres doivent être :

  • (optionnel) FORMAT des données retournées (voir : Balises pouvant être utilisées comme FORMAT paramètre)

=VIESAPI_ACCOUNT_STATUS()

Attention! L'appel de la fonction n'augmente pas le nombre de requêtes effectuées.

Les balises disponibles dans le VIESAPI_ACCOUNT_STATUS fonction peut être utilisée comme FORMAT paramètre:

  • $(UID) – identifiant unique généré par le service viesApi.eu
  • $(BillingPlanName) – nom du plan actuel
  • $(SubscriptionPrice) – frais d’abonnement mensuels
  • $(ItemPrice) – coût d’une seule requête hors forfait
  • $(ItemPriceStatus) – coût par requête – TVA/VIES/Statut d'activité de l'entreprise
  • $(ItemPriceParsed) – coût par requête – TVA/VIES/Statut d'activité de l'entreprise avec données analysées
  • $(Limit) – nombre maximal de requêtes dans le plan
  • $(RequestDelay) – intervalle de temps minimum entre les requêtes
  • $(DomainLimit) – nombre maximal de domaines (clés API)
  • $(OverPlanAllowed) – possibilité de dépasser le nombre maximum de requêtes dans le plan
  • $(ExcelAddIn) – accès aux modules complémentaires Google Sheets™ et Microsoft Excel™
  • $(Stats) – accès aux statistiques des requêtes
  • $(NIPMonitor) – accès au suivi du statut des entreprises : TVA/VIES/Statut d'activité
  • $(FuncGetVIESData) – accès aux fonctions qui vérifient le statut de l’entreprise dans le système VIES
  • $(FuncGetVIESDataParsed) – accès aux fonctions qui vérifient le statut de l'entreprise dans le système VIES et analysent le nom et l'adresse du commerçant
  • $(VIESDataCount) – nombre de requêtes VIES effectuées ce mois-ci
  • $(VIESDataParsedCount) – nombre de requêtes VIES avec données analysées effectuées ce mois-ci
  • $(TotalCount) – nombre total de requêtes effectuées ce mois-ci

FORMAT par défaut : "Name of the current tariff plan: $(BillingPlanName), Monthly subscription net price: $(SubscriptionPrice), Maximum number of inquiries in the plan: $(Limit), Total number of queries made in the current month: $(TotalCount)"

Si la chaîne "JSON" est donné comme le FORMAT paramètre, la fonction renverra le résultat complet sous la forme d'une chaîne JSON, qui peut être librement analysée et traitée ultérieurement.

Vérification de l'état du système VIES (gratuit)

VIESAPI_VIES_STATUS() Cette fonction permet de vérifier l'état actuel du système VIES. Elle renvoie un état général indiquant la disponibilité, ainsi qu'une liste des pays membres et l'état actuel de disponibilité de leurs systèmes nationaux. Les paramètres doivent être :

  • (optionnel) FORMAT des données retournées (voir : Balises pouvant être utilisées comme FORMAT paramètre)

=VIESAPI_VIES_STATUS()

Attention! L'appel de la fonction n'augmente pas le nombre de requêtes effectuées.

Les balises disponibles dans le VIESAPI_VIES_STATUS fonction peut être utilisée comme FORMAT paramètre:

  • $(UID) – identifiant unique généré par le service viesApi.eu
  • $(Available) – disponibilité actuelle du système VIES (Disponible, Partiellement disponible, Indisponible)
  • $(Countries) – liste des États membres individuels (Disponible, Indisponible)
  • $(AT), $(FR), $(PL), etc. – statut de disponibilité d’un pays membre spécifique (utilisez un code pays à 2 lettres majuscules comme valeur de balise)

FORMAT par défaut : "$(Available)"

Si la chaîne "JSON" est donné comme le FORMAT paramètre, la fonction renverra le résultat complet sous la forme d'une chaîne JSON, qui peut être librement analysée et traitée ultérieurement.

Autres fonctions utiles (gratuites)

VIESAPI_ACCOUNT_STATUS_TOTAL() – La fonction renvoie des informations sur le nombre total de requêtes effectuées au cours du mois de facturation en cours pour un compte donné (toutes les clés API). Renvoie exactement le même nombre que le $(TotalCount) balise dans le VIESAPI_STATUS_ACCOUNT() fonction.

VIESAPI_ACCOUNT_STATUS_LIMIT() – La fonction renvoie des informations sur le nombre maximum de requêtes disponibles dans le plan sélectionné par l'utilisateur. Renvoie exactement le même nombre que le $(Limit) faire VIES.STATUS.ACCOUNT() fonction

VIESAPI_EUVAT_NORM() - Cette fonctionnalité corrige et formate le numéro de TVA intracommunautaire (supprime les espaces et les tirets, etc.) hors ligne et ne récupère aucune donnée de VIES :

=VIESAPI_EUVAT_NORM("PL 717-164-20-51")

VIESAPI_EUVAT_VALID() – La fonction vérifie uniquement l'exactitude (syntaxe, somme de contrôle) du numéro de TVA intracommunautaire hors ligne et ne récupère aucune donnée du système VIES. Retour TRUE si le numéro est valide ou FALSE s'il n'est pas valide :

=VIESAPI_EUVAT_VALID("PL7171642051")

VIESAPI_CONNECTION_STATE() – La fonction renvoie l'état actuel de la configuration du complément.

Si la fonction renvoie la valeur suivante, cela signifie, entre autres, que le ID et API key n'ont pas été sauvegardés :

ERROR: Connection requires configuration

Après avoir enregistré le API ID et key, la fonction doit renvoyer le message suivant :

SUCCESS: Production

Google Sheets™ est une marque déposée de Google LLC.