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