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