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..b7b4a354 --- /dev/null +++ b/website_sale_payment_terms/__manifest__.py @@ -0,0 +1,27 @@ +{ + 'name': 'Website Payment Terms', + 'author': 'Hibou Corp. ', + 'category': 'Sales', + 'version': '14.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': [ + 'security/ir.model.access.csv', + '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..40857f03 --- /dev/null +++ b/website_sale_payment_terms/controllers/main.py @@ -0,0 +1,82 @@ +from odoo.http import request, route +from odoo.addons.website_sale_delivery.controllers.main import WebsiteSaleDelivery + + +class WebsiteSalePaymentTerms(WebsiteSaleDelivery): + + # 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: + Monetary = request.env['ir.qweb.field.monetary'] + currency = order.currency_id + return { + 'payment_term_name': order.payment_term_id.name, + 'payment_term_id': order.payment_term_id.id, + 'note': order.payment_term_id.note, + 'amount_due_today': order.amount_due_today, + 'amount_due_today_html': Monetary.value_to_html(order.amount_due_today, {'display_currency': currency}), + } + 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: + order.payment_term_id = False + 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.amount_due_today: + 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') + + def _update_website_sale_delivery_return(self, order, **post): + res = super(WebsiteSalePaymentTerms, self)._update_website_sale_delivery_return(order, **post) + Monetary = request.env['ir.qweb.field.monetary'] + currency = order.currency_id + if order: + res['amount_due_today'] = Monetary.value_to_html(order.amount_due_today, {'display_currency': currency}) + return res diff --git a/website_sale_payment_terms/models/__init__.py b/website_sale_payment_terms/models/__init__.py new file mode 100644 index 00000000..b17172fe --- /dev/null +++ b/website_sale_payment_terms/models/__init__.py @@ -0,0 +1,6 @@ +from . import account +from . import payment +from . import res_config +from . import sale +from . import sale_patch +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..5bebe138 --- /dev/null +++ b/website_sale_payment_terms/models/payment.py @@ -0,0 +1,46 @@ +from odoo import models, _ +import logging +_logger = logging.getLogger(__name__) + + +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_due_today, + order.pricelist_id.currency_id.id, + values=values, + ) + + # Override to confirm payments totaling the amount_due_today + def _check_amount_and_confirm_order(self): + self.ensure_one() + for order in self.sale_order_ids.filtered(lambda so: so.state in ('draft', 'sent')): + amount = order.amount_due_today + if order.currency_id.compare_amounts(self.amount, amount) == 0: + order.with_context(send_email=True).action_confirm() + else: + _logger.warning( + '<%s> transaction AMOUNT MISMATCH for order %s (ID %s): expected %r, got %r', + self.acquirer_id.provider, order.name, order.id, + amount, self.amount, + ) + order.message_post( + subject=_("Amount Mismatch (%s)") % self.acquirer_id.provider, + body=_( + "The order was not confirmed despite response from the acquirer (%s): order total is %r but acquirer replied with %r.") % ( + self.acquirer_id.provider, + amount, + self.amount, + ) + ) 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..2544aa0d --- /dev/null +++ b/website_sale_payment_terms/models/sale.py @@ -0,0 +1,29 @@ +from odoo import api, fields, models + + +class SaleOrder(models.Model): + _inherit = 'sale.order' + + amount_due_today = fields.Float('Due Now', compute='_compute_amount_due_today', + help='Amount due at checkout on the website.') + + @api.depends('amount_total', 'payment_term_id') + def _compute_amount_due_today(self): + today_string = fields.Date.to_string(fields.Date.today()) + for order in self: + amount = order.amount_total + if order.payment_term_id: + term_amount = [amt for date_string, amt in order.payment_term_id.compute(order.amount_total) if date_string == today_string] + term_amount = term_amount and term_amount[0] or 0.0 + amount = term_amount if term_amount > order.amount_total_deposit else order.amount_total_deposit + order.amount_due_today = amount + + 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.payment_term_id = payment_term diff --git a/website_sale_payment_terms/models/sale_patch.py b/website_sale_payment_terms/models/sale_patch.py new file mode 100644 index 00000000..07d85994 --- /dev/null +++ b/website_sale_payment_terms/models/sale_patch.py @@ -0,0 +1,86 @@ +from odoo.exceptions import ValidationError +from odoo.addons.sale.models.sale import SaleOrder + + +def _create_payment_transaction(self, vals): + # Code copied from sale_payment_deposit to use order.amount_due_today + # + # This is a copy job from odoo.addons.sale.models.sale due to the closed nature of the vals.update(dict) call + # Ultimately, only the 'vals.update' with the new amount is really used. + '''Similar to self.env['payment.transaction'].create(vals) but the values are filled with the + current sales orders fields (e.g. the partner or the currency). + :param vals: The values to create a new payment.transaction. + :return: The newly created payment.transaction record. + ''' + # Ensure the currencies are the same. + + # extract variable for use later. + sale = self[0] + + currency = sale.pricelist_id.currency_id + if any([so.pricelist_id.currency_id != currency for so in self]): + raise ValidationError(_('A transaction can\'t be linked to sales orders having different currencies.')) + + # Ensure the partner are the same. + partner = sale.partner_id + if any([so.partner_id != partner for so in self]): + raise ValidationError(_('A transaction can\'t be linked to sales orders having different partners.')) + + # Try to retrieve the acquirer. However, fallback to the token's acquirer. + acquirer_id = vals.get('acquirer_id') + acquirer = False + payment_token_id = vals.get('payment_token_id') + + if payment_token_id: + payment_token = self.env['payment.token'].sudo().browse(payment_token_id) + + # Check payment_token/acquirer matching or take the acquirer from token + if acquirer_id: + acquirer = self.env['payment.acquirer'].browse(acquirer_id) + if payment_token and payment_token.acquirer_id != acquirer: + raise ValidationError(_('Invalid token found! Token acquirer %s != %s') % ( + payment_token.acquirer_id.name, acquirer.name)) + if payment_token and payment_token.partner_id != partner: + raise ValidationError(_('Invalid token found! Token partner %s != %s') % ( + payment_token.partner.name, partner.name)) + else: + acquirer = payment_token.acquirer_id + + # Check an acquirer is there. + if not acquirer_id and not acquirer: + raise ValidationError(_('A payment acquirer is required to create a transaction.')) + + if not acquirer: + acquirer = self.env['payment.acquirer'].browse(acquirer_id) + + # Check a journal is set on acquirer. + if not acquirer.journal_id: + raise ValidationError(_('A journal must be specified of the acquirer %s.' % acquirer.name)) + + if not acquirer_id and acquirer: + vals['acquirer_id'] = acquirer.id + + # Override for Deposit + amount = sum(self.mapped('amount_total')) + # This is a patch, all databases will run this code even if this field doesn't exist. + if hasattr(sale, 'amount_due_today'): + amount = sum(self.mapped('amount_due_today')) + + vals.update({ + 'amount': amount, + 'currency_id': currency.id, + 'partner_id': partner.id, + 'sale_order_ids': [(6, 0, self.ids)], + }) + + transaction = self.env['payment.transaction'].create(vals) + + # Process directly if payment_token + if transaction.payment_token_id: + transaction.s2s_do_transaction() + + return transaction + + +# Patch core implementation. +SaleOrder._create_payment_transaction = _create_payment_transaction 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/security/ir.model.access.csv b/website_sale_payment_terms/security/ir.model.access.csv new file mode 100644 index 00000000..6e51b316 --- /dev/null +++ b/website_sale_payment_terms/security/ir.model.access.csv @@ -0,0 +1,2 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_account_payment_term_public,account.payment.term.public,account.model_account_payment_term,,1,0,0,0 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..d54876cf --- /dev/null +++ b/website_sale_payment_terms/static/src/js/payment_terms.js @@ -0,0 +1,125 @@ +odoo.define('website_sale_payment_terms.payment_terms', function (require) { + "use strict"; + + require('web.dom_ready'); + var concurrency = require('web.concurrency'); + var core = require('web.core'); + var dp = new concurrency.DropPrevious(); + var publicWidget = require('web.public.widget'); + require('website_sale_delivery.checkout'); + + + publicWidget.registry.websiteSalePaymentTerms = publicWidget.Widget.extend({ + selector: '.oe_payment_terms', + events: { + "click input[name='payment_term_id']": '_onPaymentTermClick', + "click #btn_accept_payment_terms": '_acceptPaymentTerms', + "click #btn_deny_payment_terms": '_denyPaymentTerms', + }, + + /** + * @override + */ + start: function () { + console.log('Payment Terms V10.3'); + return this._super.apply(this, arguments).then(function () { + var available_term = $('input[name="payment_term_id"]').length; + if (available_term > 0) { + var $payButton = $('#o_payment_form_pay'); + $payButton.prop('disabled', true); + var disabledReasons = $payButton.data('disabled_reasons') || {}; + if ($('input[name="payment_term_id"][checked]')) { + disabledReasons.payment_terms_selection = false; + } else { + disabledReasons.payment_terms_selection = true; + } + $payButton.data('disabled_reasons', disabledReasons); + $payButton.prop('disabled', _.contains($payButton.data('disabled_reasons'), true)); + } + }); + }, + + //-------------------------------------------------------------------------- + // Private + //-------------------------------------------------------------------------- + + /** + * @private + * @param {object} ev + */ + _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(this._rpc({ + 'route': '/shop/update_payment_term', + 'params': values, + }).then(this._onPaymentTermUpdateAnswer.bind(this))); + }, + + /** + * Show amount due if operation is a success + * + * @private + * @param {Object} result + */ + _onPaymentTermUpdateAnswer: function (result) { + if (!result.error) { + console.log("_onPaymentTermUpdateAnswer"); + console.log(result); + // 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 + $('#order_due_today .monetary_field').html(result.amount_due_today_html); + if(result.amount_due_today == 0.0) { + $('#payment_method').hide(); + $('#non_payment_method').show(); + } else { + $('#payment_method').show(); + $('#non_payment_method').hide(); + } + + // 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(); + } + }, + + /* + * @private + */ + _acceptPaymentTerms: function () { + var $payButton = $('#o_payment_form_pay'); + var disabledReasons = $payButton.data('disabled_reasons') || {}; + disabledReasons.payment_terms_selection = false; + $payButton.data('disabled_reasons', disabledReasons); + $payButton.prop('disabled', _.contains($payButton.data('disabled_reasons'), true)); + }, + + /* + * @private + */ + _denyPaymentTerms: function () { + window.location = '/shop/reject_term_agreement'; + }, + }); + + + // update amount due after delivery options change + publicWidget.registry.websiteSaleDelivery.include({ + _handleCarrierUpdateResult: function (result) { + this._super.apply(this, arguments); + $('#order_due_today .monetary_field').html(result.amount_due_today); + }, + }); + + return publicWidget.registry.websiteSalePaymentTerms; +}); diff --git a/website_sale_payment_terms/tests/__init__.py b/website_sale_payment_terms/tests/__init__.py new file mode 100644 index 00000000..a9caa7cd --- /dev/null +++ b/website_sale_payment_terms/tests/__init__.py @@ -0,0 +1 @@ +from . import test_amount_due diff --git a/website_sale_payment_terms/tests/test_amount_due.py b/website_sale_payment_terms/tests/test_amount_due.py new file mode 100644 index 00000000..e772009e --- /dev/null +++ b/website_sale_payment_terms/tests/test_amount_due.py @@ -0,0 +1,54 @@ +from odoo.tests import tagged, TransactionCase + + +@tagged('post_install', '-at_install') +class TestWebsiteSalePaymentTerms(TransactionCase): + def setUp(self): + super(TestWebsiteSalePaymentTerms, self).setUp() + self.so = self.env['sale.order'].create({ + 'partner_id': self.ref('base.res_partner_12'), + 'order_line': [(0, 0, { + 'product_id': self.env['product.product'].create({'name': 'Product A', 'list_price': 100}).id, + 'product_uom_qty': 1, + 'name': 'Product A', + 'tax_id': False, + })] + }) + + def test_00_immediate(self): + # Double-check that we're asking for money if no payment terms are set + self.assertEqual(self.so.amount_due_today, self.so.amount_total) + + immediate_terms = self.browse_ref('account.account_payment_term_immediate') + self.so._check_payment_term_quotation(immediate_terms.id) + self.assertEqual(self.so.amount_due_today, self.so.amount_total) + + def test_10_thirty_percent(self): + thirty_percent_terms = self.browse_ref('account.account_payment_term_advance_60days') + self.so._check_payment_term_quotation(thirty_percent_terms.id) + self.assertEqual(self.so.amount_due_today, 30.0) + + def test_20_fifteen_days(self): + fifteen_days_terms = self.browse_ref('account.account_payment_term_15days') + self.so._check_payment_term_quotation(fifteen_days_terms.id) + self.assertEqual(self.so.amount_due_today, 0.0) + + def test_30_deposit_requested(self): + """ + Ask for deposit if deposit amount is greater + """ + thirty_percent_terms = self.browse_ref('account.account_payment_term_advance_60days') + thirty_percent_terms.deposit_percentage = 40 + thirty_percent_terms.deposit_flat = 5 + self.so._check_payment_term_quotation(thirty_percent_terms.id) + self.assertEqual(self.so.amount_due_today, 45.0) + + def test_40_low_deposit(self): + """ + Ask for terms amount if greater than requested deposit + """ + thirty_percent_terms = self.browse_ref('account.account_payment_term_advance_60days') + thirty_percent_terms.deposit_percentage = 20 + thirty_percent_terms.deposit_flat = 5 + self.so._check_payment_term_quotation(thirty_percent_terms.id) + self.assertEqual(self.so.amount_due_today, 30.0) 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..b480a686 --- /dev/null +++ b/website_sale_payment_terms/views/account_views.xml @@ -0,0 +1,15 @@ + + + + + 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 @@ + + + +