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