diff --git a/website_sale_charge_payment_fee/README.rst b/website_sale_charge_payment_fee/README.rst new file mode 100644 index 0000000000..fc5d88bd80 --- /dev/null +++ b/website_sale_charge_payment_fee/README.rst @@ -0,0 +1,112 @@ +============================= +eCommerce: charge payment fee +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:3a67cc1583ea293fcac70c6cdcae7551370e3a7669c85ef1dc2b2809983aff5d + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fe--commerce-lightgray.png?logo=github + :target: https://github.com/OCA/e-commerce/tree/18.0/website_sale_charge_payment_fee + :alt: OCA/e-commerce +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/e-commerce-18-0/e-commerce-18-0-website_sale_charge_payment_fee + :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/e-commerce&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to associate generic payment fee to online payment +methods. Thus, when website user select a payment method with additional +fee, an additional sale order line will be added to online order + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +Click + +Accounting -> Configuration -> Payments -> Payment Acquirers + +open an acquirer and in CHARGE PAYMENT FEE tab, you can set the fee to +be charged to customer. + +Known issues / Roadmap +====================== + +- As for now, this module does not handle express checkout. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Agile Business Group +* AITIC S.A.S +* Quartile Limited +* Studio73 + +Contributors +------------ + +- Lorenzo Battistini + +- AITIC S.A. + +- Quartile Limited + +- `Studio73 `__: + + - Miguel Gandia + +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-miguel-S73| image:: https://github.com/miguel-S73.png?size=40px + :target: https://github.com/miguel-S73 + :alt: miguel-S73 + +Current `maintainer `__: + +|maintainer-miguel-S73| + +This module is part of the `OCA/e-commerce `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/website_sale_charge_payment_fee/__init__.py b/website_sale_charge_payment_fee/__init__.py new file mode 100644 index 0000000000..f7209b1710 --- /dev/null +++ b/website_sale_charge_payment_fee/__init__.py @@ -0,0 +1,2 @@ +from . import models +from . import controllers diff --git a/website_sale_charge_payment_fee/__manifest__.py b/website_sale_charge_payment_fee/__manifest__.py new file mode 100644 index 0000000000..49f94e8d92 --- /dev/null +++ b/website_sale_charge_payment_fee/__manifest__.py @@ -0,0 +1,31 @@ +# Copyright 2018 Lorenzo Battistini - Agile Business Group +# Copyright 2020 AITIC S.A.S +# Copyright 2020 Quartile Limited +# Copyright 2024 Miguel Gandia - Studio73 +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). +{ + "name": "eCommerce: charge payment fee", + "summary": "Payment fee charged to customer", + "version": "18.0.1.0.0", + "category": "Website", + "website": "https://github.com/OCA/e-commerce", + "maintainers": ["miguel-S73"], + "author": "Agile Business Group, " + "AITIC S.A.S, " + "Quartile Limited, " + "Studio73, " + "Odoo Community Association (OCA)", + "license": "LGPL-3", + "application": False, + "installable": True, + "depends": ["payment", "website_sale"], + "data": ["views/payment_provider_views.xml", "views/website_sale_templates.xml"], + "assets": { + "web.assets_frontend": [ + "website_sale_charge_payment_fee/static/src/js/website_sale_fee.esm.js", + ], + "web.assets_tests": [ + "website_sale_charge_payment_fee/static/tests/tours/website_sale_fee_tour.esm.js", + ], + }, +} diff --git a/website_sale_charge_payment_fee/controllers/__init__.py b/website_sale_charge_payment_fee/controllers/__init__.py new file mode 100644 index 0000000000..12a7e529b6 --- /dev/null +++ b/website_sale_charge_payment_fee/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/website_sale_charge_payment_fee/controllers/main.py b/website_sale_charge_payment_fee/controllers/main.py new file mode 100644 index 0000000000..4dc63a9e16 --- /dev/null +++ b/website_sale_charge_payment_fee/controllers/main.py @@ -0,0 +1,43 @@ +# Copyright 2018 Lorenzo Battistini - Agile Business Group +# Copyright 2020 AITIC S.A.S +# Copyright 2020 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import http +from odoo.http import request + +from odoo.addons.website_sale.controllers.main import WebsiteSale + + +class WebsiteSaleFee(WebsiteSale): + @http.route( + "/shop/payment", type="http", auth="public", website=True, sitemap=False + ) + def shop_payment(self, **post): + order = request.website.sudo().sale_get_order() + render_values = self._get_shop_payment_values(order, **post) + provider_id = post.get("provider_id") + payment_option_id = post.get("payment_option_id") + payment_methods_sudo = render_values.get("payment_methods_sudo") + providers_sudo = render_values.get("providers_sudo") + selected_provider = False + if provider_id or providers_sudo: + if provider_id: + selected_provider = request.env["payment.provider"].browse( + int(provider_id) + ) + else: + _selected_provider = [ + provider_sudo + for provider_sudo in payment_methods_sudo.provider_ids + if provider_sudo in providers_sudo + ][:1] + if len(_selected_provider) > 0: + selected_provider = _selected_provider[0] + order.sudo().update_fee_line(selected_provider.sudo()) + res = super().shop_payment(**post) + if payment_option_id: + res.qcontext["selected_payment_method"] = int(payment_option_id) + if selected_provider: + res.qcontext["selected_provider"] = selected_provider + return res diff --git a/website_sale_charge_payment_fee/i18n/es.po b/website_sale_charge_payment_fee/i18n/es.po new file mode 100644 index 0000000000..d0670ed20f --- /dev/null +++ b/website_sale_charge_payment_fee/i18n/es.po @@ -0,0 +1,111 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * website_sale_charge_payment_fee +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 18.0+e\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-04-17 16:07+0000\n" +"PO-Revision-Date: 2025-04-17 16:07+0000\n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.method_form_fee +msgid "(Fee:" +msgstr "(Tasa:" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_provider__charge_fee +msgid "" +"An extra fee line will be added to online order when using this payment " +"method" +msgstr "" +"Se añadirá una línea de tarifa adicional al pedido en línea cuando se " +"utilice este método de pago" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.provider_form_fee_inherit +msgid "Charge payment fee" +msgstr "Cargo por pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_type +msgid "Computation type" +msgstr "Tipo de computación" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_currency_id +msgid "Fee Currency" +msgstr "Divisa de la Tasa" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_description +msgid "Fee Description" +msgstr "Descripción de Tasa" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_product_id +msgid "Fee Product" +msgstr "Producto de tarifa" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee +msgid "Fee charged to customer" +msgstr "Tarifa cobrada al cliente" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields.selection,name:website_sale_charge_payment_fee.selection__payment_provider__charge_fee_type__fixed +msgid "Fixed" +msgstr "Fijo" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_fixed_price +msgid "Fixed Price" +msgstr "Precio Fijo" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.payment_fee +msgid "Payment Fee" +msgstr "Cuota de pago:" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order__amount_payment_fee +msgid "Payment Fee Amount" +msgstr "Importe de la tarifa de pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_payment_provider +msgid "Payment Provider" +msgstr "Proveedor de pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line__payment_fee_line +msgid "Payment fee line" +msgstr "Línea de cuota pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_provider__charge_fee_percentage +#: model:ir.model.fields.selection,name:website_sale_charge_payment_fee.selection__payment_provider__charge_fee_type__percentage +msgid "Percentage" +msgstr "Porcentaje" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_provider__charge_fee_percentage +msgid "Percentage applied to order total" +msgstr "Porcentaje aplicado al total del pedido" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order +msgid "Sales Order" +msgstr "Pedido de venta" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order_line +msgid "Sales Order Line" +msgstr "Línea de pedido de venta" diff --git a/website_sale_charge_payment_fee/i18n/es_AR.po b/website_sale_charge_payment_fee/i18n/es_AR.po new file mode 100644 index 0000000000..efad6ff54d --- /dev/null +++ b/website_sale_charge_payment_fee/i18n/es_AR.po @@ -0,0 +1,113 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * website_sale_charge_payment_fee +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 12.0+e\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2020-06-01 03:04+0000\n" +"PO-Revision-Date: 2020-06-01 03:04+0000\n" +"Last-Translator: <>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.payment_tokens_list_fee +msgid "(Fee:" +msgstr "(Cargo:" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.cart_lines_fee +msgid "Add one" +msgstr "Agregue uno" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee +msgid "An extra fee line will be added to online order when using this payment method" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.acquirer_form_fee_inherit +msgid "Charge payment fee" +msgstr "Cargo por pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_type +msgid "Computation type" +msgstr "Tipo de computación" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_description +msgid "Fee Description" +msgstr "Descripción de la tarifa" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_product_id +msgid "Fee Product" +msgstr "Producto de tarifa" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee +msgid "Fee charged to customer" +msgstr "Tarifa cobrada al cliente" + +#. module: website_sale_charge_payment_fee +#: selection:payment.acquirer,charge_fee_type:0 +msgid "Fixed" +msgstr "Fijo" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_fixed_price +msgid "Fixed Price" +msgstr "Precio fijo" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_payment_acquirer +msgid "Payment Acquirer" +msgstr "Medio de pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line__payment_fee_line +msgid "Payment fee line" +msgstr "Línea de pago" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_percentage +#: selection:payment.acquirer,charge_fee_type:0 +msgid "Percentage" +msgstr "Porcentaje" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_percentage +msgid "Percentage applied to order total" +msgstr "Porcentaje aplicado al total del pedido" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.cart_lines_fee +msgid "Remove from cart" +msgstr "Eliminar del carrito" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.cart_lines_fee +msgid "Remove one" +msgstr "Eliminar uno" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order +msgid "Sale Order" +msgstr "Pedido de venta" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order_line +msgid "Sales Order Line" +msgstr "Línea de pedido de venta" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_tax_ids +msgid "Taxes" +msgstr "Impuestos" + diff --git a/website_sale_charge_payment_fee/i18n/website_sale_charge_payment_fee.pot b/website_sale_charge_payment_fee/i18n/website_sale_charge_payment_fee.pot new file mode 100644 index 0000000000..b08476ae09 --- /dev/null +++ b/website_sale_charge_payment_fee/i18n/website_sale_charge_payment_fee.pot @@ -0,0 +1,128 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * website_sale_charge_payment_fee +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.payment_tokens_list_fee +msgid "(Fee:" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee +msgid "" +"An extra fee line will be added to online order when using this payment " +"method" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.acquirer_form_fee_inherit +msgid "Charge payment fee" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_type +msgid "Computation type" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__display_name +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order__display_name +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line__display_name +msgid "Display Name" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_currency_id +msgid "Fee Currency" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_description +msgid "Fee Description" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_product_id +msgid "Fee Product" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee +msgid "Fee charged to customer" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields.selection,name:website_sale_charge_payment_fee.selection__payment_acquirer__charge_fee_type__fixed +msgid "Fixed" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_fixed_price +msgid "Fixed Price" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__id +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order__id +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line__id +msgid "ID" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer____last_update +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order____last_update +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line____last_update +msgid "Last Modified on" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_payment_acquirer +msgid "Payment Acquirer" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order__amount_payment_fee +msgid "Payment Fee Amount" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model_terms:ir.ui.view,arch_db:website_sale_charge_payment_fee.payment_fee +msgid "Payment Fee:" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_sale_order_line__payment_fee_line +msgid "Payment fee line" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,field_description:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_percentage +#: model:ir.model.fields.selection,name:website_sale_charge_payment_fee.selection__payment_acquirer__charge_fee_type__percentage +msgid "Percentage" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model.fields,help:website_sale_charge_payment_fee.field_payment_acquirer__charge_fee_percentage +msgid "Percentage applied to order total" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order +msgid "Sales Order" +msgstr "" + +#. module: website_sale_charge_payment_fee +#: model:ir.model,name:website_sale_charge_payment_fee.model_sale_order_line +msgid "Sales Order Line" +msgstr "" diff --git a/website_sale_charge_payment_fee/models/__init__.py b/website_sale_charge_payment_fee/models/__init__.py new file mode 100644 index 0000000000..816b38e533 --- /dev/null +++ b/website_sale_charge_payment_fee/models/__init__.py @@ -0,0 +1,3 @@ +from . import payment_provider +from . import sale_order +from . import sale_order_line diff --git a/website_sale_charge_payment_fee/models/payment_provider.py b/website_sale_charge_payment_fee/models/payment_provider.py new file mode 100644 index 0000000000..67b26f5652 --- /dev/null +++ b/website_sale_charge_payment_fee/models/payment_provider.py @@ -0,0 +1,41 @@ +# Copyright 2018 Lorenzo Battistini - Agile Business Group +# Copyright 2020 AITIC S.A.S +# Copyright 2020 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import api, fields, models + + +class PaymentProvider(models.Model): + _inherit = "payment.provider" + + charge_fee = fields.Boolean( + "Fee charged to customer", + help="An extra fee line will be added to online order when using this " + "payment method", + ) + charge_fee_description = fields.Text( + "Fee Description", compute="_compute_charge_fee_description" + ) + charge_fee_product_id = fields.Many2one( + "product.product", string="Fee Product", domain="[('type', '=', 'service')]" + ) + charge_fee_fixed_price = fields.Float("Fixed Price", digits="Product Price") + charge_fee_currency_id = fields.Many2one("res.currency", string="Fee Currency") + charge_fee_percentage = fields.Float( + "Percentage", help="Percentage applied to order total" + ) + charge_fee_type = fields.Selection( + [("fixed", "Fixed"), ("percentage", "Percentage")], + string="Computation type", + default="fixed", + ) + + @api.depends("charge_fee_product_id") + def _compute_charge_fee_description(self): + for provider in self: + provider.charge_fee_description = ( + provider.charge_fee_product_id.name + if provider.charge_fee_product_id + else None + ) diff --git a/website_sale_charge_payment_fee/models/sale_order.py b/website_sale_charge_payment_fee/models/sale_order.py new file mode 100644 index 0000000000..7748aa2d1d --- /dev/null +++ b/website_sale_charge_payment_fee/models/sale_order.py @@ -0,0 +1,83 @@ +# Copyright 2018 Lorenzo Battistini - Agile Business Group +# Copyright 2020 AITIC S.A.S +# Copyright 2020 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import api, fields, models + + +class SaleOrder(models.Model): + _inherit = "sale.order" + + # Follow the field definition as amount_delivery from + # the website_sale_delivery module. + amount_payment_fee = fields.Monetary( + compute="_compute_amount_payment_fee", + string="Payment Fee Amount", + store=True, + tracking=True, + ) + + def _compute_website_order_line(self): + res = super()._compute_website_order_line() + for order in self: + order.website_order_line = order.website_order_line.filtered( + lambda line: not line.payment_fee_line + ) + return res + + @api.depends( + "order_line.price_unit", + "order_line.tax_id", + "order_line.discount", + "order_line.product_uom_qty", + ) + def _compute_amount_payment_fee(self): + for order in self: + if ( + self.env["website"] + .get_current_website() + .show_line_subtotals_tax_selection + == "tax_excluded" + ): + order.amount_payment_fee = sum( + order.order_line.filtered("payment_fee_line").mapped( + "price_subtotal" + ) + ) + else: + order.amount_payment_fee = sum( + order.order_line.filtered("payment_fee_line").mapped("price_total") + ) + + def update_fee_line(self, provider): + self.ensure_one() + for line in self.order_line: + if line.payment_fee_line: + line.unlink() + if provider.charge_fee: + if provider.charge_fee_type == "fixed": + price = provider.charge_fee_fixed_price + if ( + provider.charge_fee_currency_id.id + != self.pricelist_id.currency_id.id + ): + price = provider.charge_fee_currency_id._convert( + price, + self.pricelist_id.currency_id, + self.company_id, + self.date_order, + ) + elif provider.charge_fee_type == "percentage": + price = (provider.charge_fee_percentage / 100.0) * self.amount_total + self.env["sale.order.line"].create( + { + "order_id": self.id, + "payment_fee_line": True, + "product_id": provider.charge_fee_product_id.id, + "product_uom": provider.charge_fee_product_id.uom_id.id, + "name": provider.charge_fee_description, + "price_unit": price, + "product_uom_qty": 1, + } + ) diff --git a/website_sale_charge_payment_fee/models/sale_order_line.py b/website_sale_charge_payment_fee/models/sale_order_line.py new file mode 100644 index 0000000000..06150137ff --- /dev/null +++ b/website_sale_charge_payment_fee/models/sale_order_line.py @@ -0,0 +1,12 @@ +# Copyright 2018 Lorenzo Battistini - Agile Business Group +# Copyright 2020 AITIC S.A.S +# Copyright 2020 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import fields, models + + +class SaleOrderLine(models.Model): + _inherit = "sale.order.line" + + payment_fee_line = fields.Boolean("Payment fee line", readonly=True) diff --git a/website_sale_charge_payment_fee/pyproject.toml b/website_sale_charge_payment_fee/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/website_sale_charge_payment_fee/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/website_sale_charge_payment_fee/readme/CONFIGURE.md b/website_sale_charge_payment_fee/readme/CONFIGURE.md new file mode 100644 index 0000000000..2fa4b33273 --- /dev/null +++ b/website_sale_charge_payment_fee/readme/CONFIGURE.md @@ -0,0 +1,6 @@ +Click + +Accounting -\> Configuration -\> Payments -\> Payment Acquirers + +open an acquirer and in CHARGE PAYMENT FEE tab, you can set the fee to +be charged to customer. diff --git a/website_sale_charge_payment_fee/readme/CONTRIBUTORS.md b/website_sale_charge_payment_fee/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..712a916a40 --- /dev/null +++ b/website_sale_charge_payment_fee/readme/CONTRIBUTORS.md @@ -0,0 +1,9 @@ +- Lorenzo Battistini \<\> + +- AITIC S.A. \<\> + +- Quartile Limited \<\> + +- [Studio73](https://www.studio73.es): + + > - Miguel Gandia diff --git a/website_sale_charge_payment_fee/readme/DESCRIPTION.md b/website_sale_charge_payment_fee/readme/DESCRIPTION.md new file mode 100644 index 0000000000..aefdfc90e3 --- /dev/null +++ b/website_sale_charge_payment_fee/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module allows to associate generic payment fee to online payment +methods. Thus, when website user select a payment method with additional +fee, an additional sale order line will be added to online order diff --git a/website_sale_charge_payment_fee/readme/ROADMAP.md b/website_sale_charge_payment_fee/readme/ROADMAP.md new file mode 100644 index 0000000000..ff8f68576e --- /dev/null +++ b/website_sale_charge_payment_fee/readme/ROADMAP.md @@ -0,0 +1 @@ +- As for now, this module does not handle express checkout. \ No newline at end of file diff --git a/website_sale_charge_payment_fee/static/description/icon.png b/website_sale_charge_payment_fee/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/website_sale_charge_payment_fee/static/description/icon.png differ diff --git a/website_sale_charge_payment_fee/static/description/index.html b/website_sale_charge_payment_fee/static/description/index.html new file mode 100644 index 0000000000..bc7b68c888 --- /dev/null +++ b/website_sale_charge_payment_fee/static/description/index.html @@ -0,0 +1,457 @@ + + + + + +eCommerce: charge payment fee + + + +
+

