Metadata-Version: 2.1
Name: odoo-addon-contract_line_successor
Version: 18.0.1.0.1.11
Requires-Python: >=3.10
Requires-Dist: odoo-addon-contract==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Contract Line Successor
Home-page: https://github.com/OCA/contract
License: AGPL-3
Author: ACSONE SA/NV,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 5 - Production/Stable
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=======================
Contract Line Successor
=======================

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

.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
    :target: https://odoo-community.org/page/development-status
    :alt: Production/Stable
.. |badge2| image:: https://img.shields.io/badge/license-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%2Fcontract-lightgray.png?logo=github
    :target: https://github.com/OCA/contract/tree/18.0/contract_line_successor
    :alt: OCA/contract
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/contract-18-0/contract-18-0-contract_line_successor
    :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/contract&target_branch=18.0
    :alt: Try me on Runboat

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

| **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.

**Table of contents**

.. contents::
   :local:

Configuration
=============

- | **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.

Usage
=====

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.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/contract/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/contract/issues/new?body=module:%20contract_line_successor%0Aversion:%2018.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

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

- Souheil Bejaoui souheil.bejaoui@acsone.eu (ACSONE SA/NV)

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.

.. |maintainer-sbejaoui| image:: https://github.com/sbejaoui.png?size=40px
    :target: https://github.com/sbejaoui
    :alt: sbejaoui

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-sbejaoui| 

This module is part of the `OCA/contract <https://github.com/OCA/contract/tree/18.0/contract_line_successor>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
