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