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 /*
  13     Update average inventory item cost.
  14 */
  15 function update_average_material_cost($supplier, $stock_id, $price, $qty, $date, $adj_only=false)
  16 {
  17         // probably this function should be optimized
  18         // passing transaction cart as argument. This would
  19         // save a couple of db calls like get_supplier()
  20
  21         $supp = get_supplier($supplier);
  22         if ($supplier != null)
  23                 $currency = $supp['curr_code'];
  24         else
  25                 $currency = null;
  26
  27         if ($supp['tax_included'])
  28                 $price = get_tax_free_price_for_item($stock_id, $price, $supp['tax_group_id'],
  29                         $supp['tax_included']);
  30
  31         if ($currency != null)
  32         {
  33                 $ex_rate = get_exchange_rate_to_home_currency($currency, $date);
  34                 $price_in_home_currency = $price / $ex_rate;
  35         }
  36         else
  37                 $price_in_home_currency = $price;
  38
  39         $price_in_home_currency_ = $price_in_home_currency;
  40
  41         // Handle if inventory will become negative
  42     // Skip negative inventory adjustment for case of adjust_only
  43     if (is_inventory_item($stock_id) && !$adj_only)
  44         handle_negative_inventory($stock_id, $qty, $price_in_home_currency, $date);
  45
  46         $item = get_item($stock_id);
  47         $avg_cost =  $item['material_cost'];
  48
  49         $qoh = get_qoh_on_date($stock_id);
  50
  51         $cost_adjust = false;
  52
  53         if ($adj_only)
  54         {
  55                 if ($qoh > 0)
  56                         $avg_cost = ($qoh * $avg_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                         $avg_cost = ($qoh * $avg_cost + $qty * $price_in_home_currency) / ($qoh + $qty);
  68         }
  69
  70         if ($cost_adjust) // Material_cost replaced with price
  71                 adjust_deliveries($stock_id, $price_in_home_currency_, $date);
  72
  73         $sql = "UPDATE ".TB_PREF."stock_master SET material_cost=".db_escape($avg_cost)."
  74                 WHERE stock_id=".db_escape($stock_id);
  75
  76         db_query($sql,"The cost details for the inventory item could not be updated");
  77         return $avg_cost;
  78 }
  79
  80 //-------------------------------------------------------------------------------------------------------------
  81
  82 function add_grn(&$po)
  83 {
  84         global $Refs;
  85
  86         $date_ = $po->orig_order_date;
  87
  88         begin_transaction();
  89         hook_db_prewrite($po, ST_SUPPRECEIVE);
  90
  91         if (!is_company_currency($po->curr_code))
  92         {
  93                 if (!$po->ex_rate)
  94                         $po->ex_rate = get_date_exchange_rate($po->curr_code, $date_);
  95                 else
  96                         add_new_exchange_rate($po->curr_code, $date_, $po->ex_rate);
  97         } else
  98                 $po->ex_rate = 1;
  99
 100         $grn = add_grn_batch($po->order_no, $po->supplier_id, $po->reference, $po->Location, $date_, $po->ex_rate);
 101
 102     $clearing_act = get_company_pref('grn_clearing_act');
 103         if ($clearing_act) {    // otherwise GRN clearing account is not used
 104             $total = 0;
 105         }
 106         foreach ($po->line_items as $line_no => $order_line)
 107         {
 108                 if ($order_line->receive_qty != 0 && $order_line->receive_qty != "" && isset($order_line->receive_qty))
 109                 {
 110                         $stock_gl_code = get_stock_gl_code($order_line->stock_id);
 111
 112                         /*Update sales_order_details for the new quantity received and the standard cost used for postings to GL
 113                           and recorded in the stock movements for FIFO/LIFO stocks valuations*/
 114                         //------------------- update average material cost and clearing account --------------------------------
 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->taxfree_charge_value($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->unit_cost = get_unit_cost($order_line->stock_id);
 130                         }
 131                         // 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->unit_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->unit_cost, $order_line->taxfree_charge_value($po)/$order_line->receive_qty);
 146
 147                 } /*quantity received is != 0 */
 148         } /*end of order_line loop */
 149
 150         if ($clearing_act && $total != 0.0) {
 151                 $accs = get_supplier_accounts($po->supplier_id);
 152                 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $clearing_act,
 153                         $accs['dimension_id'], $accs['dimension2_id'], -$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_, $rate)
 169 {
 170         $date = date2sql($date_);
 171
 172         $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code, rate)
 173                         VALUES (".db_escape($po_number).", ".db_escape($date).", "
 174                         .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).", ".db_escape($rate).")";
 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         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 193
 194         $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
 195                 VALUES (".db_escape($grn_batch_id).", "
 196                 .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
 197                 .", ".db_escape($quantity_received).")";
 198
 199         db_query($sql, "A GRN detail item could not be inserted.");
 200
 201         return db_insert_id();
 202 }
 203
 204 //----------------------------------------------------------------------------------------
 205 function get_grn_batch_from_item($item)
 206 {
 207         $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
 208         $result = db_query($sql, "Could not retreive GRN batch id");
 209         $row = db_fetch_row($result);
 210         return $row[0];
 211 }
 212
 213 function get_grn_batch($grn)
 214 {
 215         $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
 216         $result = db_query($sql, "Could not retreive GRN batch id");
 217         return db_fetch($result);
 218 }
 219
 220 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
 221 {
 222         $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
 223                 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
 224
 225         $sql = "SELECT grn.*, item.*
 226         FROM ".TB_PREF."grn_batch grn,"
 227                 .TB_PREF."grn_items item
 228         WHERE item.grn_batch_id=grn.id
 229                 AND item.id=".db_escape($entered_grn->id)."
 230         AND item.item_code=".db_escape($entered_grn->item_code);
 231
 232         $result = db_query($sql, "Could not retreive GRNS");
 233         $myrow = db_fetch($result);
 234
 235         $sql = "UPDATE ".TB_PREF."purch_order_details
 236         SET quantity_received = quantity_received + "
 237                 .db_escape($entered_grn->this_quantity_inv).",
 238         quantity_ordered = quantity_ordered + "
 239         .db_escape($entered_grn->this_quantity_inv).",
 240         qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
 241         std_cost_unit=".db_escape($mcost).",
 242         act_price=".db_escape($entered_grn->chg_price)."
 243         WHERE po_detail_item = ".$myrow["po_detail_item"];
 244         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 245
 246         //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
 247         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
 248         .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
 249         ." WHERE id=".db_escape($entered_grn->id);
 250         db_query($sql);
 251
 252     add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
 253         $entered_grn->this_quantity_inv, $mcost, $entered_grn->chg_price);
 254 }
 255
 256 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
 257         $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
 258 {
 259     $sql = "SELECT grn.*, grn_item.*, po_item.delivery_date as req_del_date,
 260                 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')."  quantity_inv,
 261         po_item.unit_price,
 262         po_item.act_price,
 263         po_item.quantity_ordered,
 264         po_item.std_cost_unit, units
 265         FROM    ".TB_PREF."grn_batch grn, "
 266                         .TB_PREF."purch_order_details po_item, "
 267                         .TB_PREF."stock_master stock_item,"
 268                                 .TB_PREF."grn_items grn_item ";
 269
 270     if ($invoice_no != 0) {
 271         $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
 272
 273                 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
 274                 if (is_array($invoice_no))
 275                         $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
 276                 else
 277                         $inv_cond .= " = $invoice_no";
 278                 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
 279         }
 280     $sql .= " WHERE grn_item.grn_batch_id=grn.id
 281                 AND grn_item.po_detail_item=po_item.po_detail_item";
 282
 283         if ($outstanding_only)
 284         $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
 285
 286         $sql .= " AND stock_item.stock_id=grn_item.item_code ";
 287
 288         if ($begin != "")
 289                 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
 290         if ($end != "")
 291                 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
 292         if ($grn_batch_id != 0)
 293                 $sql .= " AND grn.id=".db_escape($grn_batch_id)
 294                         ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
 295
 296         if ($is_invoiced_only)
 297                 $sql .= " AND grn_item.quantity_inv > 0";
 298
 299         if ($supplier_id != "")
 300                 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
 301
 302         $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
 303
 304         return db_query($sql, "Could not retreive GRNS");
 305 }
 306
 307 //----------------------------------------------------------------------------------------
 308
 309 // get the details for a given grn item
 310
 311 function get_grn_item_detail($grn_item_no)
 312 {
 313         $sql = "SELECT grn.*, po.unit_price, grn.qty_recd - grn.quantity_inv AS QtyOstdg,
 314                 po.std_cost_unit
 315                 FROM ".TB_PREF."grn_items grn,"
 316                         .TB_PREF."purch_order_details po,"
 317                         .TB_PREF."stock_master item
 318                 WHERE grn.po_detail_item=po.po_detail_item
 319                         AND item.stock_id=grn.item_code
 320                         AND grn.id=".db_escape($grn_item_no);
 321
 322         $result = db_query($sql, "could not retreive grn item details");
 323         return db_fetch($result);
 324 }
 325
 326 //----------------------------------------------------------------------------------------
 327
 328 function read_grn_items_to_order($grn_batch, &$order)
 329 {
 330         $result = get_grn_items($grn_batch);
 331
 332         if (db_num_rows($result) > 0)
 333         {
 334
 335                 while ($myrow = db_fetch($result))
 336                 {
 337                         if ($myrow['qty_recd'] == 0 && $myrow['quantity_inv'] == 0)
 338                                 continue; // We will not have empty credited rows.
 339                         if (is_null($myrow["units"]))
 340                         {
 341                                 $units = "";
 342                         }
 343                         else
 344                         {
 345                                 $units = $myrow["units"];
 346                         }
 347
 348                         $order->add_to_order($order->lines_on_order, $myrow["item_code"],
 349                                 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
 350                                 sql2date($myrow["req_del_date"]), $myrow["quantity_inv"],
 351                                 $myrow["qty_recd"]);
 352
 353                         $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
 354                 } /* line po from purchase order details */
 355         } //end of checks on returned data set
 356 }
 357
 358 //----------------------------------------------------------------------------------------
 359
 360 // read a grn into an order class
 361
 362 function read_grn($grn_batch, &$order)
 363 {
 364         $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 365
 366         $result = db_query($sql, "The grn sent is not valid");
 367
 368         $row = db_fetch($result);
 369         $po_number = $row["purch_order_no"];
 370         $order->ex_rate = $row["rate"];
 371
 372         $result = read_po_header($po_number, $order);
 373
 374         if ($result)
 375         {
 376
 377                 $order->trans_type = ST_SUPPRECEIVE;
 378                 $order->orig_order_date = sql2date($row["delivery_date"]);
 379                 $order->Location = $row["loc_code"];
 380                 $order->reference = $row["reference"];
 381
 382                 read_grn_items_to_order($grn_batch, $order);
 383         }
 384 }
 385
 386 //----------------------------------------------------------------------------------------------------------
 387
 388 // get the GRNs (batch info not details) for a given po number
 389
 390 function get_po_grns($po_number)
 391 {
 392     $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
 393
 394         return db_query($sql, "The grns for the po $po_number could not be retreived");
 395 }
 396
 397 //----------------------------------------------------------------------------------------------------------
 398
 399 function exists_grn($grn_batch)
 400 {
 401         $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 402         $result = db_query($sql, "Cannot retreive a grn");
 403
 404     return (db_num_rows($result) > 0);
 405 }
 406
 407 //----------------------------------------------------------------------------------------------------------
 408
 409 function exists_grn_on_invoices($grn_batch)
 410 {
 411         $sql = "SELECT inv.id
 412                 FROM ".TB_PREF."supp_invoice_items inv,"
 413                         .TB_PREF."grn_items grn
 414                 WHERE inv.grn_item_id=grn.id
 415                 AND quantity != 0
 416                 AND grn_batch_id=".db_escape($grn_batch);
 417         $result = db_query($sql, "Cannot query GRNs");
 418
 419     return (db_num_rows($result) > 0);
 420 }
 421
 422 //----------------------------------------------------------------------------------------------------------
 423
 424 function void_grn($grn_batch)
 425 {
 426         // if this grn is references on any invoices/credit notes, then it
 427         // can't be voided
 428         if (exists_grn_on_invoices($grn_batch))
 429                 return false;
 430
 431         begin_transaction();
 432         hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
 433
 434         void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
 435         void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
 436
 437         // clear the quantities of the grn items in the POs and invoices
 438         $result = get_grn_items($grn_batch);
 439
 440     if (db_num_rows($result) > 0)
 441     {
 442
 443         while ($myrow = db_fetch($result))
 444         {
 445
 446                 $sql = "UPDATE ".TB_PREF."purch_order_details
 447                 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
 448                 WHERE po_detail_item = " . $myrow["po_detail_item"];
 449
 450                 db_query($sql, "a purchase order details record could not be voided.");
 451         }
 452     }
 453
 454         // clear the quantities in the grn items
 455         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
 456                 WHERE grn_batch_id=".db_escape($grn_batch);
 457
 458         db_query($sql, "A grn detail item could not be voided.");
 459
 460     // clear the stock move items
 461     void_stock_move(ST_SUPPRECEIVE, $grn_batch);
 462
 463         commit_transaction();
 464
 465         return true;
 466 }
 467
 468 //----------------------------------------------------------------------------------------------------------
 469