0002615: voiding an allocated currency invoice doesn't clear FX account
[fa-stable.git] / sales / includes / db / custalloc_db.inc
index 0a1c78f251123cfdfcb7c0e62d90f0be3dd43d42..3010931d59ead0b720cae0fc00f605b2b4084362 100644 (file)
@@ -1,15 +1,25 @@
 <?php
-
+/**********************************************************************
+    Copyright (C) FrontAccounting, LLC.
+       Released under the terms of the GNU General Public License, GPL, 
+       as published by the Free Software Foundation, either version 3 
+       of the License, or (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+    See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
 //----------------------------------------------------------------------------------------
 
-function add_cust_allocation($amount, $trans_type_from, $trans_no_from, 
+function add_cust_allocation($amount, $trans_type_from, $trans_no_from,
        $trans_type_to, $trans_no_to)
 {
        $sql = "INSERT INTO ".TB_PREF."cust_allocations (
-               amt, date_alloc, 
-               trans_type_from, trans_no_from, trans_no_to, trans_type_to) 
-               VALUES ($amount, Now(), $trans_type_from, $trans_no_from, $trans_no_to, $trans_type_to)";
-                       
+               amt, date_alloc,
+               trans_type_from, trans_no_from, trans_no_to, trans_type_to)
+               VALUES ($amount, Now(), ".db_escape($trans_type_from).", ".db_escape($trans_no_from).", ".db_escape($trans_no_to)
+               .", ".db_escape($trans_type_to).")";
+
        db_query($sql, "A customer allocation could not be added to the database");
 }
 
@@ -18,103 +28,291 @@ function add_cust_allocation($amount, $trans_type_from, $trans_no_from,
 
 function delete_cust_allocation($trans_id)
 {
-       $sql = "DELETE FROM ".TB_PREF."cust_allocations WHERE id = " . $trans_id;
+       $sql = "DELETE FROM ".TB_PREF."cust_allocations WHERE id = ".db_escape($trans_id);
        return db_query($sql, "The existing allocation $trans_id could not be deleted");
 }
 
 //----------------------------------------------------------------------------------------
-
-function get_DebtorTrans_allocation_balance($trans_type, $trans_no)
+//     Update debtor trans alloc field according to current status of cust_allocations
+//
+function update_debtor_trans_allocation($trans_type, $trans_no)
 {
-       $sql = "SELECT (ov_amount+ov_gst+ov_freight-ov_discount-alloc) AS BalToAllocate 
-               FROM ".TB_PREF."debtor_trans WHERE trans_no=$trans_no AND type=$trans_type";
-       $result = db_query($sql,"calculate the allocation");
-       $myrow = db_fetch_row($result); 
-       
-       return $myrow[0];
-}
-
-//----------------------------------------------------------------------------------------
+       $sql = "UPDATE `".TB_PREF."debtor_trans` trans,
+                       (SELECT sum(amt) amt from ".TB_PREF."cust_allocations
+                               WHERE (trans_type_to=".db_escape($trans_type)." AND trans_no_to=".db_escape($trans_no).")
+                               OR (trans_type_from=".db_escape($trans_type)." AND trans_no_from=".db_escape($trans_no).")) allocated
+               SET 
+                       trans.alloc=IFNULL(allocated.amt,0)
+               WHERE trans.type=".db_escape($trans_type)." AND trans_no=".db_escape($trans_no);
 
-function update_debtor_trans_allocation($trans_type, $trans_no, $alloc)
-{
-       $sql = "UPDATE ".TB_PREF."debtor_trans SET alloc = alloc + $alloc
-               WHERE type=$trans_type AND trans_no = $trans_no";
        db_query($sql, "The debtor transaction record could not be modified for the allocation against it");
 }
 
 //-------------------------------------------------------------------------------------------------------------
 
-function void_cust_allocations($type, $type_no)
+function void_cust_allocations($type, $type_no, $date="")
 {
-       return clear_cust_alloctions($type, $type_no);
+       return clear_cust_alloctions($type, $type_no, $date);
 }
 
 //-------------------------------------------------------------------------------------------------------------
 
-function clear_cust_alloctions($type, $type_no)
+function clear_cust_alloctions($type, $type_no, $date="")
 {
        // clear any allocations for this transaction
-       $sql = "SELECT * FROM ".TB_PREF."cust_allocations 
-               WHERE (trans_type_from=$type AND trans_no_from=$type_no) 
-               OR (trans_type_to=$type AND trans_no_to=$type_no)";
+       $sql = "SELECT * FROM ".TB_PREF."cust_allocations
+               WHERE (trans_type_from=".db_escape($type)." AND trans_no_from=".db_escape($type_no).")
+               OR (trans_type_to=".db_escape($type)." AND trans_no_to=".db_escape($type_no).")";
        $result = db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
-       
+
        while ($row = db_fetch($result))
        {
                $sql = "UPDATE ".TB_PREF."debtor_trans SET alloc=alloc - " . $row['amt'] . "
-                       WHERE (type= " . $row['trans_type_from'] . " AND trans_no=" . $row['trans_no_from'] . ") 
+                       WHERE (type= " . $row['trans_type_from'] . " AND trans_no=" . $row['trans_no_from'] . ")
                        OR (type=" . $row['trans_type_to'] . " AND trans_no=" . $row['trans_no_to'] . ")";
-               db_query($sql, "could not clear allocation");                                           
+               db_query($sql, "could not clear allocation");
+               // 2008-09-20 Joe Hunt
+               if ($date != "")
+                       exchange_variation($type, $type_no, $row['trans_type_to'], $row['trans_no_to'], $date,
+                               $row['amt'], PT_CUSTOMER, true);
+               // 2014-01-16 Joe Hunt. Fix for voiding allocated currency sales_invoices.              
+               elseif ($type == ST_SALESINVOICE && $row['trans_type_to'] == $type && $row['trans_no_to'] == $type_no)          
+                       exchange_variation($row['trans_type_from'], $row['trans_no_from'], $row['trans_type_to'], $row['trans_no_to'], 
+                               sql2date($row['date_alloc']), $row['amt'], PT_SUPPLIER, true);
+               //////////////////////
        }
-                                               
+
 
        // remove any allocations for this transaction
-       $sql = "DELETE FROM ".TB_PREF."cust_allocations 
-               WHERE (trans_type_from=$type AND trans_no_from=$type_no) 
-               OR (trans_type_to=$type AND trans_no_to=$type_no)";
-                               
-       db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");                                      
+       $sql = "DELETE FROM ".TB_PREF."cust_allocations
+               WHERE (trans_type_from=".db_escape($type)." AND trans_no_from=".db_escape($type_no).")
+               OR (trans_type_to=".db_escape($type)." AND trans_no_to=".db_escape($type_no).")";
+
+       db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
+}
+//----------------------------------------------------------------------------------------
+
+function get_alloc_trans_sql($extra_fields=null, $extra_conditions=null, $extra_tables=null)
+{
+       $sql = "SELECT
+               trans.type,
+               trans.trans_no,
+               trans.reference,
+               trans.tran_date,
+               debtor.name AS DebtorName, 
+               debtor.curr_code, 
+               ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,
+               trans.alloc,
+               trans.due_date,
+               debtor.address,
+               trans.version,
+               trans.debtor_no ";
+
+       if ($extra_fields)
+               $sql .= ", $extra_fields ";
+
+       $sql .= " FROM ".TB_PREF."debtor_trans as trans, "
+                               .TB_PREF."debtors_master as debtor";
+       if ($extra_tables)
+               $sql .= ",$extra_tables ";
+
+       $sql .= " WHERE trans.debtor_no=debtor.debtor_no";
+
+       if ($extra_conditions)
+               $sql .= " AND $extra_conditions ";
+
+       return $sql;
 }
 
+
 //-------------------------------------------------------------------------------------------------------------
 
-function get_allocatable_from_cust_transactions($customer_id, $settled)
+function get_allocatable_from_cust_sql($customer_id, $settled)
 {
        $settled_sql = "";
-       if (!$settled) 
+       if (!$settled)
        {
-               $settled_sql = " AND round(ABS(ov_amount+ov_gst+ov_freight+ov_discount)-alloc,6) > 0";
+               $settled_sql = " AND (round(ov_amount+ov_gst+ov_freight+ov_freight_tax-ov_discount-alloc,6) > 0)";
        }
-       
        $cust_sql = "";
        if ($customer_id != null)
-               $cust_sql = " AND ".TB_PREF."debtor_trans.debtor_no = $customer_id";            
-       
-       return get_customer_transactions("round(ABS(ov_amount+ov_gst+ov_freight+ov_discount)-alloc,6) <= 0 AS settled", 
-               "(type=" . systypes::cust_payment(). " OR type=11 OR type=2) AND (".TB_PREF."debtor_trans.ov_amount < 0) " . $settled_sql . $cust_sql); 
+               $cust_sql = " AND trans.debtor_no = ".db_escape($customer_id);
+
+       $sql = get_alloc_trans_sql("round(ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount-alloc,6) <= 0 AS settled",
+               "(type=".ST_CUSTPAYMENT." OR type=".ST_CUSTCREDIT." OR type=".ST_BANKDEPOSIT.") AND (trans.ov_amount > 0) " . $settled_sql . $cust_sql);
+
+       return $sql;
 }
 
 //-------------------------------------------------------------------------------------------------------------
 
 function get_allocatable_to_cust_transactions($customer_id, $trans_no=null, $type=null)
-{      
-       if ($trans_no != null and $type != null) 
+{
+       if ($trans_no != null and $type != null)
+       {
+               $sql = get_alloc_trans_sql("amt", "trans.trans_no = alloc.trans_no_to
+                       AND trans.type = alloc.trans_type_to
+                       AND alloc.trans_no_from=".db_escape($trans_no)."
+                       AND alloc.trans_type_from=".db_escape($type)."
+                       AND trans.debtor_no=".db_escape($customer_id),
+                       "".TB_PREF."cust_allocations as alloc");
+       }
+       else
+       {
+               $sql = get_alloc_trans_sql(null, "round(ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount-alloc,6) > 0
+                       AND trans.type <> " . ST_CUSTPAYMENT . "
+                       AND trans.type <> " . ST_BANKDEPOSIT . "
+                       AND trans.type <> " . ST_CUSTCREDIT . "
+                       AND trans.type <> " . ST_CUSTDELIVERY . "
+                       AND trans.debtor_no=".db_escape($customer_id));
+       }
+
+       return db_query($sql." ORDER BY trans_no", "Cannot retreive alloc to transactions");
+}
+
+//-------------------------------------------------------------------------------------------------------------
+
+function get_allocatable_from_cust_transactions($customer_id, $trans_no=null, $type=null)
+{
+       if ($trans_no != null and $type != null)
        {
-               return get_customer_transactions("amt", "".TB_PREF."debtor_trans.trans_no = ".TB_PREF."cust_allocations.trans_no_to 
-                       AND ".TB_PREF."debtor_trans.type = ".TB_PREF."cust_allocations.trans_type_to
-                       AND ".TB_PREF."cust_allocations.trans_no_from=$trans_no
-                       AND ".TB_PREF."cust_allocations.trans_type_from=$type 
-                       AND ".TB_PREF."debtor_trans.debtor_no=$customer_id", 
-                       "".TB_PREF."cust_allocations");                                         
-       } 
-       else 
+               $sql = get_alloc_trans_sql("amt", "trans.trans_no = alloc.trans_no_from
+                       AND trans.type = alloc.trans_type_from
+                       AND alloc.trans_no_to=".db_escape($trans_no)."
+                       AND alloc.trans_type_to=".db_escape($type)."
+                       AND trans.debtor_no=".db_escape($customer_id),
+                       "".TB_PREF."cust_allocations as alloc");
+       }
+       else
        {
-               return get_customer_transactions(null, "round(ABS(ov_amount+ov_gst+ov_freight+ov_discount)-alloc,6) > 0
-                       AND ".TB_PREF."debtor_trans.type != " . systypes::cust_payment() . "
-                       AND ".TB_PREF."debtor_trans.debtor_no=$customer_id");
-       }                                                                                                                       
+               $sql = get_alloc_trans_sql(null, "round(ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount-alloc,6) > 0
+                       AND trans.type <> " . ST_CUSTPAYMENT . "
+                       AND trans.type <> " . ST_BANKDEPOSIT . "
+                       AND trans.type <> " . ST_CUSTCREDIT . "
+                       AND trans.type <> " . ST_CUSTDELIVERY . "
+                       AND trans.debtor_no=".db_escape($customer_id));
+       }
+
+       return db_query($sql." ORDER BY trans_no", "Cannot retreive alloc to transactions");
+}
+
+function get_sql_for_customer_allocation_inquiry($from, $to, $customer, $filterType, $settled)
+{
+       $data_after = date2sql($from);
+       $date_to = date2sql($to);
+
+       $sql = "SELECT 
+               trans.type,
+               trans.trans_no,
+               trans.reference,
+               trans.order_,
+               trans.tran_date,
+               trans.due_date,
+               debtor.name,
+               debtor.curr_code,
+       (trans.ov_amount + trans.ov_gst + trans.ov_freight 
+                       + trans.ov_freight_tax + trans.ov_discount)     AS TotalAmount,
+               trans.alloc AS Allocated,
+               ((trans.type = ".ST_SALESINVOICE.")
+                       AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue,
+               trans.debtor_no
+       FROM "
+                       .TB_PREF."debtor_trans as trans, "
+                       .TB_PREF."debtors_master as debtor
+       WHERE debtor.debtor_no = trans.debtor_no
+                       AND (trans.ov_amount + trans.ov_gst + trans.ov_freight 
+                               + trans.ov_freight_tax + trans.ov_discount != 0)
+               AND trans.tran_date >= '$data_after'
+               AND trans.tran_date <= '$date_to'";
+
+       if ($customer != ALL_TEXT)
+               $sql .= " AND trans.debtor_no = ".db_escape($customer);
+
+       if (isset($filterType) && $filterType != ALL_TEXT)
+       {
+               if ($filterType == '1' || $filterType == '2')
+               {
+                       $sql .= " AND trans.type = ".ST_SALESINVOICE." ";
+               }
+               elseif ($filterType == '3')
+               {
+                       $sql .= " AND trans.type = " . ST_CUSTPAYMENT;
+               }
+               elseif ($filterType == '4')
+               {
+                       $sql .= " AND trans.type = ".ST_CUSTCREDIT." ";
+               }
+
+       if ($filterType == '2')
+       {
+               $today =  date2sql(Today());
+               $sql .= " AND trans.due_date < '$today'
+                               AND (round(abs(trans.ov_amount + "
+                               ."trans.ov_gst + trans.ov_freight + "
+                               ."trans.ov_freight_tax + trans.ov_discount) - trans.alloc,6) > 0) ";
+       }
+       }
+       else
+       {
+           $sql .= " AND trans.type <> ".ST_CUSTDELIVERY." ";
+       }
+
+
+       if (!$settled)
+       {
+               $sql .= " AND (round(abs(trans.ov_amount + trans.ov_gst + "
+               ."trans.ov_freight + trans.ov_freight_tax + "
+               ."trans.ov_discount) - trans.alloc,6) != 0) ";
+       }
+
+       return $sql;
 }
 
+function credit_sales_invoice_allocate($invoice_no, $credit_no, $amount, $date)
+{
+
+       $sql = "SELECT ov_freight+ov_gst+ov_amount+ov_freight_tax as total, alloc FROM ".TB_PREF."debtor_trans
+               WHERE (`type`=".ST_SALESINVOICE." AND trans_no=".db_escape($invoice_no).")";
+       $result = db_query($sql, "can't retrieve invoice totals");
+       $invoice = db_fetch($result);
+       $free = $invoice['total'] - $invoice['alloc'];
+       
+       if ($free < $amount) {
+        // if there is not enough unallocated amount - remove some payment allocations
+               $sql = "SELECT * FROM ".TB_PREF."cust_allocations
+                       WHERE (trans_type_to=".ST_SALESINVOICE." AND trans_no_to=".db_escape($invoice_no).")
+                       AND trans_type_from <> ".ST_CUSTCREDIT;
+               $result = db_query($sql, "can't retrieve invoice allocations");
+
+               while(($free < $amount) && ($alloc = db_fetch($result))) {
+                       $unalloc = min($alloc['amt'], $amount-$free);
+                       update_debtor_trans_allocation($alloc['trans_type_to'], $alloc['trans_no_to'], 
+                               -$unalloc);
+                       update_debtor_trans_allocation($alloc['trans_type_from'], $alloc['trans_no_from'], 
+                               -$unalloc);
+
+                       delete_cust_allocation($alloc['id']);
+                       if ($unalloc < $alloc['amt'])
+                               add_cust_allocation($alloc['amt']-$unalloc, $alloc['trans_type_from'],
+                                       $alloc['trans_no_from'], ST_SALESINVOICE, $invoice_no);
+
+                       $free += $unalloc;
+               }
+       }
+       if (floatcmp($free, $amount)<0) {
+               // this should never happen unless sparse credit notices were allocated to 
+               // the invoice, or summarized freight costs on credit notes is more than those on invoice.
+               display_error(_("Unsuspected overallocation happened due to sparse credit notes exists for this invoice.
+ Check all credit notes allocated to this invoice for summarized freight charges."));
+               return false;
+       }
+       update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $amount);
+       update_debtor_trans_allocation(ST_CUSTCREDIT, $credit_no, $amount);
+       add_cust_allocation($amount, ST_CUSTCREDIT, $credit_no, ST_SALESINVOICE, $invoice_no);
+
+       exchange_variation(ST_CUSTCREDIT, $credit_no, ST_SALESINVOICE, $invoice_no, $date,
+               $amount, PT_CUSTOMER);
+       return true;
+}
 
 ?>
\ No newline at end of file