includes/db/inventory_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 function get_qoh_on_date($stock_id, $location=null, $date_=null)
  13 {
  14     if ($date_ == null)
  15         $date_ = Today();
  16
  17      $date = date2sql($date_);
  18      $sql = "SELECT SUM(qty)
  19         FROM ".TB_PREF."stock_moves st
  20                 LEFT JOIN ".TB_PREF."voided v ON st.type=v.type AND st.trans_no=v.id
  21           WHERE ISNULL(v.id)
  22           AND stock_id=".db_escape($stock_id)."
  23           AND tran_date <= '$date'";
  24
  25     if ($location != null)
  26         $sql .= " AND loc_code = ".db_escape($location);
  27
  28     $result = db_query($sql, "QOH calculation failed");
  29
  30     $myrow = db_fetch_row($result);
  31
  32     $qoh =  $myrow[0];
  33                 return $qoh ? $qoh : 0;
  34 }
  35
  36 /**
  37 *       Check whether change in stock on date would not cause negative qoh in stock history.
  38 *       Returns null on success or max. available quantity with respective date otherwise.
  39 *   Running balance is checked on daily basis only, as we do not control time of transaction.
  40 *
  41 *       $delta_qty - tested change in stock qty at $date.
  42 *       $date - check date; when set to null checks all the stock history.
  43 **/
  44
  45 function check_negative_stock($stock_id, $delta_qty, $location=null, $date=null)
  46 {
  47
  48         if ($delta_qty >= 0)
  49                  return null;   // qty increese is always safe
  50
  51         if (!isset($date))
  52                 $date = Today();
  53
  54         $date = date2sql($date);
  55
  56         // check stock status on date
  57     $sql = "SELECT SUM(qty) qty, '$date' tran_date FROM ".TB_PREF."stock_moves
  58             WHERE stock_id=".db_escape($stock_id)."
  59             AND tran_date <= '$date'";
  60
  61     if ($location)
  62         $sql .= " AND loc_code = ".db_escape($location);
  63
  64     $result = db_query($sql, "QOH calculation failed");
  65     $qos = db_fetch_assoc($result);
  66
  67         // check also all stock changes after the date to avoid negative stock in future
  68         $sql = TB_PREF."stock_moves WHERE stock_id=".db_escape($stock_id) . " AND tran_date > '$date'";
  69
  70         if ($location)
  71                 $sql .= " AND loc_code=".db_escape($location);
  72
  73         $rt = running_total_sql($sql, 'qty', 'tran_date');
  74
  75         $sql = "SELECT  {$qos['qty']}+total qty, tran_date FROM ($rt) stock_status ORDER by total, tran_date";
  76         $history = db_query($sql, 'cannot check stock history');
  77         $min_qos = db_fetch($history);
  78
  79         if ($min_qos && ($min_qos['qty'] < $qos['qty']))
  80                 $qos = $min_qos;
  81
  82         return  -$delta_qty > $qos['qty'] ? $qos : null;
  83 }
  84
  85 //--------------------------------------------------------------------------------------
  86
  87 function get_item_edit_info($stock_id)
  88 {
  89         $sql = "SELECT item.material_cost, item.units, unit.decimals
  90                 FROM ".TB_PREF."stock_master item,"
  91                         .TB_PREF."item_units unit
  92                 WHERE stock_id=".db_escape($stock_id)
  93                 ." AND item.units=unit.abbr";
  94         $result = db_query($sql, "The standard cost cannot be retrieved");
  95
  96         return db_fetch($result);
  97 }
  98
  99 //--------------------------------------------------------------------------------------
 100
 101 function get_unit_cost($stock_id)
 102 {
 103         $sql = "SELECT material_cost
 104                 FROM ".TB_PREF."stock_master
 105                 WHERE stock_id=".db_escape($stock_id);
 106         $result = db_query($sql, "The standard cost cannot be retrieved");
 107
 108         $myrow = db_fetch_row($result);
 109
 110         return $myrow[0];
 111 }
 112
 113 //--------------------------------------------------------------------------------------
 114
 115 function get_purchase_cost($stock_id)
 116 {
 117         $sql = "SELECT purchase_cost
 118                 FROM ".TB_PREF."stock_master
 119                 WHERE stock_id=".db_escape($stock_id);
 120         $result = db_query($sql, "The purchase cost cannot be retrieved");
 121
 122         $myrow = db_fetch_row($result);
 123
 124         return $myrow[0];
 125 }
 126
 127 //--------------------------------------------------------------------------------------
 128
 129 function is_inventory_item($stock_id)
 130 {
 131         $sql = "SELECT stock_id FROM "
 132                 .TB_PREF."stock_master
 133                 WHERE stock_id=".db_escape($stock_id)." AND mb_flag <> 'D'";
 134         $result = db_query($sql, "Cannot query is inventory item or not");
 135
 136         return db_num_rows($result) > 0;
 137 }
 138
 139 //-------------------------------------------------------------------
 140
 141 function last_negative_stock_begin_date($stock_id, $to)
 142 {
 143         $to = date2sql($to);
 144         $sql ="SET @q = 0";
 145         db_query($sql);
 146         $sql = "SET @flag = 0";
 147         db_query($sql);
 148         $sql = "SELECT SUM(qty), @q:= @q + qty, IF(@q < 0 AND @flag=0, @flag:=1,@flag:=0), IF(@q < 0 AND @flag=1, tran_date,'') AS begin_date
 149                 FROM ".TB_PREF."stock_moves
 150                 WHERE stock_id=".db_escape($stock_id)." AND tran_date<='$to'
 151                 AND qty <> 0
 152                 GROUP BY stock_id ORDER BY tran_date";
 153
 154         $result = db_query($sql, "The dstock moves could not be retrieved");
 155         $row = db_fetch_row($result);
 156         return $row[3];
 157 }
 158
 159 //-------------------------------------------------------------------
 160
 161 function get_already_delivered($stock_id, $location, $trans_no)
 162 {
 163         $sql = "SELECT qty
 164                 FROM ".TB_PREF."stock_moves
 165                 WHERE stock_id = ".db_escape($stock_id)."
 166                 AND loc_code = ".db_escape($location)."
 167                 AND type=".ST_CUSTDELIVERY." AND trans_no=".db_escape($trans_no);
 168         $result = db_query($sql, "Could not get stock moves");
 169         $row = db_fetch_row($result);
 170         return $row[0];
 171 }
 172 /*
 173         Returns start move_id in latest negative status period for $stock_id
 174         FIXME: $to ?
 175 */
 176 function last_negative_stock_trans_id($stock_id, $to)
 177 {
 178         $sql = "SELECT * from ".TB_PREF."stock_moves
 179                 WHERE stock_id=".db_escape($stock_id)."
 180                 AND qty <> 0 order by trans_id asc";
 181
 182         $result = db_query($sql, "The query on stock moves failed.");
 183
 184         $qty = 0;
 185         $flag = 0;
 186         $negative_trans_id = -1;
 187
 188         while ($myrow = db_fetch($result))
 189         {
 190                 $qty += $myrow['qty'];
 191                 if ($qty < 0 && $flag == 0)
 192                 {
 193                         $flag = 1;
 194                         $negative_trans_id = $myrow['trans_id'];
 195                 }
 196                 if ($qty >= 0)
 197                         $flag = 0;
 198         }
 199
 200         if ($flag == 1)
 201                 return $negative_trans_id;
 202         else
 203                 return false;
 204 }
 205
 206 //-------------------------------------------------------------------
 207
 208 function get_deliveries_between($stock_id, $from, $to)
 209 {
 210         $from = date2sql($from);
 211         $to = date2sql($to);
 212         $sql = "SELECT SUM(-qty), SUM(-qty*standard_cost) FROM ".TB_PREF."stock_moves
 213                 WHERE type=".ST_CUSTDELIVERY." AND stock_id=".db_escape($stock_id)." AND
 214                         tran_date>='$from' AND tran_date<='$to' GROUP BY stock_id";
 215
 216         $result = db_query($sql, "The deliveries could not be updated");
 217         return db_fetch_row($result);
 218 }
 219
 220 /*
 221         Returns quantity and total cost of $stock_id sales, entered after record with $move_id
 222 */
 223 function get_deliveries_from_trans($stock_id, $move_id)
 224 {
 225         // -ve qty is delivery either by ST_CUSTDELIVERY or inventory adjustment
 226     //Price for GRN and SUPPCREDIT and std_cost for other trans_types
 227     $sql = "SELECT SUM(-qty), SUM(-qty*IF(type=".ST_SUPPRECEIVE." OR type=".ST_SUPPCREDIT.", price, standard_cost))
 228         FROM ".TB_PREF."stock_moves
 229         WHERE stock_id=".db_escape($stock_id)." AND qty < 0 AND
 230             trans_id>='$move_id' GROUP BY stock_id";
 231         $result = db_query($sql, "The deliveries could not be updated");
 232         $row = db_fetch_row($result);
 233
 234     $sql = "SELECT IF(type=".ST_SUPPRECEIVE." OR type=".ST_SUPPCREDIT.", price, standard_cost)
 235         FROM ".TB_PREF."stock_moves
 236         WHERE stock_id=".db_escape($stock_id)
 237             ." AND trans_id ='$move_id'";
 238     $result = db_query($sql, "The deliveries could not be updated");
 239     $cost = db_fetch_row($result);
 240
 241         // Adjusting QOH valuation
 242         $sql = "SELECT SUM(qty)
 243                 FROM ".TB_PREF."stock_moves
 244                 WHERE stock_id=".db_escape($stock_id)." AND
 245                         trans_id<'$move_id' GROUP BY stock_id";
 246         $result = db_query($sql, "The deliveries could not be updated");
 247         $qoh = db_fetch_row($result);
 248
 249         $qty = $row[0] - $qoh[0]; //QOH prior to -ve stock is subtracted
 250         $final_cost = $row[1] - $qoh[0]*$cost[0];
 251
 252         return array($qty,$final_cost);
 253 }
 254
 255 /*
 256         Returns quantity and total cost of $stock_id purchases, entered after record with $move_id
 257 */
 258 function get_purchases_from_trans($stock_id, $move_id)
 259 {
 260         // Calculate All inward stock moves i.e. qty > 0
 261         $sql = "SELECT SUM(qty), SUM(qty*standard_cost)
 262                 FROM ".TB_PREF."stock_moves
 263                 WHERE stock_id=".db_escape($stock_id)." AND qty > 0 AND
 264                         trans_id>'$move_id' GROUP BY stock_id";
 265         $result = db_query($sql, "Could not get get_purchases_from_trans");
 266         $row = db_fetch_row($result);
 267
 268         return $row;
 269 }
 270
 271 //-------------------------------------------------------------------
 272 /*
 273         This routine fixes stock and COGS balances for all $stock_id sales made during negative inventory status.
 274         This is called when delivery is received causing inventory status to be positive again.
 275 */
 276 function adjust_deliveries($stock_id, $material_cost, $to)
 277 {
 278         global $Refs;
 279
 280         if (!is_inventory_item($stock_id))
 281                 return;
 282
 283         $move_id = last_negative_stock_trans_id($stock_id, $to);
 284         if ($move_id == false || $move_id == -1)
 285                 return;
 286
 287         $row = get_deliveries_from_trans($stock_id, $move_id);
 288
 289         if ($row == false)
 290                 return;
 291         $old_sales_cost = $row[1];
 292         $new_sales_cost = $row[0] * $material_cost;
 293         $sales_diff = $new_sales_cost - $old_sales_cost;
 294
 295         $row = get_purchases_from_trans($stock_id, $move_id);
 296         $purchase_diff = 0;
 297         $old_purchase_cost = $new_purchase_cost = 0;
 298         if ($row != false)
 299         {
 300                 $old_purchase_cost = $row[1];
 301                 $new_purchase_cost = $row[0] * $material_cost;
 302                 $purchase_diff = $new_purchase_cost - $old_purchase_cost;
 303         }
 304
 305         $diff =  $sales_diff - $purchase_diff;
 306
 307         if ($diff != 0)
 308         {
 309                 $stock_gl_code = get_stock_gl_code($stock_id);
 310
 311                 $dec = user_price_dec();
 312                 $old_cost = -round2($old_sales_cost-$old_purchase_cost,$dec);
 313                 $new_cost = -round2($new_sales_cost-$new_purchase_cost,$dec);
 314
 315                 $cart = new items_cart(ST_COSTUPDATE);
 316                 $cart->tran_date = $cart->doc_date = $cart->event_date = $to;
 317                 if (!is_date_in_fiscalyear($cart->tran_date))
 318                         $cart->tran_date = end_fiscalyear();
 319                 $cart->reference = $Refs->get_next(ST_COSTUPDATE, null, $cart->tran_date, $to);
 320
 321                 $cart->memo_ = _("Cost was ") . $old_cost. _(" changed to ") . $new_cost . _(" for item ")."'$stock_id'";
 322
 323                 $cart->add_gl_item($stock_gl_code["cogs_account"], $stock_gl_code["dimension_id"], $stock_gl_code["dimension2_id"], $diff);
 324                 $cart->add_gl_item($stock_gl_code["inventory_account"], 0, 0, -$diff);
 325
 326                 write_journal_entries($cart);
 327         }
 328 }
 329
 330 function get_stock_gl_code($stock_id)
 331 {
 332         /*Gets the GL Codes relevant to the item account  */
 333         $sql = "SELECT mb_flag, inventory_account, cogs_account,
 334                 adjustment_account, sales_account, wip_account, dimension_id, dimension2_id FROM
 335                 ".TB_PREF."stock_master WHERE stock_id = ".db_escape($stock_id);
 336
 337         $get = db_query($sql,"retreive stock gl code");
 338         return db_fetch($get);
 339 }
 340
 341 function get_purchase_value($stock_id)
 342 {
 343         $sql = "SELECT purchase_cost FROM
 344                 ".TB_PREF."stock_master WHERE stock_id = ".db_escape($stock_id);
 345
 346         $result = db_query($sql,"retreive stock purchase price");
 347         $row = db_fetch_row($result);
 348         return $row[0];
 349 }
 350
 351 function update_purchase_value($stock_id, $price)
 352 {
 353         $price = round2($price, user_price_dec());
 354         $sql = "UPDATE ".TB_PREF."stock_master SET purchase_cost=".db_escape($price)
 355                         ." WHERE stock_id=".db_escape($stock_id);
 356         db_query($sql, "The stock master purchase_cost cannot be updated");
 357 }
 358 //-----------------------------------------------------------------------------------------
 359
 360 function handle_negative_inventory($stock_id, $quantity, $standard_cost, $date_)
 361 {
 362         //If negative adjustment result in negative or zero inventory
 363         //then difference should be adjusted
 364         $qoh = get_qoh_on_date($stock_id);
 365
 366         if ($qoh + $quantity <= 0 && $qoh > 0) //Positive inventory turning zero/negative
 367         {
 368                 global $Refs;
 369
 370                 $id = get_next_trans_no(ST_JOURNAL);
 371                 $ref = $Refs->get_next(ST_JOURNAL, null, $date_);
 372                 $diff = round($qoh*get_unit_cost($stock_id) + $quantity*$standard_cost, user_price_dec());
 373
 374                 if ($diff != 0)
 375                 {
 376                         begin_transaction();
 377                         add_journal(ST_JOURNAL, $id, $diff, $date_, get_company_currency(), $ref);
 378                         $Refs->save(ST_JOURNAL, $id, $ref);
 379
 380                         $stock_gl_code = get_stock_gl_code($stock_id);
 381                         $memo = _("Zero/negative inventory handling");
 382                         //Reverse the inventory effect if $qoh <=0
 383                         add_gl_trans_std_cost(ST_JOURNAL, $id, $date_,
 384                                 $stock_gl_code["inventory_account"],
 385                                 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'], $memo,
 386                                 -$diff);
 387                         //GL Posting to inventory adjustment account
 388                         add_gl_trans_std_cost(ST_JOURNAL, $id, $date_,
 389                                 $stock_gl_code["adjustment_account"],
 390                                 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'], $memo,
 391                                 $diff);
 392
 393                         add_audit_trail(ST_JOURNAL, $id, $date_);
 394                         add_comments(ST_JOURNAL, $id, $date_, $memo);
 395                         $Refs->save(ST_JOURNAL, $id, $ref);
 396                         commit_transaction();
 397                 }
 398         }
 399 }
 400
 401 //--------------------------------------------------------------------------------------
 402
 403 // $date_ - display / non-sql date
 404 // $std_cost - in HOME currency
 405 // $price - in transaction currency
 406
 407 function add_stock_move($type, $stock_id, $trans_no, $location,
 408     $date_, $reference, $quantity, $std_cost, $price=0)
 409 {
 410         $date = date2sql($date_);
 411
 412         $sql = "INSERT INTO ".TB_PREF."stock_moves (stock_id, trans_no, type, loc_code,
 413                 tran_date, reference, qty, standard_cost, price) VALUES ("
 414                 .db_escape($stock_id).", ".db_escape($trans_no).", "
 415                 .db_escape($type).", ".db_escape($location).", '$date', "
 416                 .db_escape($reference).", "
 417                 .db_escape($quantity).", ".db_escape($std_cost)."," .db_escape($price).")";
 418
 419         db_query($sql, "The stock movement record cannot be inserted");
 420
 421         return db_insert_id();
 422 }
 423
 424 function update_stock_move($type, $trans_no, $stock_id, $cost)
 425 {
 426         $sql = "UPDATE ".TB_PREF."stock_moves SET standard_cost=".db_escape($cost)
 427                         ." WHERE type=".db_escape($type)
 428                         ."      AND trans_no=".db_escape($trans_no)
 429                         ."      AND stock_id=".db_escape($stock_id);
 430         db_query($sql, "The stock movement standard_cost cannot be updated");
 431 }
 432
 433 //--------------------------------------------------------------------------------------------------
 434
 435 function get_stock_moves($type, $type_no)
 436 {
 437         $sql = "SELECT move.*, item.description, item.mb_flag, item.units, stock.location_name
 438                 FROM ".TB_PREF."stock_moves move,"
 439                         .TB_PREF."locations stock,"
 440                         .TB_PREF."stock_master item
 441                 WHERE move.stock_id = item.stock_id
 442                 AND stock.loc_code=move.loc_code
 443                 AND type=".db_escape($type)
 444                 ." AND trans_no=".db_escape($type_no)
 445                 ." ORDER BY trans_id";
 446
 447         return db_query($sql, "Could not get stock moves");
 448 }
 449
 450 //--------------------------------------------------------------------------------------------------
 451
 452 function void_stock_move($type, $type_no)
 453 {
 454     $sql = "SELECT move.*, supplier.supplier_id
 455                 FROM ".TB_PREF."stock_moves move
 456                                 LEFT JOIN ".TB_PREF."supp_trans credit ON credit.trans_no=move.trans_no AND credit.type=move.type
 457                                 LEFT JOIN ".TB_PREF."grn_batch grn ON grn.id=move.trans_no AND 25=move.type
 458                                 LEFT JOIN ".TB_PREF."suppliers supplier ON IFNULL(grn.supplier_id, credit.supplier_id)=supplier.supplier_id
 459                         WHERE move.type=".db_escape($type)." AND move.trans_no=".db_escape($type_no);
 460
 461     $result = db_query($sql, "Could not void stock moves");
 462     while ($row = db_fetch($result))
 463     {
 464                 //Skip cost averaging of service items
 465                 if (is_inventory_item($row["stock_id"]))
 466                 {
 467                         // The cost has to be adjusted.
 468                         // Transaction rates are stored either as price or standard_cost depending on types
 469                         $types = array(ST_SUPPCREDIT, ST_SUPPRECEIVE);
 470                         if (in_array($type, $types))
 471                                 $unit_cost = $row["price"];
 472                         else
 473                                 $unit_cost = $row["standard_cost"];
 474
 475                         update_average_material_cost($row["supplier_id"], $row["stock_id"],
 476                                 $unit_cost, -$row["qty"], sql2date($row["tran_date"]));
 477                 }
 478     }
 479         $sql = "DELETE FROM ".TB_PREF."stock_moves
 480                         WHERE type=".db_escape($type)
 481                         ."      AND trans_no=".db_escape($type_no);
 482         db_query($sql, "The stock movement cannot be delated");
 483 }
 484
 485 //--------------------------------------------------------------------------------------------------
 486
 487 function get_location_name($loc_code)
 488 {
 489         $sql = "SELECT location_name FROM ".TB_PREF."locations
 490                 WHERE loc_code=".db_escape($loc_code);
 491
 492         $result = db_query($sql, "could not retreive the location name for $loc_code");
 493
 494         if (db_num_rows($result) == 1)
 495         {
 496                 $row = db_fetch_row($result);
 497                 return $row[0];
 498         }
 499
 500         display_db_error("could not retreive the location name for $loc_code", $sql, true);
 501 }
 502
 503 function get_mb_flag($stock_id)
 504 {
 505         $sql = "SELECT mb_flag FROM ".TB_PREF."stock_master
 506                 WHERE stock_id = ".db_escape($stock_id);
 507         $result = db_query($sql, "retreive mb_flag from item");
 508
 509         if (db_num_rows($result) == 0)
 510                 return -1;
 511
 512         $myrow = db_fetch_row($result);
 513         return $myrow[0];
 514 }
 515