Chl 0b08f125c9 readme: specify 'customer invoice'

Following the arrival of supplier invoice templates in Dolibarr 16, it's better
to specify than this module only manage customer invoices.

Adding the management of supplier invoice seems possible but I don't really see
a use case at the moment.

2024-03-13 18:54:01 +01:00

3.5 KiB

Raw Blame History

SendRecurringInvoiceByMail for DOLIBARR ERP CRM

Features

(en) This module sends by email the customer invoice generated with a recurring invoice template via scheduled jobs.

(fr) Ce module envoie par mail les factures clientes générées automatiquement par les travaux planifiés et les factures modèles.

You can customize the mail globally or by recurring invoice.

To edit the default global mail template, go to Home > Setup > Emails > Email templates, and modify the SendRecurringInvoiceByMail : original template. If you don't want to attach the PDF of the invoice to the mails, set the Attach file input to 0 (default: 1, PDF attached).

To edit the default sender address, go to Home > Setup > Emails, and edit the Sender email for automatic emails field.

This module hooks himself on the end of the Recurring invoices job from the Scheduled jobs (aka. cron) module. It will only be triggered via this Scheduled job and will not send mail when manually generating an invoice from a recurring invoice template.

Requirements

It requires Dolibarr version 10.0 at least (first version with the cron/afterCreationOfRecurringInvoice() hook).

Don't forget to also activate the Scheduled jobs module.

Other modules are available on Dolistore.com.

Install

From the ZIP file and GUI interface

Go to Home > Setup > Modules/Applications and finally the Deploy/install external app/module tab and upload the module_sendrecurringinvoicebymail-x.y.z.zip file (you can get it from the original forge or Github).

Next, on the Modules/Applications page, activate the newly available sendrecurringinvoicebymail module, and probably the Scheduled jobs (alias cron or modCron) integrated module too.

Troubleshooting

Note: If the module screen tells you there is no custom directory, check that your setup is correct:

In your Dolibarr installation directory, edit the htdocs/conf/conf.php file and check that following lines are not commented:
```
//$dolibarr_main_url_root_alt ...
//$dolibarr_main_document_root_alt ...
```

Uncomment them if necessary (delete the leading //) and assign a sensible value according to your Dolibarr installation

For example :

UNIX:

$dolibarr_main_url_root_alt = '/custom';
$dolibarr_main_document_root_alt = '/var/www/Dolibarr/htdocs/custom';

Windows:

$dolibarr_main_url_root_alt = '/custom';
$dolibarr_main_document_root_alt = 'C:/My Web Sites/Dolibarr/htdocs/custom';

From a GIT repository

Clone the repository in $dolibarr_main_document_root_alt/sendrecurringinvoicebymail

cd ....../custom
git clone https://code.bugness.org/Dolibarr/sendrecurringinvoicebymail.git sendrecurringinvoicebymail

Then, from your browser:

Log into Dolibarr as a super-administrator
Go to "Setup" -> "Modules"
You should now be able to find and enable the module

Updating instructions

Disable the module,
Update the files (see Install),
Re-enable the module.

Licenses

Main code

GPLv3 or (at your option) any later version.

See file COPYING for more information.

Documentation

All texts and readmes.

3.5 KiB Raw Blame History