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     $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 */ // also need to check for over-receive.(within allowance)
 125                         if ($order_line->receive_qty + $order_line->qty_received > $order_line->quantity)
 126                                 $order_line->quantity = $order_line->receive_qty + $order_line->qty_received;
 127                         $grn_item = add_grn_detail_item($grn, $order_line->po_detail_rec,
 128                                 $order_line->stock_id, $order_line->item_description,
 129                                 $order_line->standard_cost,     $order_line->receive_qty, $order_line->price, $order_line->quantity);
 130
 131                         $po->line_items[$line_no]->grn_item_id = $grn_item;
 132                         /* Update location stock records - NB  a po cannot be entered for a service/kit parts done automatically */
 133                         add_stock_move(ST_SUPPRECEIVE, $order_line->stock_id, $grn, $po->Location, $date_, "",
 134                                 $order_line->receive_qty, $order_line->standard_cost,
 135                         $po->supplier_id, 1, $order_line->price);
 136
 137                 } /*quantity received is != 0 */
 138         } /*end of order_line loop */
 139
 140         if ($clearing_act && $total != 0.0) {
 141                 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $clearing_act,
 142                         0, 0, -$total, null);
 143         }
 144         $Refs->save(ST_SUPPRECEIVE, $grn, $po->reference);
 145
 146         add_audit_trail(ST_SUPPRECEIVE, $grn, $date_);
 147
 148         $po->trans_no = $grn;
 149         hook_db_postwrite($po, ST_SUPPRECEIVE);
 150         commit_transaction();
 151
 152         return $grn;
 153 }
 154
 155 //----------------------------------------------------------------------------------------
 156
 157 function add_grn_batch($po_number, $supplier_id, $reference, $location, $date_)
 158 {
 159         $date = date2sql($date_);
 160
 161         $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code)
 162                         VALUES (".db_escape($po_number).", ".db_escape($date).", "
 163                         .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).")";
 164
 165         db_query($sql, "A grn batch record could not be inserted.");
 166
 167         return db_insert_id();
 168 }
 169
 170 //-------------------------------------------------------------------------------------------------------------
 171
 172 function add_grn_detail_item($grn_batch_id, $po_detail_item, $item_code, $description, $standard_unit_cost,
 173         $quantity_received, $price)
 174 {
 175         $sql = "UPDATE ".TB_PREF."purch_order_details
 176         SET quantity_received = quantity_received + ".db_escape($quantity_received).",
 177         std_cost_unit=".db_escape($standard_unit_cost).",
 178         act_price=".db_escape($price)."
 179         WHERE po_detail_item = ".db_escape($po_detail_item);
 180
 181         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 182
 183         $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
 184                 VALUES (".db_escape($grn_batch_id).", "
 185                 .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
 186                 .", ".db_escape($quantity_received).")";
 187
 188         db_query($sql, "A GRN detail item could not be inserted.");
 189
 190         return db_insert_id();
 191 }
 192
 193 //----------------------------------------------------------------------------------------
 194 function get_grn_batch_from_item($item)
 195 {
 196         $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
 197         $result = db_query($sql, "Could not retreive GRN batch id");
 198         $row = db_fetch_row($result);
 199         return $row[0];
 200 }
 201
 202 function get_grn_batch($grn)
 203 {
 204         $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
 205         $result = db_query($sql, "Could not retreive GRN batch id");
 206         return db_fetch($result);
 207 }
 208
 209 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
 210 {
 211         $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
 212                 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
 213
 214         $sql = "SELECT ".TB_PREF."grn_batch.*, ".TB_PREF."grn_items.*
 215         FROM ".TB_PREF."grn_batch, ".TB_PREF."grn_items
 216         WHERE ".TB_PREF."grn_items.grn_batch_id=".TB_PREF."grn_batch.id
 217                 AND ".TB_PREF."grn_items.id=".db_escape($entered_grn->id)."
 218         AND ".TB_PREF."grn_items.item_code=".db_escape($entered_grn->item_code);
 219         $result = db_query($sql, "Could not retreive GRNS");
 220         $myrow = db_fetch($result);
 221
 222         $sql = "UPDATE ".TB_PREF."purch_order_details
 223         SET quantity_received = quantity_received + "
 224                 .db_escape($entered_grn->this_quantity_inv).",
 225         quantity_ordered = quantity_ordered + "
 226         .db_escape($entered_grn->this_quantity_inv).",
 227         qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
 228         std_cost_unit=".db_escape($mcost).",
 229         act_price=".db_escape($entered_grn->chg_price)."
 230         WHERE po_detail_item = ".$myrow["po_detail_item"];
 231         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
 232
 233         //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
 234         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
 235         .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
 236         ." WHERE id=".db_escape($entered_grn->id);
 237         db_query($sql);
 238
 239     add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
 240         $entered_grn->this_quantity_inv, $mcost, $supplier, 1, $entered_grn->chg_price);
 241 }
 242 /*
 243         Returns selected  grn items:
 244
 245         $grn_batch_id != 0  - only items for selected grn
 246         $supplier_id!=''    - only items for selected supplier
 247         $outsanding_only==true - only not fully invoiced items
 248         $is_invoiced_only==true - only those which are at least partially invoiced
 249         $invoice_no!=0 - for selected invoice(s)
 250         $begin!='' or $end!='' - within selected delivery time range
 251 */
 252 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
 253         $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
 254 {
 255     $sql = "SELECT grn.*, grn_item.*,
 256                 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')."  quantity_inv,
 257         po_item.unit_price,
 258         po_item.act_price,
 259         po_item.quantity_ordered,
 260         po_item.std_cost_unit, units
 261         FROM    ".TB_PREF."grn_batch grn, "
 262                         .TB_PREF."purch_order_details po_item, "
 263                         .TB_PREF."stock_master stock_item,"
 264                                 .TB_PREF."grn_items grn_item ";
 265
 266     if ($invoice_no != 0) {
 267         $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
 268
 269                 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
 270                 if (is_array($invoice_no))
 271                         $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
 272                 else
 273                         $inv_cond .= " = $invoice_no";
 274                 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
 275         }
 276     $sql .= " WHERE grn_item.grn_batch_id=grn.id
 277                 AND grn_item.po_detail_item=po_item.po_detail_item";
 278
 279         if ($outstanding_only)
 280         $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
 281
 282         $sql .= " AND stock_item.stock_id=grn_item.item_code ";
 283
 284         if ($begin != "")
 285                 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
 286         if ($end != "")
 287                 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
 288         if ($grn_batch_id != 0)
 289                 $sql .= " AND grn.id=".db_escape($grn_batch_id)
 290                         ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
 291
 292         if ($is_invoiced_only)
 293                 $sql .= " AND grn_item.quantity_inv > 0";
 294
 295         if ($supplier_id != "")
 296                 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
 297
 298         $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
 299
 300         return db_query($sql, "Could not retreive GRNS");
 301 }
 302
 303 //----------------------------------------------------------------------------------------
 304
 305 // get the details for a given grn item
 306
 307 function get_grn_item_detail($grn_item_no)
 308 {
 309         $sql = "SELECT ".TB_PREF."grn_items.*, ".TB_PREF."purch_order_details.unit_price,
 310         ".TB_PREF."grn_items.qty_recd - ".TB_PREF."grn_items.quantity_inv AS QtyOstdg,
 311         ".TB_PREF."purch_order_details.std_cost_unit
 312                 FROM ".TB_PREF."grn_items, ".TB_PREF."purch_order_details, ".TB_PREF."stock_master
 313                 WHERE ".TB_PREF."grn_items.po_detail_item=".TB_PREF."purch_order_details.po_detail_item
 314                         AND ".TB_PREF."stock_master.stock_id=".TB_PREF."grn_items.item_code
 315                         AND ".TB_PREF."grn_items.id=".db_escape($grn_item_no);
 316
 317         $result = db_query($sql, "could not retreive grn item details");
 318         return db_fetch($result);
 319 }
 320
 321 //----------------------------------------------------------------------------------------
 322
 323 function read_grn_items_to_order($grn_batch, &$order)
 324 {
 325         $result = get_grn_items($grn_batch);
 326
 327         if (db_num_rows($result) > 0)
 328         {
 329
 330                 while ($myrow = db_fetch($result))
 331                 {
 332
 333                         if (is_null($myrow["units"]))
 334                         {
 335                                 $units = "";
 336                         }
 337                         else
 338                         {
 339                                 $units = $myrow["units"];
 340                         }
 341
 342                         $order->add_to_order($order->lines_on_order, $myrow["item_code"],
 343                                 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
 344                                 sql2date($myrow["delivery_date"]), $myrow["quantity_inv"],
 345                                 $myrow["qty_recd"]);
 346
 347                         $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
 348                 } /* line po from purchase order details */
 349         } //end of checks on returned data set
 350 }
 351
 352 //----------------------------------------------------------------------------------------
 353
 354 // read a grn into an order class
 355
 356 function read_grn($grn_batch, &$order)
 357 {
 358         $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 359
 360         $result = db_query($sql, "The grn sent is not valid");
 361
 362         $row = db_fetch($result);
 363         $po_number = $row["purch_order_no"];
 364
 365         $result = read_po_header($po_number, $order);
 366
 367         if ($result)
 368         {
 369
 370                 $order->trans_type = ST_SUPPRECEIVE;
 371                 $order->orig_order_date = sql2date($row["delivery_date"]);
 372                 $order->location = $row["loc_code"];
 373                 $order->reference = $row["reference"];
 374
 375                 read_grn_items_to_order($grn_batch, $order);
 376         }
 377 }
 378
 379 //----------------------------------------------------------------------------------------------------------
 380
 381 // get the GRNs (batch info not details) for a given po number
 382
 383 function get_po_grns($po_number)
 384 {
 385     $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
 386
 387         return db_query($sql, "The grns for the po $po_number could not be retreived");
 388 }
 389
 390 //----------------------------------------------------------------------------------------------------------
 391
 392 function exists_grn($grn_batch)
 393 {
 394         $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
 395         $result = db_query($sql, "Cannot retreive a grn");
 396
 397     return (db_num_rows($result) > 0);
 398 }
 399
 400 //----------------------------------------------------------------------------------------------------------
 401
 402 function exists_grn_on_invoices($grn_batch)
 403 {
 404         $sql = "SELECT ".TB_PREF."supp_invoice_items.id FROM ".TB_PREF."supp_invoice_items,".TB_PREF."grn_items
 405                 WHERE ".TB_PREF."supp_invoice_items.grn_item_id=".TB_PREF."grn_items.id
 406                 AND quantity != 0
 407                 AND grn_batch_id=".db_escape($grn_batch);
 408         $result = db_query($sql, "Cannot query GRNs");
 409
 410     return (db_num_rows($result) > 0);
 411 }
 412
 413 //----------------------------------------------------------------------------------------------------------
 414
 415 function void_grn($grn_batch)
 416 {
 417         // if this grn is references on any invoices/credit notes, then it
 418         // can't be voided
 419         if (exists_grn_on_invoices($grn_batch))
 420                 return false;
 421
 422         begin_transaction();
 423         hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
 424
 425         void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
 426         void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
 427
 428         // clear the quantities of the grn items in the POs and invoices
 429         $result = get_grn_items($grn_batch);
 430
 431     if (db_num_rows($result) > 0)
 432     {
 433
 434         while ($myrow = db_fetch($result))
 435         {
 436
 437                 $sql = "UPDATE ".TB_PREF."purch_order_details
 438                 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
 439                 WHERE po_detail_item = " . $myrow["po_detail_item"];
 440
 441                 db_query($sql, "a purchase order details record could not be voided.");
 442         }
 443     }
 444
 445         // clear the quantities in the grn items
 446         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
 447                 WHERE grn_batch_id=".db_escape($grn_batch);
 448
 449         db_query($sql, "A grn detail item could not be voided.");
 450
 451     // clear the stock move items
 452     void_stock_move(ST_SUPPRECEIVE, $grn_batch);
 453
 454         commit_transaction();
 455
 456         return true;
 457 }
 458
 459 //----------------------------------------------------------------------------------------------------------
 460
 461 ?>