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