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