sales/includes/db/custalloc_db.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 //----------------------------------------------------------------------------------------
  13
  14 function add_cust_allocation($amount, $trans_type_from, $trans_no_from,
  15         $trans_type_to, $trans_no_to, $person_id, $date_)
  16 {
  17         $date = date2sql($date_);
  18         $sql = "INSERT INTO ".TB_PREF."cust_allocations (
  19                 amt, date_alloc,
  20                 trans_type_from, trans_no_from, trans_no_to, trans_type_to, person_id)
  21                 VALUES ($amount, '$date', ".db_escape($trans_type_from).", ".db_escape($trans_no_from).", ".db_escape($trans_no_to)
  22                 .", ".db_escape($trans_type_to).", ".db_escape($person_id).")";
  23
  24         db_query($sql, "A customer allocation could not be added to the database");
  25 }
  26
  27 //----------------------------------------------------------------------------------------
  28
  29
  30 function delete_cust_allocation($trans_id)
  31 {
  32         $sql = "DELETE FROM ".TB_PREF."cust_allocations WHERE id = ".db_escape($trans_id);
  33         return db_query($sql, "The existing allocation $trans_id could not be deleted");
  34 }
  35
  36 //----------------------------------------------------------------------------------------
  37
  38 function get_cust_allocation($trans_id)
  39 {
  40         $sql = "SELECT * FROM ".TB_PREF."cust_allocations WHERE id = ".db_escape($trans_id);
  41         return db_fetch(db_query($sql), "Cannot retrieve customer allocation $trans_id");
  42 }
  43
  44 //----------------------------------------------------------------------------------------
  45 //      Update debtor trans alloc field according to current status of cust_allocations
  46 //
  47 function update_debtor_trans_allocation($trans_type, $trans_no, $person_id)
  48 {
  49         $sql =
  50                 "UPDATE `".TB_PREF.($trans_type==ST_SALESORDER ? 'sales_orders' : 'debtor_trans')."` trans,
  51                         (SELECT sum(amt) amt FROM ".TB_PREF."cust_allocations
  52                                 WHERE person_id=".db_escape($person_id)." AND ((trans_type_to=".db_escape($trans_type)." AND trans_no_to=".db_escape($trans_no).")
  53                                 OR (trans_type_from=".db_escape($trans_type)." AND trans_no_from=".db_escape($trans_no)."))) allocated
  54                 SET
  55                         trans.alloc=IFNULL(allocated.amt,0)
  56                 WHERE trans.debtor_no=".db_escape($person_id)." AND ".($trans_type==ST_SALESORDER ?
  57                            "trans.trans_type=".db_escape($trans_type)." AND order_no=".db_escape($trans_no)
  58                         :  "trans.type=".db_escape($trans_type)." AND trans_no=".db_escape($trans_no));
  59         db_query($sql, "The debtor transaction record could not be modified for the allocation against it");
  60 }
  61
  62 //-------------------------------------------------------------------------------------------------------------
  63 //
  64 function void_cust_allocations($type, $type_no, $date="")
  65 {
  66         return clear_cust_alloctions($type, $type_no, null, $date);
  67 }
  68
  69 //-------------------------------------------------------------------------------------------------------------
  70 //
  71 function clear_cust_alloctions($type, $type_no, $person_id=null, $date="")
  72 {
  73         $sql = "UPDATE  ".TB_PREF."cust_allocations ca
  74                                 LEFT JOIN ".TB_PREF."debtor_trans paym ON ca.trans_type_from=paym.type AND ca.trans_no_from=paym.trans_no AND ca.person_id=paym.debtor_no
  75                                 LEFT JOIN ".TB_PREF."debtor_trans dt ON ca.trans_type_to=dt.type AND ca.trans_no_to=dt.trans_no AND ca.person_id=dt.debtor_no
  76                                 LEFT JOIN ".TB_PREF."sales_orders so ON ca.trans_type_to=so.trans_type AND ca.trans_no_to=so.order_no AND ca.person_id=so.debtor_no
  77                         SET paym.alloc=paym.alloc - ca.amt,
  78                                 dt.alloc=dt.alloc -  ca.amt,
  79                                 so.alloc=so.alloc -  ca.amt
  80                         WHERE  ((ca.trans_type_from=".db_escape($type)." AND ca.trans_no_from=".db_escape($type_no).")
  81                                 OR (ca.trans_type_to=".db_escape($type)." AND ca.trans_no_to=".db_escape($type_no)."))";
  82         if ($person_id)
  83                 $sql .= " AND ca.person_id=".db_escape($person_id);
  84         db_query($sql, "could not clear allocation");
  85
  86         // remove any allocations for this transaction
  87         $sql = "DELETE FROM ".TB_PREF."cust_allocations
  88                         WHERE  ((trans_type_from=".db_escape($type)." AND trans_no_from=".db_escape($type_no).")
  89                                 OR (trans_type_to=".db_escape($type)." AND trans_no_to=".db_escape($type_no)."))";
  90         if ($person_id)
  91                 $sql .= " AND person_id=".db_escape($person_id);
  92
  93         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
  94 // is this necessary?
  95 //      if ($date != "")
  96 //              exchange_variation($type, $type_no, $row['trans_type_to'], $row['trans_no_to'], $date,
  97 //                      $row['amt'], PT_CUSTOMER, true);
  98 }
  99 //-------------------------------------------------------------------------------------------------------------
 100
 101 function get_allocatable_from_cust_sql($customer_id=null, $settled)
 102 {
 103         $sql = "SELECT
 104                 trans.type,
 105                 trans.trans_no,
 106                 trans.reference,
 107                 trans.tran_date,
 108                 debtor.name AS DebtorName,
 109                 debtor.curr_code,
 110                 ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,
 111                 trans.alloc,
 112                 trans.due_date,
 113                 debtor.address,
 114                 trans.version,
 115                 round(abs(ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount-alloc),6) <= 0 AS settled,
 116                 trans.debtor_no
 117
 118          FROM "
 119                 .TB_PREF."debtor_trans as trans, "
 120                 .TB_PREF."debtors_master as debtor"
 121         ." WHERE trans.debtor_no=debtor.debtor_no
 122                 AND (((type=".ST_CUSTPAYMENT." OR type=".ST_BANKDEPOSIT.") AND (trans.ov_amount > 0))"
 123                 ." OR ( (type=".ST_CUSTCREDIT. " OR type=".ST_JOURNAL. ") AND (ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount)>0))";
 124
 125         if (!$settled)
 126                 $sql .= " AND (round(abs(ov_amount+ov_gst+ov_freight+ov_freight_tax-ov_discount-alloc),6) > 0)";
 127
 128         if ($customer_id != null)
 129                 $sql .= " AND trans.debtor_no = ".db_escape($customer_id);
 130
 131         return $sql;
 132 }
 133
 134 function get_allocatable_sales_orders($customer_id = null, $trans_no=null, $type=null)
 135 {
 136         $sql = "SELECT
 137                 sorder.trans_type as type,
 138                 sorder.order_no as trans_no,
 139                 sorder.reference,
 140                 sorder.ord_date,
 141                 debtor.name AS DebtorName,
 142                 debtor.curr_code,
 143                 total-IFNULL(invoiced.amount,0) as Total,
 144                 sorder.alloc,
 145                 sorder.delivery_date as due_date,
 146                 debtor.address,
 147                 sorder.version,
 148                 amt,
 149                 sorder.debtor_no,
 150                 sorder.branch_code
 151                 FROM ".TB_PREF."sales_orders as sorder
 152                         LEFT JOIN ".TB_PREF."debtors_master as debtor ON sorder.debtor_no = debtor.debtor_no
 153                         LEFT JOIN ".TB_PREF."cust_allocations as alloc
 154                                 ON sorder.order_no = alloc.trans_no_to AND sorder.trans_type = alloc.trans_type_to AND alloc.person_id=sorder.debtor_no
 155                         LEFT JOIN (SELECT order_, sum(prep_amount) amount FROM ".TB_PREF."debtor_trans dt
 156                         WHERE prep_amount>0 AND dt.type=".ST_SALESINVOICE." GROUP BY order_) as invoiced ON sorder.order_no = invoiced.order_
 157                 WHERE sorder.trans_type=".ST_SALESORDER;
 158
 159         if ($trans_no != null and $type != null)
 160         {
 161                 $sql .= " AND alloc.trans_no_from=".db_escape($trans_no)."
 162                                   AND alloc.trans_type_from=".db_escape($type);
 163         }
 164         else
 165         {
 166                 $sql .= " AND round(sorder.prep_amount)>0 and Total>0"; // only sales orders with prepayment level set and no yet fully invoiced
 167         }
 168         if ($customer_id)
 169                 $sql .= " AND sorder.debtor_no=".db_escape($customer_id);
 170
 171         $sql .= " GROUP BY sorder.order_no";
 172
 173         return $sql;
 174 }
 175 //-------------------------------------------------------------------------------------------------------------
 176
 177 function get_allocatable_to_cust_transactions($customer_id = null, $trans_no=null, $type=null)
 178 {
 179         $sql = "SELECT
 180                 trans.type,
 181                 trans.trans_no,
 182                 trans.reference,
 183                 trans.tran_date,
 184                 debtor.name AS DebtorName,
 185                 debtor.curr_code,
 186                 IF(prep_amount, prep_amount, ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount) AS Total,
 187                 trans.alloc,
 188                 trans.due_date,
 189                 debtor.address,
 190                 trans.version,
 191                 amt,
 192                 trans.debtor_no,
 193                 trans.branch_code
 194          FROM ".TB_PREF."debtor_trans as trans
 195                         LEFT JOIN ".TB_PREF."cust_allocations as alloc
 196                                 ON trans.trans_no = alloc.trans_no_to AND trans.type = alloc.trans_type_to AND alloc.person_id=trans.debtor_no,"
 197                         .TB_PREF."debtors_master as debtor
 198          WHERE
 199                  trans.debtor_no=debtor.debtor_no";
 200         if ($customer_id)
 201                 $sql .= " AND trans.debtor_no=".db_escape($customer_id);
 202
 203         if ($trans_no != null and $type != null)
 204         {
 205                 $sql .= " AND alloc.trans_no_from=".db_escape($trans_no)."
 206                                   AND alloc.trans_type_from=".db_escape($type);
 207         }
 208         else
 209         {
 210                 $sql .= "
 211                                  AND (
 212                                         trans.type='".ST_SALESINVOICE."'
 213                                         AND round(IF(prep_amount, prep_amount, ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount)-alloc,6) > 0
 214                                         OR
 215                                         trans.type='". ST_CUSTCREDIT."'
 216                                         AND round(-IF(prep_amount, prep_amount, ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount)-alloc,6) > 0
 217                                         OR
 218                                         trans.type = '". ST_JOURNAL."'
 219                                         AND ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount<0
 220                                         OR
 221                                         trans.type = '". ST_BANKPAYMENT."'
 222                                         AND ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount>0
 223                                 )";
 224                 $sql .= " GROUP BY type, trans_no";
 225         }
 226
 227         $orders = get_allocatable_sales_orders($customer_id, $trans_no, $type);
 228         $sql = "($sql ORDER BY trans_no) \nUNION \n($orders)";
 229
 230         return db_query($sql, "Cannot retreive alloc to transactions");
 231 }
 232
 233 //-------------------------------------------------------------------------------------------------------------
 234
 235 function get_allocatable_from_cust_transactions($customer_id, $trans_no=null, $type=null)
 236 {
 237
 238         $sql = "SELECT
 239                 trans.type,
 240                 trans.trans_no,
 241                 trans.reference,
 242                 trans.tran_date,
 243                 debtor.name AS DebtorName,
 244                 debtor.curr_code,
 245                 ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,
 246                 trans.alloc,
 247                 trans.due_date,
 248                 debtor.address,
 249                 trans.version,
 250                 amt,
 251                 trans.debtor_no
 252          FROM  ".TB_PREF."debtor_trans as trans,"
 253                         .TB_PREF."debtors_master as debtor,"
 254                         .TB_PREF."cust_allocations as alloc
 255          WHERE trans.debtor_no=debtor.debtor_no
 256                         AND trans.trans_no = alloc.trans_no_from
 257                         AND trans.type = alloc.trans_type_from
 258                         AND trans.debtor_no = alloc.person_id";
 259
 260         if ($trans_no != null and $type != null)
 261         {
 262                 $sql .= " AND alloc.trans_no_to=".db_escape($trans_no)."
 263                                   AND alloc.trans_type_to=".db_escape($type);
 264         }
 265         else
 266         {
 267                 $sql .= " AND round(ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount-alloc,6) > 0
 268                         AND trans.type NOT IN (".implode(',',array(ST_CUSTPAYMENT,ST_BANKDEPOSIT,ST_CUSTCREDIT,ST_CUSTDELIVERY)).")";
 269                 $sql .= " GROUP BY type, trans_no";
 270         }
 271
 272         if($customer_id)
 273                 $sql .= " AND trans.debtor_no=".db_escape($customer_id);
 274
 275         return db_query($sql." ORDER BY trans_no", "Cannot retreive alloc to transactions");
 276 }
 277
 278 function get_sql_for_customer_allocation_inquiry($from, $to, $customer, $filterType, $settled)
 279 {
 280         $data_after = date2sql($from);
 281         $date_to = date2sql($to);
 282
 283         $sql = "SELECT
 284                 trans.type,
 285                 trans.trans_no,
 286                 trans.reference,
 287                 trans.order_,
 288                 trans.tran_date,
 289                 trans.due_date,
 290                 debtor.name,
 291                 debtor.curr_code,
 292         (trans.ov_amount + trans.ov_gst + trans.ov_freight
 293                         + trans.ov_freight_tax + trans.ov_discount)     AS TotalAmount,
 294                 trans.alloc AS Allocated,
 295                 ((trans.type = ".ST_SALESINVOICE.")
 296                         AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue,
 297                 trans.debtor_no
 298         FROM "
 299                         .TB_PREF."debtor_trans as trans, "
 300                         .TB_PREF."debtors_master as debtor
 301         WHERE debtor.debtor_no = trans.debtor_no
 302                         AND (trans.ov_amount + trans.ov_gst + trans.ov_freight
 303                                 + trans.ov_freight_tax + trans.ov_discount != 0)
 304                 AND trans.tran_date >= '$data_after'
 305                 AND trans.tran_date <= '$date_to'";
 306
 307         if ($customer != ALL_TEXT)
 308                 $sql .= " AND trans.debtor_no = ".db_escape($customer);
 309
 310         if (isset($filterType) && $filterType != ALL_TEXT)
 311         {
 312                 if ($filterType == '1' || $filterType == '2')
 313                 {
 314                         $sql .= " AND trans.type = ".ST_SALESINVOICE." ";
 315                 }
 316                 elseif ($filterType == '3')
 317                 {
 318                         $sql .= " AND trans.type = " . ST_CUSTPAYMENT;
 319                 }
 320                 elseif ($filterType == '4')
 321                 {
 322                         $sql .= " AND trans.type = ".ST_CUSTCREDIT." ";
 323                 }
 324
 325         if ($filterType == '2')
 326         {
 327                 $today =  date2sql(Today());
 328                 $sql .= " AND trans.due_date < '$today'
 329                                 AND (round(abs(trans.ov_amount + "
 330                                 ."trans.ov_gst + trans.ov_freight + "
 331                                 ."trans.ov_freight_tax + trans.ov_discount) - trans.alloc,6) > 0) ";
 332         }
 333         }
 334         else
 335         {
 336             $sql .= " AND trans.type <> ".ST_CUSTDELIVERY." ";
 337         }
 338
 339
 340         if (!$settled)
 341         {
 342                 $sql .= " AND (round(IF(trans.prep_amount,trans.prep_amount, abs(trans.ov_amount + trans.ov_gst + "
 343                 ."trans.ov_freight + trans.ov_freight_tax + "
 344                 ."trans.ov_discount)) - trans.alloc,6) != 0) ";
 345         }
 346         return $sql;
 347 }
 348
 349 function credit_sales_invoice_allocate($invoice_no, $credit_no, $amount, $date)
 350 {
 351
 352         $sql = "SELECT ov_freight+ov_gst+ov_amount+ov_freight_tax as total, alloc, debtor_no FROM ".TB_PREF."debtor_trans
 353                 WHERE (`type`=".ST_SALESINVOICE." AND trans_no=".db_escape($invoice_no).")";
 354         $result = db_query($sql, "can't retrieve invoice totals");
 355         $invoice = db_fetch($result);
 356         $free = $invoice['total'] - $invoice['alloc'];
 357
 358         if ($free < $amount) {
 359          // if there is not enough unallocated amount - remove some payment allocations
 360                 $sql = "SELECT * FROM ".TB_PREF."cust_allocations
 361                         WHERE (trans_type_to=".ST_SALESINVOICE." AND trans_no_to=".db_escape($invoice_no)." AND person_id=".db_escape($invoice['debtor_no']).")
 362                         AND trans_type_from <> ".ST_CUSTCREDIT;
 363                 $result = db_query($sql, "can't retrieve invoice allocations");
 364
 365                 while(($free < $amount) && ($alloc = db_fetch($result))) {
 366                         $unalloc = min($alloc['amt'], $amount-$free);
 367
 368                         delete_cust_allocation($alloc['id']);
 369                         if ($unalloc < $alloc['amt'])
 370                                 add_cust_allocation($alloc['amt']-$unalloc, $alloc['trans_type_from'],
 371                                         $alloc['trans_no_from'], ST_SALESINVOICE, $invoice_no, $invoice['debtor_no'], $date);
 372
 373                         update_debtor_trans_allocation($alloc['trans_type_to'], $alloc['trans_no_to'], $invoice['debtor_no']);
 374                         update_debtor_trans_allocation($alloc['trans_type_from'], $alloc['trans_no_from'], $invoice['debtor_no']);
 375                         $free += $unalloc;
 376                 }
 377         }
 378         if (floatcmp($free, $amount)<0) {
 379                 // this should never happen unless sparse credit notices were allocated to
 380                 // the invoice, or summarized freight costs on credit notes is more than those on invoice.
 381                 display_error(_("Unsuspected overallocation happened due to sparse credit notes exists for this invoice.
 382  Check all credit notes allocated to this invoice for summarized freight charges."));
 383                 return false;
 384         }
 385         add_cust_allocation($amount, ST_CUSTCREDIT, $credit_no, ST_SALESINVOICE, $invoice_no, $invoice['debtor_no'], $date);
 386         update_debtor_trans_allocation(ST_SALESINVOICE, $invoice_no, $invoice['debtor_no']);
 387         update_debtor_trans_allocation(ST_CUSTCREDIT, $credit_no, $invoice['debtor_no']);
 388
 389         exchange_variation(ST_CUSTCREDIT, $credit_no, ST_SALESINVOICE, $invoice_no, $date,
 390                 $amount, PT_CUSTOMER);
 391         return true;
 392 }