Changed calculating of cost update (average material price) for better sync.
[fa-stable.git] / 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
14 function update_average_material_cost($supplier, $stock_id, $price, $qty, $date, $adj_only=false)
15 {
16         if ($supplier != null)
17                 $currency = get_supplier_currency($supplier);
18         else
19                 $currency = null;
20         $dec = user_price_dec();
21         price_decimal_format($price, $dec);
22         $price = round2($price, $dec);
23         if ($currency != null)
24         {
25                 $ex_rate = get_exchange_rate_to_home_currency($currency, $date);
26                 $price_in_home_currency = $price / $ex_rate;
27         }       
28         else
29                 $price_in_home_currency = $price;
30         $sql = "SELECT material_cost FROM ".TB_PREF."stock_master WHERE stock_id=".db_escape($stock_id);
31         $result = db_query($sql);
32         $myrow = db_fetch($result);
33         $material_cost = $myrow['material_cost'];
34         if ($price > -0.0001 && $price < 0.0001)
35                 return $material_cost;
36         if ($adj_only)
37                 $exclude = ST_CUSTDELIVERY;
38         else
39                 $exclude = 0;
40         $cost_adjust = false;
41         //$qoh = get_qoh_on_date($stock_id, null, $date, $exclude);
42         $qoh = get_qoh_on_date($stock_id);
43         
44         if ($adj_only)
45         {
46                 if ($qoh > 0)
47                         $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) /     $qoh;
48         }
49         else
50         {
51                 if ($qoh < 0)
52                 {
53                         if ($qoh + $qty > 0)
54                                 $cost_adjust = true;
55                         $qoh = 0;
56                 }
57                 if ($qoh + $qty != 0)
58                         $material_cost = ($qoh * $material_cost + $qty * $price_in_home_currency) /     ($qoh + $qty);
59         }       
60         //$material_cost = round2($material_cost, $dec);
61         
62         if ($cost_adjust) // new 2010-02-10
63                 adjust_deliveries($stock_id, $material_cost, $date);
64         $sql = "UPDATE ".TB_PREF."stock_master SET material_cost=".db_escape($material_cost)."
65                 WHERE stock_id=".db_escape($stock_id);
66         db_query($sql,"The cost details for the inventory item could not be updated");
67         return $material_cost;
68 }
69
70 //-------------------------------------------------------------------------------------------------------------
71
72 function add_grn(&$po)
73 {
74         global $Refs;
75
76         $date_ = $po->orig_order_date;
77
78         begin_transaction();
79
80         $grn = add_grn_batch($po->order_no, $po->supplier_id, $po->reference, $po->Location, $date_);
81
82         foreach ($po->line_items as $line_no => $order_line)
83         {
84
85                 if ($order_line->receive_qty != 0 && $order_line->receive_qty != "" && isset($order_line->receive_qty))
86                 {
87
88                         /*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*/
89                         //------------------- update average material cost ------------------------------------------ Joe Hunt Mar-03-2008
90                         update_average_material_cost($po->supplier_id, $order_line->stock_id, $order_line->price,
91                                 $order_line->receive_qty, $date_);
92                         //----------------------------------------------------------------------------------------------------------------
93                         if ($order_line->qty_received == 0)
94                         {
95                                 /*This must be the first receipt of goods against this line */
96                                 /*Need to get the standard cost as it is now so we can process GL jorunals later*/
97                                 $order_line->standard_cost = get_standard_cost($order_line->stock_id);
98                         }
99                         // added 2008-12-08 Joe Hunt. Update the purchase data table
100                         add_or_update_purchase_data($po->supplier_id, $order_line->stock_id, $order_line->price, 
101                                 $order_line->item_description); 
102
103                         /*Need to insert a grn item */
104
105                         $grn_item = add_grn_detail_item($grn, $order_line->po_detail_rec,
106                                 $order_line->stock_id, $order_line->item_description,
107                                 $order_line->standard_cost,     $order_line->receive_qty, $order_line->price);
108
109                         $po->line_items[$line_no]->grn_item_id = $grn_item;
110                         /* Update location stock records - NB  a po cannot be entered for a service/kit parts */
111             add_stock_move(ST_SUPPRECEIVE, $order_line->stock_id, $grn, $po->Location, $date_, "",
112                 $order_line->receive_qty, $order_line->standard_cost,
113                 $po->supplier_id, 1, $order_line->price);
114
115                 } /*quantity received is != 0 */
116         } /*end of order_line loop */
117
118         $Refs->save(ST_SUPPRECEIVE, $grn, $po->reference);
119
120         add_audit_trail(ST_SUPPRECEIVE, $grn, $date_);
121
122         commit_transaction();
123
124         return $grn;
125 }
126
127 //----------------------------------------------------------------------------------------
128
129 function add_grn_batch($po_number, $supplier_id, $reference, $location, $date_)
130 {
131         $date = date2sql($date_);
132
133         $sql = "INSERT INTO ".TB_PREF."grn_batch (purch_order_no, delivery_date, supplier_id, reference, loc_code)
134                         VALUES (".db_escape($po_number).", ".db_escape($date).", "
135                         .db_escape($supplier_id).", ".db_escape($reference).", ".db_escape($location).")";
136
137         db_query($sql, "A grn batch record could not be inserted.");
138
139         return db_insert_id();
140 }
141
142 //-------------------------------------------------------------------------------------------------------------
143
144 function add_grn_detail_item($grn_batch_id, $po_detail_item, $item_code, $description, $standard_unit_cost,
145         $quantity_received, $price)
146 {
147         $sql = "UPDATE ".TB_PREF."purch_order_details
148         SET quantity_received = quantity_received + ".db_escape($quantity_received).",
149         std_cost_unit=".db_escape($standard_unit_cost).",
150         act_price=".db_escape($price)."
151         WHERE po_detail_item = ".db_escape($po_detail_item);
152
153         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
154
155         $sql = "INSERT INTO ".TB_PREF."grn_items (grn_batch_id, po_detail_item, item_code, description, qty_recd)
156                 VALUES (".db_escape($grn_batch_id).", "
157                 .db_escape($po_detail_item).", ".db_escape($item_code).", ".db_escape($description)
158                 .", ".db_escape($quantity_received).")";
159
160         db_query($sql, "A GRN detail item could not be inserted.");
161
162         return db_insert_id();
163 }
164
165 //----------------------------------------------------------------------------------------
166 function get_grn_batch_from_item($item)
167 {
168         $sql = "SELECT grn_batch_id FROM ".TB_PREF."grn_items WHERE id=".db_escape($item);
169         $result = db_query($sql, "Could not retreive GRN batch id");
170         $row = db_fetch_row($result);
171         return $row[0];
172 }
173
174 function get_grn_batch($grn)
175 {
176         $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn);
177         $result = db_query($sql, "Could not retreive GRN batch id");
178         return db_fetch($result);
179 }
180
181 function set_grn_item_credited(&$entered_grn, $supplier, $transno, $date)
182 {
183         $mcost = update_average_material_cost($supplier, $entered_grn->item_code,
184                 $entered_grn->chg_price, $entered_grn->this_quantity_inv, $date);
185
186         $sql = "SELECT ".TB_PREF."grn_batch.*, ".TB_PREF."grn_items.*
187         FROM ".TB_PREF."grn_batch, ".TB_PREF."grn_items
188         WHERE ".TB_PREF."grn_items.grn_batch_id=".TB_PREF."grn_batch.id
189                 AND ".TB_PREF."grn_items.id=".db_escape($entered_grn->id)."
190         AND ".TB_PREF."grn_items.item_code=".db_escape($entered_grn->item_code);
191         $result = db_query($sql, "Could not retreive GRNS");
192         $myrow = db_fetch($result);
193
194         $sql = "UPDATE ".TB_PREF."purch_order_details
195         SET quantity_received = quantity_received + "
196                 .db_escape($entered_grn->this_quantity_inv).",
197         quantity_ordered = quantity_ordered + "
198         .db_escape($entered_grn->this_quantity_inv).",
199         qty_invoiced = qty_invoiced + ".db_escape($entered_grn->this_quantity_inv).",
200         std_cost_unit=".db_escape($mcost).",
201         act_price=".db_escape($entered_grn->chg_price)."
202         WHERE po_detail_item = ".$myrow["po_detail_item"];
203         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
204
205         //$sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0 WHERE id=$entered_grn->id";
206         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".db_escape($entered_grn->this_quantity_inv)
207         .",quantity_inv=quantity_inv+".db_escape($entered_grn->this_quantity_inv)
208         ." WHERE id=".db_escape($entered_grn->id);
209         db_query($sql);
210
211     add_stock_move(ST_SUPPCREDIT, $entered_grn->item_code, $transno, $myrow['loc_code'], $date, "",
212         $entered_grn->this_quantity_inv, $mcost, $supplier, 1, $entered_grn->chg_price);
213 }
214
215 function get_grn_items($grn_batch_id=0, $supplier_id="", $outstanding_only=false,
216         $is_invoiced_only=false, $invoice_no=0, $begin="", $end="")
217 {
218     $sql = "SELECT ".TB_PREF."grn_batch.*, ".TB_PREF."grn_items.*, "
219         .TB_PREF."purch_order_details.unit_price,
220                 ".TB_PREF."purch_order_details.std_cost_unit, units
221         FROM ".TB_PREF."grn_batch, ".TB_PREF."grn_items, "
222         .TB_PREF."purch_order_details, ".TB_PREF."stock_master";
223     if ($invoice_no != 0)
224         $sql .= ", ".TB_PREF."supp_invoice_items";
225     $sql .= " WHERE ".TB_PREF."grn_items.grn_batch_id=".TB_PREF."grn_batch.id
226                 AND ".TB_PREF."grn_items.po_detail_item=".TB_PREF."purch_order_details.po_detail_item";
227         if ($invoice_no != 0)
228                 $sql .= " AND ".TB_PREF."supp_invoice_items.supp_trans_type=".ST_SUPPINVOICE." AND 
229                         ".TB_PREF."supp_invoice_items.supp_trans_no=$invoice_no AND
230                         ".TB_PREF."grn_items.id=".TB_PREF."supp_invoice_items.grn_item_id";
231         $sql .= " AND ".TB_PREF."stock_master.stock_id=".TB_PREF."grn_items.item_code ";
232
233         if ($begin != "")
234                 $sql .= " AND ".TB_PREF."grn_batch.delivery_date>='".date2sql($begin)."'";
235         if ($end != "")
236                 $sql .= " AND ".TB_PREF."grn_batch.delivery_date<='".date2sql($end)."'";
237         if ($grn_batch_id != 0)
238                 $sql .= " AND ".TB_PREF."grn_batch.id=".db_escape($grn_batch_id)
239                         ." AND ".TB_PREF."grn_items.grn_batch_id=".db_escape($grn_batch_id);
240
241         if ($is_invoiced_only)
242                 $sql .= " AND ".TB_PREF."grn_items.quantity_inv > 0";
243
244         if ($outstanding_only)
245         $sql .= " AND ".TB_PREF."grn_items.qty_recd - ".TB_PREF."grn_items.quantity_inv > 0";
246
247         if ($supplier_id != "")
248                 $sql .= " AND ".TB_PREF."grn_batch.supplier_id =".db_escape($supplier_id);
249
250         $sql .= " ORDER BY ".TB_PREF."grn_batch.delivery_date, ".TB_PREF."grn_batch.id, ".TB_PREF."grn_items.id";
251
252         return db_query($sql, "Could not retreive GRNS");
253 }
254
255 //----------------------------------------------------------------------------------------
256
257 // get the details for a given grn item
258
259 function get_grn_item_detail($grn_item_no)
260 {
261         $sql = "SELECT ".TB_PREF."grn_items.*, ".TB_PREF."purch_order_details.unit_price,
262         ".TB_PREF."grn_items.qty_recd - ".TB_PREF."grn_items.quantity_inv AS QtyOstdg,
263         ".TB_PREF."purch_order_details.std_cost_unit
264                 FROM ".TB_PREF."grn_items, ".TB_PREF."purch_order_details, ".TB_PREF."stock_master
265                 WHERE ".TB_PREF."grn_items.po_detail_item=".TB_PREF."purch_order_details.po_detail_item
266                         AND ".TB_PREF."stock_master.stock_id=".TB_PREF."grn_items.item_code
267                         AND ".TB_PREF."grn_items.id=".db_escape($grn_item_no);
268
269         $result = db_query($sql, "could not retreive grn item details");
270         return db_fetch($result);
271 }
272
273 //----------------------------------------------------------------------------------------
274
275 function read_grn_items_to_order($grn_batch, &$order)
276 {
277         $result = get_grn_items($grn_batch);
278
279         if (db_num_rows($result) > 0)
280         {
281
282                 while ($myrow = db_fetch($result))
283                 {
284
285                         if (is_null($myrow["units"]))
286                         {
287                                 $units = "";
288                         }
289                         else
290                         {
291                                 $units = $myrow["units"];
292                         }
293
294                         $order->add_to_order($order->lines_on_order, $myrow["item_code"],
295                                 1,$myrow["description"], $myrow["unit_price"],$units,
296                                 sql2date($myrow["delivery_date"]), $myrow["quantity_inv"],
297                                 $myrow["qty_recd"]);
298
299                         $order->line_items[$order->lines_on_order-1]->po_detail_rec = $myrow["po_detail_item"];
300                 } /* line po from purchase order details */
301         } //end of checks on returned data set
302 }
303
304 //----------------------------------------------------------------------------------------
305
306 // read a grn into an order class
307
308 function read_grn($grn_batch, &$order)
309 {
310         $sql= "SELECT * FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
311
312         $result = db_query($sql, "The grn sent is not valid");
313
314         $row = db_fetch($result);
315         $po_number = $row["purch_order_no"];
316
317         $result = read_po_header($po_number, $order);
318
319         if ($result)
320         {
321
322                 $order->orig_order_date = sql2date($row["delivery_date"]);
323                 $order->location = $row["loc_code"];
324                 $order->reference = $row["reference"];
325
326                 read_grn_items_to_order($grn_batch, $order);
327         }
328 }
329
330 //----------------------------------------------------------------------------------------------------------
331
332 // get the GRNs (batch info not details) for a given po number
333
334 function get_po_grns($po_number)
335 {
336     $sql = "SELECT * FROM ".TB_PREF."grn_batch WHERE purch_order_no=".db_escape($po_number);
337
338         return db_query($sql, "The grns for the po $po_number could not be retreived");
339 }
340
341 //----------------------------------------------------------------------------------------------------------
342
343 function exists_grn($grn_batch)
344 {
345         $sql = "SELECT id FROM ".TB_PREF."grn_batch WHERE id=".db_escape($grn_batch);
346         $result = db_query($sql, "Cannot retreive a grn");
347
348     return (db_num_rows($result) > 0);
349 }
350
351 //----------------------------------------------------------------------------------------------------------
352
353 function exists_grn_on_invoices($grn_batch)
354 {
355         $sql = "SELECT ".TB_PREF."supp_invoice_items.id FROM ".TB_PREF."supp_invoice_items,".TB_PREF."grn_items
356                 WHERE ".TB_PREF."supp_invoice_items.grn_item_id=".TB_PREF."grn_items.id
357                 AND quantity != 0
358                 AND grn_batch_id=".db_escape($grn_batch);
359         $result = db_query($sql, "Cannot query GRNs");
360
361     return (db_num_rows($result) > 0);
362 }
363
364 //----------------------------------------------------------------------------------------------------------
365
366 function void_grn($grn_batch)
367 {
368         // if this grn is references on any invoices/credit notes, then it
369         // can't be voided
370         if (exists_grn_on_invoices($grn_batch))
371                 return false;
372
373         begin_transaction();
374
375         void_bank_trans(ST_SUPPRECEIVE, $grn_batch, true);
376         void_gl_trans(ST_SUPPRECEIVE, $grn_batch, true);
377
378         // clear the quantities of the grn items in the POs and invoices
379         $result = get_grn_items($grn_batch);
380
381     if (db_num_rows($result) > 0)
382     {
383
384         while ($myrow = db_fetch($result))
385         {
386
387                 $sql = "UPDATE ".TB_PREF."purch_order_details
388                 SET quantity_received = quantity_received - " . $myrow["qty_recd"] . "
389                 WHERE po_detail_item = " . $myrow["po_detail_item"];
390
391                 db_query($sql, "a purchase order details record could not be voided.");
392         }
393     }
394
395         // clear the quantities in the grn items
396         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=0, quantity_inv=0
397                 WHERE grn_batch_id=".db_escape($grn_batch);
398
399         db_query($sql, "A grn detail item could not be voided.");
400
401     // clear the stock move items
402     void_stock_move(ST_SUPPRECEIVE, $grn_batch);
403
404         commit_transaction();
405
406         return true;
407 }
408
409 //----------------------------------------------------------------------------------------------------------
410
411 ?>