Manuel d’utilisation

CONTRAT D’ABONNEMENT
DOLIBARR

MAXIME MANGIN
 Statut du document
Date Version Commentaire Auteur
07/2012 1.0 Création du document Maxime
02/2013 1.1 Actualisation du document et traduction en anglais Maxime
02/2013 1.2 Ajout des fonctionnalités des versions 3.3 Maxime
01/2014 1.3 Ajout du module d’envoi de factures en masse Maxime
09/2014 1.4 Ajout des fonctionnalités de la version 3.6 Maxime
05/2015 1.5 Ajout des fonctionnalités de la version 3.6 Maxime

Page 1 sur 17
Table des matières
Introduction ................................................................................................................................................................. 3
Partie 1 : Contrat d’abonnement................................................................................................................................. 4
Installation et configuration du module .................................................................................................................. 4
Gestion d’un abonnement....................................................................................................................................... 4
Impression d’un abonnement ................................................................................................................................. 6
Suivi d’un abonnement............................................................................................................................................ 7
Facturation d’un abonnement................................................................................................................................. 8
Partie 2 : Modules complémentaires .......................................................................................................................... 9
Tacites reconductions .............................................................................................................................................. 9
Facturation en masse ............................................................................................................................................ 11
Facturation et envoi en masse .............................................................................................................................. 13
Périodes non civiles ............................................................................................................................................... 14
Partie 3 : Mises à jour ................................................................................................................................................ 16
Partie 4 : Autres ......................................................................................................................................................... 16

Page 2 sur 17
Introduction

Ce document est le manuel d’utilisation du module « Contrat d’abonnement » développé pour

Dolibarr par Maxime MANGIN <[email protected]>.

Ce module est disponible directement sur ma boutique à l’adresse suivante :

http://boutique.tuxserv.fr/

L’objectif de ce module est de permettre la création et la gestion des abonnements au sein de

Dolibarr, venant ainsi compléter les contrats existants.

Ce document vise à décrire les fonctionnalités principales de ce module en détaillant son utilisation,
permettant ainsi une utilisation plus aisée.
Des modules complémentaires ont étés développés afin de répondre à des besoins plus spécifiques.
Ils seront également présentés.

Note concernant les mises à jour : Les mises à jour de ce module incluent généralement, en plus de la
compatibilité avec les nouvelles versions de Dolibarr, un certain nombre de nouveautés / corrections qui
m’ont semblées pertinentes (la plupart étant remontée par les utilisateurs du module).

Ce document présente :
1. Le module « contrat d’abonnements » (partie 1)
2. Les modules complémentaires (partie 2)
a. Tacites reconductions
b. Facturation en masse
c. Périodes non civiles
3. Autres (partie 3)

Page 3 sur 17
Partie 1 : Contrat d’abonnement

Le module « contrat d’abonnement » permet de gérer des abonnements sur les produits et les services
de Dolibarr.
Venant compléter l’interface de « contrat » actuel de Dolibarr, ce module permet de créer les périodes
d’abonnement selon l’échéancier défini, calculant automatiquement les dates et montants de ces dernières.
Une boite est également présente sur la page d’accueil vous informant des abonnements à facturer.

Installation et configuration du module

L’installation du module se fait par simple copier-coller du module. Vous pouvez au choix :
 Copier les fichiers dans htdocs (vous retrouvez alors le dossier « contratabonnement » dans htdocs)
 Utiliser le répertoire custom de dolibarr (version 3.3 et supérieur). Dans ce cas pensez à activer les
deux paramètres dans le fichier de configuration

Une fois les fichiers copiés, le module est activable dans les modules de Dolibarr :

Après activation, vous devez procéder au paramétrage du module à l’aide du bouton de configuration (le
petit ordinateur dans mon cas).
Cette interface peut varier en fonction du nombre de module complémentaires que vous avez installé.
Dans sa version de base, le module vous propose de configurer le nombre de jours d’alerte avant et après la date
d’échéance pour la boite sur la page d’accueil.
Si vous spécifiez 15 dans « nombre de jours avant », cela signifie que vous désirez être prévenu 15 jours avant la
date d’échéance des périodes. Inversement pour le « nombre de jours après ».
Pensez pour finir à activer la « boite » sur la page d’accueil afin d’être informé des périodes à facturer.

Gestion d’un abonnement

La création d’un abonnement débute dans la partie « Contrat » de Dolibarr, sur laquelle un nouvel
onglet est venu s’ajouter.

Si ce n’est pas déjà fait, ajoutez un produit ou un service sur la fiche contrat (composant Dolibarr de
base) avec une date de début et une date de fin (sauf cas du complément de module ‘tacites reconductions’,
voir partie 2).

Page 4 sur 17
 Rendez-vous ensuite sur le nouvel onglet « abonnements » afin de retrouver votre article dans la
première liste intitulée « -- Produits/Services trouvés --».

Si vous utilisez la version 3.7 du module, vous avez la possibilité de modifier la date de début de
l’abonnement.

