Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[16.0][Add] sale_order_blanket_order #3436

Open
wants to merge 40 commits into
base: 16.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
8fd7874
[DO NOT MERGE] tests dependency
lmignon Nov 25, 2024
86ffed5
[ADD] sale_order_blanket_order, sale_order_blanket_order_stock_prebook
lmignon Nov 26, 2024
47c45f0
[FIX] sale_order_blanket_order: Not compatible with sale_blanket_order
lmignon Dec 4, 2024
6db4530
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
14b4b03
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
fb48c28
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
d374a76
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
3ef53b7
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
b8b9003
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
7cfac20
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
1b1aa70
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
25a0b15
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
d9d79df
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
eba97ff
fixup! [ADD] sale_order_blanket_order, sale_order_blanket_order_stock…
lmignon Dec 6, 2024
72860aa
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
1dea676
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
fba53aa
Update sale_order_blanket_order/readme/USAGE.md
lmignon Dec 9, 2024
f94cc96
Update sale_order_blanket_order/readme/DESCRIPTION.md
lmignon Dec 9, 2024
3c87cc8
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
280c547
Update sale_order_blanket_order/i18n/fr.po
lmignon Dec 9, 2024
d072f86
Update sale_order_blanket_order/i18n/fr.po
lmignon Dec 9, 2024
7b285f3
Update sale_order_blanket_order/models/res_company.py
lmignon Dec 9, 2024
cd0e0a2
Update sale_order_blanket_order/models/res_config_settings.py
lmignon Dec 9, 2024
39dc6ff
Update sale_order_blanket_order/models/sale_order_line.py
lmignon Dec 9, 2024
c3b7363
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
f2170ff
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
e86a85e
Update sale_order_blanket_order/readme/CONTEXT.md
lmignon Dec 9, 2024
7eb5057
[FIXUP] translations
lmignon Dec 9, 2024
a0016e3
[FIXUP] don't use freezetime at class level to avoid bloking tests
lmignon Dec 9, 2024
8cc6357
[FIXUP] little improvements
lmignon Dec 9, 2024
2977606
[FIXUP] check constrains on confirm to ease creation process
lmignon Dec 9, 2024
d4ff6cb
[FIXUP] raise right exception
lmignon Dec 9, 2024
be10c8d
[FIXUP] Improves perf
lmignon Dec 9, 2024
a4bb856
[FIXUP] check line overlap only at confirmation
lmignon Dec 11, 2024
dff351c
[FIXUP] no taxes on call off lines
lmignon Dec 17, 2024
8051695
[FIXUP] allows to change the reservation strategy while the blanket o…
lmignon Dec 18, 2024
fff6a65
[FIXUP] allows to change the eol strategy while the blanket order is …
lmignon Dec 18, 2024
666fa5a
[FIXUP] allows to control cut-off auto create on the SO
lmignon Dec 18, 2024
fb44614
FIXUP translations
lmignon Dec 18, 2024
62b6d5e
[FIXUP] allows to update the product_uom_qty into blanket order
lmignon Dec 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,17 @@ jobs:
name: test with OCB
makepot: "true"
- container: ghcr.io/oca/oca-ci/py3.10-odoo16.0:latest
exclude: "sale_packaging_default,sale_order_product_recommendation,sale_order_product_recommendation_packaging_default,sale_order_product_recommendation_elaboration"
exclude: "sale_packaging_default,sale_order_product_recommendation,sale_order_product_recommendation_packaging_default,sale_order_product_recommendation_elaboration,sale_order_blanket_order,sale_order_blanket_order_stock_prebook"
name: test with Odoo
- container: ghcr.io/oca/oca-ci/py3.10-ocb16.0:latest
exclude: "sale_packaging_default,sale_order_product_recommendation,sale_order_product_recommendation_packaging_default,sale_order_product_recommendation_elaboration"
exclude: "sale_packaging_default,sale_order_product_recommendation,sale_order_product_recommendation_packaging_default,sale_order_product_recommendation_elaboration,sale_order_blanket_order,sale_order_blanket_order_stock_prebook"
name: test with OCB
makepot: "true"
- container: ghcr.io/oca/oca-ci/py3.10-odoo16.0:latest
include: "sale_order_blanket_order,sale_order_blanket_order_stock_prebook"
name: test with Odoo
- container: ghcr.io/oca/oca-ci/py3.10-ocb16.0:latest
include: "sale_order_blanket_order,sale_order_blanket_order_stock_prebook"
name: test with OCB
makepot: "true"
services:
Expand Down
223 changes: 223 additions & 0 deletions sale_order_blanket_order/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
========================
Sale Order Blanket Order
========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:d0b6a096d18178fbd15da557bf07466d1ff491c59a2b56a17781a6d020da21dd
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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_blanket_order
: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_blanket_order
: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/sale-workflow&target_branch=16.0
:alt: Try me on Runboat

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

