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