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