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