Skip to content

Commit

Permalink
[ADD] - sale_order_line_cancel
Browse files Browse the repository at this point in the history
  • Loading branch information
sbejaoui authored and cyrilmanuel committed Nov 23, 2023
1 parent 9008e79 commit 7d37940
Show file tree
Hide file tree
Showing 21 changed files with 980 additions and 0 deletions.
96 changes: 96 additions & 0 deletions sale_order_line_cancel/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
======================
Sale Order Line Cancel
======================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsale--workflow-lightgray.png?logo=github
:target: https://github.com/OCA/sale-workflow/tree/16.0/sale_order_line_cancel
:alt: OCA/sale-workflow
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/sale-workflow-16-0/sale-workflow-16-0-sale_order_line_cancel
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/sale-workflow&target_branch=16.0
:alt: Try me on Runboat

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

This module allows you to cancel the remaining quantity on sale order by adding
a dedicated action to sale lines. It also add two new fields to track canceled
and remaining to deliver quantities.

This module differs from the original odoo behavior in the following way:

* In odoo, if the update of the quantity ordered is allowed on the sale order at
the confirmed state, odoo will recompute the required stock operations
according to the new quantity. This change is possible
even the stock operations are started for this sale order line.
* In this module, the quantity ordered is not updated on the sale order line to
keep track of the original ordered by the customer. At the same time, we
cancel only the stock moves for the remaining qty to deliver. This is only
possible if no operation is started for this sale order line.


.. warning::

It's not recommended to use this module if the update of the quantity ordered
on the sale order line is allowed the confirmed state. This could lead to
unpredictable behavior.

**Table of contents**

.. contents::
:local:

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/sale-workflow/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/sale-workflow/issues/new?body=module:%20sale_order_line_cancel%0Aversion:%2016.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
~~~~~~~

* Camptocamp
* ACSONE SA/NV

Contributors
~~~~~~~~~~~~

* Sylvain Van Hoof <[email protected]>
* Jacques-Etienne Baudoux (BCIM) <[email protected]>
* Souheil Bejaoui <[email protected]>

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

This module is part of the `OCA/sale-workflow <https://github.com/OCA/sale-workflow/tree/16.0/sale_order_line_cancel>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions sale_order_line_cancel/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from . import wizards
20 changes: 20 additions & 0 deletions sale_order_line_cancel/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# © 2016 Sylvain Van Hoof
# Copyright 2023 ACSONE SA/NV
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

{
"name": "Sale Order Line Cancel",
"version": "16.0.1.0.0",
"author": "Camptocamp, ACSONE SA/NV, Odoo Community Association (OCA)",
"license": "AGPL-3",
"category": "Sales",
"summary": """Sale cancel remaining""",
"depends": ["sale_stock"],
"data": [
"security/sale_order_line_cancel.xml",
"wizards/sale_order_line_cancel.xml",
"views/sale_order.xml",
"views/sale_order_line.xml",
],
"website": "https://github.com/OCA/sale-workflow",
}
3 changes: 3 additions & 0 deletions sale_order_line_cancel/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from . import sale_order_line
from . import stock_move
from . import sale_order
22 changes: 22 additions & 0 deletions sale_order_line_cancel/models/sale_order.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright 2023 ACSONE SA/NV
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import models


class SaleOrder(models.Model):

_inherit = "sale.order"

def action_draft(self):
res = super().action_draft()
orders = self.filtered(lambda s: s.state == "draft")
orders.order_line.write({"product_qty_canceled": 0})
return res

def _action_cancel(self):
res = super()._action_cancel()
orders = self.filtered(lambda s: s.state == "cancel")
for line in orders.order_line:
line.product_qty_canceled = line.product_uom_qty - line.qty_delivered
return res
43 changes: 43 additions & 0 deletions sale_order_line_cancel/models/sale_order_line.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Copyright 2018 Okia SPRL
# Copyright 2020 ACSONE SA/NV
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from odoo import api, fields, models


class SaleOrderLine(models.Model):
_inherit = "sale.order.line"

product_qty_canceled = fields.Float(
"Qty canceled", readonly=True, copy=False, digits="Product Unit of Measure"
)
product_qty_remains_to_deliver = fields.Float(
string="Remains to deliver",
digits="Product Unit of Measure",
compute="_compute_product_qty_remains_to_deliver",
store=True,
)
can_cancel_remaining_qty = fields.Boolean(
compute="_compute_can_cancel_remaining_qty"
)

@api.depends("product_qty_remains_to_deliver", "state")
def _compute_can_cancel_remaining_qty(self):
for rec in self:
rec.can_cancel_remaining_qty = (
rec.product_qty_remains_to_deliver > 0
and rec.state == "done"
and rec.move_ids
)

@api.depends(
"product_uom_qty",
"qty_delivered",
"product_qty_canceled",
)
def _compute_product_qty_remains_to_deliver(self):
for line in self:
remaining_to_deliver = (
line.product_uom_qty - line.qty_delivered - line.product_qty_canceled
)
line.product_qty_remains_to_deliver = remaining_to_deliver
20 changes: 20 additions & 0 deletions sale_order_line_cancel/models/stock_move.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2023 ACSONE SA/NV
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import models


class StockMove(models.Model):

_inherit = "stock.move"

def _action_cancel(self):
sale_moves = self.filtered(
lambda m: m.sale_line_id and m.state not in ("done", "cancel")
)
res = super()._action_cancel()
for rec in sale_moves:
if rec.state != "cancel":
continue

Check warning on line 18 in sale_order_line_cancel/models/stock_move.py

View check run for this annotation

Codecov / codecov/patch

sale_order_line_cancel/models/stock_move.py#L18

Added line #L18 was not covered by tests
rec.sale_line_id.product_qty_canceled = rec.product_uom_qty
return res
3 changes: 3 additions & 0 deletions sale_order_line_cancel/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* Sylvain Van Hoof <[email protected]>
* Jacques-Etienne Baudoux (BCIM) <[email protected]>
* Souheil Bejaoui <[email protected]>
21 changes: 21 additions & 0 deletions sale_order_line_cancel/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This module allows you to cancel the remaining quantity on sale order by adding
a dedicated action to sale lines. It also add two new fields to track canceled
and remaining to deliver quantities.

This module differs from the original odoo behavior in the following way:

* In odoo, if the update of the quantity ordered is allowed on the sale order at
the confirmed state, odoo will recompute the required stock operations
according to the new quantity. This change is possible
even the stock operations are started for this sale order line.
* In this module, the quantity ordered is not updated on the sale order line to
keep track of the original ordered by the customer. At the same time, we
cancel only the stock moves for the remaining qty to deliver. This is only
possible if no operation is started for this sale order line.


.. warning::

It's not recommended to use this module if the update of the quantity ordered
on the sale order line is allowed the confirmed state. This could lead to
unpredictable behavior.
14 changes: 14 additions & 0 deletions sale_order_line_cancel/security/sale_order_line_cancel.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2023 ACSONE SA/NV
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<odoo>
<record model="ir.model.access" id="sale_order_line_cancel_access">
<field name="name">sale.order.line.cancel access</field>
<field name="model_id" ref="model_sale_order_line_cancel" />
<field name="group_id" ref="sales_team.group_sale_manager" />
<field name="perm_read" eval="1" />
<field name="perm_create" eval="1" />
<field name="perm_write" eval="1" />
<field name="perm_unlink" eval="1" />
</record>
</odoo>
Loading

0 comments on commit 7d37940

Please sign in to comment.