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