This module extends the functionality of Sale Order to support Blanket
Order and Call-off Order.

Blanket Order
=============

A Blanket Order is a standard sales order with the following specific
features:

- Type: Classified as "Blanket Order".
- Defined Duration: Includes a validity period (end date).
- Payment Terms: Allows selection of preferred terms (e.g., 90 days end
of month, upon delivery, etc.).
- Invoicing Policy: Can be based on product settings or the order
itself.
- Stock Reservation: Allows advance reservation of sold quantities.
- Handling Unfulfilled Quantities: Provides options for dealing with
undelivered quantities upon order expiration.
- Prices are calculated based on existing rules since it is a standard
sales order type.

The blanket order serves as the central element triggering stock
management and invoicing mechanisms.

Stock Management
----------------

Delivered quantities are tracked on the sales order lines as with
regular sales orders. By default, the stock is not reserved upon
confirmation of the blanket order. This is achieved by using the OCA
module
`sale_manual_delivery <https://pypi.org/project/odoo-addon-sale-manual-delivery/>`__.
As a result, the stock will be reserved only when a call-off order is
created for the quantity to be delivered.

In some cases, you may want to reserve stock upon confirmation of the
blanket order. This can be achieved by using the OCA module
`sale_order_blanket_order_stock_prebook <https://pypi.org/project/odoo-addon-sale-order-blanket-order-stock-prebook/>`__.
This module extends the functionality of Sale Blanket Order to support
the reservation of stock for future consumption by call-off orders. The
reservation is done at the time of the blanket order confirmation for a
consumption starting at the validity start date of the blanket order.
This behavior can be configured on the blanket order.

Invoicing
---------

Standard invoicing policies apply (e.g., invoice on order or on
delivery). Payment terms are configurable per order. Prepayment can be
enforced by configuring the invoicing policy at the order level using
the OCA module
`sale_invoice_policy <https://pypi.org/project/odoo-addon-sale-invoice-policy/>`__.

Consumption Management
----------------------

A wizard will be available on the blanket order to initiate a delivery.
It allows users to select products and quantities for delivery. This
action creates a Call-off Order linked to the blanket order.

Call-off Order
==============

A Call-off Order is a standard sales order with these specific
characteristics:

- Type: Classified as "Call-off Order".
- Linked to Blanket Order: Only includes products from the blanket
order.
- Delivery Release: Enables the release of reserved stock for delivery.
- No Invoicing or Stock Management: These are handled via the linked
blanket order.

Stock Management
----------------

No delivery is generated directly from the call-off order.

It triggers:

- Release of the reserved quantity in the blanket order.
- Adjustment of stock reservations for the remaining quantities.

Standard Sales Orders
=====================

To support existing workflows (e.g., e-commerce), call-off orders can be
generated transparently from standard sales orders based on product and
availability:

Entire orders may be converted into call-off orders if all products are
linked to a blanket order. Mixed orders split call-off items into a new
call-off order, with both confirmed within the available quantities of
the blanket order.

**Table of contents**

.. contents::
:local:

Use Cases / Context
===================

When a company sells the same products to the same customers on a
regular basis, it's a common business practice to create a blanket order
that defines the terms and conditions of the sales.

If you need a way to define:

- the terms and conditions of the sales,
- the payment terms,
- the delivery terms,

and also secure the quantities of the products to be delivered, the sale
order blanket order module is the right choice.

This module introduces 2 new kinds of sales orders:

1. Blanket Order: This is a sales order that defines the terms and
conditions of the sales, the price, the payment terms, the delivery
terms, and secures the quantities of the products to be delivered.

2. Call of order: This is a sales order linked to a blanket order that
is created to trigger the delivery of quantities of the products
secured in the blanket order.

