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