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