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)
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()
19 $supp = get_supplier($supplier);
20 if ($supplier != null)
21 $currency = $supp['curr_code'];
25 if ($supp['tax_included'])
26 $price = get_tax_free_price_for_item($stock_id, $price, $supp['tax_group_id'],
27 $supp['tax_included']);
29 if ($currency != null)
31 $ex_rate = get_exchange_rate_to_home_currency($currency, $date);
32 $price_in_home_currency = $price / $ex_rate;
35 $price_in_home_currency = $price;
37 $price_in_home_currency_ = $price_in_home_currency;
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);
44 $sql = "SELECT mb_flag, material_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'];
51 $qoh = get_qoh_on_date($stock_id);
56 $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) / $qoh;
67 $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) / ($qoh + $qty);
70 if ($cost_adjust) // Material_cost replaced with price
71 adjust_deliveries($stock_id, $price_in_home_currency_, $date);
72 $sql = "UPDATE ".TB_PREF."stock_master SET material_cost=".db_escape($material_cost)."
73 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;
79 //-------------------------------------------------------------------------------------------------------------
81 function add_grn(&$po)
85 $date_ = $po->orig_order_date;
88 hook_db_prewrite($po, ST_SUPPRECEIVE);
90 if (!is_company_currency($po->curr_code))
93 $po->ex_rate = get_date_exchange_rate($po->curr_code, $date_);
95 add_new_exchange_rate($po->curr_code, $date_, $po->ex_rate);
99 $grn = add_grn_batch($po->order_no, $po->supplier_id, $po->reference, $po->Location, $date_, $po->ex_rate);
101 $clearing_act = get_company_pref('grn_clearing_act');
102 if ($clearing_act) { // otherwise GRN clearing account is not used
105 foreach ($po->line_items as $line_no => $order_line)
107 if ($order_line->receive_qty != 0 && $order_line->receive_qty != "" && isset($order_line->receive_qty))
109 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
111 /*Update sales_order_details for the new quantity received and the standard cost used for postings to GL
112 and recorded in the stock movements for FIFO/LIFO stocks valuations*/
113 //------------------- update average material cost and clearing account --------------------------------
114 if (is_inventory_item($order_line->stock_id))
117 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $stock_gl_code["inventory_account"],
118 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'],
119 $order_line->taxfree_charge_value($po), $po->supplier_id, '', 0, $order_line->stock_id);
120 update_average_material_cost($po->supplier_id, $order_line->stock_id, $order_line->price,
121 $order_line->receive_qty, $date_);
123 //------------------------------------------------------------------------------------------------------
124 if ($order_line->qty_received == 0)
126 /*This must be the first receipt of goods against this line */
127 /*Need to get the standard cost as it is now so we can process GL jorunals later*/
128 $order_line->standard_cost = get_unit_cost($order_line->stock_id);
130 // Update the purchase data table
131 add_or_update_purchase_data($po->supplier_id, $order_line->stock_id, $order_line->price,
132 $order_line->item_description);
134 /*Need to insert a grn item */ // also need to check for over-receive.(within allowance)
135 if ($order_line->receive_qty + $order_line->qty_received > $order_line->quantity)
136 $order_line->quantity = $order_line->receive_qty + $order_line->qty_received;
137 $grn_item = add_grn_detail_item($grn, $order_line->po_detail_rec,
138 $order_line->stock_id, $order_line->item_description,
139 $order_line->standard_cost, $order_line->receive_qty, $order_line->price, $order_line->quantity);
141 $po->line_items[$line_no]->grn_item_id = $grn_item;
142 /* Update location stock records - NB a po cannot be entered for a service/kit parts done automatically */
143 add_stock_move(ST_SUPPRECEIVE, $order_line->stock_id, $grn, $po->Location, $date_, "",
144 $order_line->receive_qty, $order_line->standard_cost,
145 $po->supplier_id, 1, $order_line->taxfree_charge_value($po)/$order_line->receive_qty);
147 } /*quantity received is != 0 */
148 } /*end of order_line loop */
150 if ($clearing_act && $total != 0.0) {
151 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $clearing_act,
152 0, 0, -$total, null);
154 $Refs->save(ST_SUPPRECEIVE, $grn, $po->reference);
156 add_audit_trail(ST_SUPPRECEIVE, $grn, $date_);
158 $po->trans_no = $grn;
159 hook_db_postwrite($po, ST_SUPPRECEIVE);
160 commit_transaction();
165 //----------------------------------------------------------------------------------------
167 function add_grn_batch($po_number, $supplier_id, $reference, $location, $date_, $rate)
169 $date = date2sql($date_);
171 $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code, rate)
172 VALUES (".db_escape($po_number).", ".db_escape($date).", "
173 .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).", ".db_escape($rate).")";
175 db_query($sql, "A grn batch record could not be inserted.");
177 return db_insert_id();
180 //-------------------------------------------------------------------------------------------------------------
182 function add_grn_detail_item($grn_batch_id, $po_detail_item, $item_code, $description, $standard_unit_cost,
183 $quantity_received, $price, $quantity)
185 $sql = "UPDATE ".TB_PREF."purch_order_details
186 SET quantity_received = quantity_received + ".db_escape($quantity_received).",
187 std_cost_unit=".db_escape($standard_unit_cost).",
188 quantity_ordered=".db_escape($quantity).",
189 act_price=".db_escape($price)."
190 WHERE po_detail_item = ".db_escape($po_detail_item);
191 db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
193 $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
194 VALUES (".db_escape($grn_batch_id).", "
195 .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
196 .", ".db_escape($quantity_received).")";
198 db_query($sql, "A GRN detail item could not be inserted.");
200 return db_insert_id();
203 //----------------------------------------------------------------------------------------
204 function get_grn_batch_from_item($item)
206 $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
207 $result = db_query($sql, "Could not retreive GRN batch id");
208 $row = db_fetch_row($result);
212 function get_grn_batch($grn)
214 $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
215 $result = db_query($sql, "Could not retreive GRN batch id");
216 return db_fetch($result);
219 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
221 $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
222 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
224 $sql = "SELECT grn.*, item.*
225 FROM ".TB_PREF."grn_batch grn,"
226 .TB_PREF."grn_items item
227 WHERE item.grn_batch_id=grn.id
228 AND item.id=".db_escape($entered_grn->id)."
229 AND item.item_code=".db_escape($entered_grn->item_code);
231 $result = db_query($sql, "Could not retreive GRNS");
232 $myrow = db_fetch($result);
234 $sql = "UPDATE ".TB_PREF."purch_order_details
235 SET quantity_received = quantity_received + "
236 .db_escape($entered_grn->this_quantity_inv).",
237 quantity_ordered = quantity_ordered + "
238 .db_escape($entered_grn->this_quantity_inv).",
239 qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
240 std_cost_unit=".db_escape($mcost).",
241 act_price=".db_escape($entered_grn->chg_price)."
242 WHERE po_detail_item = ".$myrow["po_detail_item"];
243 db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
245 //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
246 $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
247 .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
248 ." WHERE id=".db_escape($entered_grn->id);
251 add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
252 $entered_grn->this_quantity_inv, $mcost, $entered_grn->chg_price);
255 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
256 $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
258 $sql = "SELECT grn.*, grn_item.*,
259 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')." quantity_inv,
262 po_item.quantity_ordered,
263 po_item.std_cost_unit, units
264 FROM ".TB_PREF."grn_batch grn, "
265 .TB_PREF."purch_order_details po_item, "
266 .TB_PREF."stock_master stock_item,"
267 .TB_PREF."grn_items grn_item ";
269 if ($invoice_no != 0) {
270 $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
272 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
273 if (is_array($invoice_no))
274 $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
276 $inv_cond .= " = $invoice_no";
277 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
279 $sql .= " WHERE grn_item.grn_batch_id=grn.id
280 AND grn_item.po_detail_item=po_item.po_detail_item";
282 if ($outstanding_only)
283 $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
285 $sql .= " AND stock_item.stock_id=grn_item.item_code ";
288 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
290 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
291 if ($grn_batch_id != 0)
292 $sql .= " AND grn.id=".db_escape($grn_batch_id)
293 ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
295 if ($is_invoiced_only)
296 $sql .= " AND grn_item.quantity_inv > 0";
298 if ($supplier_id != "")
299 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
301 $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
303 return db_query($sql, "Could not retreive GRNS");
306 //----------------------------------------------------------------------------------------
308 // get the details for a given grn item
310 function get_grn_item_detail($grn_item_no)
312 $sql = "SELECT grn.*, po.unit_price, grn.qty_recd - grn.quantity_inv AS QtyOstdg,
314 FROM ".TB_PREF."grn_items grn,"
315 .TB_PREF."purch_order_details po,"
316 .TB_PREF."stock_master item
317 WHERE grn.po_detail_item=po.po_detail_item
318 AND item.stock_id=grn.item_code
319 AND grn.id=".db_escape($grn_item_no);
321 $result = db_query($sql, "could not retreive grn item details");
322 return db_fetch($result);
325 //----------------------------------------------------------------------------------------
327 function read_grn_items_to_order($grn_batch, &$order)
329 $result = get_grn_items($grn_batch);
331 if (db_num_rows($result) > 0)
334 while ($myrow = db_fetch($result))
336 if ($myrow['qty_recd'] == 0 && $myrow['quantity_inv'] == 0)
337 continue; // We will not have empty credited rows.
338 if (is_null($myrow["units"]))
344 $units = $myrow["units"];
347 $order->add_to_order($order->lines_on_order, $myrow["item_code"],
348 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
349 sql2date($myrow["delivery_date"]), $myrow["quantity_inv"],
352 $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
353 } /* line po from purchase order details */
354 } //end of checks on returned data set
357 //----------------------------------------------------------------------------------------
359 // read a grn into an order class
361 function read_grn($grn_batch, &$order)
363 $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
365 $result = db_query($sql, "The grn sent is not valid");
367 $row = db_fetch($result);
368 $po_number = $row["purch_order_no"];
369 $order->ex_rate = $row["rate"];
371 $result = read_po_header($po_number, $order);
376 $order->trans_type = ST_SUPPRECEIVE;
377 $order->orig_order_date = sql2date($row["delivery_date"]);
378 $order->Location = $row["loc_code"];
379 $order->reference = $row["reference"];
381 read_grn_items_to_order($grn_batch, $order);
385 //----------------------------------------------------------------------------------------------------------
387 // get the GRNs (batch info not details) for a given po number
389 function get_po_grns($po_number)
391 $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
393 return db_query($sql, "The grns for the po $po_number could not be retreived");
396 //----------------------------------------------------------------------------------------------------------
398 function exists_grn($grn_batch)
400 $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
401 $result = db_query($sql, "Cannot retreive a grn");
403 return (db_num_rows($result) > 0);
406 //----------------------------------------------------------------------------------------------------------
408 function exists_grn_on_invoices($grn_batch)
410 $sql = "SELECT inv.id
411 FROM ".TB_PREF."supp_invoice_items inv,"
412 .TB_PREF."grn_items grn
413 WHERE inv.grn_item_id=grn.id
415 AND grn_batch_id=".db_escape($grn_batch);
416 $result = db_query($sql, "Cannot query GRNs");
418 return (db_num_rows($result) > 0);
421 //----------------------------------------------------------------------------------------------------------
423 function void_grn($grn_batch)
425 // if this grn is references on any invoices/credit notes, then it
427 if (exists_grn_on_invoices($grn_batch))
431 hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
433 void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
434 void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
436 // clear the quantities of the grn items in the POs and invoices
437 $result = get_grn_items($grn_batch);
439 if (db_num_rows($result) > 0)
442 while ($myrow = db_fetch($result))
445 $sql = "UPDATE ".TB_PREF."purch_order_details
446 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
447 WHERE po_detail_item = " . $myrow["po_detail_item"];
449 db_query($sql, "a purchase order details record could not be voided.");
453 // clear the quantities in the grn items
454 $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
455 WHERE grn_batch_id=".db_escape($grn_batch);
457 db_query($sql, "A grn detail item could not be voided.");
459 // clear the stock move items
460 void_stock_move(ST_SUPPRECEIVE, $grn_batch);
462 commit_transaction();
467 //----------------------------------------------------------------------------------------------------------