0044874: The payments info printed in tickets and invoices is wrong for payments in cash with returns

From 14de2e47e99ce69cb98df6a4a0c3986d5f03bef2 Mon Sep 17 00:00:00 2001
From: Prakash M <prakash@qualiantech.com>
Date: Mon, 14 Sep 2020 19:18:17 +0530
Subject: [PATCH] Related to BUG-44874: Calculated exact paid amount from
 changeAmt before printing receipt * This fixes overpayment amount displayed
 properly on printing and reprinting * In case of main printing, change amount
 are fetched from changePayments property * In case of reprinting, change
 amount are fetched from payment's paymentData property * In case of cancel
 and replace, overpayment data is not displayed for old payment(cancelled
 receipt) * In case of multireceipt, overpayment data is not displayed *
 Included MultiReceipt flag to paymentData information * With this info
 overpayment calculation from change amount can be skipped in case
 multireceipt printing

---
 .../js/data/dataordersave.js                  | 15 +++-
 .../js/pointofsale/model/pointofsale-model.js |  8 ++-
 .../js/pointofsale/model/pointofsale-print.js | 69 ++++++++++++++++++-
 .../js/utils/ticketCloseUtils.js              | 23 ++++---
 4 files changed, 102 insertions(+), 13 deletions(-)

diff --git a/web/org.openbravo.retail.posterminal/js/data/dataordersave.js b/web/org.openbravo.retail.posterminal/js/data/dataordersave.js
index b20f906d5..56792719a 100644
--- a/web/org.openbravo.retail.posterminal/js/data/dataordersave.js
+++ b/web/org.openbravo.retail.posterminal/js/data/dataordersave.js
@@ -1,6 +1,6 @@
 /*
  ************************************************************************************
- * Copyright (C) 2013-2019 Openbravo S.L.U.
+ * Copyright (C) 2013-2020 Openbravo S.L.U.
  * Licensed under the Openbravo Commercial License version 1.0
  * You may obtain a copy of the License at http://www.openbravo.com/legal/obcl.html
  * or in the legal folder of this module distribution.
@@ -867,6 +867,19 @@
                           ) {
                             invoiceLine.unset('product');
                           });
+                          invoiceToPrint.get('payments').reset();
+                          for (
+                            let i = 0;
+                            i < theReceipt.get('payments').models.length;
+                            i += 1
+                          ) {
+                            const model = theReceipt.get('payments').models[i];
+                            invoiceToPrint
+                              .get('payments')
+                              .add(new Backbone.Model(model.toJSON()), {
+                                silent: true
+                              });
+                          }
                           if (
                             OB.MobileApp.model.hasPermission(
                               'OBPOS_print.invoicesautomatically',
diff --git a/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-model.js b/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-model.js
index 39bf4532c..dd33f89e8 100644
--- a/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-model.js
+++ b/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-model.js
@@ -1,6 +1,6 @@
 /*
  ************************************************************************************
- * Copyright (C) 2012-2019 Openbravo S.L.U.
+ * Copyright (C) 2012-2020 Openbravo S.L.U.
  * Licensed under the Openbravo Commercial License version 1.0
  * You may obtain a copy of the License at http://www.openbravo.com/legal/obcl.html
  * or in the legal folder of this module distribution.
@@ -899,6 +899,12 @@ OB.OBPOSPointOfSale.Model.PointOfSale = OB.Model.TerminalWindowModel.extend({
           }
         };
 
+        // Set isMultiTicketPayment for changePayments
+        for (let i = 0; i < multiorders.get('changePayments').length; i += 1) {
+          const change = multiorders.get('changePayments')[i];
+          change.isMultiTicketPayment = true;
+        }
+
         OB.UTIL.HookManager.executeHooks(
           'OBPOS_MultiOrders_PreSetPaymentsToReceipt',
           {
diff --git a/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-print.js b/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-print.js
index 8f193b767..cb2235cb1 100644
--- a/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-print.js
+++ b/web/org.openbravo.retail.posterminal/js/pointofsale/model/pointofsale-print.js
@@ -1,6 +1,6 @@
 /*
  ************************************************************************************
- * Copyright (C) 2013-2019 Openbravo S.L.U.
+ * Copyright (C) 2013-2020 Openbravo S.L.U.
  * Licensed under the Openbravo Commercial License version 1.0
  * You may obtain a copy of the License at http://www.openbravo.com/legal/obcl.html
  * or in the legal folder of this module distribution.
@@ -156,6 +156,69 @@
     this.isRetry = false;
   };
 
+  //Include over-payment amount to total paid amount from change amount
+  var includeOverPaymentAmt = function(ticketToPrint) {
+    const paymentList = ticketToPrint.get('payments');
+    const changedPaymntList = ticketToPrint.get('changePayments');
+    const isCancelAndReplace = ticketToPrint.get('doCancelAndReplace');
+    const isNegativeReceipt = ticketToPrint.get('isNegative');
+
+    for (let i = 0; i < paymentList.length; i += 1) {
+      const payment = paymentList.models[i];
+      let paymntData = payment.get('paymentData');
+      let paymentAmt = payment.get('amount');
+      let paymentOrigAmt = payment.get('origAmount');
+      let changeAmount, changeOrigAmount, overPaymentAmt, overPaymentOrigAmt;
+
+      if (paymntData) {
+        if (typeof paymntData !== 'object') {
+          paymntData = JSON.parse(paymntData);
+        }
+
+        // Do not print over-payment amount for CancelAndReplace's old-payment and MultiTicket payments
+        if (!isCancelAndReplace && !paymntData.isMultiTicketPayment) {
+          changeAmount = paymntData.amount;
+          changeOrigAmount = paymntData.origAmount;
+          if (!Number.isNaN(Number(changeAmount))) {
+            overPaymentAmt =
+              paymentAmt + (isNegativeReceipt ? -changeAmount : changeAmount);
+            payment.set('amount', overPaymentAmt);
+          }
+          if (!Number.isNaN(Number(changeOrigAmount))) {
+            overPaymentOrigAmt =
+              paymentOrigAmt +
+              (isNegativeReceipt ? -changeOrigAmount : changeOrigAmount);
+            payment.set('origAmount', overPaymentOrigAmt);
+          }
+        }
+      } else if (changedPaymntList) {
+        const chngpayments = changedPaymntList.filter(
+          chngpayment => chngpayment.key === payment.get('kind')
+        );
+
+        chngpayments.forEach(chngpayment => {
+          // Do not print over-payment amount for MultiTicket payments
+          if (!chngpayment.isMultiTicketPayment) {
+            changeAmount = chngpayment.amount;
+            changeOrigAmount = chngpayment.origAmount;
+            if (!Number.isNaN(Number(changeAmount))) {
+              overPaymentAmt =
+                paymentAmt + (isNegativeReceipt ? -changeAmount : changeAmount);
+              payment.set('amount', overPaymentAmt);
+            }
+            if (!Number.isNaN(Number(changeOrigAmount))) {
+              overPaymentOrigAmt =
+                paymentOrigAmt +
+                (isNegativeReceipt ? -changeOrigAmount : changeOrigAmount);
+              payment.set('origAmount', overPaymentOrigAmt);
+            }
+          }
+        });
+      }
+    }
+    return ticketToPrint;
+  };
+
   PrintReceipt.prototype.print = function(order, printargs) {
     printargs = printargs || {};
 
@@ -170,12 +233,14 @@
       OB.UTIL.clone(me.receipt, receipt);
     }
 
+    var receiptToPrint = includeOverPaymentAmt(receipt);
+
     OB.UTIL.HookManager.executeHooks(
       'OBPRINT_PrePrint',
       {
         forcePrint: printargs.forcePrint,
         offline: printargs.offline,
-        order: receipt,
+        order: receiptToPrint,
         template: template,
         forcedtemplate: printargs.forcedtemplate,
         model: me.model,
diff --git a/web/org.openbravo.retail.posterminal/js/utils/ticketCloseUtils.js b/web/org.openbravo.retail.posterminal/js/utils/ticketCloseUtils.js
index 16f0bc349..94ca16634 100644
--- a/web/org.openbravo.retail.posterminal/js/utils/ticketCloseUtils.js
+++ b/web/org.openbravo.retail.posterminal/js/utils/ticketCloseUtils.js
@@ -1,6 +1,6 @@
 /*
  ************************************************************************************
- * Copyright (C) 2017-2019 Openbravo S.L.U.
+ * Copyright (C) 2017-2020 Openbravo S.L.U.
  * Licensed under the Openbravo Commercial License version 1.0
  * You may obtain a copy of the License at http://www.openbravo.com/legal/obcl.html
  * or in the legal folder of this module distribution.
@@ -208,14 +208,6 @@
           if (args.isCancelled !== true) {
             var orderToPrint = OB.UTIL.clone(args.frozenReceipt),
               invoice = orderToPrint.get('calculatedInvoice');
-            orderToPrint.get('payments').reset();
-            clonedCollection.each(function(model) {
-              orderToPrint
-                .get('payments')
-                .add(new Backbone.Model(model.toJSON()), {
-                  silent: true
-                });
-            });
             orderToPrint.set('hasbeenpaid', 'Y');
             receipt.trigger('print', orderToPrint, {
               offline: true
@@ -223,6 +215,19 @@
             if (invoice && invoice.get('id')) {
               var invoiceToPrint = OB.UTIL.clone(invoice),
                 printInvoice = function() {
+                  invoiceToPrint.get('payments').reset();
+                  for (
+                    let i = 0;
+                    i < receipt.get('payments').models.length;
+                    i += 1
+                  ) {
+                    const model = receipt.get('payments').models[i];
+                    invoiceToPrint
+                      .get('payments')
+                      .add(new Backbone.Model(model.toJSON()), {
+                        silent: true
+                      });
+                  }
                   invoiceToPrint.set('hasbeenpaid', 'Y');
                   receipt.trigger('print', invoiceToPrint, {
                     offline: true
-- 
2.20.1