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
  17     if (is_inventory_item($stock_id) && !$adj_only)
  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
  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         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);
 121                                 update_average_material_cost($po->supplier_id, $order_line->stock_id, $order_line->price,
 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));
 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 grn.*, grn_item.*,
 259                 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')."  quantity_inv,
 260         po_item.unit_price,
 261         po_item.act_price,
 262         po_item.quantity_ordered,
 263         po_item.std_cost_unit, units
 264         FROM    ".TB_PREF."grn_batch grn, "
 265                         .TB_PREF."purch_order_details po_item, "
 266                         .TB_PREF."stock_master stock_item,"
 267                                 .TB_PREF."grn_items grn_item ";
 268
 269     if ($invoice_no != 0) {
 270         $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
 271
 272                 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
 273                 if (is_array($invoice_no))
 274                         $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
 275                 else
 276                         $inv_cond .= " = $invoice_no";
 277                 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
 278         }
 279     $sql .= " WHERE grn_item.grn_batch_id=grn.id
 280                 AND grn_item.po_detail_item=po_item.po_detail_item";
 281
 282         if ($outstanding_only)
 283         $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
 284
 285         $sql .= " AND stock_item.stock_id=grn_item.item_code ";
 286
 287         if ($begin != "")
 288                 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
 289         if ($end != "")
 290                 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
 291         if ($grn_batch_id != 0)
 292                 $sql .= " AND grn.id=".db_escape($grn_batch_id)
 293                         ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
 294
 295         if ($is_invoiced_only)
 296                 $sql .= " AND grn_item.quantity_inv > 0";
 297
 298         if ($supplier_id != "")
 299                 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
 300
 301         $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
 302
 303         return db_query($sql, "Could not retreive GRNS");
 304 }
 305
 306 //----------------------------------------------------------------------------------------
 307
 308 // get the details for a given grn item
 309
 310 function get_grn_item_detail($grn_item_no)
 311 {
 312         $sql = "SELECT ".TB_PREF."grn_items.*, ".TB_PREF."purch_order_details.unit_price,
 313         ".TB_PREF."grn_items.qty_recd - ".TB_PREF."grn_items.quantity_inv AS QtyOstdg,
 314         ".TB_PREF."purch_order_details.std_cost_unit
 315                 FROM ".TB_PREF."grn_items, ".TB_PREF."purch_order_details, ".TB_PREF."stock_master
 316                 WHERE ".TB_PREF."grn_items.po_detail_item=".TB_PREF."purch_order_details.po_detail_item
 317                         AND ".TB_PREF."stock_master.stock_id=".TB_PREF."grn_items.item_code
 318                         AND ".TB_PREF."grn_items.id=".db_escape($grn_item_no);
 319
 320         $result = db_query($sql, "could not retreive grn item details");
 321         return db_fetch($result);
 322 }
 323
 324 //----------------------------------------------------------------------------------------
 325
 326 function read_grn_items_to_order($grn_batch, &$order)
 327 {
 328         $result = get_grn_items($grn_batch);
 329
 330         if (db_num_rows($result) > 0)
 331         {
 332
 333                 while ($myrow = db_fetch($result))
 334                 {
 335                         if ($myrow['qty_recd'] == 0 && $myrow['quantity_inv'] == 0)
 336                                 continue; // 2011-01-18 Joe Hunt. We will not have empty credited rows.
 337                         if (is_null($myrow["units"]))
 338                         {
 339                                 $units = "";
 340                         }
 341                         else
 342                         {
 343                                 $units = $myrow["units"];
 344                         }
 345
 346                         $order->add_to_order($order->lines_on_order, $myrow["item_code"],
 347                                 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
 348                                 sql2date($myrow["delivery_date"]), $myrow["quantity_inv"],
 349                                 $myrow["qty_recd"]);
 350
 351                         $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
 352                 } /* line po from purchase order details */
 353         } //end of checks on returned data set
 354 }
 355
 356 //----------------------------------------------------------------------------------------
 357
 358 // read a grn into an order class
 359
 360 function read_grn($grn_batch, &$order)
 361 {
 362         $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 363
 364         $result = db_query($sql, "The grn sent is not valid");
 365
 366         $row = db_fetch($result);
 367         $po_number = $row["purch_order_no"];
 368
 369         $result = read_po_header($po_number, $order);
 370
 371         if ($result)
 372         {
 373
 374                 $order->trans_type = ST_SUPPRECEIVE;
 375                 $order->orig_order_date = sql2date($row["delivery_date"]);
 376                 $order->location = $row["loc_code"];
 377                 $order->reference = $row["reference"];
 378
 379                 read_grn_items_to_order($grn_batch, $order);
 380         }
 381 }
 382
 383 //----------------------------------------------------------------------------------------------------------
 384
 385 // get the GRNs (batch info not details) for a given po number
 386
 387 function get_po_grns($po_number)
 388 {
 389     $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
 390
 391         return db_query($sql, "The grns for the po $po_number could not be retreived");
 392 }
 393
 394 //----------------------------------------------------------------------------------------------------------
 395
 396 function exists_grn($grn_batch)
 397 {
 398         $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 399         $result = db_query($sql, "Cannot retreive a grn");
 400
 401     return (db_num_rows($result) > 0);
 402 }
 403
 404 //----------------------------------------------------------------------------------------------------------
 405
 406 function exists_grn_on_invoices($grn_batch)
 407 {
 408         $sql = "SELECT ".TB_PREF."supp_invoice_items.id FROM ".TB_PREF."supp_invoice_items,".TB_PREF."grn_items
 409                 WHERE ".TB_PREF."supp_invoice_items.grn_item_id=".TB_PREF."grn_items.id
 410                 AND quantity != 0
 411                 AND grn_batch_id=".db_escape($grn_batch);
 412         $result = db_query($sql, "Cannot query GRNs");
 413
 414     return (db_num_rows($result) > 0);
 415 }
 416
 417 //----------------------------------------------------------------------------------------------------------
 418
 419 function void_grn($grn_batch)
 420 {
 421         // if this grn is references on any invoices/credit notes, then it
 422         // can't be voided
 423         if (exists_grn_on_invoices($grn_batch))
 424                 return false;
 425
 426         begin_transaction();
 427         hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
 428
 429         void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
 430         void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
 431
 432         // clear the quantities of the grn items in the POs and invoices
 433         $result = get_grn_items($grn_batch);
 434
 435     if (db_num_rows($result) > 0)
 436     {
 437
 438         while ($myrow = db_fetch($result))
 439         {
 440
 441                 $sql = "UPDATE ".TB_PREF."purch_order_details
 442                 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
 443                 WHERE po_detail_item = " . $myrow["po_detail_item"];
 444
 445                 db_query($sql, "a purchase order details record could not be voided.");
 446         }
 447     }
 448
 449         // clear the quantities in the grn items
 450         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
 451                 WHERE grn_batch_id=".db_escape($grn_batch);
 452
 453         db_query($sql, "A grn detail item could not be voided.");
 454
 455     // clear the stock move items
 456     void_stock_move(ST_SUPPRECEIVE, $grn_batch);
 457
 458         commit_transaction();
 459
 460         return true;
 461 }
 462
 463 //----------------------------------------------------------------------------------------------------------
 464
 465 ?>