odoo-addon-contract-line-successor 18.0.1.0.0.2__py3-none-any.whl

odoo/addons/contract_line_successor/models/contract_line_constraints.py

@@ -0,0 +1,429 @@
+# Copyright 2018 ACSONE SA/NV.
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import itertools
+from collections import namedtuple
+
+from odoo.fields import Date
+
+Criteria = namedtuple(
+    "Criteria",
+    [
+        "when",  # Contract line relatively to today (BEFORE, IN, AFTER)
+        "has_date_end",  # Is date_end set on contract line (bool)
+        "has_last_date_invoiced",  # Is last_date_invoiced set on contract line
+        "is_auto_renew",  # Is is_auto_renew set on contract line (bool)
+        "has_successor",  # Is contract line has_successor (bool)
+        "predecessor_has_successor",
+        # Is contract line predecessor has successor (bool)
+        # In almost of the cases
+        # contract_line.predecessor.successor == contract_line
+        # But at cancel action,
+        # contract_line.predecessor.successor == False
+        # This is to permit plan_successor on predecessor
+        # If contract_line.predecessor.successor != False
+        # and contract_line is canceled, we don't allow uncancel
+        # else we re-link contract_line and its predecessor
+        "canceled",  # Is contract line canceled (bool)
+    ],
+)
+Allowed = namedtuple(
+    "Allowed",
+    ["plan_successor", "stop_plan_successor", "stop", "cancel", "uncancel"],
+)
+
+
+def _expand_none(criteria):
+    variations = []
+    for attribute, value in criteria._asdict().items():
+        if value is None:
+            if attribute == "when":
+                variations.append(["BEFORE", "IN", "AFTER"])
+            else:
+                variations.append([True, False])
+        else:
+            variations.append([value])
+    return itertools.product(*variations)
+
+
+def _add(matrix, criteria, allowed):
+    """Expand None values to True/False combination"""
+    for c in _expand_none(criteria):
+        matrix[c] = allowed
+
+
+CRITERIA_ALLOWED_DICT = {
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=True,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=True,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=True,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=False,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=True,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=True,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=True,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=False,
+        has_last_date_invoiced=False,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=True,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=True,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=True,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=True,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="BEFORE",
+        has_date_end=False,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=True,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=True,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=True,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=True,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="IN",
+        has_date_end=False,
+        has_last_date_invoiced=True,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=True,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="AFTER",
+        has_date_end=True,
+        has_last_date_invoiced=None,
+        is_auto_renew=True,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="AFTER",
+        has_date_end=True,
+        has_last_date_invoiced=None,
+        is_auto_renew=False,
+        has_successor=True,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=False,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when="AFTER",
+        has_date_end=True,
+        has_last_date_invoiced=None,
+        is_auto_renew=False,
+        has_successor=False,
+        predecessor_has_successor=None,
+        canceled=False,
+    ): Allowed(
+        plan_successor=True,
+        stop_plan_successor=False,
+        stop=True,
+        cancel=False,
+        uncancel=False,
+    ),
+    Criteria(
+        when=None,
+        has_date_end=None,
+        has_last_date_invoiced=None,
+        is_auto_renew=None,
+        has_successor=None,
+        predecessor_has_successor=False,
+        canceled=True,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=False,
+        cancel=False,
+        uncancel=True,
+    ),
+    Criteria(
+        when=None,
+        has_date_end=None,
+        has_last_date_invoiced=None,
+        is_auto_renew=None,
+        has_successor=None,
+        predecessor_has_successor=True,
+        canceled=True,
+    ): Allowed(
+        plan_successor=False,
+        stop_plan_successor=False,
+        stop=False,
+        cancel=False,
+        uncancel=False,
+    ),
+}
+criteria_allowed_dict = {}
+
+for c in CRITERIA_ALLOWED_DICT:
+    _add(criteria_allowed_dict, c, CRITERIA_ALLOWED_DICT[c])
+
+
+def compute_when(date_start, date_end):
+    today = Date.today()
+    if today < date_start:
+        return "BEFORE"
+    if date_end and today > date_end:
+        return "AFTER"
+    return "IN"
+
+
+def compute_criteria(
+    date_start,
+    date_end,
+    has_last_date_invoiced,
+    is_auto_renew,
+    successor_contract_line_id,
+    predecessor_contract_line_id,
+    is_canceled,
+):
+    return Criteria(
+        when=compute_when(date_start, date_end),
+        has_date_end=bool(date_end),
+        has_last_date_invoiced=bool(has_last_date_invoiced),
+        is_auto_renew=is_auto_renew,
+        has_successor=bool(successor_contract_line_id),
+        predecessor_has_successor=bool(
+            predecessor_contract_line_id.successor_contract_line_id
+        ),
+        canceled=is_canceled,
+    )
+
+
+def get_allowed(
+    date_start,
+    date_end,
+    has_last_date_invoiced,
+    is_auto_renew,
+    successor_contract_line_id,
+    predecessor_contract_line_id,
+    is_canceled,
+):
+    criteria = compute_criteria(
+        date_start,
+        date_end,
+        has_last_date_invoiced,
+        is_auto_renew,
+        successor_contract_line_id,
+        predecessor_contract_line_id,
+        is_canceled,
+    )
+    if criteria in criteria_allowed_dict:
+        return criteria_allowed_dict[criteria]
+    return False