Sélectionnez la valeur désirée pour la colonne « Prix par ». Cette liste permet de spécifier si le prix
indiqué sur le produit/service du contrat doit être considéré comme le prix pour un mois, pour un an, etc.
(L’utilisateur final étant libre quant à sa méthode de facturation, cette liste est nécessaire afin de garder une
facturation cohérente).

Le champ « Répéter » permet de spécifier le mode d’abonnement. Les périodes peuvent se répéter :
 Tous les mois
 Tous les trimestres
 Tous les quadrimestres
 Tous les semestres
 Tous les ans

Pour finir, sélectionnez la date de facturation de la période (termes à échu ou termes à échoir).

Au clic sur le bouton « Ajouter », le module créé automatiquement les périodes correspondantes.

Par défaut, le module se base sur les périodes civiles, vous permettant d’établir toute votre facturation à la
même date (ce comportement peut être modifié à l’aide du module « périodes non civiles », voir partie deux).
Une période commence donc toujours en début de mois et finira toujours en fin de mois, sauf
éventuellement pour la première et la dernière période qui est basée sur les dates réelles du produit /
service (le calcul du montant étant au prorata du nombre de jours dans la période).

Un clic sur le bouton « modifier », vous permettra de visualiser les différentes périodes, et d’en
modifier éventuellement le montant ainsi que son statut.

Page 5 sur 17
Les cases « facturé » présentes sur la capture ci-dessus permettent de spécifier si la période a déjà été
facturée. Cette case peut être modifiée manuellement en cas de besoin, mais elle est automatiquement
renseignée lors de la création de la facture correspondante.
Dans la version 3.3, le module affiche également le prix avant remise et après remise, si un pourcentage a
été saisi sur le contrat.

Depuis la version 3.6, vous avez la possibilité de stopper un abonnement à l’aide du bouton , ou le

rendre de nouveaux actif à l’aide du bouton . L’abonnement ne sera alors plus notifé sur la boite
disponible sur la page d’accueil.
Le statut de l’abonnement peut être consulté à tout moment à l’aide des icones prévues à cet effet :

La version 3.7 du module permet d’ajouter, supprimer, et modifier les périodes de l’abonnement.

Impression d’un abonnement

Le bouton « Imprimer les périodes » situé en bas de l’interface, vous permet

d’exporter le statut actuel des périodes pour le ou les abonnements en cours.

Page 6 sur 17
 Les dates, les montants, le type d’abonnement (échu ou échoir) ainsi que le statut (facturé ou non) y
sont affichés.

Suivant la version du module, l’export peut être réalisé soit en PDF (3.1 et précédent) soit en ODT
(3.2 et suivant).

Si votre impression est en ODT, vous avez la possibilité de modifier le template en éditant
directement le fichier « contratabonnement/tpl/contratabonnement.odt »

Pour plus d’informations :

http://wiki.dolibarr.org/index.php/Cr%C3%A9er_un_mod%C3%A8le_de_document_ODT

Suivi d’un abonnement

Bien que le suivi puisse être réalisé au cas par cas (en visualisant le statut de chaque abonnement), le
module dispose d’une boite placée sur la page d’accueil de Dolibarr.

Cette boite affiche les informations suivantes :

 Référence du contrat
 Tiers
 Date de facturation (En tenant compte du terme à échu ou échoir)
 Montant à facturer
 Statuts du contrat de base
 Nombre de jours de retards (au survol du triangle d’avertissement)

Page 7 sur 17
Merci de vous référer à la partie de paramétrage du module afin modifier les délais d’alertes.

Un clic sur le contrat vous redirigera vers l’abonnement correspondant.

Vous avez la possibilité de facturer tout ou partie des abonnements d’un seul clic à l’aide du
complément de module « facturation en masse » décrit en partie deux.

Facturation d’un abonnement

La facturation d’un abonnement se fait à l’aide du bouton « Créer

facture abonnement » situé en bas de l’interface des abonnements.

Il vous est ensuite demandé de cocher les périodes à facturer pour permettre la création du brouillon.

Par défaut, le module sélectionne la période courante, ou la période à venir dans le cadre d’un abonnement
à échoir. Libre à vous d’accepter ou non ce choix.
La case « Cocher comme facturé » permet de considérer les périodes facturées comme tel sur l’abonnement.
Cela revient à cocher manuellement les cases suivantes (en rouge) :

L’abonnement et la facture sont liés après la création de cette dernière.

Page 8 sur 17
Partie 2 : Modules complémentaires

Ces modules complémentaires viennent s’ajouter au module « Contrat d’abonnement » pour

répondre à des besoins plus spécifiques. Ils sont également disponibles sur ma boutique.
A noter qu’ils ne peuvent fonctionner sans la version de base « contrat d’abonnement ».

Il est important de noter que les différents modules complémentaires sont compatibles entre eux
(on peut par exemple utiliser la facturation en masse avec les tacites reconductions).

Tacites reconductions

