Browse Source

[IMP] Fix README.rst

Runbot URL in old README.rst pointed to 10.0 runbot,
fixed by upgrading template
pull/173/head
Roel Adriaans 6 years ago
committed by Pedro M. Baeza
parent
commit
10417118a2
  1. 76
      contract/README.rst
  2. 2
      contract/readme/CONFIGURE.rst
  3. 5
      contract/readme/CONTRIBUTORS.rst
  4. 4
      contract/readme/DESCRIPTION.rst
  5. 2
      contract/readme/ROADMAP.rst
  6. 27
      contract/readme/USAGE.rst

76
contract/README.rst

@ -1,20 +1,45 @@
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
================================
Contracts Management - Recurring
================================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! 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 :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3 :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/11.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-11-0/contract-11-0-contract
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/110/11.0
:alt: Try me on Runbot
=================================
Contracts for recurrent invoicing
=================================
|badge1| |badge2| |badge3| |badge4| |badge5|
This module forward-port to v10 the contracts management with recurring
invoicing functions. Also you can print and send by email contract report.
This module brings back the contracts management with recurring invoicing
features. Also you can print and send by email contract report.
In upstream Odoo, this functionality was moved into the Enterprise edition. In upstream Odoo, this functionality was moved into the Enterprise edition.
**Table of contents**
.. contents::
:local:
Configuration Configuration
============= =============
To view discount field set *Discount on lines* in user access rights.
To view discount field in contract line, you need to set *Discount on lines* in
user access rights.
Usage Usage
===== =====
@ -31,6 +56,7 @@ To use this module, you need to:
years. years.
* Start date and next invoice date. * Start date and next invoice date.
* Invoicing type: pre-paid or post-paid. * Invoicing type: pre-paid or post-paid.
#. Add the lines to be invoiced with the product, description, quantity and #. Add the lines to be invoiced with the product, description, quantity and
price. price.
#. You can mark Auto-price? for having a price automatically obtained applying #. You can mark Auto-price? for having a price automatically obtained applying
@ -46,28 +72,34 @@ To use this module, you need to:
#. Click on *Print > Contract* menu to print contract report. #. Click on *Print > Contract* menu to print contract report.
#. Click on *Send by Email* button to send contract by email. #. Click on *Send by Email* button to send contract by email.
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
:alt: Try me on Runbot
:target: https://runbot.odoo-community.org/runbot/110/10.0
Known issues / Roadmap Known issues / Roadmap
====================== ======================
* Recover states and others functional fields in Contracts. * Recover states and others functional fields in Contracts.
Bug Tracker 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 smashing it by providing a detailed and welcomed feedback.
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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/contract/issues/new?body=module:%20contract%0Aversion:%2011.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 Credits
======= =======
Authors
~~~~~~~
* OpenERP SA
* Tecnativa
* LasLabs
Contributors Contributors
------------
~~~~~~~~~~~~
* Pedro M. Baeza <pedro.baeza@tecnativa.com> * Pedro M. Baeza <pedro.baeza@tecnativa.com>
* Carlos Dauden <carlos.dauden@tecnativa.com> * Carlos Dauden <carlos.dauden@tecnativa.com>
@ -75,17 +107,19 @@ Contributors
* Dave Lasley <dave@laslabs.com> * Dave Lasley <dave@laslabs.com>
* Vicent Cubells <vicent.cubells@tecnativa.com> * Vicent Cubells <vicent.cubells@tecnativa.com>
Maintainer
----------
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit https://odoo-community.org.
This module is part of the `OCA/contract <https://github.com/OCA/contract/tree/11.0/contract>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

2
contract/readme/CONFIGURE.rst

@ -0,0 +1,2 @@
To view discount field in contract line, you need to set *Discount on lines* in
user access rights.

5
contract/readme/CONTRIBUTORS.rst

@ -0,0 +1,5 @@
* Pedro M. Baeza <pedro.baeza@tecnativa.com>
* Carlos Dauden <carlos.dauden@tecnativa.com>
* Angel Moya <angel.moya@domatix.com>
* Dave Lasley <dave@laslabs.com>
* Vicent Cubells <vicent.cubells@tecnativa.com>

4
contract/readme/DESCRIPTION.rst

@ -0,0 +1,4 @@
This module brings back the contracts management with recurring invoicing
features. Also you can print and send by email contract report.
In upstream Odoo, this functionality was moved into the Enterprise edition.

2
contract/readme/ROADMAP.rst

@ -0,0 +1,2 @@
* Recover states and others functional fields in Contracts.

27
contract/readme/USAGE.rst

@ -0,0 +1,27 @@
To use this module, you need to:
#. Go to Accounting -> Contracts and select or create a new contract.
#. Check *Generate recurring invoices automatically*.
#. Fill fields for selecting the recurrency and invoice parameters:
* Journal
* Pricelist
* Period. It can be any interval of days, weeks, months, months last day or
years.
* Start date and next invoice date.
* Invoicing type: pre-paid or post-paid.
#. Add the lines to be invoiced with the product, description, quantity and
price.
#. You can mark Auto-price? for having a price automatically obtained applying
the pricelist to the product price.
#. You have the possibility to use the markers #START# or #END# in the
description field to show the start and end date of the invoiced period.
#. Choosing between pre-paid and post-paid, you modify the dates that are shown
with the markers.
#. A cron is created with daily interval, but if you are in debug mode, you can
click on *Create invoices* to force this action.
#. Click *Show recurring invoices* link to show all invoices created by the
contract.
#. Click on *Print > Contract* menu to print contract report.
#. Click on *Send by Email* button to send contract by email.
Loading…
Cancel
Save