Contract Refund On Stop
by ACSONE SA/NV https://github.com/OCA/contract , Odoo Community Association (OCA) https://github.com/OCA/contract| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Invoicing (account)
• Discuss (mail) |
| Community Apps Dependencies | Show |
| Lines of code | 5403 |
| Technical Name |
contract_refund_on_stop |
| License | AGPL-3 |
| Website | https://github.com/OCA/contract |
Contract Refund On Stop
This module allows stopping a contract line even after it has been invoiced.
When the stop date is earlier than the last invoiced date, the system will:
- Automatically create a refund invoice for the period between the stop date and the last invoiced date.
- Adjust the last_date_invoiced of the contract line to match the stop date.
- Proceed with the normal stop process.
To accurately compute the refund amount, the module depends on ``contract_variable_qty_prorated``, which provides the prorating logic used to determine how much of the previously invoiced quantity should be refunded based on the actual number of days covered by the refund period.
Without this dependency, it would not be possible to proportionally calculate the part of the invoiced quantity corresponding to unused service time when a contract is stopped mid-period.
This ensures that users can gracefully handle early contract terminations without manual refund management, while maintaining accurate prorated invoicing and accounting consistency.
Table of contents
Use Cases / Context
In the standard behavior of the Contract module, it is not possible to stop a contract line if its stop date is earlier than the last invoiced date. This restriction prevents users from adjusting contracts that were invoiced too far in advance.
In some business cases, however, a contract may need to be stopped retroactively (e.g., customer cancellation, early termination, or service interruption). In such cases, it is necessary to automatically create a refund for the invoiced period that should no longer be billed.
Configuration
To enable the refund behavior when stopping invoiced contract lines:
Go to Invoicing / Configuration / Settings.
In the Contracts section, enable the checkbox:
Enable Contract Line Refund on Stop
Usage
- Ensure the Enable Contract Line Refund on Stop option is enabled for your company.
- Open any active contract line that has been invoiced.
- Click Stop and choose a stop date earlier than the last invoiced period.
- The system will:
- Create a refund invoice covering the over-invoiced period.
- Update the contract line to end on the chosen stop date.
Bug Tracker
Bugs are tracked on GitHub 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.
Do not contact contributors directly about support or help with technical issues.
Credits
Authors
- ACSONE SA/NV
Contributors
- Souheil Bejaoui souheil.bejaoui@acsone.eu
Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
Current maintainer:
This module is part of the OCA/contract project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Please log in to comment on this module