sales/includes/sales_db.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU Affero General Public License,
   5         AGPL, as published by the Free Software Foundation, either version
   6         3 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/agpl-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_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
  61 {
  62         if ($date == null)
  63             $date = Today();
  64
  65         if ($factor === null)
  66         {
  67                 $myrow = get_sales_type($sales_type_id);
  68                 $factor = $myrow['factor'];
  69         }
  70
  71         $sql = "SELECT price
  72                 FROM ".TB_PREF."prices
  73                 WHERE stock_id = '" . $stock_id . "' "
  74                 ." AND sales_type_id = " . $sales_type_id
  75                 ." AND curr_abrev = '$currency'";
  76
  77         $msg = "There was a problem retrieving the pricing information for the part $stock_id for customer";
  78         $result = db_query($sql, $msg);
  79
  80         if (db_num_rows($result) != 0)
  81         {
  82                 $myrow = db_fetch_row($result);
  83                 return $myrow[0];
  84         }
  85         if ($factor == 0) return false; // auto price calculations off
  86
  87         $base_id = get_base_sales_type();
  88         if ($base_id <= 0) return 0; // auto price calculations off
  89
  90     $home_curr = get_company_currency();
  91
  92     // get all prices which we can use to guess the price.
  93     // alternative is make up to 2 additional sql queries
  94         $sql = "SELECT price, curr_abrev, sales_type_id
  95                 FROM ".TB_PREF."prices
  96                 WHERE stock_id = '" . $stock_id . "' "
  97                 ." AND (sales_type_id = " . $sales_type_id
  98                 ." OR sales_type_id = " . $base_id.")"
  99                 ." AND (curr_abrev = '$currency'"
 100                 ." OR curr_abrev = '$home_curr')";
 101
 102         $result = db_query($sql, $msg);
 103
 104         $prices = array();
 105         while($myrow = db_fetch($result))
 106         {
 107             $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
 108         }
 109
 110         $rate = round(get_exchange_rate_from_home_currency($currency, $date),
 111             user_exrate_dec());
 112         $price = false;
 113
 114         if (isset($prices[$sales_type_id][$home_curr]))
 115         {
 116             $price = $prices[$sales_type_id][$home_curr] / $rate;
 117         }
 118         elseif (isset($prices[$base_id][$currency]))
 119         {
 120             $price = $prices[$base_id][$currency] * $factor;
 121         }
 122         elseif (isset($prices[$base_id][$home_curr]))
 123         {
 124             $price = $prices[$base_id][$home_curr] * $factor / $rate;
 125         }
 126
 127         return $price === false ? false : round($price, user_price_dec());
 128 }
 129 //----------------------------------------------------------------------------------------
 130 //
 131 //      Get price for given item or kit.
 132 //  When $std==true price is calculated as a sum of all included stock items,
 133 //      otherwise all prices set for kits and items are accepted.
 134 //
 135 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
 136         $date=null, $std = false)
 137 {
 138         $kit_price = 0.00;
 139         if (!$std) {
 140                 $kit_price = get_price( $item_code, $currency, $sales_type_id,
 141                         $factor, $date);
 142
 143                 if ($kit_price !== false) {
 144                         return $kit_price;
 145                 }
 146         }
 147         // no price for kit found, get total value of all items
 148         $kit = get_item_kit($item_code);
 149
 150         while($item = db_fetch($kit)) {
 151                 if ($item['item_code'] != $item['stock_id']) {
 152                         // foreign/kit code
 153                         $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
 154                                 $currency, $sales_type_id, $factor, $date, $std);
 155
 156                 } else {
 157                         // stock item
 158                         $kit_price += $item['quantity'] * get_price( $item['stock_id'],
 159                                 $currency, $sales_type_id, $factor, $date);
 160                 }
 161         }
 162         return $kit_price;
 163 }
 164
 165 //-----------------------------------------------------------------------------
 166
 167 function set_document_parent($cart)
 168 {
 169         $inv_no = key($cart->trans_no);
 170
 171         if (count($cart->src_docs) == 1) {
 172
 173         // if this child document has only one parent - update child link
 174         $del_no = reset(array_keys($cart->src_docs));
 175
 176         $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $del_no .
 177                 ' WHERE type='.$cart->trans_type.' AND trans_no='. $inv_no ;
 178         db_query($sql, 'Child document link cannot be updated');
 179
 180         }
 181         if ($cart->trans_type != 10)
 182                 return 0;
 183
 184         // the rest is batch invoice specific
 185
 186         foreach ($cart->line_items as $line) {
 187                 if ($line->quantity != $line->qty_dispatched) {
 188                         return 1;       // this is partial invoice
 189                 }
 190         }
 191
 192         $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $inv_no .
 193         ' WHERE type='.get_parent_type($cart->trans_type).' AND (';
 194
 195         $deliveries = array_keys($cart->src_docs);
 196
 197         foreach ($deliveries as $key=>$del)
 198                 $deliveries[$key] = 'trans_no='.$del;
 199
 200         $sql .= implode(' OR ', $deliveries) . ')';
 201         db_query($sql, 'Delivery links cannot be updated');
 202
 203         return 0; // batch or complete invoice
 204 }
 205
 206 //--------------------------------------------------------------------------------------------------
 207 function get_parent_type($type)
 208 {
 209         $parent_types = array( 11=>10, 10=>13, 13=>30 );
 210         return isset($parent_types[$type]) ?  $parent_types[$type] : 0;
 211 }
 212
 213 //--------------------------------------------------------------------------------------------------
 214 function update_parent_line($doc_type, $line_id, $qty_dispatched)
 215 {
 216         $doc_type = get_parent_type($doc_type);
 217
 218 //      echo "update line: $line_id, $doc_type, $qty_dispatched";
 219         if ($doc_type==0)
 220                 return false;
 221         else {
 222                 if ($doc_type==30)
 223                         $sql = "UPDATE ".TB_PREF."sales_order_details
 224                                 SET qty_sent = qty_sent + $qty_dispatched
 225                                 WHERE id=$line_id";
 226                 else
 227                         $sql = "UPDATE ".TB_PREF."debtor_trans_details
 228                                 SET qty_done = qty_done + $qty_dispatched
 229                                 WHERE id=$line_id";
 230         }
 231         db_query($sql, "The parent document detail record could not be updated");
 232         return true;
 233 }
 234
 235 //--------------------------------------------------------------------------------------------------
 236 // find inventory location for given transaction
 237 //
 238 function get_location(&$cart)
 239 {
 240         $sql = "SELECT ".TB_PREF."locations.* FROM ".TB_PREF."stock_moves,"
 241                 .TB_PREF."locations".
 242                 " WHERE type=".$cart->trans_type.
 243                 " AND trans_no=".key($cart->trans_no).
 244                 " AND qty!=0 ".
 245                 " AND ".TB_PREF."locations.loc_code=".TB_PREF."stock_moves.loc_code";
 246         $result = db_query($sql, 'Retreiving inventory location');
 247
 248
 249         if (db_num_rows($result)) {
 250                 return db_fetch($result);
 251         }
 252         return null;
 253 }
 254 //--------------------------------------------------------------------------------------------------
 255 // Generic read debtor transaction into cart
 256 //
 257 //      $trans_no - array of trans nums; special case trans_no==0 - new doc
 258 //
 259 function read_sales_trans($doc_type, $trans_no, &$cart)
 260 {
 261         if (!is_array($trans_no) && $trans_no)
 262                         $trans_no = array($trans_no);
 263
 264         $cart->trans_type = $doc_type;
 265         if (!$trans_no) { // new document
 266                 $cart->trans_no = $trans_no;
 267         } else {
 268                 // read header data from first document
 269                 $myrow = get_customer_trans($trans_no[0],$doc_type);
 270                 if (count($trans_no)>1)
 271                         $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
 272                 else
 273                         $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
 274
 275                 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
 276
 277                 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
 278                         $myrow["curr_code"], $myrow["discount"]);
 279
 280                 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
 281                         $myrow["tax_group_name"],       $myrow["phone"], $myrow["email"]);
 282
 283                 $cart->reference = $myrow["reference"];
 284                 $cart->order_no = $myrow["order_"];
 285                 $cart->trans_link = $myrow["trans_link"];
 286                 $cart->due_date = sql2date($myrow["due_date"]);
 287                 $cart->document_date = sql2date($myrow["tran_date"]);
 288                 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
 289                 $cart->dimension2_id = $myrow['dimension2_id'];
 290                 $cart->Comments = '';
 291                 foreach ( $trans_no as $trans ) {
 292                         $coms =  get_comments($doc_type,$trans);
 293                         while($row=db_fetch($coms)) {
 294                                 $text = $row['memo_'];
 295                                 if ($text!='') {
 296                                         if ($cart->Comments!='')
 297                                                 $cart->Comments .= "\n";
 298                                         $cart->Comments .= $text;
 299                                 }
 300                         }
 301                 }
 302
 303                 // FIX this should be calculated sum() for multiply parents
 304
 305                 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
 306                 $myrow["br_address"], $myrow["ov_freight"]);
 307
 308                 $location = 0;
 309                 $myrow = get_location($cart); // find location from movement
 310
 311                 if($myrow!=null) {
 312                         $cart->set_location($myrow['loc_code'], $myrow['location_name']);
 313                 }
 314
 315                 $result = get_customer_trans_details($doc_type,$trans_no);
 316                 if (db_num_rows($result) > 0) {
 317                         for($line_no=0; $myrow = db_fetch($result); $line_no++) {
 318                                 $cart->line_items[$line_no] = new line_details(
 319                                         $myrow["stock_id"],$myrow["quantity"],
 320                                         $myrow["unit_price"], $myrow["discount_percent"],
 321                                         $myrow["qty_done"], $myrow["standard_cost"],
 322                                         $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"]);
 323                         }
 324                 }
 325         } // !newdoc
 326
 327         return true;
 328 }
 329 //----------------------------------------------------------------------------------------
 330 ?>