purchasing/includes/db/grn_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 /*
  13     Update average inventory item cost.
  14 */
  15 function update_average_material_cost($supplier, $stock_id, $price, $qty, $date, $adj_only=false)
  16 {
  17         // probably this function should be optimized
  18         // passing transaction cart as argument. This would
  19         // save a couple of db calls like get_supplier()
  20
  21         $supp = get_supplier($supplier);
  22         if ($supplier != null)
  23                 $currency = $supp['curr_code'];
  24         else
  25                 $currency = null;
  26
  27         if ($supp['tax_included'])
  28                 $price = get_tax_free_price_for_item($stock_id, $price, $supp['tax_group_id'],
  29                         $supp['tax_included']);
  30
  31         if ($currency != null)
  32         {
  33                 $ex_rate = get_exchange_rate_to_home_currency($currency, $date);
  34                 $price_in_home_currency = $price / $ex_rate;
  35         }
  36         else
  37                 $price_in_home_currency = $price;
  38
  39         $price_in_home_currency_ = $price_in_home_currency;
  40
  41         // Handle if inventory will become negative
  42     // Skip negative inventory adjustment for case of adjust_only
  43     if (is_inventory_item($stock_id) && !$adj_only)
  44         handle_negative_inventory($stock_id, $qty, $price_in_home_currency, $date);
  45
  46         $item = get_item($stock_id);
  47         $avg_cost =  $item['material_cost'];
  48
  49         $qoh = get_qoh_on_date($stock_id);
  50
  51         $cost_adjust = false;
  52
  53         if ($adj_only)
  54         {
  55                 if ($qoh > 0)
  56                         $avg_cost = ($qoh * $avg_cost + $qty * $price_in_home_currency) / $qoh;
  57         }
  58         else
  59         {
  60                 if ($qoh < 0)
  61                 {
  62                         if ($qoh + $qty >= 0)
  63                                 $cost_adjust = true;
  64                         $qoh = 0;
  65                 }
  66                 if ($qoh + $qty > 0)
  67                         $avg_cost = ($qoh * $avg_cost + $qty * $price_in_home_currency) / ($qoh + $qty);
  68         }
  69
  70         if ($cost_adjust) // Material_cost replaced with price
  71                 adjust_deliveries($stock_id, $price_in_home_currency_, $date);
  72
  73         $sql = "UPDATE ".TB_PREF."stock_master SET material_cost=".db_escape($avg_cost)."
  74                 WHERE stock_id=".db_escape($stock_id);
  75
  76         db_query($sql,"The cost details for the inventory item could not be updated");
  77         return $avg_cost;
  78 }
  79
  80 //-------------------------------------------------------------------------------------------------------------
  81 //
  82 //      Add or update GRN transaction.
  83 //
  84 function write_grn(&$po)
  85 {
  86         global $Refs;
  87
  88         $date_ = $po->orig_order_date;
  89         $grn = $po->grn_id;
  90
  91         begin_transaction();
  92         hook_db_prewrite($po, ST_SUPPRECEIVE);
  93
  94         if (!is_company_currency($po->curr_code))
  95         {
  96                 if (!$po->ex_rate)
  97                         $po->ex_rate = get_date_exchange_rate($po->curr_code, $date_);
  98                 else
  99                         add_new_exchange_rate($po->curr_code, $date_, $po->ex_rate);
 100         } else
 101                 $po->ex_rate = 1;
 102
 103         if(!$grn)
 104                 $grn = add_grn_batch($po->order_no, $po->supplier_id, $po->reference, $po->Location, $date_, $po->ex_rate);
 105         else {
 106
 107                 update_grn_batch($grn, $po->reference, $po->Location, $date_);
 108
 109                 void_gl_trans(ST_SUPPRECEIVE, $grn, true);
 110                 void_stock_move(ST_SUPPRECEIVE, $grn);
 111                 void_trans_tax_details(ST_SUPPRECEIVE, $grn);
 112                 delete_comments(ST_SUPPRECEIVE, $grn);
 113         }
 114
 115     $clearing_act = get_company_pref('grn_clearing_act');
 116     $total = 0;
 117         foreach ($po->line_items as $line_no => $order_line)
 118         {
 119                 if ($order_line->quantity != 0)
 120                 {
 121                         $stock_gl_code = get_stock_gl_code($order_line->stock_id);
 122
 123                         /*Update sales_order_details for the new quantity received and the standard cost used for postings to GL
 124                           and recorded in the stock movements for FIFO/LIFO stocks valuations*/
 125                         //------------------- update average material cost and clearing account --------------------------------
 126                         if (is_inventory_item($order_line->stock_id))
 127                         {
 128                                 if ($clearing_act)
 129                                         $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $stock_gl_code["inventory_account"],
 130                                                 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'],
 131                                             $order_line->taxfree_charge_value($po), $po->supplier_id, '', 0, $order_line->stock_id);
 132                                 update_average_material_cost($po->supplier_id, $order_line->stock_id, $order_line->price,
 133                                         $order_line->quantity, $date_);
 134                         }
 135                         //------------------------------------------------------------------------------------------------------
 136                         if ($order_line->qty_received == 0)
 137                         {
 138                                 /*This must be the first receipt of goods against this line */
 139                                 /*Need to get the standard cost as it is now so we can process GL jorunals later*/
 140                                 $order_line->unit_cost = get_unit_cost($order_line->stock_id);
 141                         }
 142                         // Update the purchase data table
 143                         add_or_update_purchase_data($po->supplier_id, $order_line->stock_id, $order_line->price,
 144                                 $order_line->item_description);
 145
 146                         /*Need to insert a grn item */ // also need to check for over-receive.(within allowance)
 147                         if ($order_line->quantity + $order_line->qty_received > $order_line->qty_ordered)
 148                                 $order_line->qty_ordered = $order_line->quantity + $order_line->qty_received;
 149
 150                         $grn_item = write_grn_item($grn, $order_line->po_detail_rec,
 151                                 $order_line->stock_id, $order_line->item_description, $order_line->quantity, $order_line->grn_item_id);
 152
 153                         $po->line_items[$line_no]->grn_item_id = $grn_item;
 154                         /* Update location stock records - NB  a po cannot be entered for a service/kit parts done automatically */
 155                         add_stock_move(ST_SUPPRECEIVE, $order_line->stock_id, $grn, $po->Location, $date_, "",
 156                                 $order_line->quantity, $order_line->unit_cost, $order_line->taxfree_charge_value($po)/$order_line->quantity);
 157
 158                 } /*quantity received is != 0 */
 159         } /*end of order_line loop */
 160
 161         if ($clearing_act && $total != 0.0) {
 162                 $accs = get_supplier_accounts($po->supplier_id);
 163                 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $clearing_act,
 164                         $accs['dimension_id'], $accs['dimension2_id'], -$total, null);
 165         }
 166         $Refs->save(ST_SUPPRECEIVE, $grn, $po->reference);
 167
 168         add_audit_trail(ST_SUPPRECEIVE, $grn, $date_);
 169
 170         $po->trans_no = $grn;
 171         hook_db_postwrite($po, ST_SUPPRECEIVE);
 172         commit_transaction();
 173
 174         return $grn;
 175 }
 176
 177 //----------------------------------------------------------------------------------------
 178
 179 function add_grn_batch($po_number, $supplier_id, $reference, $location, $date_, $rate)
 180 {
 181         $date = date2sql($date_);
 182
 183         $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code, rate)
 184                         VALUES (".db_escape($po_number).", ".db_escape($date).", "
 185                         .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).", ".db_escape($rate).")";
 186
 187         db_query($sql, "A grn batch record could not be inserted.");
 188
 189         return db_insert_id();
 190 }
 191
 192 //----------------------------------------------------------------------------------------
 193
 194 function update_grn_batch($grn, $reference, $location, $date_)
 195 {
 196         $date = date2sql($date_);
 197
 198         $sql = "UPDATE ".TB_PREF."grn_batch SET
 199                         delivery_date=".db_escape($date).",
 200                         reference=".db_escape($reference).",
 201                         loc_code=".db_escape($location)."
 202                         WHERE id=".db_escape($grn);
 203
 204         db_query($sql, "A grn batch record could not be updated.");
 205
 206         return db_insert_id();
 207 }
 208 //-------------------------------------------------------------------------------------------------------------
 209
 210 function write_grn_item($grn_batch_id, $po_detail_item, $item_code, $description, $quantity_received, $grn_item_id)
 211 {
 212         if ($grn_item_id)
 213                 $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=".db_escape($quantity_received)
 214                         ." WHERE id=".db_escape($grn_item_id);
 215         else
 216                 $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
 217                         VALUES (".db_escape($grn_batch_id).", "
 218                         .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
 219                         .", ".db_escape($quantity_received).")";
 220
 221         db_query($sql, "A GRN detail item could not be stored.");
 222
 223         $sql = "UPDATE ".TB_PREF."purch_order_details po,
 224                         (SELECT SUM(qty_recd) received FROM ".TB_PREF."grn_items grn WHERE po_detail_item=".db_escape($po_detail_item).") grn
 225         SET po.quantity_received = grn.received
 226         WHERE po_detail_item = ".db_escape($po_detail_item);
 227         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 228
 229         return db_insert_id();
 230 }
 231
 232 //----------------------------------------------------------------------------------------
 233 function get_grn_batch_from_item($item)
 234 {
 235         $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
 236         $result = db_query($sql, "Could not retreive GRN batch id");
 237         $row = db_fetch_row($result);
 238         return $row[0];
 239 }
 240
 241 function get_grn_batch($grn)
 242 {
 243         $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
 244         $result = db_query($sql, "Could not retreive GRN batch id");
 245         return db_fetch($result);
 246 }
 247
 248 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
 249 {
 250         $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
 251                 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
 252
 253         $sql = "SELECT grn.*, item.*
 254         FROM ".TB_PREF."grn_batch grn,"
 255                 .TB_PREF."grn_items item
 256         WHERE item.grn_batch_id=grn.id
 257                 AND item.id=".db_escape($entered_grn->id)."
 258         AND item.item_code=".db_escape($entered_grn->item_code);
 259
 260         $result = db_query($sql, "Could not retreive GRNS");
 261         $myrow = db_fetch($result);
 262
 263         $sql = "UPDATE ".TB_PREF."purch_order_details
 264         SET quantity_received = quantity_received + "
 265                 .db_escape($entered_grn->this_quantity_inv).",
 266         quantity_ordered = quantity_ordered + "
 267         .db_escape($entered_grn->this_quantity_inv).",
 268         qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
 269         std_cost_unit=".db_escape($mcost).",
 270         act_price=".db_escape($entered_grn->chg_price)."
 271         WHERE po_detail_item = ".$myrow["po_detail_item"];
 272         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 273
 274         //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
 275         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
 276         .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
 277         ." WHERE id=".db_escape($entered_grn->id);
 278         db_query($sql);
 279
 280     add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
 281         $entered_grn->this_quantity_inv, $mcost, $entered_grn->chg_price);
 282 }
 283
 284 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
 285         $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
 286 {
 287     $sql = "SELECT grn.*, grn_item.*, po_item.delivery_date as req_del_date,
 288                 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')."  quantity_inv,
 289         po_item.unit_price,
 290         po_item.act_price,
 291         po_item.quantity_ordered,
 292         po_item.quantity_received,
 293         po_item.std_cost_unit, units
 294         FROM    ".TB_PREF."grn_batch grn"
 295                                 ." INNER JOIN ".TB_PREF."grn_items grn_item ON grn_item.grn_batch_id=grn.id"
 296                         ." INNER JOIN ".TB_PREF."purch_order_details po_item ON grn_item.po_detail_item=po_item.po_detail_item"
 297                         ." INNER JOIN ".TB_PREF."stock_master stock_item ON stock_item.stock_id=grn_item.item_code";
 298
 299     if ($invoice_no != 0) {
 300         $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
 301
 302                 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
 303                 if (is_array($invoice_no))
 304                         $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
 305                 else
 306                         $inv_cond .= " = $invoice_no";
 307                 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
 308         }
 309
 310     $sql .= " WHERE grn_item.qty_recd != 0";
 311
 312         if ($outstanding_only)
 313         $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
 314
 315         $sql .= " AND stock_item.stock_id=grn_item.item_code ";
 316
 317         if ($begin != "")
 318                 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
 319         if ($end != "")
 320                 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
 321         if ($grn_batch_id != 0)
 322                 $sql .= " AND grn.id=".db_escape($grn_batch_id)
 323                         ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
 324
 325         if ($is_invoiced_only)
 326                 $sql .= " AND grn_item.quantity_inv > 0";
 327
 328         if ($supplier_id != "")
 329                 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
 330
 331         $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
 332
 333         return db_query($sql, "Could not retreive GRNS");
 334 }
 335
 336 //----------------------------------------------------------------------------------------
 337
 338 // get the details for a given grn item
 339
 340 function get_grn_item_detail($grn_item_no)
 341 {
 342         $sql = "SELECT grn.*, po.unit_price, grn.qty_recd - grn.quantity_inv AS QtyOstdg,
 343                 po.std_cost_unit
 344                 FROM ".TB_PREF."grn_items grn,"
 345                         .TB_PREF."purch_order_details po,"
 346                         .TB_PREF."stock_master item
 347                 WHERE grn.po_detail_item=po.po_detail_item
 348                         AND item.stock_id=grn.item_code
 349                         AND grn.id=".db_escape($grn_item_no);
 350
 351         $result = db_query($sql, "could not retreive grn item details");
 352         return db_fetch($result);
 353 }
 354
 355 //----------------------------------------------------------------------------------------
 356
 357 function read_grn_items_to_order($grn_batch, &$order)
 358 {
 359         $result = get_grn_items($grn_batch);
 360
 361         if (db_num_rows($result) > 0)
 362         {
 363
 364                 while ($myrow = db_fetch_assoc($result))
 365                 {
 366                         if ($myrow['qty_recd'] == 0 && $myrow['quantity_inv'] == 0)
 367                                 continue; // We will not have empty credited rows.
 368                         if (is_null($myrow["units"]))
 369                         {
 370                                 $units = "";
 371                         }
 372                         else
 373                         {
 374                                 $units = $myrow["units"];
 375                         }
 376
 377                         $order->add_to_order($order->lines_on_order, $myrow["item_code"],
 378                                 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
 379                                 sql2date($myrow["req_del_date"]), $myrow["quantity_inv"],
 380                                 $myrow["quantity_received"], $myrow["quantity_ordered"], $myrow["id"]);
 381
 382                         $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
 383                 } /* line po from purchase order details */
 384         } //end of checks on returned data set
 385 }
 386
 387 //----------------------------------------------------------------------------------------
 388
 389 // read a grn into an order class
 390
 391 function read_grn($grn_batch, &$order)
 392 {
 393         $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 394
 395         $result = db_query($sql, "The grn sent is not valid");
 396
 397         $row = db_fetch($result);
 398         $po_number = $row["purch_order_no"];
 399         $order->ex_rate = $row["rate"];
 400
 401         $result = read_po_header($po_number, $order);
 402
 403         if ($result)
 404         {
 405
 406                 $order->trans_type = ST_SUPPRECEIVE;
 407                 $order->orig_order_date = sql2date($row["delivery_date"]);
 408                 $order->Location = $row["loc_code"];
 409                 $order->reference = $row["reference"];
 410                 $order->grn_id = $grn_batch;
 411
 412                 read_grn_items_to_order($grn_batch, $order);
 413         }
 414 }
 415
 416 //----------------------------------------------------------------------------------------------------------
 417
 418 // get the GRNs (batch info not details) for a given po number
 419
 420 function get_po_grns($po_number)
 421 {
 422     $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
 423
 424         return db_query($sql, "The grns for the po $po_number could not be retreived");
 425 }
 426
 427 //----------------------------------------------------------------------------------------------------------
 428
 429 function exists_grn($grn_batch)
 430 {
 431         $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 432         $result = db_query($sql, "Cannot retreive a grn");
 433
 434     return (db_num_rows($result) > 0);
 435 }
 436
 437 //----------------------------------------------------------------------------------------------------------
 438
 439 function exists_grn_on_invoices($grn_batch)
 440 {
 441         $sql = "SELECT inv.id
 442                 FROM ".TB_PREF."supp_invoice_items inv,"
 443                         .TB_PREF."grn_items grn
 444                 WHERE inv.grn_item_id=grn.id
 445                 AND quantity != 0
 446                 AND grn_batch_id=".db_escape($grn_batch);
 447         $result = db_query($sql, "Cannot query GRNs");
 448
 449     return (db_num_rows($result) > 0);
 450 }
 451
 452 //----------------------------------------------------------------------------------------------------------
 453
 454 function void_grn($grn_batch)
 455 {
 456         // if this grn is references on any invoices/credit notes, then it
 457         // can't be voided
 458         if (exists_grn_on_invoices($grn_batch))
 459                 return false;
 460
 461         begin_transaction();
 462         hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
 463
 464         void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
 465         void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
 466
 467         // clear the quantities of the grn items in the POs and invoices
 468         $result = get_grn_items($grn_batch);
 469
 470     if (db_num_rows($result) > 0)
 471     {
 472
 473         while ($myrow = db_fetch($result))
 474         {
 475
 476                 $sql = "UPDATE ".TB_PREF."purch_order_details
 477                 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
 478                 WHERE po_detail_item = " . $myrow["po_detail_item"];
 479
 480                 db_query($sql, "a purchase order details record could not be voided.");
 481         }
 482     }
 483
 484         // clear the quantities in the grn items
 485         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
 486                 WHERE grn_batch_id=".db_escape($grn_batch);
 487
 488         db_query($sql, "A grn detail item could not be voided.");
 489
 490     // clear the stock move items
 491     void_stock_move(ST_SUPPRECEIVE, $grn_batch);
 492
 493         commit_transaction();
 494
 495         return true;
 496 }
 497
 498 //----------------------------------------------------------------------------------------------------------
 499