From cb0c6361cc9ac7d92731f7e0267124205246abc3 Mon Sep 17 00:00:00 2001 From: Cedric Collins Date: Fri, 22 Jan 2021 14:16:21 -0600 Subject: [PATCH 01/10] [ADD] website_sale_payment_terms: allow ecommerce customers to choose payment terms H4799 --- website_sale_payment_terms/__init__.py | 2 + website_sale_payment_terms/__manifest__.py | 26 ++++ .../controllers/__init__.py | 1 + .../controllers/main.py | 76 +++++++++ website_sale_payment_terms/models/__init__.py | 5 + website_sale_payment_terms/models/account.py | 7 + website_sale_payment_terms/models/payment.py | 21 +++ .../models/res_config.py | 9 ++ website_sale_payment_terms/models/sale.py | 18 +++ website_sale_payment_terms/models/website.py | 12 ++ .../static/src/js/payment_terms.js | 107 +++++++++++++ .../views/account_views.xml | 17 ++ .../views/res_config_views.xml | 27 ++++ .../views/web_assets.xml | 10 ++ .../views/website_templates.xml | 145 ++++++++++++++++++ .../views/website_views.xml | 16 ++ 16 files changed, 499 insertions(+) create mode 100644 website_sale_payment_terms/__init__.py create mode 100644 website_sale_payment_terms/__manifest__.py create mode 100644 website_sale_payment_terms/controllers/__init__.py create mode 100644 website_sale_payment_terms/controllers/main.py create mode 100644 website_sale_payment_terms/models/__init__.py create mode 100644 website_sale_payment_terms/models/account.py create mode 100644 website_sale_payment_terms/models/payment.py create mode 100644 website_sale_payment_terms/models/res_config.py create mode 100644 website_sale_payment_terms/models/sale.py create mode 100644 website_sale_payment_terms/models/website.py create mode 100644 website_sale_payment_terms/static/src/js/payment_terms.js create mode 100644 website_sale_payment_terms/views/account_views.xml create mode 100644 website_sale_payment_terms/views/res_config_views.xml create mode 100644 website_sale_payment_terms/views/web_assets.xml create mode 100644 website_sale_payment_terms/views/website_templates.xml create mode 100644 website_sale_payment_terms/views/website_views.xml diff --git a/website_sale_payment_terms/__init__.py b/website_sale_payment_terms/__init__.py new file mode 100644 index 00000000..91c5580f --- /dev/null +++ b/website_sale_payment_terms/__init__.py @@ -0,0 +1,2 @@ +from . import controllers +from . import models diff --git a/website_sale_payment_terms/__manifest__.py b/website_sale_payment_terms/__manifest__.py new file mode 100644 index 00000000..6fdfc70f --- /dev/null +++ b/website_sale_payment_terms/__manifest__.py @@ -0,0 +1,26 @@ +{ + 'name': 'Website Payment Terms', + 'author': 'Hibou Corp. ', + 'category': 'Sales', + 'version': '13.0.1.0.0', + 'description': + """ +Website Payment Terms +===================== + +Allow customers to choose payment terms if order total meets a configured threshold. + """, + 'depends': [ + 'sale_payment_deposit', + 'website_sale', + 'website_sale_delivery', + ], + 'auto_install': False, + 'data': [ + 'views/account_views.xml', + 'views/res_config_views.xml', + 'views/web_assets.xml', + 'views/website_templates.xml', + 'views/website_views.xml', + ], +} diff --git a/website_sale_payment_terms/controllers/__init__.py b/website_sale_payment_terms/controllers/__init__.py new file mode 100644 index 00000000..12a7e529 --- /dev/null +++ b/website_sale_payment_terms/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/website_sale_payment_terms/controllers/main.py b/website_sale_payment_terms/controllers/main.py new file mode 100644 index 00000000..c7bf2301 --- /dev/null +++ b/website_sale_payment_terms/controllers/main.py @@ -0,0 +1,76 @@ +from odoo.http import request, route +from odoo.addons.website_sale.controllers.main import WebsiteSale + + +class WebsiteSalePaymentTerms(WebsiteSale): + + # In case payment_term_id is set by query-string in a link (from website_sale_delivery) + @route(['/shop/payment'], type='http', auth="public", website=True) + def payment(self, **post): + order = request.website.sale_get_order() + payment_term_id = post.get('payment_term_id') + if order.amount_total <= request.website.payment_deposit_threshold: + if payment_term_id: + payment_term_id = int(payment_term_id) + if order: + order._check_payment_term_quotation(payment_term_id) + if payment_term_id: + return request.redirect("/shop/payment") + else: + order.payment_term_id = False + + return super(WebsiteSalePaymentTerms, self).payment(**post) + + # Main JS driven payment term updater. + @route(['/shop/update_payment_term'], type='json', auth='public', methods=['POST'], website=True, csrf=False) + def update_order_payment_term(self, **post): + order = request.website.sale_get_order() + payment_term_id = int(post['payment_term_id']) + try: + if order: + order._check_payment_term_quotation(payment_term_id) + return self._update_website_payment_term_return(order, **post) + except: + return {'error': '[101] Unable to update payment terms.'} + + # Return values after order payment_term_id is updated + def _update_website_payment_term_return(self, order, **post): + if order: + return { + 'payment_term_name': order.payment_term_id.name, + 'payment_term_id': order.payment_term_id.id, + 'note': order.payment_term_id.note, + 'require_payment': order.require_payment, + } + return {} + + @route(['/shop/reject_term_agreement'], type='http', auth='public', website=True) + def reject_term_agreement(self, **kw): + order = request.website.sale_get_order() + if order: + partner = request.env.user.partner_id + order.write({'payment_term_id': request.website.sale_get_payment_term(partner), + 'require_payment': True}) + return request.redirect('/shop/cart') + + # Confirm order without taking payment + @route(['/shop/confirm_without_payment'], type='http', auth='public', website=True) + def confirm_without_payment(self, **post): + order = request.website.sale_get_order() + if not order: + return request.redirect('/shop') + if order.require_payment: + return request.redirect('/shop/payment') + if not order.payment_term_id or ( + order.payment_term_id.deposit_percentage or order.payment_term_id.deposit_flat): + return request.redirect('/shop/payment') + + # made it this far, lets confirm + order.sudo().action_confirm() + request.session['sale_last_order_id'] = order.id + + # cleans session/context + # This should always exist, but it is possible to + if request.website and request.website.sale_reset: + request.website.sale_reset() + return request.redirect('/shop/confirmation') diff --git a/website_sale_payment_terms/models/__init__.py b/website_sale_payment_terms/models/__init__.py new file mode 100644 index 00000000..dc24d95a --- /dev/null +++ b/website_sale_payment_terms/models/__init__.py @@ -0,0 +1,5 @@ +from . import account +from . import payment +from . import res_config +from . import sale +from . import website diff --git a/website_sale_payment_terms/models/account.py b/website_sale_payment_terms/models/account.py new file mode 100644 index 00000000..386c5578 --- /dev/null +++ b/website_sale_payment_terms/models/account.py @@ -0,0 +1,7 @@ +from odoo import fields, models + + +class AccountPaymentTerm(models.Model): + _inherit = 'account.payment.term' + + allow_in_website_sale = fields.Boolean('Allow in website checkout') diff --git a/website_sale_payment_terms/models/payment.py b/website_sale_payment_terms/models/payment.py new file mode 100644 index 00000000..748c891e --- /dev/null +++ b/website_sale_payment_terms/models/payment.py @@ -0,0 +1,21 @@ +from odoo import models, _ + + +class PaymentTransaction(models.Model): + _inherit = 'payment.transaction' + + def render_sale_button(self, order, submit_txt=None, render_values=None): + values = { + 'partner_id': order.partner_id.id, + 'type': self.type, + } + if render_values: + values.update(render_values) + # Not very elegant to do that here but no choice regarding the design. + self._log_payment_transaction_sent() + return self.acquirer_id.with_context(submit_class='btn btn-primary', submit_txt=submit_txt or _('Pay Now')).sudo().render( + self.reference, + order.amount_total_deposit or order.amount_total, + order.pricelist_id.currency_id.id, + values=values, + ) diff --git a/website_sale_payment_terms/models/res_config.py b/website_sale_payment_terms/models/res_config.py new file mode 100644 index 00000000..2595876a --- /dev/null +++ b/website_sale_payment_terms/models/res_config.py @@ -0,0 +1,9 @@ +from odoo import fields, models + + +class WebsiteConfigSettings(models.TransientModel): + _inherit = 'res.config.settings' + + payment_deposit_threshold = fields.Monetary(string="Payment Deposit Threshold", + related="website_id.payment_deposit_threshold", + readonly=False) diff --git a/website_sale_payment_terms/models/sale.py b/website_sale_payment_terms/models/sale.py new file mode 100644 index 00000000..b7a98e83 --- /dev/null +++ b/website_sale_payment_terms/models/sale.py @@ -0,0 +1,18 @@ +from odoo import fields, models + + +class SaleOrder(models.Model): + _inherit = 'sale.order' + + def _check_payment_term_quotation(self, payment_term_id): + self.ensure_one() + if payment_term_id and self.payment_term_id.id != payment_term_id: + # TODO how can we set a default if we can only set ones partner has assigned... + # Otherwise.. how do we prevent using any payment term by ID? + payment_term = self.env['account.payment.term'].sudo().browse(payment_term_id) + if not payment_term.exists(): + raise Exception('Could not find payment terms.') + self.write({ + 'payment_term_id': payment_term_id, + 'require_payment': bool(payment_term.deposit_percentage) or bool(payment_term.deposit_flat), + }) diff --git a/website_sale_payment_terms/models/website.py b/website_sale_payment_terms/models/website.py new file mode 100644 index 00000000..3388f5f1 --- /dev/null +++ b/website_sale_payment_terms/models/website.py @@ -0,0 +1,12 @@ +from odoo import fields, models + + +class Website(models.Model): + _inherit = 'website' + + payment_deposit_threshold = fields.Monetary(string='Payment Deposit Threshold', + help='Allow customers to make a deposit when their order ' + 'total is above this amount.') + + def get_payment_terms(self): + return self.env['account.payment.term'].search([('allow_in_website_sale', '=', True)]) diff --git a/website_sale_payment_terms/static/src/js/payment_terms.js b/website_sale_payment_terms/static/src/js/payment_terms.js new file mode 100644 index 00000000..6eaeaa46 --- /dev/null +++ b/website_sale_payment_terms/static/src/js/payment_terms.js @@ -0,0 +1,107 @@ +odoo.define('website_sale_payment_terms.payment_terms', function (require) { + "use strict"; + + require('web.dom_ready'); + var ajax = require('web.ajax'); + var concurrency = require('web.concurrency'); + var dp = new concurrency.DropPrevious(); + var publicWidget = require('web.public.widget'); + require('website_sale_delivery.checkout'); + + + console.log('Payment Terms V10.1'); + + var available_term = $('input[name="payment_term_id"]').length; + if (available_term > 0) { + console.log('Payment term detected'); + // Detect pay button and disable on page load - This isn't ideal but there is something I cant find that is preventing disabling this + setTimeout(function(){ $('#o_payment_form_pay').prop('disabled', true); }, 500); + } else { + console.log('no payment term detected'); + } + + // Calculate amount Due Now + function calculate_deposit(t, d, f) { + var amount = t * d / 100 + f; + if (amount > 0) { + amount = amount.toFixed(2); + amount = amount.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ","); + return amount; + } else { + amount = 0.00; + return amount; + } + } + + // Payment input clicks update sale.order payment_term_id + var _onPaymentTermClick = function (ev) { + $('#o_payment_form_pay').prop('disabled', true); + var payment_term_id = $(ev.currentTarget).val(); + var values = {'payment_term_id': payment_term_id}; + dp.add(ajax.jsonRpc('/shop/update_payment_term', 'call', values).then(_onPaymentTermUpdateAnswer)); + }; + var $payment_terms = $("#payment_terms input[name='payment_term_id']"); + $payment_terms.click(_onPaymentTermClick); + + + // All input clicks update due amount + function updateAmountDue() { + var $amount_total = $('#order_total span.oe_currency_value').html().replace(',', ''); + $amount_total = parseFloat($amount_total); + var $checked = $('input[name="payment_term_id"]:checked'); + var $deposit_percentage = $checked.attr('data-deposit-percentage'); + var $deposit_flat = parseFloat($checked.attr('data-deposit-flat')); + var $due_amount = calculate_deposit($amount_total, $deposit_percentage, $deposit_flat); + $('#order_due_today span.oe_currency_value').html($due_amount); + } + + // update amount due after delivery options change + publicWidget.registry.websiteSaleDelivery.include({ + _handleCarrierUpdateResult: function (result) { + this._super.apply(this, arguments); + updateAmountDue(); + }, + }); + + // Show amount due if operation is a success + var _onPaymentTermUpdateAnswer = function (result) { + if (!result.error) { + + // Get Payment Term note/description for modal + var note = result.note; + if (!result.note) { + note = result.payment_term_name; + } + + // Change forms based on order payment requirement + updateAmountDue(); + if(!result.require_payment) { + $('#payment_method').hide(); + $('#non_payment_method').show(); + $('#order_due_today').hide(); + } else { + $('#payment_method').show(); + $('#non_payment_method').hide(); + $('#order_due_today').show(); + } + + // Open success modal with message + $('#payment_term_success_modal .success-modal-note').text(note); + $('#payment_term_success_modal').modal(); + } else { + // Open error modal + console.error(result); + $('#payment_term_error_modal').modal(); + } + }; + +}); + +function deny_payment_terms() { + $('#o_payment_form_pay').prop('disabled', true); + window.location = '/shop/reject_term_agreement'; +} + +function accept_payment_terms() { + $('#o_payment_form_pay').prop('disabled', false); +} diff --git a/website_sale_payment_terms/views/account_views.xml b/website_sale_payment_terms/views/account_views.xml new file mode 100644 index 00000000..f2828904 --- /dev/null +++ b/website_sale_payment_terms/views/account_views.xml @@ -0,0 +1,17 @@ + + + + + view.payment.term.form.inherit.website + account.payment.term + + + + + + + + + + + diff --git a/website_sale_payment_terms/views/res_config_views.xml b/website_sale_payment_terms/views/res_config_views.xml new file mode 100644 index 00000000..f1cad4b4 --- /dev/null +++ b/website_sale_payment_terms/views/res_config_views.xml @@ -0,0 +1,27 @@ + + + + + res.config.settings.view.form.inherit.payment.terms + res.config.settings + + + +
+
+
+
+
+
+
+ +
diff --git a/website_sale_payment_terms/views/web_assets.xml b/website_sale_payment_terms/views/web_assets.xml new file mode 100644 index 00000000..281bcb1c --- /dev/null +++ b/website_sale_payment_terms/views/web_assets.xml @@ -0,0 +1,10 @@ + + + +