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