Docage API V2 (beta)
Webhooks
Copy Page
Docage API V2 (beta)
Avant de commencer
Requêtes communes
Créer un objet
Créer un objet
Modifier un objet
Modifier un objet
Supprimer des objets
Supprimer un objet
Supprimer plusieurs objets
Obtenir des objets
Obtenir un objet
Récupérer un objet par son Id
Récupérer un contact par son email
Récupérer un utilisateur par son email
Obtenir plusieurs objets
Récupérer tous les objets
Requêter certaines propriétés uniquement
Filtrer les objets
Filtrer les transactions supérieure à une date
Filtrer les transactions signées ET dont le nom contient "Facture"
Filtrer les contacts en fonction des champs personnalisés
Filtrer les modèles
Filtrer les objets créés à partir d'un modèle
Filtrer les objets par classeur
Obtenir les objets d'un classeur
Trier les objets
Trier les contacts par leur prénom
Trier les contacts par leur prénom en ordre décroissant
Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
Paginer les objets
Trier les contacts par leur prénom (21 à 30)
Trier les contacts par leur prénom en ordre décroissant
Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
Docage
Classeurs
Requêtes spécifiques aux classeurs
Ajouter des entités à un classeur
Supprimer des entités d'un classeur
Créer un classeur
Créer un classeur à partir d'un modèle
Dupliquer des classeurs
Modifier un classeur
Supprimer un classeur
Supprimer des classeurs
Obtenir un classeur par son identifiant
Obtenir un classeur par son nom
Obtenir tous les classeurs accessibles par l'utilisateur
Obtenir les entrées de lot de parcours associées au classeur.
Obtenir une liste simplifiée des modèles de classeurs accessibles par l'utilisateur
Obtenir une liste simplifiée des classeurs accessibles par l'utilisateur
Obtenir tous les classeurs accessibles par un cercle
Obtenir le nom d'un classeur par son Id
Ajouter des objets à un classeur
Supprimer des objets à un classeur
Cercles
Créer un cercle
Créer un cercle à partir d'un modèle
Dupliquer des cercles
Modifier un cercle
Supprimer des cercles
Supprimer un cercle
Obtenir un cercle par son identifiant
Obtenir le nom d'un cercle par son Id
Obtenir un cercle par son nom
Obtenir la liste des membres d'un cercle
Obtenir tous les cercles accessibles par l'utilisateur
Obtenir une liste simplifiée des modèles de cercles accessibles par l'utilisateur
Obtenir une liste simplifiée des cercles accessibles par l'utilisateur
Obtenir tous les cercles liés à un classeur
Obtenir tous les cercles accessibles par un cercle
Appliquer les paramètres utilisateurs à tous les utilisateurs du cercle
Appliquer uniquement les paramètres utilisateurs modifiés à tous les utilisateurs du cercle
Ajouter des utilisateurs à un cercle
Supprimer des utilisateurs à un cercle
Ajouter des organisations à un cercle
Supprimer des organisations à un cercle
Ajouter un cercle dans plusieurs classeurs
Supprimer un cercle de plusieurs classeurs
Utilisateurs
Créer un utilisateur
Supprimer des utilisateurs
Obtenir un utilisateur par son identifiant
Obtenir un utilisateur par son email
Obtenir le nom d'un utilisateur par son Id
Générer une nouvelle clé API pour un utilisateur
Supprime la clé API d'un utilisateur
Obtenir tous les utilisateurs accessibles par l'utilisateur
Obtenir une liste simplifiée des modèles d'utilisateurs accessibles par l'utilisateur
Obtenir une liste simplifiée des utilisateurs accessibles par l'utilisateur
Obtenir tous les utilisateurs liés à un classeur
Obtenir tous les utilisateurs accessibles par un cercle
Envoie un email avec un lien de réinitialisation de mot de passe à un utilisateur
Modifier un utilisateur
Ajout d'un utilsateur à un ou plusieurs classeurs
Supprimer un utilsateur d'un ou plusieurs classeurs
Ajoute un utilisateur au cercle des administrateurs de son organisation
Supprimer un utilisateur du cercle des administrateurs de son organisation
Ajoute un utilisateur au cercle des gestionnaires de crédits de son organisation
Supprimer un utilisateur du cercle des gestionnaires de crédits de son organisation
Links
/Links/{id}
/Links
/Links
/Links/{id}/{password}
Orders
/Orders/{id}
/Orders/{id}
Definitively delete orders if they are not processed, paid or invoiced
Obtenir une facture
Obtenir tous les commandes accessibles par l'utilisateur
/Orders
Obtenir une liste simplifiée des modèles de commandes accessibles par l'utilisateur
Obtenir une liste simplifiée des commandes accessibles par l'utilisateur
Obtenir tous les commandes liés à un classeur
Obtenir tous les commandes accessibles par un cercle
Obtenir un commande par son identifiant
Obtenir le nom d'un commande par son Id
/Orders/ProcessOrder/{id}
/Orders/RejectOrder/{id}
/Orders/MarkOrderAsPaid/{id}
/Orders/MarkOrderAsInvoiced/{id}
Organizations
/Organizations
Supprimer des organisation
Obtenir toutes les organisations accessibles par l'utilisateur
Obtenir une liste simplifiée des modèles d'organisations accessibles par l'utilisateur
Obtenir une liste simplifiée des organisations accessibles par l'utilisateur
Obtenir toutes les organisations liées à un classeur
Obtenir toutes les organisations accessibles par un cercle
Obtenir une organisation par son identifiant
Obtenir le nom d'une organisation par son Id
Appliquer les paramètres utilisateurs à tous les utilisateurs de l'organisation
Appliquer uniquement les paramètres utilisateurs modifiés à tous les utilisateurs de l'organisation
Modifier une organisation
/Organizations/BlockOrganization/{id}/{numberOfDays}
Rights
/Rights/ById/{id}
Retrieves all the rights linked to an entity
Get default rights for a new entity depending on organization settings
Retrieve all the rights owned by a circle
Retrieve all the rights owned by a DocageUser
Retrieve all the rights owned by an Organization
Add a new right
Remove rights
Classeurs
Récupérer les objets d'un classeur
Récupérer les transactions d'un classeur
Liaisons lors de la création d'un objet
Ajouter un objet à un ou plusieurs classeurs à la création
Modification des liaisons lors de la modification d'un objet
Ajouter un objet à un ou plusieurs classeurs à la modification
Supprimer un objet d'un ou plusieurs classeurs à la modification
Modification des liaisons entre un objet et les classeurs
Ajouter un objet à un/des classeurs
Supprimer un objet d'un ou plusieurs classeurs
Champs personnalisés
Créer un objet avec ses champs personnalisés
Modifier les champs personnalisés d'une entité
Créer une transaction en renseignant ses champs personnalisés
Webhooks
Etre notifié lorsqu'un objet change d'état
Etre notifié lorsqu'une Transaction est supprimée
Etre notifié lorsqu'un Utilisateur est bloqué
Etre notifié lorsqu'un Utilisateur est débloqué
Créer un webhook
POST
Obtenir les webhooks de l'organisation
GET
Etre notifié lorsqu'un objet est modifié
POST
Etre notifié lorsqu'une Transaction change de statut
POST
Etre notifié lorsque le contenu d'un classeur est modifié
POST