Skip to content

Commit

Permalink
[15.0][ADD] subscription_oca
Browse files Browse the repository at this point in the history
  • Loading branch information
carlos-domatix committed Aug 6, 2023
1 parent ef8e4a0 commit 352b39d
Show file tree
Hide file tree
Showing 33 changed files with 2,662 additions and 0 deletions.
1 change: 1 addition & 0 deletions setup/subscription_oca/odoo/addons/subscription_oca
6 changes: 6 additions & 0 deletions setup/subscription_oca/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import setuptools

setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)
93 changes: 93 additions & 0 deletions subscription_oca/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
=======================
Subscription management
=======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:f5f8f391e051c82382f00d567f85e52d015f4d8d3ac22490f25a42317c6232cc
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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%2Fcontract-lightgray.png?logo=github
:target: https://github.com/OCA/contract/tree/15.0/subscription_oca
:alt: OCA/contract
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/contract-15-0/contract-15-0-subscription_oca
: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=15.0
:alt: Try me on Runboat

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

This module allows creating subscriptions that generate recurring invoices or orders. It also enables the sale of products that generate subscriptions.

**Table of contents**

.. contents::
:local:

Usage
=====

To make a subscription:

#. Go to *Subscriptions > Configuration > Subscription templates*.
#. Create the templates you consider, choosing the billing frequency: daily, monthly... and the method of creating the invoice and/or order.
#. Go to *Subscription > Subscriptions*.
#. Create a subscription and indicate the start date. When the *Subscriptions Management* cron job is executed, the subscription will begin and the first invoice will be created if the execution date matches the start date. The invoice will also be created when the execution date matches the next invoice date. Additionally, you can manually change the subscription status and create an invoice.
#. The cron job will also end the subscription if its end date has been reached.

To create subscriptions with the sale of a product:

#. Go to *Subscriptions > Subscriptions > Products*.
#. Create the product and in the sales tab, complete the fields *Subscribable product* and *Subscription template*
#. Create a sales order with the product and confirm it.

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:%20subscription_oca%0Aversion:%2015.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
~~~~~~~

* Domatix

Contributors
~~~~~~~~~~~~

