Skip to content

Commit

Permalink
[IMP] account_invoice_overdue_reminder: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
NICO-SOLUTIONS committed Mar 25, 2024
1 parent 583ce78 commit 68c1011
Show file tree
Hide file tree
Showing 12 changed files with 258 additions and 127 deletions.
133 changes: 88 additions & 45 deletions account_invoice_overdue_reminder/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,48 +17,85 @@ Overdue Invoice Reminder
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcredit--control-lightgray.png?logo=github
:target: https://github.com/OCA/credit-control/tree/16.0/account_invoice_overdue_reminder
:target: https://github.com/OCA/credit-control/tree/17.0/account_invoice_overdue_reminder
:alt: OCA/credit-control
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/credit-control-16-0/credit-control-16-0-account_invoice_overdue_reminder
:target: https://translation.odoo-community.org/projects/credit-control-17-0/credit-control-17-0-account_invoice_overdue_reminder
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/credit-control&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/credit-control&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This Odoo module is designed to send overdue invoice reminders to customers. It handles reminders by e-mail, letter and phone.

This module is an alternative to the OCA module *account_credit_control*. Why another module for invoice reminders ? Because the module *account_credit_control* is quite complex (we experienced that some users find it too complex and eventually stop using it) and its interface is designed to send massive volume of reminders.

This module has been designed from the start with the following priorities:

* **keep control**: you must keep tight control on the overdue invoice reminders that you send. Overdue invoice reminders are part of the communication with your customers, and this is very important to keep a good relation with your customers.
* **usability**: the module is easy to configure and easy to use.
* **no accounting skills needed**: the module can be used by users without accounting skills. It can even be used by salesman!
* **multi-currency**: if you invoice your customer in another currency that your company currency, the invoice reminders only mention the currency of the invoices. And if you invoice a customer with different currencies, the reminder is clear and easy-to-understand by your customer, with a total residual per currency.
* **multi-channel**: supports overdue invoice reminders by e-mail (default), phone and letter.
* **simplicity**: for the developers, the code is small and easy to understand.

The specifications written before starting the development of this module are written in this `document <https://docs.google.com/document/d/1JIIAP5QsItbJ1zLiaGHuR0RAQplEGv3diOl-d4mS__I/edit?usp=sharing>`_ (in French).

The module has one important limitation: it sends a reminder for an invoice when it has past it's *Due Date* (which is in fact the *Final Due Date*): if the invoice has a payment term with several lines, it won't send a reminder before the last term is overdue.

An overdue reminder for a customer always include all the overdue invoices of that customer.
This Odoo module is designed to send overdue invoice reminders to
customers. It handles reminders by e-mail, letter and phone.

This module is an alternative to the OCA module
*account_credit_control*. Why another module for invoice reminders ?
Because the module *account_credit_control* is quite complex (we
experienced that some users find it too complex and eventually stop
using it) and its interface is designed to send massive volume of
reminders.

This module has been designed from the start with the following
priorities:

- **keep control**: you must keep tight control on the overdue invoice
reminders that you send. Overdue invoice reminders are part of the
communication with your customers, and this is very important to keep
a good relation with your customers.
- **usability**: the module is easy to configure and easy to use.
- **no accounting skills needed**: the module can be used by users
without accounting skills. It can even be used by salesman!
- **multi-currency**: if you invoice your customer in another currency
that your company currency, the invoice reminders only mention the
currency of the invoices. And if you invoice a customer with
different currencies, the reminder is clear and easy-to-understand by
your customer, with a total residual per currency.
- **multi-channel**: supports overdue invoice reminders by e-mail
(default), phone and letter.
- **simplicity**: for the developers, the code is small and easy to
understand.

The specifications written before starting the development of this
module are written in this
`document <https://docs.google.com/document/d/1JIIAP5QsItbJ1zLiaGHuR0RAQplEGv3diOl-d4mS__I/edit?usp=sharing>`__
(in French).

The module has one important limitation: it sends a reminder for an
invoice when it has past it's *Due Date* (which is in fact the *Final
Due Date*): if the invoice has a payment term with several lines, it
won't send a reminder before the last term is overdue.

An overdue reminder for a customer always include all the overdue
invoices of that customer.

The module supports a clever per-invoice reminder counter mechanism:

