sales/includes/sales_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 include_once($path_to_root . "/includes/banking.inc");
  13 include_once($path_to_root . "/includes/inventory.inc");
  14 include_once($path_to_root . "/includes/db/allocations_db.inc");
  15 include_once($path_to_root . "/sales/includes/db/sales_order_db.inc");
  16 include_once($path_to_root . "/sales/includes/db/sales_credit_db.inc");
  17 include_once($path_to_root . "/sales/includes/db/sales_invoice_db.inc");
  18 include_once($path_to_root . "/sales/includes/db/sales_delivery_db.inc");
  19 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
  20 include_once($path_to_root . "/sales/includes/db/sales_points_db.inc");
  21 include_once($path_to_root . "/sales/includes/db/sales_groups_db.inc");
  22 include_once($path_to_root . "/sales/includes/db/recurrent_invoices_db.inc");
  23 include_once($path_to_root . "/sales/includes/db/custalloc_db.inc");
  24 include_once($path_to_root . "/sales/includes/db/cust_trans_db.inc");
  25 include_once($path_to_root . "/sales/includes/db/cust_trans_details_db.inc");
  26 include_once($path_to_root . "/sales/includes/db/payment_db.inc");
  27 include_once($path_to_root . "/sales/includes/db/branches_db.inc");
  28 include_once($path_to_root . "/sales/includes/db/customers_db.inc");
  29
  30 //----------------------------------------------------------------------------------------
  31 // add a debtor-related gl transaction
  32 // $date_ is display date (non-sql)
  33 // $amount is in CUSTOMER'S currency
  34
  35 function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
  36         $amount, $customer_id, $err_msg="", $rate=0)
  37 {
  38         if ($err_msg == "")
  39                 $err_msg = "The customer GL transaction could not be inserted";
  40
  41         return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
  42                 get_customer_currency($customer_id),
  43                 PT_CUSTOMER, $customer_id, $err_msg, $rate);
  44 }
  45
  46 //----------------------------------------------------------------------------------------
  47
  48 function get_calculated_price($stock_id, $add_pct)
  49 {
  50         $avg = get_unit_cost($stock_id);
  51         if ($avg == 0)
  52                 return 0;
  53         return round2($avg * (1 + $add_pct / 100), user_price_dec());
  54 }
  55
  56 function round_to_nearest($price, $round_to)
  57 {
  58         if ($price == 0)
  59                 return 0;
  60         $pow = pow(10, user_price_dec());
  61         if ($pow >= $round_to)
  62                 $mod = ($pow % $round_to);
  63         else
  64                 $mod = ($round_to % $pow);
  65         if ($mod != 0)
  66                 $price = ceil($price) - ($pow - $round_to) / $pow;
  67         else
  68         $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
  69     return $price;
  70
  71 }
  72
  73 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
  74 {
  75         if ($date == null)
  76             $date = new_doc_date();
  77
  78         if ($factor === null)
  79         {
  80                 $myrow = get_sales_type($sales_type_id);
  81                 $factor = $myrow['factor'];
  82         }
  83
  84         $add_pct = get_company_pref('add_pct');
  85         $base_id = get_base_sales_type();
  86     $home_curr = get_company_currency();
  87         //      AND (sales_type_id = $sales_type_id     OR sales_type_id = $base_id)
  88         $sql = "SELECT price, curr_abrev, sales_type_id
  89                 FROM ".TB_PREF."prices
  90                 WHERE stock_id = ".db_escape($stock_id)."
  91                         AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
  92
  93         $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
  94         $num_rows = db_num_rows($result);
  95         $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
  96             user_exrate_dec());
  97         $round_to = get_company_pref('round_to');
  98         $prices = array();
  99         while($myrow = db_fetch($result))
 100         {
 101             $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
 102         }
 103         $price = false;
 104         if (isset($prices[$sales_type_id][$currency]))
 105         {
 106             $price = $prices[$sales_type_id][$currency];
 107         }
 108         elseif (isset($prices[$base_id][$currency]))
 109         {
 110             $price = $prices[$base_id][$currency] * $factor;
 111         }
 112         elseif (isset($prices[$sales_type_id][$home_curr]))
 113         {
 114             $price = $prices[$sales_type_id][$home_curr] / $rate;
 115         }
 116         elseif (isset($prices[$base_id][$home_curr]))
 117         {
 118             $price = $prices[$base_id][$home_curr] * $factor / $rate;
 119         }
 120         elseif ($num_rows == 0 && $add_pct != -1)
 121         {
 122                 $price = get_calculated_price($stock_id, $add_pct);
 123                 if ($currency != $home_curr)
 124                         $price /= $rate;
 125                 if ($factor != 0)
 126                         $price *= $factor;
 127         }
 128         if ($price === false)
 129                 return 0;
 130         elseif ($round_to != 1)
 131                 return round_to_nearest($price, $round_to);
 132         else
 133                 return round2($price, user_price_dec());
 134 }
 135 //----------------------------------------------------------------------------------------
 136 //
 137 //      Get price for given item or kit.
 138 //  When $std==true price is calculated as a sum of all included stock items,
 139 //      otherwise all prices set for kits and items are accepted.
 140 //
 141 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
 142         $date=null, $std = false)
 143 {
 144         $kit_price = 0.00;
 145         if (!$std) {
 146                 $kit_price = get_price( $item_code, $currency, $sales_type_id,
 147                         $factor, $date);
 148
 149                 if ($kit_price !== 0) {
 150                         return $kit_price;
 151                 }
 152         }
 153         // no price for kit found, get total value of all items
 154         $kit = get_item_kit($item_code);
 155
 156         while($item = db_fetch($kit)) {
 157                 if ($item['item_code'] != $item['stock_id']) {
 158                         // foreign/kit code
 159                         $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
 160                                 $currency, $sales_type_id, $factor, $date, $std);
 161
 162                 } else {
 163                         // stock item
 164                         $kit_price += $item['quantity'] * get_price( $item['stock_id'],
 165                                 $currency, $sales_type_id, $factor, $date);
 166                 }
 167         }
 168         return $kit_price;
 169 }
 170
 171 //--------------------------------------------------------------------------------------------------
 172 function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
 173 {
 174         $doc_type = get_parent_type($doc_type);
 175
 176         $qty_dispatched = (float)$qty_dispatched;
 177
 178         if ($doc_type == 0)
 179                 return false;
 180         else {
 181                 if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
 182                 {
 183                         $sql = "UPDATE ".TB_PREF."sales_order_details
 184                                 SET qty_sent = qty_sent + $qty_dispatched";
 185                         if ($auto)
 186                                 $sql .= ", quantity = quantity + $qty_dispatched";
 187                         $sql .= " WHERE id=".db_escape($line_id);
 188                 }
 189                 else
 190                         $sql = "UPDATE ".TB_PREF."debtor_trans_details
 191                                 SET qty_done = qty_done + $qty_dispatched
 192                                 WHERE id=".db_escape($line_id);
 193         }
 194         db_query($sql, "The parent document detail record could not be updated");
 195         return true;
 196 }
 197
 198 //--------------------------------------------------------------------------------------------------
 199 // find inventory location for given transaction
 200 //
 201 function get_location(&$cart)
 202 {
 203         $sql = "SELECT location.*
 204                 FROM ".TB_PREF."stock_moves move,"
 205                         .TB_PREF."locations location".
 206                 " WHERE type=".db_escape($cart->trans_type).
 207                 " AND trans_no=".key($cart->trans_no).
 208                 " AND qty!=0 ".
 209                 " AND location.loc_code=move.loc_code";
 210
 211         $result = db_query($sql, 'Retreiving inventory location');
 212
 213         if (db_num_rows($result)) {
 214                 return db_fetch($result);
 215         }
 216         return null;
 217 }
 218 //--------------------------------------------------------------------------------------------------
 219 // Generic read debtor transaction into cart
 220 //
 221 //      $trans_no - array of trans nums; special case trans_no==0 - new doc
 222 //
 223 function read_sales_trans($doc_type, $trans_no, &$cart)
 224 {
 225         if (!is_array($trans_no) && $trans_no)
 226                 $trans_no = array($trans_no);
 227
 228         $cart->trans_type = $doc_type;
 229         if (!$trans_no) { // new document
 230                 $cart->trans_no = $trans_no;
 231         } else {
 232                 // read header data from first document
 233                 $myrow = get_customer_trans($trans_no[0],$doc_type);
 234         $debtor_no = $myrow['debtor_no'];
 235                 if (count_array($trans_no)>1)
 236                         $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
 237                 else
 238                         $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
 239
 240                 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
 241
 242         $cart->set_customer($debtor_no, $myrow["DebtorName"],
 243                         $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
 244
 245                 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
 246                         $myrow["tax_group_name"]);
 247
 248                 $cart->reference = $myrow["reference"];
 249                 $cart->prepaid = $myrow["prepaid"];
 250                 $cart->order_no = $myrow["order_"];
 251                 $cart->due_date = sql2date($myrow["due_date"]);
 252                 $cart->document_date = sql2date($myrow["tran_date"]);
 253                 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
 254                 $cart->dimension2_id = $myrow['dimension2_id'];
 255                 $cart->Comments = '';
 256                 foreach ( $trans_no as $trans ) {
 257                         $cart->Comments .= get_comments_string($doc_type,$trans);
 258                 }
 259
 260                 // FIX this should be calculated sum() for multiply parents
 261
 262                 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
 263                 $myrow["br_address"], $myrow["ov_freight"]);
 264
 265                 $location = 0;
 266                 $myrow = get_location($cart); // find location from movement
 267
 268                 if($myrow!=null) {
 269                         $cart->set_location($myrow['loc_code'], $myrow['location_name']);
 270                 }
 271
 272                 $result = get_customer_trans_details($doc_type,$trans_no);
 273                 if (db_num_rows($result) > 0) {
 274                         for($line_no=0; $myrow = db_fetch($result); $line_no++) {
 275                                 $cart->line_items[$line_no] = new line_details(
 276                                         $myrow["stock_id"],$myrow["quantity"],
 277                                         $myrow["unit_price"], $myrow["discount_percent"],
 278                                         $myrow["qty_done"], $myrow["standard_cost"],
 279                                         $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
 280                                         @$myrow["src_id"]);
 281                         }
 282                 }
 283         $cart->prepayments = get_payments_for($trans_no[0], $doc_type, $debtor_no);
 284
 285         } // !newdoc
 286
 287         return true;
 288 }
 289 //----------------------------------------------------------------------------------------
 290
 291 function get_sales_child_lines($trans_type, $trans_no, $lines=true)
 292 {
 293         if (!($ctype = get_child_type($trans_type)))
 294                 return false;
 295         if (!is_array($trans_no)) {
 296                 $trans_no = array($trans_no);
 297         }
 298
 299         $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
 300         $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
 301
 302         foreach($trans_no as $n => $trans) {
 303                 $trans_no[$n] = db_escape($trans);
 304         }
 305         $sql = "SELECT child.*
 306                         FROM
 307                                 ".TB_PREF."debtor_trans_details child
 308                         LEFT JOIN ".TB_PREF."$par_tbl trans
 309                                 ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
 310                         WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
 311
 312         if (!$lines)
 313                 $sql .= " GROUP BY child.debtor_trans_no";
 314
 315         $sql .= " ORDER BY child.debtor_trans_no";
 316
 317         return db_query($sql, "can't retrieve child trans");
 318 }
 319
 320 function get_sales_child_numbers($trans_type, $trans_no)
 321 {
 322         $trans = array();
 323         $res = get_sales_child_lines($trans_type, $trans_no, false);
 324         while ($line = db_fetch($res)) {
 325                 $trans[] = $line['debtor_trans_no'];
 326         }
 327         return $trans;
 328 }
 329
 330 function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
 331 {
 332         $partype = get_parent_type($trans_type);
 333
 334         if (!$partype)
 335                 return false;
 336
 337         $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
 338         $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
 339         $sql = "SELECT parent.*
 340                         FROM
 341                                 ".TB_PREF."$par_tbl parent
 342                         LEFT JOIN ".TB_PREF."debtor_trans_details trans
 343                                 ON trans.src_id=parent.id
 344                         WHERE
 345                                 trans.debtor_trans_type=".db_escape($trans_type)
 346                                 ." AND trans.debtor_trans_no=".db_escape($trans_no);
 347         if (!$lines)
 348                 $sql .= " GROUP BY $par_no";
 349
 350         $sql .= " ORDER BY $par_no";
 351
 352         return db_query($sql, "can't retrieve child trans");
 353
 354 }
 355
 356 function get_sales_parent_numbers($trans_type, $trans_no)
 357 {
 358         $trans = array();
 359         $res = get_sales_parent_lines($trans_type, $trans_no, false);
 360         while ($line = db_fetch($res))
 361                 $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
 362         return $trans;
 363 }
 364
 365 //----------------------------------------------------------------------------------------
 366
 367 function get_sales_child_documents($trans_type, $trans_no)
 368 {
 369         // FIXME -  credit notes retrieved here should be those linked to invoices containing
 370         // at least one line from related invoice
 371
 372         if (!count_array($trans_no))
 373                 return false;
 374         $childs = get_sales_child_numbers($trans_type, $trans_no, false);
 375         if (!count_array($childs))
 376                 return false;
 377
 378         $sql = "SELECT * FROM ".TB_PREF."debtor_trans
 379                 WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
 380
 381         return db_query($sql,"The related credit notes could not be retreived");
 382 }
 383