* Carlos Martínez <carlos@domatix.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/15.0/subscription_oca>`_ 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 subscription_oca/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from . import wizard
28 changes: 28 additions & 0 deletions subscription_oca/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copyright 2023 Domatix - Carlos Martínez
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{
"name": "Subscription management",
"summary": "Generate recurring invoices.",
"version": "15.0.1.0.0",
"development_status": "Beta",
"category": "Subscription Management",
"website": "https://github.com/OCA/contract",
"license": "AGPL-3",
"author": "Domatix, Odoo Community Association (OCA)",
"depends": ["sale_management", "account"],
"data": [
"views/product_template_views.xml",
"views/sale_subscription_views.xml",
"views/sale_subscription_stage_views.xml",
"views/sale_subscription_tag_views.xml",
"views/sale_subscription_template_views.xml",
"views/sale_order_views.xml",
"views/res_partner_views.xml",
"data/ir_cron.xml",
"data/sale_subscription_data.xml",
"wizard/close_subscription_wizard.xml",
"security/ir.model.access.csv",
],
"installable": True,
"application": True,
}
15 changes: 15 additions & 0 deletions subscription_oca/data/ir_cron.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="ir_cron_subscription_management" model="ir.cron">
<field name="name">Subscriptions management</field>
<field eval="True" name="active" />
<field name="user_id" ref="base.user_root" />
<field name="interval_number">24</field>
<field name="interval_type">hours</field>
<field name="numbercall">-1</field>
<field eval="False" name="doall" />
<field ref="model_sale_subscription" name="model_id" />
<field name="state">code</field>
<field name="code">model.cron_subscription_management()</field>
</record>
</odoo>
82 changes: 82 additions & 0 deletions subscription_oca/data/sale_subscription_data.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>

<data>
<record id="seq_id" model="ir.sequence">
<field name="name">sale_subscription_sequencer</field>
<field name="code">sale.subscription</field>
<field name="prefix">SUB</field>
<field name="padding">5</field>
</record>
</data>

<data noupdate="1">
<record id="subscription_stage_draft" model="sale.subscription.stage">
<!-- <field eval="True" name="active"/> -->
<field name="name">Ready to start</field>
<field name="sequence">0</field>
<field name="type">pre</field>
<field name="description">
DEFAULT STAGE

Draft equivalent, a subscription is ready to start when is not marked as in progress but it can be at any moment. If there's no 'Closed'-type stage defined, when a subscription comes to an end by automatic means, it will be marked with this stage.
</field>
<field eval="False" name="fold" />
</record>

<record id="subscription_stage_in_progress" model="sale.subscription.stage">
<!-- <field eval="True" name="active"/> -->
<field name="name">In progress</field>
<field name="sequence">1</field>
<field name="type">in_progress</field>
<field eval="False" name="fold" />
<field name="description">
DEFAULT STAGE

As an 'In progress'-type of stage, it will trigger the recurring invoicing process if applicable. If this stage is the first - sequence order - of the available 'In progress' types and there's a stage change from any other non-'In progress' types to this one, an invoice will be created automatically if the start date is the present day.
</field>
</record>

<record id="subscription_stage_closed" model="sale.subscription.stage">
<!-- <field eval="True" name="active"/> -->
<field name="name">Closed</field>
<field name="sequence">2</field>
<field name="type">post</field>
<field eval="False" name="fold" />
<field name="description">
DEFAULT STAGE

The final stage of a subscription. There are two ways to mark a subscription as closed. The easiest one is using the kanban card-moving capabilities, pressing the 'Close subscription' button (only available if a subscription is in progress).
</field>
</record>


</data>

<record id="close_reason_expensive" model="sale.subscription.close.reason">
<!-- <field eval="True" name="active"/> -->
<field name="name">The subscription is too expensive</field>
</record>

<record id="close_reason_expecs" model="sale.subscription.close.reason">
<!-- <field eval="True" name="active"/> -->
<field name="name">Subscription does not meet my requirements</field>
</record>

<record id="close_reason_ended" model="sale.subscription.close.reason">
<!-- <field eval="True" name="active"/> -->
<field name="name">The subscription ended</field>
</record>

<record id="close_reason_use" model="sale.subscription.close.reason">
<!-- <field eval="True" name="active"/> -->
<field name="name">I don't really use it</field>
</record>

<record id="close_reason_other" model="sale.subscription.close.reason">
<!-- <field eval="True" name="active"/> -->
<field name="name">Other</field>
</record>


</odoo>
9 changes: 9 additions & 0 deletions subscription_oca/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from . import account_move
from . import product_template
from . import res_partner
from . import sale_order
from . import sale_subscription
from . import sale_subscription_close_reason
from . import sale_subscription_stage
from . import sale_subscription_tag
from . import sale_subscription_template
12 changes: 12 additions & 0 deletions subscription_oca/models/account_move.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Copyright 2023 Domatix - Carlos Martínez
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import fields, models


class AccountMove(models.Model):
_inherit = "account.move"

subscription_id = fields.Many2one(
comodel_name="sale.subscription", string="Subscription"
)
13 changes: 13 additions & 0 deletions subscription_oca/models/product_template.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright 2023 Domatix - Carlos Martínez
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from odoo import fields, models


class Product(models.Model):
_inherit = "product.template"

subscribable = fields.Boolean(string="Subscribable product")

subscription_template_id = fields.Many2one(
comodel_name="sale.subscription.template", string="Subscription template"
)
35 changes: 35 additions & 0 deletions subscription_oca/models/res_partner.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Copyright 2023 Domatix - Carlos Martínez
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from odoo import fields, models


class Partner(models.Model):
_inherit = "res.partner"

subscription_ids = fields.One2many(
comodel_name="sale.subscription",
inverse_name="partner_id",
string="Subscriptions",
)

subscription_ids_count = fields.Integer(
string="Subscription Count",
required=False,
compute="_compute_subscription_ids_count",
)

def _compute_subscription_ids_count(self):
for record in self:
record.subscription_ids_count = len(record.subscription_ids)

Check warning on line 23 in subscription_oca/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

subscription_oca/models/res_partner.py#L23

Added line #L23 was not covered by tests

def action_view_subscription_ids(self):
return {

Check warning on line 26 in subscription_oca/models/res_partner.py

View check run for this annotation

Codecov / codecov/patch

subscription_oca/models/res_partner.py#L26

Added line #L26 was not covered by tests
"type": "ir.actions.act_window",
"res_model": "sale.subscription",
"domain": [("id", "in", self.subscription_ids.ids)],
"name": self.name,
"view_mode": "tree,form",
"context": {
"default_partner_id": self.id,
},
}
Loading

0 comments on commit 352b39d

Please sign in to comment.