* the reminder counter is a property of an invoice,
* the reminder counter of each overdue invoice is incremented when sending a reminder by email or by post. It is not incremented for reminders by phone.
* in an email or a letter, the subject will be *Overdue invoice reminder n°N* where N is the maximum value of the counter of the overdue invoices plus one.
- the reminder counter is a property of an invoice,
- the reminder counter of each overdue invoice is incremented when
sending a reminder by email or by post. It is not incremented for
reminders by phone.
- in an email or a letter, the subject will be *Overdue invoice
reminder n°N* where N is the maximum value of the counter of the
overdue invoices plus one.

There are two user interfaces to send reminders:

* the **one-by-one** interface, which displays one screen for each customer that has overdue invoices, one after the other. You should use this interface when you have a reasonable volume of reminders to send (less than 100 overdue reminders for example). It gives you a tight control on the reminders and the possibility to easily and rapidly customize the reminder e-mails.
* the **mass** interface, which displays a list view of all customers that have overdue invoices, and you can process several reminders at the same time (via the *Actions* menu).
- the **one-by-one** interface, which displays one screen for each
customer that has overdue invoices, one after the other. You should
use this interface when you have a reasonable volume of reminders to
send (less than 100 overdue reminders for example). It gives you a
tight control on the reminders and the possibility to easily and
rapidly customize the reminder e-mails.
- the **mass** interface, which displays a list view of all customers
that have overdue invoices, and you can process several reminders at
the same time (via the *Actions* menu).

This video tutorial in English will show you how to configure and use the module: `Youtube link <https://www.youtube.com/watch?v=MaOoVAi7Tc0>`_.
This video tutorial in English will show you how to configure and use
the module: `Youtube
link <https://www.youtube.com/watch?v=MaOoVAi7Tc0>`__.

**Table of contents**

Expand All @@ -68,58 +105,64 @@ This video tutorial in English will show you how to configure and use the module
Usage
=====

Of course, before sending invoice reminders, you must import your bank statements and process them, so that you are up-to-date on customer payments.
Of course, before sending invoice reminders, you must import your bank
statements and process them, so that you are up-to-date on customer
payments.

Then, go to the menu *Invoicing > Customers > Overdue Invoice Remind*: you will get the start screen where you can:
Then, go to the menu *Invoicing > Customers > Overdue Invoice Remind*:
you will get the start screen where you can:

* filter the customers that you want to remind (filter by customer or by salesman),
* check that your bank journals are up-to-date,
* choose between the *one-by-one* and *mass* interfaces,
* customize some parameters.
- filter the customers that you want to remind (filter by customer or
by salesman),
- check that your bank journals are up-to-date,
- choose between the *one-by-one* and *mass* interfaces,
- customize some parameters.

Then follow the process until the end.

You can also start the invoice reminder wizard via the button *Overdue Reminder* on an overdue invoice.
You can also start the invoice reminder wizard via the button *Overdue
Reminder* on an overdue invoice.

Changelog
=========

16.0.1.2.0 (2023-12-11)
~~~~~~~~~~~~~~~~~~~~~~~
-----------------------

**Features**

- Credit notes have been added to the e-mail summary that are sent to the
customer. They are marked in a different colour.
- Credit notes have been added to the e-mail summary that are sent to
the customer. They are marked in a different colour.

Furthermore, the button toggle to allow to send a reminder with unreconciled
payments has been removed. The warning remains. (`#226 <https://github.com/OCA/credit-control/issues/226>`_)
Furthermore, the button toggle to allow to send a reminder with
unreconciled payments has been removed. The warning remains.
(`#226 <https://github.com/OCA/credit-control/issues/226>`__)

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/credit-control/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/credit-control/issues/new?body=module:%20account_invoice_overdue_reminder%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/credit-control/issues/new?body=module:%20account_invoice_overdue_reminder%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~
-------

* Akretion

Contributors
~~~~~~~~~~~~
------------

* Alexis de Lattre <[email protected]>
- Alexis de Lattre <[email protected]>

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -139,6 +182,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-alexis-via|

