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