odoo/addons/contract_line_successor/models/contract_template_line.py

@@ -0,0 +1,35 @@
+# Copyright 2025 ACSONE SA/NV
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ContractTemplateLine(models.Model):
+    _inherit = "contract.template.line"
+
+    is_auto_renew = fields.Boolean(string="Auto Renew", default=False)
+    auto_renew_interval = fields.Integer(
+        string="Renew Every",
+        default=1,
+        help="Renew every (Days/Weeks/Months/Years)",
+    )
+    auto_renew_rule_type = fields.Selection(
+        [
+            ("daily", "Day(s)"),
+            ("weekly", "Week(s)"),
+            ("monthly", "Month(s)"),
+            ("yearly", "Year(s)"),
+        ],
+        default="yearly",
+        string="Renewal type",
+        help="Specify interval for automatic renewal.",
+    )
+    termination_notice_interval = fields.Integer(
+        default=1,
+        string="Termination Notice Before",
+    )
+    termination_notice_rule_type = fields.Selection(
+        [("daily", "Day(s)"), ("weekly", "Week(s)"), ("monthly", "Month(s)")],
+        default="monthly",
+        string="Termination Notice type",
+    )

odoo/addons/contract_line_successor/models/res_company.py

@@ -0,0 +1,15 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ResCompany(models.Model):
+    _inherit = "res.company"
+
+    create_new_line_at_contract_line_renew = fields.Boolean(
+        help="If checked, a new line will be generated at contract line renew "
+        "and linked to the original one as successor. The default "
+        "behavior is to extend the end date of the contract by a new "
+        "subscription period",
+    )

odoo/addons/contract_line_successor/models/res_config_settings.py

@@ -0,0 +1,18 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ResConfigSettings(models.TransientModel):
+    _inherit = "res.config.settings"
+
+    create_new_line_at_contract_line_renew = fields.Boolean(
+        related="company_id.create_new_line_at_contract_line_renew",
+        readonly=False,
+        string="Create New Line At Contract Line Renew",
+        help="If checked, a new line will be generated at contract line renew "
+        "and linked to the original one as successor. The default "
+        "behavior is to extend the end date of the contract by a new "
+        "subscription period",
+    )

odoo/addons/contract_line_successor/readme/CONFIGURE.md

@@ -0,0 +1,10 @@
+- **Auto-Renewal Strategy**  
+  In the company settings, define whether renewing a contract line:
+  - Extends the current line (updates `date_end`),
+  - or creates a new successor contract line.
+  
+  Field:  
+  `Company > Configuration > Contracts > Create new contract line at renewal`
+- **Scheduled Actions**  
+  Ensure the scheduled action `Contract Line: Auto Renew` is activated if you
+  want automatic renewal without manual intervention.

odoo/addons/contract_line_successor/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- Souheil Bejaoui <souheil.bejaoui@acsone.eu> (ACSONE SA/NV)

odoo/addons/contract_line_successor/readme/DESCRIPTION.md

@@ -0,0 +1,40 @@
+**Contract Line Successor** extends `contract.line` model to support advanced
+contract lifecycle management, including suspension, successor planning,
+cancellation, and renewal.  
+It provides a flexible and robust framework for managing complex contract
+line scenarios in a clean and structured way.
+
+## Features
+
+- **Successor and Predecessor Management**
+  - Link contract lines with successor and predecessor lines.
+  - Plan successors automatically or manually after a stop or suspension.
+
+- **Contract Line Lifecycle States**
+  - Manage contract lines with the following computed states:
+    - `Upcoming`
+    - `In-Progress`
+    - `To Renew`
+    - `Upcoming Close`
+    - `Closed`
+    - `Canceled`
+
+- **Lifecycle Operations**
+  - Stop a contract line.
+  - Plan a successor for a contract line.
+  - Stop and plan a successor in one operation (useful for suspensions).
+  - Cancel and un-cancel contract lines.
+  - Renew contract lines automatically (new line or extension).
+
+- **Auto-Renewal Handling**
+  - Auto-renewal based on company settings (extend existing line or create a new one).
+  - Cron job to automate renewal of eligible contract lines.
+
+- **Data Integrity and Validation**
+  - Prevent invalid successor or predecessor configurations.
+  - Validate state transitions and date overlaps.
+  - Ensure clean renewal and cancellation workflows.
+
+- **Audit Trail**
+  - Automatic posting of chatter messages for lifecycle events like stops, 
+    renewals, suspensions, cancellations, etc.

odoo/addons/contract_line_successor/readme/USAGE.md

@@ -0,0 +1,6 @@
+1. **Select a contract** and enable the option **"Recurrence at line level?"**.
+2. Once enabled, you will have access to several actions at the contract line level:
+   - **Stop** a contract line and optionally **plan a successor**.
+   - **Handle temporary suspensions** and **resume** the contract line after the suspension period.
+   - **Cancel** and **un-cancel** contract lines if necessary.
+   - **Renew** contract lines either by **extending** the current line or by **creating a new successor line** automatically.

odoo/addons/contract_line_successor/security/ir.model.access.csv

@@ -0,0 +1,2 @@
+"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink"
+"contract_line_wizard","contract_line_wizard","model_contract_line_wizard","account.group_account_manager",1,1,1,1