This module is part of the `OCA/credit-control <https://github.com/OCA/credit-control/tree/16.0/account_invoice_overdue_reminder>`_ project on GitHub.
This module is part of the `OCA/credit-control <https://github.com/OCA/credit-control/tree/17.0/account_invoice_overdue_reminder>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions account_invoice_overdue_reminder/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
1 change: 1 addition & 0 deletions account_invoice_overdue_reminder/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Alexis de Lattre \<<[email protected]>\>
1 change: 0 additions & 1 deletion account_invoice_overdue_reminder/readme/CONTRIBUTORS.rst

This file was deleted.

67 changes: 67 additions & 0 deletions account_invoice_overdue_reminder/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
This Odoo module is designed to send overdue invoice reminders to
customers. It handles reminders by e-mail, letter and phone.

This module is an alternative to the OCA module
*account_credit_control*. Why another module for invoice reminders ?
Because the module *account_credit_control* is quite complex (we
experienced that some users find it too complex and eventually stop
using it) and its interface is designed to send massive volume of
reminders.

This module has been designed from the start with the following
priorities:

- **keep control**: you must keep tight control on the overdue invoice
reminders that you send. Overdue invoice reminders are part of the
communication with your customers, and this is very important to keep
a good relation with your customers.
- **usability**: the module is easy to configure and easy to use.
- **no accounting skills needed**: the module can be used by users
without accounting skills. It can even be used by salesman!
- **multi-currency**: if you invoice your customer in another currency
that your company currency, the invoice reminders only mention the
currency of the invoices. And if you invoice a customer with different
currencies, the reminder is clear and easy-to-understand by your
customer, with a total residual per currency.
- **multi-channel**: supports overdue invoice reminders by e-mail
(default), phone and letter.
- **simplicity**: for the developers, the code is small and easy to
understand.

The specifications written before starting the development of this
module are written in this
[document](https://docs.google.com/document/d/1JIIAP5QsItbJ1zLiaGHuR0RAQplEGv3diOl-d4mS__I/edit?usp=sharing)
(in French).

The module has one important limitation: it sends a reminder for an
invoice when it has past it's *Due Date* (which is in fact the *Final
Due Date*): if the invoice has a payment term with several lines, it
won't send a reminder before the last term is overdue.

An overdue reminder for a customer always include all the overdue
invoices of that customer.

The module supports a clever per-invoice reminder counter mechanism:

- the reminder counter is a property of an invoice,
- the reminder counter of each overdue invoice is incremented when
sending a reminder by email or by post. It is not incremented for
reminders by phone.
- in an email or a letter, the subject will be *Overdue invoice reminder
n°N* where N is the maximum value of the counter of the overdue
invoices plus one.

There are two user interfaces to send reminders:

- the **one-by-one** interface, which displays one screen for each
customer that has overdue invoices, one after the other. You should
use this interface when you have a reasonable volume of reminders to
send (less than 100 overdue reminders for example). It gives you a
tight control on the reminders and the possibility to easily and
rapidly customize the reminder e-mails.
- the **mass** interface, which displays a list view of all customers
that have overdue invoices, and you can process several reminders at
the same time (via the *Actions* menu).

This video tutorial in English will show you how to configure and use
the module: [Youtube link](https://www.youtube.com/watch?v=MaOoVAi7Tc0).
31 changes: 0 additions & 31 deletions account_invoice_overdue_reminder/readme/DESCRIPTION.rst

This file was deleted.

10 changes: 10 additions & 0 deletions account_invoice_overdue_reminder/readme/HISTORY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## 16.0.1.2.0 (2023-12-11)

**Features**

- Credit notes have been added to the e-mail summary that are sent to
the customer. They are marked in a different colour.

Furthermore, the button toggle to allow to send a reminder with
unreconciled payments has been removed. The warning remains.
([\#226](https://github.com/OCA/credit-control/issues/226))
10 changes: 0 additions & 10 deletions account_invoice_overdue_reminder/readme/HISTORY.rst

This file was deleted.

17 changes: 17 additions & 0 deletions account_invoice_overdue_reminder/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Of course, before sending invoice reminders, you must import your bank
statements and process them, so that you are up-to-date on customer
payments.

Then, go to the menu *Invoicing \> Customers \> Overdue Invoice Remind*:
you will get the start screen where you can:

- filter the customers that you want to remind (filter by customer or by
salesman),
- check that your bank journals are up-to-date,
- choose between the *one-by-one* and *mass* interfaces,
- customize some parameters.

Then follow the process until the end.

You can also start the invoice reminder wizard via the button *Overdue
Reminder* on an overdue invoice.
Loading

0 comments on commit 68c1011

Please sign in to comment.