sales/includes/db/cust_trans_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 //      Retreive parent document number(s) for given transaction
  14 //
  15 function get_parent_trans($trans_type, $trans_no) {
  16
  17         $sql = 'SELECT trans_link FROM
  18                         '.TB_PREF.'debtor_trans WHERE
  19                         (trans_no='.db_escape($trans_no).' AND type='.db_escape($trans_type).' AND trans_link!=0)';
  20
  21         $result = db_query($sql, 'Parent document numbers cannot be retrieved');
  22
  23         if (db_num_rows($result)) {
  24                 $link = db_fetch($result);
  25                 return array($link['trans_link']);
  26         }
  27         if ($trans_type!=ST_SALESINVOICE) return 0;     // this is credit note with no parent invoice
  28         // invoice: find batch invoice parent trans.
  29         $sql = 'SELECT trans_no FROM
  30                         '.TB_PREF.'debtor_trans WHERE
  31                         (trans_link='.db_escape($trans_no).' AND type='. get_parent_type($trans_type) .')';
  32
  33         $result = db_query($sql, 'Delivery links cannot be retrieved');
  34
  35         $delivery = array();
  36         if(db_num_rows($result)>0) {
  37                 while($link = db_fetch($result)) {
  38                         $delivery[] = $link['trans_no'];
  39                 }
  40         }
  41         return count($delivery) ? $delivery : 0;
  42 }
  43
  44 //----------------------------------------------------------------------------------------
  45 // Mark changes in debtor_trans_details
  46 //
  47 function update_customer_trans_version($type, $versions) {
  48
  49         $sql= 'UPDATE '.TB_PREF. 'debtor_trans SET version=version+1
  50                         WHERE type='.db_escape($type).' AND (';
  51
  52         foreach ($versions as $trans_no=>$version)
  53                 $where[] =      '(trans_no='.db_escape($trans_no).' AND version='.$version.')';
  54
  55                 $sql .= implode(' OR ', $where) .')';
  56
  57         return  db_query($sql, 'Concurrent editing conflict');
  58 }
  59
  60 //----------------------------------------------------------------------------------------
  61 // Gets document header versions for transaction set of type $type
  62 // $trans_no = array(num1, num2,...);
  63 // returns array(num1=>ver1, num2=>ver2...)
  64 //
  65 function get_customer_trans_version($type, $trans_no) {
  66         if (!is_array($trans_no))
  67                 $trans_no = array( $trans_no );
  68
  69         $sql= 'SELECT trans_no, version FROM '.TB_PREF. 'debtor_trans
  70                         WHERE type='.db_escape($type).' AND (';
  71
  72         foreach ($trans_no as $key=>$trans)
  73                 $trans_no[$key] =       'trans_no='.$trans_no[$key];
  74
  75         $sql .= implode(' OR ', $trans_no) . ')';
  76
  77         $res = db_query($sql, 'document version retreival');
  78
  79         $vers = array();
  80         while($mysql=db_fetch($res)) {
  81                 $vers[$mysql['trans_no']] = $mysql['version'];
  82         }
  83         return $vers;
  84 }
  85 //----------------------------------------------------------------------------------------
  86 // $Total, $Tax, $Freight, $discount all in customer's currency
  87 // date_ is display date (non-sql)
  88 function write_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
  89         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
  90         $sales_type=0, $order_no=0, $trans_link=0, $ship_via=0, $due_date="",
  91         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0, $payment_terms=null)
  92 {
  93         $new = $trans_no==0;
  94         $curr = get_customer_currency($debtor_no);
  95         if ($rate == 0)
  96                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
  97
  98         $SQLDate = date2sql($date_);
  99         if ($due_date == "")
 100                 $SQLDueDate = "0000-00-00";
 101         else
 102                 $SQLDueDate = date2sql($due_date);
 103
 104         if ($trans_type == ST_BANKPAYMENT)
 105                 $Total = -$Total;
 106
 107         if ($new) {
 108         $trans_no = get_next_trans_no($trans_type);
 109
 110         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
 111                 trans_no, type,
 112                 debtor_no, branch_code,
 113                 tran_date, due_date,
 114                 reference, tpe,
 115                 order_, ov_amount, ov_discount,
 116                 ov_gst, ov_freight, ov_freight_tax,
 117                 rate, ship_via, alloc, trans_link,
 118                 dimension_id, dimension2_id, payment_terms
 119                 ) VALUES ($trans_no, ".db_escape($trans_type).",
 120                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
 121                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
 122                 ".db_escape($sales_type).", ".db_escape($order_no).", $Total, ".db_escape($discount).", $Tax,
 123                 ".db_escape($Freight).",
 124                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt, ".db_escape($trans_link).",
 125                 ".db_escape($dimension_id).", ".db_escape($dimension2_id).", "
 126                 .db_escape($payment_terms).")";
 127         } else {        // may be optional argument should stay unchanged ?
 128         $sql = "UPDATE ".TB_PREF."debtor_trans SET
 129                 debtor_no=".db_escape($debtor_no)." , branch_code=".db_escape($BranchNo).",
 130                 tran_date='$SQLDate', due_date='$SQLDueDate',
 131                 reference=".db_escape($reference).", tpe=".db_escape($sales_type).", order_=".db_escape($order_no).",
 132                 ov_amount=$Total, ov_discount=".db_escape($discount).", ov_gst=$Tax,
 133                 ov_freight=".db_escape($Freight).", ov_freight_tax=$FreightTax, rate=$rate,
 134                 ship_via=".db_escape($ship_via).", alloc=$AllocAmt, trans_link=$trans_link,
 135                 dimension_id=".db_escape($dimension_id).", dimension2_id=".db_escape($dimension2_id).",
 136                 payment_terms=".db_escape($payment_terms)."
 137                 WHERE trans_no=$trans_no AND type=".db_escape($trans_type);
 138         }
 139         db_query($sql, "The debtor transaction record could not be inserted");
 140
 141         add_audit_trail($trans_type, $trans_no, $date_, $new ? '': _("Updated."));
 142
 143         return $trans_no;
 144 }
 145
 146 //----------------------------------------------------------------------------------------
 147
 148 function reinsert_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
 149         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
 150         $sales_type=0, $order_no=0, $trans_link=0, $ship_via=0, $due_date="",
 151         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0)
 152 {
 153         if ($trans_no == '')
 154                 display_db_error('Invalid call to function reinsert_customer_trans');
 155
 156         $curr = get_customer_currency($debtor_no);
 157         if ($rate == 0)
 158                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
 159
 160         $SQLDate = date2sql($date_);
 161         if ($due_date == "")
 162                 $SQLDueDate = "0000-00-00";
 163         else
 164                 $SQLDueDate = date2sql($due_date);
 165
 166         if ($trans_type == ST_BANKPAYMENT)
 167                 $Total = -$Total;
 168
 169         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
 170                 trans_no, type,
 171                 debtor_no, branch_code,
 172                 tran_date, due_date,
 173                 reference, tpe,
 174                 order_, ov_amount, ov_discount,
 175                 ov_gst, ov_freight, ov_freight_tax,
 176                 rate, ship_via, alloc, trans_link,
 177                 dimension_id, dimension2_id
 178                 ) VALUES ($trans_no, ".db_escape($trans_type).",
 179                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
 180                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
 181                 ".db_escape($sales_type).", ".db_escape($order_no).", $Total, ".db_escape($discount).", $Tax,
 182                 ".db_escape($Freight).",
 183                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt, ".db_escape($trans_link).",
 184                 ".db_escape($dimension_id).", ".db_escape($dimension2_id).")";
 185
 186         db_query($sql, "The debtor transaction record could not be inserted");
 187
 188         add_audit_trail($trans_type, $trans_no, $date_, _("Updated."));
 189
 190         return $trans_no;
 191 }
 192
 193 //----------------------------------------------------------------------------------------
 194
 195 function get_customer_trans($trans_id, $trans_type)
 196 {
 197         $sql = "SELECT trans.*,"
 198                 ."ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,"
 199                 ."cust.name AS DebtorName, cust.address, "
 200                 ."cust.curr_code, "
 201                 ."cust.tax_id ";
 202
 203         if ($trans_type == ST_CUSTPAYMENT) {
 204                 // it's a payment so also get the bank account
 205                 $sql .= ", ".TB_PREF."bank_accounts.bank_name, ".TB_PREF."bank_accounts.bank_account_name,
 206                         ".TB_PREF."bank_accounts.account_type AS BankTransType ";
 207         }
 208
 209         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
 210                 // it's an invoice so also get the shipper and salestype
 211                 $sql .= ", ".TB_PREF."shippers.shipper_name, "
 212                 .TB_PREF."sales_types.sales_type, "
 213                 .TB_PREF."sales_types.tax_included, "
 214                 ."branch.*, "
 215                 ."cust.discount, "
 216                 .TB_PREF."tax_groups.name AS tax_group_name, "
 217                 .TB_PREF."tax_groups.id AS tax_group_id ";
 218         }
 219
 220         $sql .= " FROM ".TB_PREF."debtor_trans trans, ".TB_PREF."debtors_master cust";
 221
 222         if ($trans_type == ST_CUSTPAYMENT) {
 223                 // it's a payment so also get the bank account
 224                 $sql .= ", ".TB_PREF."bank_trans, ".TB_PREF."bank_accounts";
 225         }
 226
 227         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
 228                 // it's an invoice so also get the shipper, salestypes
 229                 $sql .= ", ".TB_PREF."shippers, "
 230                 .TB_PREF."sales_types, "
 231                 .TB_PREF."cust_branch branch, "
 232                 .TB_PREF."tax_groups ";
 233         }
 234
 235         $sql .= " WHERE trans.trans_no=".db_escape($trans_id)."
 236                 AND trans.type=".db_escape($trans_type)."
 237                 AND trans.debtor_no=cust.debtor_no";
 238
 239         if ($trans_type == ST_CUSTPAYMENT) {
 240                 // it's a payment so also get the bank account
 241                 $sql .= " AND ".TB_PREF."bank_trans.trans_no =$trans_id
 242                         AND ".TB_PREF."bank_trans.type=$trans_type
 243                         AND ".TB_PREF."bank_accounts.id=".TB_PREF."bank_trans.bank_act ";
 244         }
 245         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
 246                 // it's an invoice so also get the shipper
 247                 $sql .= " AND ".TB_PREF."shippers.shipper_id=trans.ship_via
 248                         AND ".TB_PREF."sales_types.id = trans.tpe
 249                         AND branch.branch_code = trans.branch_code
 250                         AND branch.tax_group_id = ".TB_PREF."tax_groups.id ";
 251         }
 252
 253         $result = db_query($sql, "Cannot retreive a debtor transaction");
 254
 255         if (db_num_rows($result) == 0) {
 256                 // can't return nothing
 257                 display_db_error("no debtor trans found for given params", $sql, true);
 258                 exit;
 259         }
 260
 261         if (db_num_rows($result) > 1) {
 262                 // can't return multiple
 263                 display_db_error("duplicate debtor transactions found for given params", $sql, true);
 264                 exit;
 265         }
 266
 267         $row = db_fetch($result);
 268         return $row;
 269 }
 270
 271 //----------------------------------------------------------------------------------------
 272
 273 function exists_customer_trans($type, $type_no)
 274 {
 275         $sql = "SELECT trans_no FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)."
 276                 AND trans_no=".db_escape($type_no);
 277
 278         $result = db_query($sql, "Cannot retreive a debtor transaction");
 279
 280         return (db_num_rows($result) > 0);
 281 }
 282
 283 //----------------------------------------------------------------------------------------
 284
 285 // retreives the related sales order for a given trans
 286
 287 function get_customer_trans_order($type, $type_no)
 288 {
 289         $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 290
 291         $result = db_query($sql, "The debtor transaction could not be queried");
 292
 293         $row = db_fetch_row($result);
 294
 295         return $row[0];
 296 }
 297
 298 //----------------------------------------------------------------------------------------
 299
 300 function get_related_documents($type, $trans_no)
 301 {
 302         $sql = "SELECT * FROM ".TB_PREF."debtor_trans WHERE type=$type AND order_=".db_escape($trans_no);
 303         return db_query($sql,"The related documents could not be retreived");
 304 }
 305 //----------------------------------------------------------------------------------------
 306
 307 function get_related_credits($inv_numbers)
 308 {
 309         // FIXME -  credit notes retrieved here should be those linked to invoices containing
 310         // at least one line from this order
 311
 312
 313         $sql = "SELECT * FROM ".TB_PREF."debtor_trans WHERE type=".ST_CUSTCREDIT
 314                 ." AND trans_link IN(". implode(',', array_values($inv_numbers)).")";
 315
 316         return db_query($sql,"The related credit notes could not be retreived");
 317 }
 318
 319 //----------------------------------------------------------------------------------------
 320
 321 function get_customer_details_from_trans($type, $type_no)
 322 {
 323         $sql = "SELECT ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code, ".TB_PREF."cust_branch.br_name
 324                 FROM ".TB_PREF."debtors_master,".TB_PREF."cust_branch,".TB_PREF."debtor_trans
 325                 WHERE ".TB_PREF."debtor_trans.type=".db_escape($type)." AND ".TB_PREF."debtor_trans.trans_no=".db_escape($type_no)."
 326                 AND ".TB_PREF."debtors_master.debtor_no = ".TB_PREF."debtor_trans.debtor_no
 327                 AND     ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code";
 328
 329         $result = db_query($sql, "could not get customer details from trans");
 330         return db_fetch($result);
 331 }
 332
 333 //----------------------------------------------------------------------------------------
 334
 335 function void_customer_trans($type, $type_no)
 336 {
 337         // clear all values and mark as void
 338         $sql = "UPDATE ".TB_PREF."debtor_trans SET ov_amount=0, ov_discount=0, ov_gst=0, ov_freight=0,
 339                 ov_freight_tax=0, alloc=0, version=version+1 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 340
 341         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
 342 }
 343
 344 //----------------------------------------------------------------------------------------
 345
 346 function clear_customer_trans($type, $type_no)
 347 {
 348         // Delete
 349         $sql = "DELETE FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 350
 351         db_query($sql, "could not clear debtor transactions for type=$type and trans_no=$type_no");
 352 }
 353 //----------------------------------------------------------------------------------------
 354
 355 function post_void_customer_trans($type, $type_no)
 356 {
 357         switch ($type) {
 358                 case ST_SALESINVOICE :
 359                 case ST_CUSTCREDIT   :
 360                         void_sales_invoice($type, $type_no);
 361                         break;
 362                 case ST_CUSTDELIVERY :
 363                         void_sales_delivery($type, $type_no);
 364                         break;
 365                 case ST_CUSTPAYMENT :
 366                         void_customer_payment($type, $type_no);
 367                         break;
 368         }
 369 }
 370
 371 //----------------------------------------------------------------------------------------
 372
 373 function get_customer_trans_link($type, $type_no)
 374 {
 375         $row = db_query("SELECT trans_link from ".TB_PREF."debtor_trans
 376                 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no),
 377                 "could not get transaction link for type=$type and trans_no=$type_no");
 378         return $row[0];
 379 }
 380 //----------------------------------------------------------------------------------------
 381
 382 function get_sql_for_customer_inquiry()
 383 {
 384     $date_after = date2sql($_POST['TransAfterDate']);
 385     $date_to = date2sql($_POST['TransToDate']);
 386
 387         $sql = "SELECT
 388                 trans.type,
 389                 trans.trans_no,
 390                 trans.order_,
 391                 trans.reference,
 392                 trans.tran_date,
 393                 trans.due_date,
 394                 debtor.name,
 395                 branch.br_name,
 396                 debtor.curr_code,
 397                 (trans.ov_amount + trans.ov_gst + trans.ov_freight
 398                         + trans.ov_freight_tax + trans.ov_discount)     AS TotalAmount, ";
 399         if ($_POST['filterType'] != ALL_TEXT)
 400                 $sql .= "@bal := @bal+(trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), ";
 401
 402 //      else
 403 //              $sql .= "IF(trans.type=".ST_CUSTDELIVERY.",'', IF(trans.type=".ST_SALESINVOICE." OR trans.type=".ST_BANKPAYMENT.",@bal := @bal+
 404 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), @bal := @bal-
 405 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount))) , ";
 406                 $sql .= "trans.alloc AS Allocated,
 407                 ((trans.type = ".ST_SALESINVOICE.")
 408                         AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue
 409                 FROM "
 410                         .TB_PREF."debtor_trans as trans, "
 411                         .TB_PREF."debtors_master as debtor, "
 412                         .TB_PREF."cust_branch as branch
 413                 WHERE debtor.debtor_no = trans.debtor_no
 414                         AND trans.tran_date >= '$date_after'
 415                         AND trans.tran_date <= '$date_to'
 416                         AND trans.branch_code = branch.branch_code";
 417
 418         if ($_POST['customer_id'] != ALL_TEXT)
 419                 $sql .= " AND trans.debtor_no = ".db_escape($_POST['customer_id']);
 420
 421         if ($_POST['filterType'] != ALL_TEXT)
 422         {
 423                 if ($_POST['filterType'] == '1')
 424                 {
 425                         $sql .= " AND (trans.type = ".ST_SALESINVOICE." OR trans.type = ".ST_BANKPAYMENT.") ";
 426                 }
 427                 elseif ($_POST['filterType'] == '2')
 428                 {
 429                         $sql .= " AND (trans.type = ".ST_SALESINVOICE.") ";
 430                 }
 431                 elseif ($_POST['filterType'] == '3')
 432                 {
 433                         $sql .= " AND (trans.type = " . ST_CUSTPAYMENT
 434                                         ." OR trans.type = ".ST_BANKDEPOSIT.") ";
 435                 }
 436                 elseif ($_POST['filterType'] == '4')
 437                 {
 438                         $sql .= " AND trans.type = ".ST_CUSTCREDIT." ";
 439                 }
 440                 elseif ($_POST['filterType'] == '5')
 441                 {
 442                         $sql .= " AND trans.type = ".ST_CUSTDELIVERY." ";
 443                 }
 444
 445         if ($_POST['filterType'] == '2')
 446         {
 447                 $today =  date2sql(Today());
 448                 $sql .= " AND trans.due_date < '$today'
 449                                 AND (trans.ov_amount + trans.ov_gst + trans.ov_freight_tax +
 450                                 trans.ov_freight + trans.ov_discount - trans.alloc > 0) ";
 451         }
 452         }
 453         return $sql;
 454 }
 455
 456 function get_sql_for_sales_deliveries_view($selected_customer, $selected_stock_item=null)
 457 {
 458         $sql = "SELECT trans.trans_no,
 459                         debtor.name,
 460                         branch.branch_code,
 461                         branch.br_name,
 462                         sorder.deliver_to,
 463                         trans.reference,
 464                         sorder.customer_ref,
 465                         trans.tran_date,
 466                         trans.due_date,
 467                         (ov_amount+ov_gst+ov_freight+ov_freight_tax) AS DeliveryValue,
 468                         debtor.curr_code,
 469                         Sum(line.quantity-line.qty_done) AS Outstanding,
 470                         Sum(line.qty_done) AS Done
 471                 FROM "
 472                  .TB_PREF."sales_orders as sorder, "
 473                  .TB_PREF."debtor_trans as trans, "
 474                  .TB_PREF."debtor_trans_details as line, "
 475                  .TB_PREF."debtors_master as debtor, "
 476                  .TB_PREF."cust_branch as branch
 477                         WHERE
 478                         sorder.order_no = trans.order_ AND
 479                         trans.debtor_no = debtor.debtor_no
 480                                 AND trans.type = ".ST_CUSTDELIVERY."
 481                                 AND line.debtor_trans_no = trans.trans_no
 482                                 AND line.debtor_trans_type = trans.type
 483                                 AND trans.branch_code = branch.branch_code
 484                                 AND trans.debtor_no = branch.debtor_no ";
 485
 486         if ($_POST['OutstandingOnly'] == true) {
 487                  $sql .= " AND line.qty_done < line.quantity ";
 488         }
 489
 490         //figure out the sql required from the inputs available
 491         if (isset($_POST['DeliveryNumber']) && $_POST['DeliveryNumber'] != "")
 492         {
 493                 $delivery = "%".$_POST['DeliveryNumber'];
 494                 $sql .= " AND trans.trans_no LIKE ".db_escape($delivery);
 495                 $sql .= " GROUP BY trans.trans_no";
 496         }
 497         else
 498         {
 499                 $sql .= " AND trans.tran_date >= '".date2sql($_POST['DeliveryAfterDate'])."'";
 500                 $sql .= " AND trans.tran_date <= '".date2sql($_POST['DeliveryToDate'])."'";
 501
 502                 if ($selected_customer != -1)
 503                         $sql .= " AND trans.debtor_no=".db_escape($selected_customer)." ";
 504
 505                 if (isset($selected_stock_item))
 506                         $sql .= " AND line.stock_id=".db_escape($selected_stock_item)." ";
 507
 508                 if (isset($_POST['StockLocation']) && $_POST['StockLocation'] != ALL_TEXT)
 509                         $sql .= " AND sorder.from_stk_loc = ".db_escape($_POST['StockLocation'])." ";
 510
 511                 $sql .= " GROUP BY trans.trans_no ";
 512
 513         } //end no delivery number selected
 514         return $sql;
 515 }
 516 ?>