Introduction
Gestion décentralisée des systèmes d’information et hébergement des API
Chaque client ACD est pleinement décisionnaire de l’organisation et de l’hébergement de son système d’information.
En conséquence, chaque client dispose de son propre serveur web, installé sur l’infrastructure de son choix (hébergement interne, hébergeur tiers ou autre).
Ce serveur web constitue la porte d’entrée des API ACD, utilisées pour les échanges entre les applications internes du client, les solutions partenaires et la suite logicielle ACD.
Chaque serveur dispose également de son propre Swagger, permettant d’accéder à la documentation et de tester les routes API disponibles pour le périmètre du client concerné.
Ainsi, le Swagger reflète l’état réel des services et des données accessibles sur le serveur du client, conformément à son environnement et à ses paramétrages internes.
Pour accompagner les clients dans la mise en place et la sécurisation de leur environnement, ACD met à disposition une documentation détaillant les prérequis techniques à respecter pour l’utilisation des API.
Accès au Swagger
L’API d’ACD se compose de plusieurs services web, documentés directement sur la plateforme i-Suite Expert du cabinet. Le swagger comportant tous les appels possibles est accessible depuis votre plateforme i-Suite Expert :
https://{Adresse URL iSuite du cabinet}/{CNX du cabinet}/api/swagger
Différentes versions de l'API sont accessibles depuis cette liste déroulante :
En choisissant la V2, seuls les endpoints disponibles en version 2 apparaissent.
Configuration des webhooks
En cas d’ajouts, modifications et suppressions de dossiers, de documents GED et de correspondants, des alertes peuvent être générées via des webhooks.
Référez-vous à la fiche Gestion des Webhooks sortants pour plus d’explications.
Liste des routes API
Connexion
Authentification
POST /v1/authentification
Premier endpoint à utiliser pour récupérer un jeton d’authentification (UUID) à partir du login et mot de passe.
Ce jeton d'identification UUID (apiKey) doit être enregistré pour pouvoir l’utiliser sur les différents endpoints dans le swagger.
POST /v1/authentification/uuid
Authentification par UUID
POST /v1/authentification/token
Authentification par Access Token
POST /v1/authentification/cle-api
Authentification par UUID
POST /v1/authentification/cles-api
Génération d'une clé API pour un dossier
POST /v1/authentification/cles-api/rafraichir
Rafraîchissement d'une clé API pour un dossier
Sessions
GET /v1/sessions/dossier
Récupérer le dossier courant lié à la session
POST /v2/sessions/dossier
Changer le dossier courant
GRC
Collaborateurs
GET /v1/collaborateurs
Récupérer tous les collaborateurs
GET /v1/collaborateurs/{code}
Récupérer un collaborateur par son code
GET /v1/ collaborateurs/{code}/iCalendar
Récupérer l’URL iCalendar d’un collaborateur par son code
Plannings
POST /V1/plannings/filtrer
Récupérer une liste de planning à partir du filtre envoyé
GET /V1/plannings/feries/cabinet/{code}
Récupérer des jours fériés pour un cabinet.
Cabinets
GET /v1/cabinets
Récupérer tous les cabinets autorisés
Utilisateurs
POST /v1/utilisateurs
Ajouter un utilisateur au dossier
GET /v1/utilisateurs
Récupère les utilisateurs du dossier en cours
Activités
GET /v1/activités
Récupération de la liste de l'ensemble des activités
Formes juridiques
GET /v1/formes_juridiques
Récupération de la liste des formes juridiques
Genres
GET /v1/genres
Récupération de la liste des genres
Titres
GET /v1/titres
Récupération de la liste des titres
Correspondants
GET /v1/correspondants/{id}
Récupérer un correspondant et toutes ses liaisons à partir de son identifiant
PATCH /v1/correspondants/{id}
Mettre à jour les informations d’un correspondant à partir de son code
DELETE /v1/correspondants/{id}
Permet de supprimer un correspondant à partir de son identifiant
GET /v1/correspondants/{code}
Récupérer les informations d’un correspondant et ses liaisons à partir de son code
PATCH /v1/correspondants/{code}
Supprimer les informations de facturation du dossier
DELETE /v1/correspondants/{code}
Permet de supprimer un correspondant à partir de son code
POST /V1/correspondants/filtrer
Récupérer un correspondant et toutes ses liaisons à partir de son code
Dossiers
GET /v1/dossiers
Récupérer tous les dossiers autorisés
POST /v1/dossiers
Créer un dossier
GET /v1/dossiers/{code}
Récupérer un dossier par son code
PATCH /v1/dossiers/{code}
Mettre à jour les informations du dossier
PUT /v1/dossiers/{code}/facturation/{codeDossier}
Renseigner un dossier en tant qu’adresse de facturation
PUT /v1/dossiers/{code}/facturation
Mettre à jour les informations de facturation du dossier
DELETE /v1/dossiers/{code}/facturation
Supprimer les informations de facturation du dossier
GET /v1/dossiers/{code}/infosplus
Récupérer les champs paramétrables d’un dossier
PATCH /v1/dossiers/{code}/infosplus
Modifie les champs paramétrables d’un dossier
GET /v1/dossiers/{code}/chiffres-cles
Récupérer les chiffres clefs d'un dossier
POST /v1/dossiers/filtrer
Récupérer une liste de dossiers à partir du filtre envoyé
Dossiers - Collaborateurs
GET /v1/dossiers/{code}/collaborateurs
Récupérer la liste des collaborateurs affectés à un dossier par niveau
PATCH /v1/dossiers/{code}/collaborateurs
Affecter des collaborateurs à un dossier par niveau
Dossiers - Correspondants
GET /v1/dossiers/{code}/correspondants
Récupérer la liste des collaborateurs affectés à un dossier par niveau
POST /v1/dossiers/{code}/correspondants
Créer un correspondant
POST /v1/dossiers/{code}/correspondants/{idCorrespondant}
Lier un correspondant existant au dossier par l’identifiant du correspondant
DELETE /v1/dossiers/{code}/correspondants/{idCorrespondant}
Supprimer une liaison entre un correspondant et un dossier
POST /v1/dossiers/{code}/correspondants/{codeCorrespondant}
Lier un correspondant existant au dossier par le code du correspondant
DELETE /v1/dossiers/{code}/correspondants/{codeCorrespondant}
Supprimer une liaison entre un correspondant et un dossier
Dossiers - Relations
GET /v1/dossiers/{code}/relations
Récupérer toutes les relations d’un dossier à partir de son code
POST /v1/dossiers/{code}/relations/dossiers/{codeDossier}
Créer une relation vers un dossier
POST /v1/dossiers/{code}/relations/associe/dossiers/{codeDossier}
Créer une relation de type associé vers un dossier
POST /v1/dossiers/{code}/relations/correspondants/{idCorrespondant}
Créer une relation de type associé via son identifiant
POST /v1/dossiers/{code}/relations/associe/correspondants/{idCorrespondant}
Créer une relation de type associé vers un correspondant via son identifiant
POST /v1/dossiers/{code}/relations/correspondants/{codeCorrespondant}
Créer une relation vers un correspondant via son code
POST /v1/dossiers/{code}/relations/associe/correspondants/{codeCorrespondant}
Créer une relation de type associé vers un correspondant via son code
POST /v1/dossiers/{code}/relations/banque/dossiers/{codeDossier}
Créer une relation de type banque vers un dossier de genre banque
POST /v1/dossiers/{code}/relations/banque/dossiers/{codeDossier}
Créer une relation de type banque vers une banque propre au dossier
Relations
GET /v1/relations/{id}
Récupérer tous les types de relations existants
DELETE /v1/relations/{id}
Récupérer tous les types de relations existants
Exercices
GET /v1/exercices
Récupérer la liste des exercices du dossier courant
POST /v1/exercices
Ajouter un exercice au dossier courant
PUT /v1/exercices
Mettre à jour un exercice
GET /v1/exercices/{code}
Récupérer un exercice par son code
PATCH /v1/exercices/{code}
Mettre à jour de façon partielle un exercice
GED
GED
GET /v1/ged/ arborescence
Récupérer le plan de classement de la GED
GET /v1/ged/documents/{id}
Récupérer un document par son identifiant
GET /v1/ged/documents/{id}/fichier
Télécharger un fichier par son identifiant
PUT /v1/ged/documents/{id}/fichier
Remplacer un document de la GED
GET /v1/ged/documents/{id}/apercu
visualiser un fichier par son identifiant
GET /v1/ged/documents/public/{cle}/fichier
Télécharger un fichier par son nom public
GET /v1/ged/documents/public/{cle}/apercu
Visualiser un fichier par son nom public
POST /v1/ged/documents/filtrer
Récupérer tous les documents en fonction du filtre envoyé
POST /v1/ged/documents
Ajouter un document dans la GED
DELETE /v1/ged/documents
Supprimer des documents par leurs identifiants
POST /v1/ged/documents/emails
Ajouter un email dans la GED
PATCH /v1/ged/documents/{id}/liberer
Libérer un document réservé dans la GED
GET /v1/ged/criteres
Récupérer les critères de la GED
GET /v1/ged/criteres/{code}
Récupérer les valeurs d'un critère sur les documents d'un dossier
Panières
POST /v1/panieres/documents
Ajouter un document dans un type panière
DELETE /v1/panieres/documents
Supprimer des documents par leur identifiant sur le dossier courant
GET /v1/panieres/documents
Récupérer tous les documents
GET /v1/panieres/documents/{id}
Récupérer un document par son identifiant
GET /v1/panieres/documents/{id}/fichier
Télécharger un document par son identifiant
PATCH /v1/panieres/documents/{id}/reserver
Réserver un document de la panière
PATCH /v1/panieres/documents/{id}/liberer
Libérer un document réservé de la panière
POST /v1/panieres/documents/{id}/transferer
Transférer un document de la panière vers la Ged
GET /v2/panieres/documents/{id}/ocr
Récupérer le statut d’océrisation d’un document
GET /v2/panieres/documents/{id}/ocr/facture
Récupérer les informations de la facture
GET /v2/panieres/documents/{id}/lad/facture
Récupérer les informations de la facture
Panières types
GET /v1/panieres/types
Récupérer les types de panière
GET /v1/panieres/types/{id}
Récupérer les documents de la panière spécifiée
GET /v1/panieres/types/nombre
Récupérer le nombre de documents
Gestion interne
Prestations
GET /v1/prestations
Récupérer la liste des prestations
Missions
GET /v1/missions
Récupérer la liste des missions pour le dossier courant
POST /v1/missions
Ajouter une mission
PUT /v1/missions
Mettre à jour une mission
POST /v1/missions/modele
Ajouter une mission depuis un modèle
GET /v1/missions/{id}
Récupérer une mission spécifique
PATCH /v1/missions/{id}
Mettre à jour de façon partielle une mission
POST /v1/missions/filtrer
Récupérer plusieurs missions par filtrage
Missions - Prestations
GET /v1/missions/{id}/prestations
Récupérer la liste des prestations pour une mission
Factures
Post V1/factures
Récupérer la liste des factures en fonction des filtres envoyés
Comptabilité
Grand livre
POST /v1/compta/grandlivre/
Récupérer le grand livre
POST /v1/compta/grandlivre/clients
Récupérer le grand livre de comptes clients
POST /v1/compta/grandlivre/fournisseurs
Récupérer le grand livre des comptes fournisseurs
POST /v1/compta/grandlivre/generaux
Récupérer le grand livre des comptes généraux
Balance
POST /v1/compta/balance/clients
Récupérer les balances de comptes clients
POST /v1/compta/balance/fournisseurs
Récupérer les balances des comptes fournisseurs
POST /v1/compta/balance/generaux
Récupérer les balances des comptes généraux
Journaux
GET /v1/compta/journal
Récupérer les journaux
POST /v1/compta/journal
Créer un journal
Paramètres
GET V1/compta/dossier
Récupérer les informations du dossier
GET /v2/compta/parametres/codesTVA
Récupérer tous les codes TVA
GET /v2/compta/parametres/comptesperiodiques
Récupérer tous les comptes actifs en charge périodiques et produits périodiques
GET /v2/compta/parametres/analytique
Récupérer la liste des sections analytiques par niveau
POST /v2/compta/parametres/analytique
Créer une section analytique
GET /v2/compta/paramètres/quantite
Récupérer les quantités
Écritures
POST /v2/compta/ecriture
Créer une écriture
POST /v1/compta/ecriture/lettrage
Lettrer une écriture de banque avec une écriture d'achat ou de vente
POST /v1/compta/fec
Récupérer les fichiers des écritures comptables
GET /v1/compta/planClassementEcriture/{codeJournal}
Récupérer le plan de classement en fonction du journal
TVA
POST /v1/compta/cerfatva
Récupérer les cerfa de TVA
Exercices comptables
POST /v1/compta/exercices
Récupérer la liste des dates d’exercices
Comptes
GET /v1/compta/comptes/generaux
Récupérer la liste des comptes généraux
GET /v1/compta/comptes/clients
Récupérer la liste des comptes clients
GET /v1/compta/comptes/fournisseurs
Récupérer la liste des comptes fournisseurs
GET /v1/compta/comptes/collectifs
Récupérer la liste des comptes collectifs
POST /v1/compta/comptes/generaux
Créer un compte général
POST /v1/compta/comptes/client
Créer un compte client
POST /v1/compta/comptes/fournisseur
Créer un compte fournisseur
POST /v1/compta/comptes/tiers
Créer un compte tiers
Tiers
GET/v2/compta/tiers
Récupérer les tiers
POST /v2/compta/tiers
Crée un tiers dans le dossier courant (et synchronise la base publiée).
Paie
GET V1/Paie/Etablissements
Récupérer la liste des établissements
POST V1/Paie/FichiersDSN
Récupérer la liste des identifiants de fichier DSN correspondant au filtre envoyé
GET V1/Paie/FichiersDSN/{id}
Télécharger un fichier par son identifiant
Les types de connexion
À savoir, il existe 3 différents types pour les appels de connexions présents dans la liste ci-dessous :
Connexion collaborateur
Login : Code du collaborateur
Cette connexion permet de travailler sur un portefeuille, dans le cadre des restrictions d’accès définies par le cabinet. Tous les documents de la GED sont accessibles, ainsi que les dossiers publiés sur i-Suite Expert en comptabilité.Connexion client
Login : Code du dossier
Cette connexion permet de travailler sur un seul dossier ouvert sur i-Suite Expert par le cabinet. Elle donne accès aux documents diffusables via la GED ainsi qu’aux modules i-Suite Expert activés par le cabinet.Connexion utilisateur
Login : Code du dossier
Cette connexion permet de travailler sur un seul dossier ouvert sur i-Suite Expert par le cabinet. Elle donne accès aux documents diffusables via la GED ainsi qu’aux modules i-Suite Expert activés par le cabinet.
Exemple d'utilisation de l'API
Connexion et contrôler des dossiers autorisés
Connexion à l’API Suite Expert (voir fiche technique) :
POST /v1/authentificationVérifier les dossiers autorisés (voir fiche technique) :
POST /v1/dossiers/filtrer
Récupérer le paramétrage comptable d'un dossier :
Se positionner sur le dossier :
POST /v2/sessions/dossierRécupération du paramétrage du dossier (voir fiches techniques) :
GET /v1/compta/dossier
GET /v1/paramètres/codesTVA
GET /v1/paramètres/comptesperiodiques
GET v1/paramètres/analytique
GET v1/paramètres/quantiteRécupération des exercices et journaux :
GET /v1/compta/journal
GET /v1/compta/exercicesRécupération du plan comptable :
GET /v1/compta/comptes/fournisseur
GET /v1/compta/comptes/generaux
GET /v1/compta/comptes/clientCréation des comptes et journaux :
POST /v1/compta/comptes/fournisseur
POST /v1/compta/comptes/generaux
POST /v1/compta/comptes/client
POST /v1/compta/journal
Lier un document à une écriture
Se positionner sur le dossier :
POST /v2/sessions/dossierRécupération de l’arborescence de la GED :
GET /v1/compta/planClassementEcriture/{codeJournal}Ajout d’un document dans la GED :
POST /v1/ged/documentsCréation d’écriture avec document lié :
POST /v1/compta/ecriture en renseignant l’information « referenceGed »