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