contract/contract/README.rst

================================
Recurring - Contracts Management
================================

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

.. |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/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%2Fcontract-lightgray.png?logo=github
    :target: https://github.com/OCA/contract/tree/17.0/contract
    :alt: OCA/contract
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/contract-17-0/contract-17-0-contract
    :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=17.0
    :alt: Try me on Runboat

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

This module enables contracts management with recurring invoicing
functions. Also you can print and send by email contract report.

It works for customer contract and supplier contracts.

Contracts are shown in portal.

**Table of contents**

.. contents::
   :local:

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

To view discount field in contract line, you need to set *Discount on
lines* in user access rights.

Contracts can be viewed on the portal (list and detail) if the user
logged into the portal is a follower of the contract.

Usage
=====

1. Contracts are in Invoicing -> Customers -> Customer and Invoicing ->
   Vendors -> Supplier Contracts
2. When creating a contract, fill fields for selecting the invoicing
   parameters:

   -  a journal
   -  a price list (optional)

3. And add the lines to be invoiced with:

   -  the product with a description, a quantity and a price
   -  the recurrence parameters: interval (days, weeks, months, months
      last day or years), start date, date of next invoice
      (automatically computed, can be modified) and end date (optional)
   -  auto-price, for having a price automatically obtained from the
      price list
   -  #START# or #END# in the description field to display the start/end
      date of the invoiced period in the invoice line description
   -  pre-paid (invoice at period start) or post-paid (invoice at start
      of next period)

4. The "Generate Recurring Invoices from Contracts" cron runs daily to
   generate the invoices. If you are in debug mode, you can click on the
   invoice creation button.
5. The *Show recurring invoices* shortcut on contracts shows all
   invoices created from the contract.
6. The contract report can be printed from the Print menu
7. The contract can be sent by email with the *Send by Email* button
8. Contract templates can be created from the Configuration -> Contracts
   -> Contract Templates menu. They allow to define default journal,
   price list and lines when creating a contract. To use it, just select
   the template on the contract and fields will be filled automatically.

-  Contracts appear in portal to following users in every contract:

|image|

|image1|

|image2|

.. |image| image:: https://raw.githubusercontent.com/OCA/contract/17.0/contract/static/src/screenshots/portal-my.png
.. |image1| image:: https://raw.githubusercontent.com/OCA/contract/17.0/contract/static/src/screenshots/portal-list.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/contract/17.0/contract/static/src/screenshots/portal-detail.png

Known issues / Roadmap
======================

-  Recover states and others functional fields in Contracts.
-  Add recurrence flag at template level.

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%0Aversion:%2017.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
-------

* Tecnativa
* ACSONE SA/NV

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

-  Angel Moya <angel.moya@domatix.com>

-  Dave Lasley <dave@laslabs.com>

-  Miquel Raïch <miquel.raich@eficent.com>

-  Souheil Bejaoui <souheil.bejaoui@acsone.eu>

-  Thomas Binsfeld <thomas.binsfeld@acsone.eu>

-  Guillaume Vandamme <guillaume.vandamme@acsone.eu>

-  Raphaël Reverdy <raphael.reverdy@akretion.com>

-  `Tecnativa <https://www.tecnativa.com>`__:

      -  Pedro M. Baeza
      -  Carlos Dauden
      -  Vicent Cubells
      -  Rafael Blasco
      -  Víctor Martínez

-  Iván Antón <ozono@ozonomultimedia.com>

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/contract <https://github.com/OCA/contract/tree/17.0/contract>`_ project on GitHub.

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