Définition : Clause d'un contrat qui indique que l'accord est reconductible automatiquement d'une période à
une autre si aucune des parties ne se manifeste.

Ce complément permet de reconduire automatiquement les abonnements.

Il est basé sur deux principes :

 Un nombre X de périodes est créé lors de la création de l’abonnement
 Le nombre de périodes facturées est automatiquement recréé indéfiniment

Pour que la tacite reconduction s’applique, il suffit de renseigner le nombre de périodes initiales
dans les paramètres du module :

puis ne de pas spécifier de date de fin sur le produit / service (contrat de base Dolibarr).

Page 9 sur 17
Exemple : Si vous facturez 3 périodes d’un abonnement, 3 nouvelles périodes sont automatiquement
ajoutées à l’abonnement.

Vous avez la possibilité de stopper la tacite reconduction à tout moment en ne cochant pas l’option
correspondante lors de la facturation des périodes.

Depuis la version 3.6, le module permet de spécifier le nombre de périodes à créer au cas par cas lors de la
création de l’abonnement :

Page 10 sur 17
Facturation en masse

Certains utilisateurs de Dolibarr gérants une quantité importantes de factures, la création manuelle
de ces dernières peut vite s’avérer fastidieuse.

Dans cette optique, ce complément de module vient s’intégrer sur la boite disponible sur la page d’accueil.

L’interface permet de sélectionner toutes les périodes que vous désirez facturer, et ce peu importe
les contrats / tiers.

Le module propose dans sa version 3.2 :

 La sélection de toutes les périodes d’un seul clic (Tout / Aucun)
 La spécification de la date de facturation (date du jour par défaut)
 La validation automatique ou non des factures (dans le cas contraire, les factures restent à l’état
de brouillon)

La version 3.3 apporte les ajouts suivants :

 Affichage de la somme des montants des périodes sélectionnées et affichage du montant total à
facturer
 Option "Générer les factures"
 Option "Considérer comme payé"

Il est de plus possible de générer automatiquement l’autorisation de prélèvement depuis la version 3.6.

Page 11 sur 17
La version 3.7 permet de lancer la génération des factures via un planificateur de tâches, via l’url suivante :
htdocs/contratabonnement/facturation_masse.php?action=launchBatchMassInvoicing&validInvoices=1&generateinvoices=1&sendByEmail=0
(Les valeurs des trois derniers paramètres pouvant être changés selon votre besoin)

Une fois les factures créées, la liste des factures générées est ajoutée en tant que nouvelle action dans
l’agenda (si il est activé).

Note :
 La période est automatiquement cochée comme facturée, et n’apparait donc plus dans la
liste de traitement en masse.

 La tacite reconduction s’applique si l’utilisateur est muni du module et si le produit / service

ne dispose pas de date de fin.

Page 12 sur 17
Facturation et envoi en masse

Ce complément de module se base sur le module de facturation en masse présenté précédemment.

Celui-ci ajoute une option permettant d’envoyer toutes les factures générée par mail.
L’envoi ou non des factures se fait via la case à cocher suivante :

Afin de rendre l’envoi le plus flexible possible, le module propose un gabari de mail général ainsi que
la possibilité de modifier ce gabari pour chaque entreprise (si besoin).
L’objet et le contenu du mail sont ainsi paramétrables.
Le gabari général est modifiable via le panneau de configuration du module :

Un onglet « Abonnement » est ajouté sur la fiche client afin de modifier le mail pour un client
spécifique :

A noter que vous avez la possibilité d’ajouter deux variables pour rendre le contenu dynamique (le
nom du tiers ainsi que la période facturée).

Page 13 sur 17
Périodes non civiles

Comme mentionné précédemment, le module « contrat d’abonnement » se base sur les périodes
civiles pour établir les dates de ses périodes.
Ce choix a été fait afin de permettre à l’utilisateur final d’établir la majorité de ses factures le même jour (en
début ou en fin de mois).

Si ce comportement ne correspond pas à votre activité, le module complémentaire « Périodes non

civiles » permet de ne pas opter pour ces échéances.

Une fois installé, il est activable / désactivable dans le panneau de configuration du module
d’abonnements :

Dès que l’option est à « Non », les périodes seront basées strictement sur les dates spécifiées sur le
produit / service (contrat de base de Dolibarr).

Exemple avec l’option à « Oui » :

Page 14 sur 17
Exemple avec l’option à « Non » :

Page 15 sur 17
Partie 3 : Mises à jour

Les mises à jour des modules sont téléchargeables sur le site http://boutique.tuxserv.fr.
Pour installer les mises à jour, il suffit d’écraser les fichiers existants dans le cas d’une migration Dolibarr ou de
copier les fichiers sur la nouvelle installation.
Pour assurer le bon fonctionnement du module, il est nécessaire de désactiver / réactiver le module.

Partie 4 : Autres

N’hésitez pas à me contacter pour tout développement spécifique à l’adresse [email protected] en me

faisant parvenir votre cahier des charges.

---- Fin du document ----

Page 16 sur 17