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