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                 PT_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         $add_pct = get_company_pref('add_pct');
  97         $base_id = get_base_sales_type();
  98     $home_curr = get_company_currency();
  99         //      AND (sales_type_id = $sales_type_id     OR sales_type_id = $base_id)
 100         $sql = "SELECT price, curr_abrev, sales_type_id
 101                 FROM ".TB_PREF."prices
 102                 WHERE stock_id = ".db_escape($stock_id)."
 103                         AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
 104
 105         $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
 106         $num_rows = db_num_rows($result);
 107         $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
 108             user_exrate_dec());
 109         $round_to = get_company_pref('round_to');
 110         $prices = array();
 111         while($myrow = db_fetch($result))
 112         {
 113             $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
 114         }
 115         $price = false;
 116         if (isset($prices[$sales_type_id][$currency]))
 117         {
 118             $price = $prices[$sales_type_id][$currency];
 119         }
 120         elseif (isset($prices[$base_id][$currency]))
 121         {
 122             $price = $prices[$base_id][$currency] * $factor;
 123         }
 124         elseif (isset($prices[$sales_type_id][$home_curr]))
 125         {
 126             $price = $prices[$sales_type_id][$home_curr] / $rate;
 127         }
 128         elseif (isset($prices[$base_id][$home_curr]))
 129         {
 130             $price = $prices[$base_id][$home_curr] * $factor / $rate;
 131         }
 132 /*
 133         if (isset($prices[$sales_type_id][$home_curr]))
 134         {
 135             $price = $prices[$sales_type_id][$home_curr] / $rate;
 136         }
 137         elseif (isset($prices[$base_id][$currency]))
 138         {
 139             $price = $prices[$base_id][$currency] * $factor;
 140         }
 141         elseif (isset($prices[$base_id][$home_curr]))
 142         {
 143             $price = $prices[$base_id][$home_curr] * $factor / $rate;
 144         }
 145 */
 146         elseif ($num_rows == 0 && $add_pct != -1)
 147         {
 148                 $price = get_calculated_price($stock_id, $add_pct);
 149                 if ($currency != $home_curr)
 150                         $price /= $rate;
 151                 if ($factor != 0)
 152                         $price *= $factor;
 153         }
 154         if ($price === false)
 155                 return 0;
 156         elseif ($round_to != 1)
 157                 return round_to_nearest($price, $round_to);
 158         else
 159                 return round2($price, user_price_dec());
 160 }
 161 //----------------------------------------------------------------------------------------
 162 //
 163 //      Get price for given item or kit.
 164 //  When $std==true price is calculated as a sum of all included stock items,
 165 //      otherwise all prices set for kits and items are accepted.
 166 //
 167 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
 168         $date=null, $std = false)
 169 {
 170         $kit_price = 0.00;
 171         if (!$std) {
 172                 $kit_price = get_price( $item_code, $currency, $sales_type_id,
 173                         $factor, $date);
 174
 175                 if ($kit_price !== false) {
 176                         return $kit_price;
 177                 }
 178         }
 179         // no price for kit found, get total value of all items
 180         $kit = get_item_kit($item_code);
 181
 182         while($item = db_fetch($kit)) {
 183                 if ($item['item_code'] != $item['stock_id']) {
 184                         // foreign/kit code
 185                         $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
 186                                 $currency, $sales_type_id, $factor, $date, $std);
 187
 188                 } else {
 189                         // stock item
 190                         $kit_price += $item['quantity'] * get_price( $item['stock_id'],
 191                                 $currency, $sales_type_id, $factor, $date);
 192                 }
 193         }
 194         return $kit_price;
 195 }
 196
 197 //-----------------------------------------------------------------------------
 198
 199 function set_document_parent($cart)
 200 {
 201         $inv_no = key($cart->trans_no);
 202
 203         if (count($cart->src_docs) == 1) {
 204
 205                 // if this child document has only one parent - update child link
 206                 $src = array_keys($cart->src_docs);
 207                 $del_no = reset($src);
 208
 209                 $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $del_no .
 210                         ' WHERE type='.db_escape($cart->trans_type).' AND trans_no='. $inv_no ;
 211                 db_query($sql, 'Child document link cannot be updated');
 212
 213         }
 214         if ($cart->trans_type != ST_SALESINVOICE)
 215                 return 0;
 216
 217         // the rest is batch invoice specific
 218
 219         foreach ($cart->line_items as $line) {
 220                 if ($line->quantity != $line->qty_dispatched) {
 221                         return 1;       // this is partial invoice
 222                 }
 223         }
 224
 225         $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $inv_no .
 226         ' WHERE type='.get_parent_type($cart->trans_type).' AND (';
 227
 228         $deliveries = array_keys($cart->src_docs);
 229
 230         foreach ($deliveries as $key=>$del)
 231                 $deliveries[$key] = 'trans_no='.$del;
 232
 233         $sql .= implode(' OR ', $deliveries) . ')';
 234         db_query($sql, 'Delivery links cannot be updated');
 235
 236         return 0; // batch or complete invoice
 237 }
 238
 239 //--------------------------------------------------------------------------------------------------
 240 function get_parent_type($type)
 241 {
 242         $parent_types = array( ST_CUSTCREDIT => ST_SALESINVOICE, ST_SALESINVOICE => ST_CUSTDELIVERY, ST_CUSTDELIVERY => ST_SALESORDER );
 243         return isset($parent_types[$type]) ?  $parent_types[$type] : 0;
 244 }
 245
 246 //--------------------------------------------------------------------------------------------------
 247 function update_parent_line($doc_type, $line_id, $qty_dispatched)
 248 {
 249         $doc_type = get_parent_type($doc_type);
 250
 251 //      echo "update line: $line_id, $doc_type, $qty_dispatched";
 252         if ($doc_type==0)
 253                 return false;
 254         else {
 255                 if ($doc_type==ST_SALESORDER)
 256                         $sql = "UPDATE ".TB_PREF."sales_order_details
 257                                 SET qty_sent = qty_sent + $qty_dispatched
 258                                 WHERE id=".db_escape($line_id);
 259                 else
 260                         $sql = "UPDATE ".TB_PREF."debtor_trans_details
 261                                 SET qty_done = qty_done + $qty_dispatched
 262                                 WHERE id=".db_escape($line_id);
 263         }
 264         db_query($sql, "The parent document detail record could not be updated");
 265         return true;
 266 }
 267
 268 //--------------------------------------------------------------------------------------------------
 269 // find inventory location for given transaction
 270 //
 271 function get_location(&$cart)
 272 {
 273         $sql = "SELECT ".TB_PREF."locations.* FROM ".TB_PREF."stock_moves,"
 274                 .TB_PREF."locations".
 275                 " WHERE type=".db_escape($cart->trans_type).
 276                 " AND trans_no=".key($cart->trans_no).
 277                 " AND qty!=0 ".
 278                 " AND ".TB_PREF."locations.loc_code=".TB_PREF."stock_moves.loc_code";
 279         $result = db_query($sql, 'Retreiving inventory location');
 280
 281
 282         if (db_num_rows($result)) {
 283                 return db_fetch($result);
 284         }
 285         return null;
 286 }
 287 //--------------------------------------------------------------------------------------------------
 288 // Generic read debtor transaction into cart
 289 //
 290 //      $trans_no - array of trans nums; special case trans_no==0 - new doc
 291 //
 292 function read_sales_trans($doc_type, $trans_no, &$cart)
 293 {
 294         if (!is_array($trans_no) && $trans_no)
 295                         $trans_no = array($trans_no);
 296
 297         $cart->trans_type = $doc_type;
 298         if (!$trans_no) { // new document
 299                 $cart->trans_no = $trans_no;
 300         } else {
 301                 // read header data from first document
 302                 $myrow = get_customer_trans($trans_no[0],$doc_type);
 303                 if (count($trans_no)>1)
 304                         $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
 305                 else
 306                         $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
 307
 308                 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
 309
 310                 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
 311                         $myrow["curr_code"], $myrow["discount"]);
 312
 313                 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
 314                         $myrow["tax_group_name"],       $myrow["phone"], $myrow["email"]);
 315
 316                 $cart->reference = $myrow["reference"];
 317                 $cart->order_no = $myrow["order_"];
 318                 $cart->trans_link = $myrow["trans_link"];
 319                 $cart->due_date = sql2date($myrow["due_date"]);
 320                 $cart->document_date = sql2date($myrow["tran_date"]);
 321                 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
 322                 $cart->dimension2_id = $myrow['dimension2_id'];
 323                 $cart->Comments = '';
 324                 foreach ( $trans_no as $trans ) {
 325                         $cart->Comments .= get_comments_string($doc_type,$trans);
 326                 }
 327
 328                 // FIX this should be calculated sum() for multiply parents
 329
 330                 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
 331                 $myrow["br_address"], $myrow["ov_freight"]);
 332
 333                 $location = 0;
 334                 $myrow = get_location($cart); // find location from movement
 335
 336                 if($myrow!=null) {
 337                         $cart->set_location($myrow['loc_code'], $myrow['location_name']);
 338                 }
 339
 340                 $result = get_customer_trans_details($doc_type,$trans_no);
 341                 if (db_num_rows($result) > 0) {
 342                         for($line_no=0; $myrow = db_fetch($result); $line_no++) {
 343                                 $cart->line_items[$line_no] = new line_details(
 344                                         $myrow["stock_id"],$myrow["quantity"],
 345                                         $myrow["unit_price"], $myrow["discount_percent"],
 346                                         $myrow["qty_done"], $myrow["standard_cost"],
 347                                         $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"]);
 348                         }
 349                 }
 350         } // !newdoc
 351
 352         return true;
 353 }
 354 //----------------------------------------------------------------------------------------
 355 ?>