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