[FIX] website_sale_payment_terms: calculate amounts based on term lines

add unit tests
refactor JS widget
H5924

website_sale_payment_terms/__manifest__.py

@@ -12,7 +12,7 @@ Allow customers to choose payment terms if order total meets a configured thresh
         """,
     'depends': [
         'sale_payment_deposit',
-        'website_sale',
+        # 'website_sale',
         'website_sale_delivery',
     ],
     'auto_install': False,

website_sale_payment_terms/controllers/main.py

@@ -1,8 +1,8 @@
 from odoo.http import request, route
-from odoo.addons.website_sale.controllers.main import WebsiteSale
+from odoo.addons.website_sale_delivery.controllers.main import WebsiteSaleDelivery
 
 
-class WebsiteSalePaymentTerms(WebsiteSale):
+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)
@@ -36,11 +36,14 @@ class WebsiteSalePaymentTerms(WebsiteSale):
     # 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,
-                'require_payment': order.require_payment,
+                'amount_due_today': order.amount_due_today,
+                'amount_due_today_html': Monetary.value_to_html(order.amount_due_today, {'display_currency': currency}),
             }
         return {}
 
@@ -74,3 +77,11 @@ class WebsiteSalePaymentTerms(WebsiteSale):
         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

website_sale_payment_terms/models/sale.py

@@ -1,9 +1,23 @@
-from odoo import fields, models
+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:
@@ -12,7 +26,4 @@ class SaleOrder(models.Model):
             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),
-            })
+            self.payment_term_id = payment_term

website_sale_payment_terms/static/src/js/payment_terms.js

@@ -9,12 +9,10 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
     require('website_sale_delivery.checkout');
 
 
-    console.log('Payment Terms V10.2');
-
     publicWidget.registry.websiteSalePaymentTerms = publicWidget.Widget.extend({
-        selector: '.oe_website_sale',
+        selector: '.oe_payment_terms',
         events: {
-            "click #payment_terms input[name='payment_term_id']": '_onPaymentTermClick',
+            "click input[name='payment_term_id']": '_onPaymentTermClick',
             "click #btn_accept_payment_terms": '_acceptPaymentTerms',
             "click #btn_deny_payment_terms": '_denyPaymentTerms',
         },
@@ -23,7 +21,7 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
          * @override
          */
         start: function () {
-            core.bus.on('payment_terms_update_amount', this, this.updateAmountDue);
+            console.log('Payment Terms V10.3');
             return this._super.apply(this, arguments).then(function () {
                 var available_term = $('input[name="payment_term_id"]').length;
                 var $payButton = $('#o_payment_form_pay');
@@ -51,32 +49,32 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
          * @param: {number} d Deposit percentage
          * @param: {number} f Deposit flat amount
          */
-        calculateDeposit: function (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;
-            }
-        },
+        // calculateDeposit: function (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;
+        //     }
+        // },
 
         /*
          * All input clicks update due amount
          *
          * @public
          */
-        updateAmountDue: function () {
-            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 = this.calculateDeposit(amount_total, $deposit_percentage, $deposit_flat);
-            $('#order_due_today span.oe_currency_value').html($due_amount);
-        },
+        // updateAmountDue: function () {
+        //     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 = this.calculateDeposit(amount_total, $deposit_percentage, $deposit_flat);
+        //     $('#order_due_today span.oe_currency_value').html($due_amount);
+        // },
 
         //--------------------------------------------------------------------------
         // Private
@@ -104,7 +102,8 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
          */
         _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) {
@@ -112,8 +111,8 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
                 }
 
                 // Change forms based on order payment requirement
-                this.updateAmountDue();
-                if(!result.require_payment) {
+                $('#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();
                     $('#order_due_today').hide();
@@ -157,7 +156,7 @@ odoo.define('website_sale_payment_terms.payment_terms', function (require) {
     publicWidget.registry.websiteSaleDelivery.include({
         _handleCarrierUpdateResult: function (result) {
             this._super.apply(this, arguments);
-            core.bus.trigger('payment_terms_update_amount');
+            $('#order_due_today .monetary_field').html(result.amount_due_today);
         },
     });
 

website_sale_payment_terms/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_amount_due

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)

website_sale_payment_terms/views/website_templates.xml

@@ -3,6 +3,8 @@
 
     <!-- Payment terms list items for /shop/payment -->
     <template id="payment_term_items">
+        <p t-esc="order.sudo().payment_term_id"/>
+        <p t-esc="website_sale_order.sudo().payment_term_id"/>
         <t t-set="partner_term" t-value="order.partner_id.property_payment_term_id"/>
         <!-- Show current partners payment terms -->
         <t t-if="partner_term and partner_term not in website_terms">
@@ -12,7 +14,8 @@
                        t-att-data-deposit-flat="partner_term.deposit_flat or '0'"
                        name="payment_term_id"
                        t-att-id="'payment_term_%i' % partner_term.id"
-                       type="radio"/>
+                       t-att-checked="term == order.payment_term_id"
+                   type="radio"/>
                 <label t-att-for="'payment_term_%i' % partner_term.id"
                        t-field="partner_term.name"
                        class="label-optional"/>
@@ -24,6 +27,7 @@
                    t-att-data-deposit-percentage="term.deposit_percentage or '0'"
                    t-att-data-deposit-flat="term.deposit_flat or '0'"
                    t-att-id="'payment_term_%i' % term.id"
+                   t-att-checked="term == order.payment_term_id"
                    type="radio"
                    name="payment_term_id"/>
             <label t-att-for="'payment_term_%i' % term.id"
@@ -37,9 +41,9 @@
         <xpath expr="//div[@id='payment_method']" position="before">
             <t t-set="website_terms" t-value="website.get_payment_terms()" />
             <t t-if="website_terms and website_sale_order.amount_total &gt; website.payment_deposit_threshold">
-                <t t-call="website_sale_payment_terms.payment_term_success_modal"/>
-                <t t-call="website_sale_payment_terms.payment_term_error_modal"/>
-                <div id="payment_terms">
+                <div class="oe_payment_terms">
+                    <t t-call="website_sale_payment_terms.payment_term_success_modal"/>
+                    <t t-call="website_sale_payment_terms.payment_term_error_modal"/>
                     <h3 class="mb24 mt24">Payment Terms</h3>
                     <div class="card border-0">
                         <ul class="list-group">
@@ -118,12 +122,12 @@
     <!-- Add empty div to calculate amount due today in payment_terms.js -->
     <template id="amount_due_today" inherit_id="website_sale.total">
         <xpath expr="//tr[@id='order_total']" position="after">
-            <tr id="order_due_today" t-att-style="'' if website_sale_order.amount_total_deposit else 'display: none;'">
+            <tr id="order_due_today" t-att-class="'' if website_sale_order.amount_due_today else 'd-none'">
                 <td class="text-right text-info">
                     <strong>Due Now:</strong>
                 </td>
                 <td class="text-xl-right">
-                    <strong t-field="website_sale_order.amount_total_deposit"
+                    <strong t-field="website_sale_order.amount_due_today" class="monetary_field"
                             t-options='{"widget": "monetary", "display_currency": website_sale_order.pricelist_id.currency_id}'/>
                 </td>
             </tr>