Others modules can be used to provide the same kind of features. For
example, the module
(sale_blanket_order)[`https://pypi.org/project/odoo-addon-sale-blanket-order] <https://pypi.org/project/odoo-addon-sale-blanket-order]>`__
also defines the concept of sale blanket order. The main difference
between the two modules is that the sale order blanket order module
extends the sale order model to add the sale blanket order and the call
off order. This allows to keep the benefits of all the extensions made
on the sale order model by other modules without having to adapt them to
the sale blanket order model (discount, invoicing; inventory process,
...).

Usage
=====

By default, the automatic creation of call-off orders from normal sale
orders containing products part of a blanket order is disabled. To
enable this feature, you need to go into the sales settings and enable
the option "Create Call-Off from SO if possible".

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/sale-workflow/issues/new?body=module:%20sale_order_blanket_order%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
-------

* ACSONE SA/NV
* BCIM

Contributors
------------

- Laurent Mignon\ [email protected] (https://www.acsone.eu)
- Jacques-Etienne Baudoux (BCIM) [email protected]

Other credits
-------------

The development of this module has been financially supported by:

- ALCYON Belux

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_blanket_order>`_ 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_blanket_order/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from .hooks import pre_init_hook
23 changes: 23 additions & 0 deletions sale_order_blanket_order/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Copyright 2024 ACSONE SA/NV
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "Sale Order Blanket Order",
"summary": """Manage blanket order and call of ordr""",
"version": "16.0.1.0.0",
"license": "AGPL-3",
"author": "ACSONE SA/NV,BCIM,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/sale-workflow",
"depends": [
"sale_manual_delivery",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lmignon The install of this addon does not work on large database.

See: #3476

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rousseldenis
It worked on my very large database.... (even if it was not fast and should be improved)

],
"excludes": ["sale_blanket_order"],
"data": [
"views/sale_order.xml",
"views/sale_order_line.xml",
"views/res_config_settings.xml",
"data/ir_cron.xml",
],
"demo": [],
"pre_init_hook": "pre_init_hook",
}
25 changes: 25 additions & 0 deletions sale_order_blanket_order/data/ir_cron.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8" ?>
<!-- Copyright 2024 ACSONE SA/NV
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -->
<odoo noupdate="1">
<record
forcecreate="True"
id="ir_cron_sale_order_blanket_order_finalizer"
model="ir.cron"
>
<field name="name">Finalize expired sale blanket orders</field>
<field eval="True" name="active" />
<field name="model_id" ref="sale.model_sale_order" />
<field name="state">code</field>
<field name="code">model._cron_manage_blanket_order_eol()</field>
<field name="user_id" ref="base.user_root" />
<field name="interval_number">1</field>
<field name="interval_type">days</field>
<field name="numbercall">-1</field>
<field name="doall" eval="False" />
<field
name="nextcall"
eval="(DateTime.now() + timedelta(days=1)).strftime('%Y-%m-%d 01:00:00')"
/>
</record>
</odoo>
38 changes: 38 additions & 0 deletions sale_order_blanket_order/hooks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import logging

_logger = logging.getLogger(__name__)


def pre_init_hook(cr):
_logger.info("Create column order_type in sale_order with default value 'order'")
cr.execute(
"ALTER TABLE sale_order ADD COLUMN order_type varchar(255) DEFAULT 'order'"
)
# drop the default value since it was only used to fill the column in existing records
cr.execute("ALTER TABLE sale_order ALTER COLUMN order_type DROP DEFAULT")

_logger.info(
"Create column order_type in sale_order_line with default value 'order'"
)
cr.execute(
"ALTER TABLE sale_order_line ADD COLUMN order_type varchar(255) DEFAULT 'order'"
)
# drop the default value since it was only used to fill the column in existing records
cr.execute("ALTER TABLE sale_order_line ALTER COLUMN order_type DROP DEFAULT")

_logger.info(
"Create columns for blanket order in sale_order and "
"sale_order_line to avoid computing the field for all records at module install"
)
# avoid computing the field for all records at module install
cr.execute(
"ALTER TABLE sale_order_line ADD COLUMN call_off_remaining_qty double precision"
)
cr.execute(
"ALTER TABLE sale_order_line ADD COLUMN blanket_validity_start_date date"
)
cr.execute("ALTER TABLE sale_order_line ADD COLUMN blanket_validity_end_date date")
cr.execute("ALTER TABLE sale_order_line ADD COLUMN blanket_order_id integer")
cr.execute(
"ALTER TABLE sale_order ADD COLUMN blanket_reservation_strategy varchar(255)"
)
Loading
Loading