eCommerce: charge payment fee

+ + +

Beta License: LGPL-3 OCA/e-commerce Translate me on Weblate Try me on Runboat

+

This module allows to associate generic payment fee to online payment +methods. Thus, when website user select a payment method with additional +fee, an additional sale order line will be added to online order

+

Table of contents

+ +
+

Configuration

+

Click

+

Accounting -> Configuration -> Payments -> Payment Acquirers

+

open an acquirer and in CHARGE PAYMENT FEE tab, you can set the fee to +be charged to customer.

+
+
+

Known issues / Roadmap

+
    +
  • As for now, this module does not handle express checkout.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Agile Business Group
    • +
  • AITIC S.A.S
    • +
  • Quartile Limited
    • +
  • Studio73
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

miguel-S73

+

This module is part of the OCA/e-commerce project on GitHub.

+

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

+
+
+
+ + diff --git a/website_sale_charge_payment_fee/static/src/js/website_sale_fee.esm.js b/website_sale_charge_payment_fee/static/src/js/website_sale_fee.esm.js new file mode 100644 index 0000000000..778fbb7b2f --- /dev/null +++ b/website_sale_charge_payment_fee/static/src/js/website_sale_fee.esm.js @@ -0,0 +1,33 @@ +import {browser} from "@web/core/browser/browser"; +import paymentForm from "@payment/js/payment_form"; +paymentForm.include({ + async start() { + await this._super(...arguments); + const $paymentForm = this.target; + const $selectedProvider = $paymentForm.querySelector( + 'input[name="o_payment_radio"][checked="True"]' + ); + this.$selectedProvider = null; + if ($selectedProvider) { + this.$selectedProvider = $selectedProvider; + } + }, + + async _selectPaymentOption(ev) { + await this._super(...arguments); + const $radio = ev.target; + const providerId = this._getProviderId($radio); + const paymentOptionId = this._getPaymentOptionId($radio); + if (this.$selectedProvider !== $radio) { + this.target + .closest(".oe_website_sale") + .querySelector('button[name="o_payment_submit_button"]').disabled = + true; + browser.location.href = + "/shop/payment?provider_id=" + + providerId + + "&payment_option_id=" + + paymentOptionId; + } + }, +}); diff --git a/website_sale_charge_payment_fee/static/tests/tours/website_sale_fee_tour.esm.js b/website_sale_charge_payment_fee/static/tests/tours/website_sale_fee_tour.esm.js new file mode 100644 index 0000000000..bff11aca73 --- /dev/null +++ b/website_sale_charge_payment_fee/static/tests/tours/website_sale_fee_tour.esm.js @@ -0,0 +1,32 @@ +import * as tourUtils from "@website_sale/js/tours/tour_utils"; +import {registry} from "@web/core/registry"; + +registry.category("web_tour.tours").add("payment_fee_tour", { + url: "/shop", + steps: () => [ + ...tourUtils.searchProduct("Test-1"), + { + content: "select Test-1", + trigger: '.oe_product_cart:first a:contains("Test-1")', + run: "click", + }, + { + content: "add 3 into cart", + trigger: '#product_details input[name="add_qty"]', + run: "edit 3", + }, + { + content: "click on add to cart", + trigger: '#product_detail form[action^="/shop/cart/update"] #add_to_cart', + run: "click", + }, + { + content: "Go To Cart", + trigger: '.toast-body a:contains("View cart")', + run: "click", + expectUnloadPage: true, + }, + tourUtils.goToCheckout(), + tourUtils.confirmOrder(), + ], +}); diff --git a/website_sale_charge_payment_fee/tests/__init__.py b/website_sale_charge_payment_fee/tests/__init__.py new file mode 100644 index 0000000000..f8186b37a6 --- /dev/null +++ b/website_sale_charge_payment_fee/tests/__init__.py @@ -0,0 +1 @@ +from . import test_website_sale_fee diff --git a/website_sale_charge_payment_fee/tests/test_website_sale_fee.py b/website_sale_charge_payment_fee/tests/test_website_sale_fee.py new file mode 100644 index 0000000000..2673d2f7cd --- /dev/null +++ b/website_sale_charge_payment_fee/tests/test_website_sale_fee.py @@ -0,0 +1,107 @@ +# Copyright 2022 Studio73 - Miguel Gandía +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + + +from odoo import Command +from odoo.tests import HttpCase, RecordCapturer, tagged + + +@tagged("post_install", "-at_install") +class TestUi(HttpCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.product_product_service = cls.env["product.product"].create( + { + "name": "Discount wire tranfer", + "standard_price": 70.0, + "list_price": 79.0, + "sale_ok": True, + } + ) + cls.product_product_buy = cls.env["product.template"].create( + { + "name": "Test-1", + "standard_price": 33.0, + "list_price": 33.0, + "is_published": True, + "sale_ok": True, + "taxes_id": [Command.clear()], + } + ) + transfer_provider = cls.env.ref("payment.payment_provider_transfer") + transfer_provider.write( + { + "charge_fee": True, + "charge_fee_product_id": cls.product_product_service.id, + "charge_fee_type": "percentage", + "charge_fee_percentage": 10.00, + "state": "enabled", + "is_published": True, + } + ) + payment_method = cls.env["payment.method"].create( + { + "name": "wire transfer2", + "code": "wire_transfer2", + "sequence": 1000, + "active": True, + "provider_ids": [Command.link(transfer_provider.id)], + } + ) + transfer_provider.write( + { + "payment_method_ids": [ + Command.link(payment_method.id), + ] + } + ) + # Avoid Shipping/Billing address page + cls.env.ref("base.partner_demo_portal").write( + { + "street": "215 Vine St", + "city": "Scranton", + "zip": "18503", + "country_id": cls.env.ref("base.us").id, + "state_id": cls.env.ref("base.state_us_39").id, + "phone": "+1 555-555-5555", + "vat": "41511545146", + } + ) + cls.env["res.config.settings"].create( + { + "show_line_subtotals_tax_selection": "tax_excluded", + } + ).execute() + + def test_charge_payment_fee_percentage(self): + with RecordCapturer(self.env["sale.order"], []) as capture: + self.start_tour("/shop", "payment_fee_tour", login="portal") + created_order = capture.records + price = 10 / 100 * 99.0 + self.assertEqual(created_order.amount_payment_fee, price) + + def test_charge_payment_fee_fixed(self): + provider = self.env.ref("payment.payment_provider_transfer") + provider.write( + { + "charge_fee_type": "fixed", + "charge_fee_fixed_price": 10.00, + "charge_fee_currency_id": self.env.ref("base.USD").id, + } + ) + with RecordCapturer(self.env["sale.order"], []) as capture: + self.start_tour("/", "payment_fee_tour", login="portal") + created_order = capture.records + price = provider.charge_fee_fixed_price + if ( + provider.charge_fee_currency_id.id + != created_order.pricelist_id.currency_id.id + ): + price = provider.charge_fee_currency_id._convert( + price, + created_order.pricelist_id.currency_id, + created_order.company_id, + created_order.date_order, + ) + self.assertEqual(created_order.amount_payment_fee, price) diff --git a/website_sale_charge_payment_fee/views/payment_provider_views.xml b/website_sale_charge_payment_fee/views/payment_provider_views.xml new file mode 100644 index 0000000000..ee54b41df3 --- /dev/null +++ b/website_sale_charge_payment_fee/views/payment_provider_views.xml @@ -0,0 +1,65 @@ + + + + payment_provider.form.fee.inherit + payment.provider + + + + + + + + + + + + + + + + + + diff --git a/website_sale_charge_payment_fee/views/website_sale_templates.xml b/website_sale_charge_payment_fee/views/website_sale_templates.xml new file mode 100644 index 0000000000..dca1e469f8 --- /dev/null +++ b/website_sale_charge_payment_fee/views/website_sale_templates.xml @@ -0,0 +1,65 @@ + + + + + +