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