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