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'];
22 if ($supp['tax_included'])
23 $price = get_tax_free_price_for_item($stock_id, $price, $supp['tax_group_id'],
24 $supp['tax_included']);
28 if ($currency != null)
30 $ex_rate = get_exchange_rate_to_home_currency($currency, $date);
31 $price_in_home_currency = $price / $ex_rate;
34 $price_in_home_currency = $price;
36 $price_in_home_currency_ = $price_in_home_currency;
38 // Handle if inventory will become negative
39 // Skip negative inventory adjustment for case of adjust_only
40 if (is_inventory_item($stock_id) && !$adj_only)
41 handle_negative_inventory($stock_id, $qty, $price_in_home_currency, $date);
43 $sql = "SELECT mb_flag, material_cost FROM ".TB_PREF."stock_master WHERE stock_id=".db_escape($stock_id);
44 $result = db_query($sql);
45 $myrow = db_fetch($result);
46 $material_cost = $myrow['material_cost'];
50 $qoh = get_qoh_on_date($stock_id);
55 $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) / $qoh;
66 $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) / ($qoh + $qty);
69 if ($cost_adjust) // Material_cost replaced with price
70 adjust_deliveries($stock_id, $price_in_home_currency_, $date);
71 $sql = "UPDATE ".TB_PREF."stock_master SET material_cost=".db_escape($material_cost)."
72 WHERE stock_id=".db_escape($stock_id);
74 db_query($sql,"The cost details for the inventory item could not be updated");
75 return $material_cost;
78 //-------------------------------------------------------------------------------------------------------------
80 function add_grn(&$po)
84 $date_ = $po->orig_order_date;
87 hook_db_prewrite($po, ST_SUPPRECEIVE);
89 if (!is_company_currency($po->curr_code))
92 $po->ex_rate = get_date_exchange_rate($po->curr_code, $date_);
94 add_new_exchange_rate($po->curr_code, $date_, $po->ex_rate);
98 $grn = add_grn_batch($po->order_no, $po->supplier_id, $po->reference, $po->Location, $date_, $po->ex_rate);
100 $clearing_act = get_company_pref('grn_clearing_act');
101 if ($clearing_act) { // otherwise GRN clearing account is not used
104 foreach ($po->line_items as $line_no => $order_line)
106 if ($order_line->receive_qty != 0 && $order_line->receive_qty != "" && isset($order_line->receive_qty))
108 $stock_gl_code = get_stock_gl_code($order_line->stock_id);
110 /*Update sales_order_details for the new quantity received and the standard cost used for postings to GL
111 and recorded in the stock movements for FIFO/LIFO stocks valuations*/
112 //------------------- update average material cost and clearing account --------------------------------
113 if (is_inventory_item($order_line->stock_id))
116 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $stock_gl_code["inventory_account"],
117 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'],
118 $order_line->taxfree_charge_value($po), $po->supplier_id, '', 0, $order_line->stock_id);
119 update_average_material_cost($po->supplier_id, $order_line->stock_id, $order_line->price,
120 $order_line->receive_qty, $date_);
122 //------------------------------------------------------------------------------------------------------
123 if ($order_line->qty_received == 0)
125 /*This must be the first receipt of goods against this line */
126 /*Need to get the standard cost as it is now so we can process GL jorunals later*/
127 $order_line->standard_cost = get_unit_cost($order_line->stock_id);
129 // Update the purchase data table
130 add_or_update_purchase_data($po->supplier_id, $order_line->stock_id, $order_line->price,
131 $order_line->item_description);
133 /*Need to insert a grn item */ // also need to check for over-receive.(within allowance)
134 if ($order_line->receive_qty + $order_line->qty_received > $order_line->quantity)
135 $order_line->quantity = $order_line->receive_qty + $order_line->qty_received;
136 $grn_item = add_grn_detail_item($grn, $order_line->po_detail_rec,
137 $order_line->stock_id, $order_line->item_description,
138 $order_line->standard_cost, $order_line->receive_qty, $order_line->price, $order_line->quantity);
140 $po->line_items[$line_no]->grn_item_id = $grn_item;
141 /* Update location stock records - NB a po cannot be entered for a service/kit parts done automatically */
142 add_stock_move(ST_SUPPRECEIVE, $order_line->stock_id, $grn, $po->Location, $date_, "",
143 $order_line->receive_qty, $order_line->standard_cost, $order_line->taxfree_charge_value($po)/$order_line->receive_qty);
145 } /*quantity received is != 0 */
146 } /*end of order_line loop */
148 if ($clearing_act && $total != 0.0) {
149 $accs = get_supplier_accounts($po->supplier_id);
150 $total += add_gl_trans_supplier(ST_SUPPRECEIVE, $grn, $date_, $clearing_act,
151 $accs['dimension_id'], $accs['dimension2_id'], -$total, null);
153 $Refs->save(ST_SUPPRECEIVE, $grn, $po->reference);
155 add_audit_trail(ST_SUPPRECEIVE, $grn, $date_);
157 $po->trans_no = $grn;
158 hook_db_postwrite($po, ST_SUPPRECEIVE);
159 commit_transaction();
164 //----------------------------------------------------------------------------------------
166 function add_grn_batch($po_number, $supplier_id, $reference, $location, $date_, $rate)
168 $date = date2sql($date_);
170 $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code, rate)
171 VALUES (".db_escape($po_number).", ".db_escape($date).", "
172 .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).", ".db_escape($rate).")";
174 db_query($sql, "A grn batch record could not be inserted.");
176 return db_insert_id();
179 //-------------------------------------------------------------------------------------------------------------
181 function add_grn_detail_item($grn_batch_id, $po_detail_item, $item_code, $description, $standard_unit_cost,
182 $quantity_received, $price, $quantity)
184 $sql = "UPDATE ".TB_PREF."purch_order_details
185 SET quantity_received = quantity_received + ".db_escape($quantity_received).",
186 std_cost_unit=".db_escape($standard_unit_cost).",
187 quantity_ordered=".db_escape($quantity).",
188 act_price=".db_escape($price)."
189 WHERE po_detail_item = ".db_escape($po_detail_item);
190 db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
192 $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
193 VALUES (".db_escape($grn_batch_id).", "
194 .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
195 .", ".db_escape($quantity_received).")";
197 db_query($sql, "A GRN detail item could not be inserted.");
199 return db_insert_id();
202 //----------------------------------------------------------------------------------------
203 function get_grn_batch_from_item($item)
205 $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
206 $result = db_query($sql, "Could not retreive GRN batch id");
207 $row = db_fetch_row($result);
211 function get_grn_batch($grn)
213 $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
214 $result = db_query($sql, "Could not retreive GRN batch id");
215 return db_fetch($result);
218 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
220 $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
221 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
223 $sql = "SELECT grn.*, item.*
224 FROM ".TB_PREF."grn_batch grn,"
225 .TB_PREF."grn_items item
226 WHERE item.grn_batch_id=grn.id
227 AND item.id=".db_escape($entered_grn->id)."
228 AND item.item_code=".db_escape($entered_grn->item_code);
230 $result = db_query($sql, "Could not retreive GRNS");
231 $myrow = db_fetch($result);
233 $sql = "UPDATE ".TB_PREF."purch_order_details
234 SET quantity_received = quantity_received + "
235 .db_escape($entered_grn->this_quantity_inv).",
236 quantity_ordered = quantity_ordered + "
237 .db_escape($entered_grn->this_quantity_inv).",
238 qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
239 std_cost_unit=".db_escape($mcost).",
240 act_price=".db_escape($entered_grn->chg_price)."
241 WHERE po_detail_item = ".$myrow["po_detail_item"];
242 db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
244 //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
245 $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
246 .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
247 ." WHERE id=".db_escape($entered_grn->id);
250 add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
251 $entered_grn->this_quantity_inv, $mcost, $entered_grn->chg_price);
254 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
255 $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
257 $sql = "SELECT grn.*, grn_item.*, po_item.delivery_date as req_del_date,
258 grn_item.quantity_inv".($invoice_no ? "-invoice_item.quantity" : '')." quantity_inv,
261 po_item.quantity_ordered,
262 po_item.std_cost_unit, units
263 FROM ".TB_PREF."grn_batch grn, "
264 .TB_PREF."purch_order_details po_item, "
265 .TB_PREF."stock_master stock_item,"
266 .TB_PREF."grn_items grn_item ";
268 if ($invoice_no != 0) {
269 $sql .= " LEFT JOIN ".TB_PREF."supp_invoice_items invoice_item ON ";
271 $inv_cond = "invoice_item.supp_trans_type=".ST_SUPPINVOICE." AND invoice_item.supp_trans_no ";
272 if (is_array($invoice_no))
273 $inv_cond .= " IN (".implode(',' , $invoice_no) . ")";
275 $inv_cond .= " = $invoice_no";
276 $sql .= "($inv_cond) AND grn_item.id=invoice_item.grn_item_id";
278 $sql .= " WHERE grn_item.grn_batch_id=grn.id
279 AND grn_item.po_detail_item=po_item.po_detail_item";
281 if ($outstanding_only)
282 $sql .= " AND (".($invoice_no ? "$inv_cond OR ":'')."grn_item.qty_recd - grn_item.quantity_inv > 0)";
284 $sql .= " AND stock_item.stock_id=grn_item.item_code ";
287 $sql .= " AND grn.delivery_date>='".date2sql($begin)."'";
289 $sql .= " AND grn.delivery_date<='".date2sql($end)."'";
290 if ($grn_batch_id != 0)
291 $sql .= " AND grn.id=".db_escape($grn_batch_id)
292 ." AND grn_item.grn_batch_id=".db_escape($grn_batch_id);
294 if ($is_invoiced_only)
295 $sql .= " AND grn_item.quantity_inv > 0";
297 if ($supplier_id != "")
298 $sql .= " AND grn.supplier_id =".db_escape($supplier_id);
300 $sql .= " ORDER BY grn.delivery_date, grn.id, grn_item.id";
302 return db_query($sql, "Could not retreive GRNS");
305 //----------------------------------------------------------------------------------------
307 // get the details for a given grn item
309 function get_grn_item_detail($grn_item_no)
311 $sql = "SELECT grn.*, po.unit_price, grn.qty_recd - grn.quantity_inv AS QtyOstdg,
313 FROM ".TB_PREF."grn_items grn,"
314 .TB_PREF."purch_order_details po,"
315 .TB_PREF."stock_master item
316 WHERE grn.po_detail_item=po.po_detail_item
317 AND item.stock_id=grn.item_code
318 AND grn.id=".db_escape($grn_item_no);
320 $result = db_query($sql, "could not retreive grn item details");
321 return db_fetch($result);
324 //----------------------------------------------------------------------------------------
326 function read_grn_items_to_order($grn_batch, &$order)
328 $result = get_grn_items($grn_batch);
330 if (db_num_rows($result) > 0)
333 while ($myrow = db_fetch($result))
335 if ($myrow['qty_recd'] == 0 && $myrow['quantity_inv'] == 0)
336 continue; // We will not have empty credited rows.
337 if (is_null($myrow["units"]))
343 $units = $myrow["units"];
346 $order->add_to_order($order->lines_on_order, $myrow["item_code"],
347 $myrow["qty_recd"],$myrow["description"], $myrow["unit_price"],$units,
348 sql2date($myrow["req_del_date"]), $myrow["quantity_inv"],
351 $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
352 } /* line po from purchase order details */
353 } //end of checks on returned data set
356 //----------------------------------------------------------------------------------------
358 // read a grn into an order class
360 function read_grn($grn_batch, &$order)
362 $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
364 $result = db_query($sql, "The grn sent is not valid");
366 $row = db_fetch($result);
367 $po_number = $row["purch_order_no"];
368 $order->ex_rate = $row["rate"];
370 $result = read_po_header($po_number, $order);
375 $order->trans_type = ST_SUPPRECEIVE;
376 $order->orig_order_date = sql2date($row["delivery_date"]);
377 $order->Location = $row["loc_code"];
378 $order->reference = $row["reference"];
380 read_grn_items_to_order($grn_batch, $order);
384 //----------------------------------------------------------------------------------------------------------
386 // get the GRNs (batch info not details) for a given po number
388 function get_po_grns($po_number)
390 $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
392 return db_query($sql, "The grns for the po $po_number could not be retreived");
395 //----------------------------------------------------------------------------------------------------------
397 function exists_grn($grn_batch)
399 $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
400 $result = db_query($sql, "Cannot retreive a grn");
402 return (db_num_rows($result) > 0);
405 //----------------------------------------------------------------------------------------------------------
407 function exists_grn_on_invoices($grn_batch)
409 $sql = "SELECT inv.id
410 FROM ".TB_PREF."supp_invoice_items inv,"
411 .TB_PREF."grn_items grn
412 WHERE inv.grn_item_id=grn.id
414 AND grn_batch_id=".db_escape($grn_batch);
415 $result = db_query($sql, "Cannot query GRNs");
417 return (db_num_rows($result) > 0);
420 //----------------------------------------------------------------------------------------------------------
422 function void_grn($grn_batch)
424 // if this grn is references on any invoices/credit notes, then it
426 if (exists_grn_on_invoices($grn_batch))
430 hook_db_prevoid(ST_SUPPRECEIVE, $grn_batch);
432 void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
433 void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
435 // clear the quantities of the grn items in the POs and invoices
436 $result = get_grn_items($grn_batch);
438 if (db_num_rows($result) > 0)
441 while ($myrow = db_fetch($result))
444 $sql = "UPDATE ".TB_PREF."purch_order_details
445 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
446 WHERE po_detail_item = " . $myrow["po_detail_item"];
448 db_query($sql, "a purchase order details record could not be voided.");
452 // clear the quantities in the grn items
453 $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
454 WHERE grn_batch_id=".db_escape($grn_batch);
456 db_query($sql, "A grn detail item could not be voided.");
458 // clear the stock move items
459 void_stock_move(ST_SUPPRECEIVE, $grn_batch);
461 commit_transaction();
466 //----------------------------------------------------------------------------------------------------------