48
edits
Module Auto Reminder: Difference between revisions
Jump to navigation
Jump to search
Traduction en anglais
(Création de la page) Tag: 2017 source edit |
(Traduction en anglais) Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Auto Reminder module by Stéphane Mallet Informatique}} | {{DISPLAYTITLE:Auto Reminder module by Stéphane Mallet Informatique}} | ||
[[Category:Complementary modules]] | |||
[[Category:Modules complémentaires]] | [[Category:Modules complémentaires]] | ||
= | =Information= | ||
{{TemplateModuleInfo | {{TemplateModuleInfo | ||
|modulename=Auto Reminder | |modulename=Auto Reminder | ||
| Line 8: | Line 9: | ||
|web=https://web-pilot.fr/offres/rsi | |web=https://web-pilot.fr/offres/rsi | ||
|status=stable | |status=stable | ||
|prerequisites=Dolibarr 19 minimum - PHP 7.1 minimum - | |prerequisites=Dolibarr 19 minimum - PHP 7.1 minimum - Scheduled jobs module enabled | ||
|webbuy=https://www.dolistore.com/product.php?id=2770&l= | |webbuy=https://www.dolistore.com/product.php?id=2770&l=en | ||
|note= | |note=Free module, GPLv3 license. Source code and zip: https://framagit.org/Steph501/dolibarr-mod-autoreminder | ||
}} | }} | ||
''' | '''Short description:''' Automatically sends invoices as soon as they are validated, and reminds unpaid invoices through configurable levels. One module, two automations, a single daily scheduled job. | ||
= | =Features= | ||
== | ==Automatic sending of validated invoices== | ||
* | * Every validated invoice is emailed without any action, with its PDF attached. | ||
* | * The email template is picked among the existing Dolibarr templates. | ||
* | * Each invoice is sent only once: the module keeps track of it in the agenda. | ||
* | * The recipient is resolved automatically: billing contact, then third party contact, then third party email. | ||
== | ==Reminders for unpaid invoices== | ||
* | * Reminders rely on levels you define: a delay in days and an email template for each level. | ||
* | * Any number of levels. | ||
* | * A negative delay sends the reminder '''before''' the due date, as a preventive notice. | ||
* Option | * Option to include or exclude partially paid invoices. | ||
* | * An invoice is never reminded twice for the same level. | ||
* | * The delay is counted from the due date, or from the invoice date when no due date is set. | ||
== | ==Excluding a customer or an invoice from reminders== | ||
* | * An "Exclude from automatic reminders" checkbox is added on the '''third party card''': this customer receives no reminder at all, while every other customer keeps being reminded. | ||
* | * The same checkbox is added on the '''invoice card''': useful for a disputed invoice or a negotiated payment schedule, without stopping the reminders of the other invoices of that customer. | ||
* | * These exclusions only apply to reminders. The initial invoice sending is not affected. | ||
== | ==Miscellaneous== | ||
* | * The module interface is translated into English, French, Spanish, German and Italian. | ||
* | * Both automations are carried by a single daily scheduled job, created when the module is enabled. | ||
= | =Prerequisites= | ||
* Dolibarr 19 | * Dolibarr 19 or above. | ||
* PHP 7.1 | * PHP 7.1 or above. | ||
* | * The Dolibarr '''Scheduled jobs''' module enabled, and a system cron calling Dolibarr (on most shared hosting, this task has to be created in the hosting control panel). Without it, no automatic sending happens. | ||
* | * A working email setup in Dolibarr (Home - Setup - Emails). | ||
=Installation= | =Installation= | ||
{{ | {{InstallModuleEn}} | ||
The zip is available for free on Dolistore: https://www.dolistore.com/product.php?id=2770&l=en | |||
The source code is public: https://framagit.org/Steph501/dolibarr-mod-autoreminder | |||
=Configuration= | =Configuration= | ||
{{ | {{ActivationModuleEn}} | ||
Once the module is enabled, its setup page allows you to: | |||
* | * enable the automatic sending of validated invoices, and choose the email template used; | ||
* | * enable the reminders, and decide whether partially paid invoices are concerned; | ||
* | * create the reminder levels: for each level, a delay in days and an email template. | ||
With no level configured, no reminder is sent: the module says so on its setup page. | |||
= | =Usage= | ||
There is nothing to do on a daily basis: the scheduled job takes care of the sendings. | |||
To stop reminding a customer, open the third party card, edit it, and tick '''Exclude from automatic reminders'''. To skip one specific invoice, tick the same checkbox on that invoice card. | |||
= | =Upgrade= | ||
Upload the new zip over the previous one (Home - Setup - Modules - Deploy external module), then '''disable and enable the module again'''. This last step is required for the new fields to be created. Since version 1.1.0, your settings and your reminder levels are kept during this operation. | |||
= | =Version history= | ||
* '''1.1.1''' : | * '''1.1.1''': module translated into Spanish, German and Italian. | ||
* '''1.1.0''' : exclusion | * '''1.1.0''': exclusion of reminders per third party and per invoice. Fix: settings are no longer lost when the module is disabled. | ||
* '''1.0.0''' : | * '''1.0.0''': initial release (automatic sending of validated invoices, reminders for unpaid invoices by levels). | ||
=Support= | =Support= | ||
By email: contact@stephane-mallet.fr | |||
{{DEFAULTSORT:Auto Reminder}} | {{DEFAULTSORT:Auto Reminder}} | ||