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