[0000137] Material Cost Averaging Problem (again) when voiding.
[fa-stable.git] / purchasing / includes / db / invoice_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 include_once($path_to_root . "/purchasing/includes/db/invoice_items_db.inc");
13
14 //--------------------------------------------------------------------------------------------------
15
16 function read_supplier_details_to_trans(&$supp_trans, $supplier_id)
17 {
18         $sql = "SELECT ".TB_PREF."suppliers.supp_name, ".TB_PREF."payment_terms.terms, ".TB_PREF."payment_terms.days_before_due,
19                 ".TB_PREF."payment_terms.day_in_following_month,
20                 ".TB_PREF."suppliers.tax_group_id, ".TB_PREF."tax_groups.name As tax_group_name
21                 From ".TB_PREF."suppliers, ".TB_PREF."payment_terms, ".TB_PREF."tax_groups
22                 WHERE ".TB_PREF."suppliers.tax_group_id = ".TB_PREF."tax_groups.id
23                 AND ".TB_PREF."suppliers.payment_terms=".TB_PREF."payment_terms.terms_indicator
24                 AND ".TB_PREF."suppliers.supplier_id = '" . $supplier_id . "'";
25
26         $result = db_query($sql, "The supplier record selected: " . $supplier_id . " cannot be retrieved");
27
28         $myrow = db_fetch($result);
29
30     $supp_trans->supplier_id = $supplier_id;
31     $supp_trans->supplier_name = $myrow['supp_name'];
32         $supp_trans->terms_description = $myrow['terms'];
33
34         if ($myrow['days_before_due'] == 0)
35         {
36                 $supp_trans->terms = "1" . $myrow['day_in_following_month'];
37         }
38         else
39         {
40                 $supp_trans->terms = "0" . $myrow['days_before_due'];
41         }
42         $supp_trans->tax_description = $myrow['tax_group_name'];
43         $supp_trans->tax_group_id = $myrow['tax_group_id'];
44
45     if ($supp_trans->tran_date == "")
46     {
47                 $supp_trans->tran_date = Today();
48                 if (!is_date_in_fiscalyear($supp_trans->tran_date))
49                         $supp_trans->tran_date = end_fiscalyear();
50         }
51     //if ($supp_trans->due_date=="") {
52     //  get_duedate_from_terms($supp_trans);
53     //}
54     get_duedate_from_terms($supp_trans);
55 }
56
57 //--------------------------------------------------------------------------------------------------
58
59 function update_supp_received_items_for_invoice($id, $po_detail_item, $qty_invoiced, $chg_price=null)
60 {
61         if ($chg_price != null)
62         {
63                 $sql = "SELECT act_price, unit_price FROM ".TB_PREF."purch_order_details WHERE
64                         po_detail_item = $po_detail_item";
65                 $result = db_query($sql, "The old actual price of the purchase order line could not be retrieved");
66                 $row = db_fetch_row($result);
67                 $ret = $row[0];
68
69                 $unit_price = $row[1]; //Added by Rasmus
70
71                 $sql = "SELECT delivery_date FROM ".TB_PREF."grn_batch,".TB_PREF."grn_items WHERE
72                         ".TB_PREF."grn_batch.id = ".TB_PREF."grn_items.grn_batch_id AND ".TB_PREF."grn_items.id=$id";
73                 $result = db_query($sql, "The old delivery date from the received record cout not be retrieved");
74                 $row = db_fetch_row($result);
75                 $date = $row[0];
76         }
77         else
78         {
79                 $ret = 0;
80                 $date = "";
81                 $unit_price = 0; // Added by Rasmus
82         }
83     $sql = "UPDATE ".TB_PREF."purch_order_details
84                 SET qty_invoiced = qty_invoiced + $qty_invoiced ";
85
86         if ($chg_price != null)
87                 $sql .= " , act_price = $chg_price ";
88
89         $sql .= " WHERE po_detail_item = $po_detail_item";
90     db_query($sql, "The quantity invoiced of the purchase order line could not be updated");
91
92     $sql = "UPDATE ".TB_PREF."grn_items
93         SET quantity_inv = quantity_inv + $qty_invoiced
94         WHERE id = $id";
95         db_query($sql, "The quantity invoiced off the items received record could not be updated");
96         return array($ret, $date, $unit_price);
97 }
98
99 function get_deliveries_between($stock_id, $from, $to)
100 {
101         $from = date2sql($from);
102         $to = date2sql($to);
103         $sql = "SELECT SUM(-qty), SUM(-qty*standard_cost) FROM ".TB_PREF."stock_moves
104                 WHERE type=13 AND stock_id='$stock_id' AND
105                         tran_date>='$from' AND tran_date<='$to' GROUP BY stock_id";
106         $result = db_query($sql, "The deliveries could not be updated");
107         return db_fetch_row($result);
108 }
109
110 function get_diff_in_home_currency($supplier, $old_date, $date, $amount1, $amount2)
111 {
112         $currency = get_supplier_currency($supplier);
113         $amount1 = to_home_currency($amount1, $currency, $old_date);
114         $amount2 = to_home_currency($amount2, $currency, $date);
115         return $amount2 - $amount1;
116 }
117 //----------------------------------------------------------------------------------------
118
119 function add_supp_invoice($supp_trans, $invoice_no=0) // do not receive as ref because we change locally
120 {
121         //$company_currency = get_company_currency();
122         /*Start an sql transaction */
123         begin_transaction();
124
125         $tax_total = 0;
126     $taxes = $supp_trans->get_taxes($supp_trans->tax_group_id);
127
128     foreach ($taxes as $taxitem)
129     {
130                 $taxitem['Value'] =  round2($taxitem['Value'], user_price_dec());
131         $tax_total += $taxitem['Value'];
132     }
133
134     $invoice_items_total = $supp_trans->get_total_charged($supp_trans->tax_group_id);
135
136         if ($supp_trans->is_invoice)
137                 $trans_type = 20;
138         else
139         {
140                 $trans_type = 21;
141                 // let's negate everything because it's a credit note
142                 $invoice_items_total = -$invoice_items_total;
143                 $tax_total = -$tax_total;
144                 $supp_trans->ov_discount = -$supp_trans->ov_discount; // this isn't used at all...
145         }
146
147     $date_ = $supp_trans->tran_date;
148         $ex_rate = get_exchange_rate_from_home_currency(get_supplier_currency($supp_trans->supplier_id), $date_);
149
150     /*First insert the invoice into the supp_trans table*/
151         $invoice_id = add_supp_trans($trans_type, $supp_trans->supplier_id, $date_, $supp_trans->due_date,
152                 $supp_trans->reference, $supp_trans->supp_reference,
153                 $invoice_items_total, $tax_total, $supp_trans->ov_discount);
154
155         $total = 0;
156     /* Now the control account */
157     $supplier_accounts = get_supplier_accounts($supp_trans->supplier_id);
158     $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $supplier_accounts["payable_account"], 0, 0,
159                 -($invoice_items_total +  $tax_total + $supp_trans->ov_discount),
160                 $supp_trans->supplier_id,
161                 "The general ledger transaction for the control total could not be added");
162
163     /*Loop through the GL Entries and create a debit posting for each of the accounts entered */
164
165     /*the postings here are a little tricky, the logic goes like this:
166     if its a general ledger amount it goes straight to the account specified
167
168     if its a GRN amount invoiced then :
169
170     The cost as originally credited to GRN suspense on arrival of items is debited to GRN suspense. Any difference
171     between the std cost and the currency cost charged as converted at the ex rate of of the invoice is written off
172     to the purchase price variance account applicable to the item being invoiced.
173     */
174     foreach ($supp_trans->gl_codes as $entered_gl_code)
175     {
176
177             /*GL Items are straight forward - just do the debit postings to the GL accounts specified -
178             the credit is to creditors control act  done later for the total invoice value + tax*/
179
180                 if (!$supp_trans->is_invoice)
181                         $entered_gl_code->amount = -$entered_gl_code->amount;
182
183                 $memo_ = $entered_gl_code->memo_;
184                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $entered_gl_code->gl_code,
185                         $entered_gl_code->gl_dim, $entered_gl_code->gl_dim2, $entered_gl_code->amount, $supp_trans->supplier_id);
186
187                 add_supp_invoice_gl_item($trans_type, $invoice_id, $entered_gl_code->gl_code,
188                         $entered_gl_code->amount, $memo_);
189
190                 // store tax details if the gl account is a tax account
191                 add_gl_tax_details($entered_gl_code->gl_code, 
192                         $trans_type, $invoice_id, $entered_gl_code->amount,
193                         $ex_rate, $date_, $supp_trans->supp_reference);
194     }
195     foreach ($supp_trans->grn_items as $entered_grn)
196     {
197
198         if (!$supp_trans->is_invoice)
199         {
200                         $entered_grn->this_quantity_inv = -$entered_grn->this_quantity_inv;
201                         set_grn_item_credited($entered_grn, $supp_trans->supplier_id, $invoice_id, $date_);
202         }
203
204                 $line_taxfree = $entered_grn->taxfree_charge_price($supp_trans->tax_group_id);
205                 $line_tax = $entered_grn->full_charge_price($supp_trans->tax_group_id) - $line_taxfree;
206                 $stock_gl_code = get_stock_gl_code($entered_grn->item_code);
207
208                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $stock_gl_code["inventory_account"],
209                         $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'],
210                         $entered_grn->this_quantity_inv * $line_taxfree, $supp_trans->supplier_id);
211         // -------------- if price changed since po received. 16 Aug 2008 Joe Hunt
212         if($supp_trans->is_invoice)
213         {
214                 $old = update_supp_received_items_for_invoice($entered_grn->id, $entered_grn->po_detail_item,
215                         $entered_grn->this_quantity_inv, $entered_grn->chg_price);
216                         // Since the standard cost is always calculated on basis of the po unit_price,
217                         // this is also the price that should be the base of calculating the price diff.
218                         // In cases where there is two different po invoices on the same delivery with different unit prices this will not work either
219
220                         //$old_price = $old[0];
221                          
222                         $old_price = $old[2];
223
224                         /*
225                         If statement is removed. Should always check for deliveries nomatter if there has been a price change. 
226                         */
227                         //if ($old_price != $entered_grn->chg_price) // price-change, so update
228                         //{
229                         //$diff = $entered_grn->chg_price - $old_price;
230                         $old_date = sql2date($old[1]);
231                         $diff = get_diff_in_home_currency($supp_trans->supplier_id, $old_date, $date_, $old_price, 
232                                 $entered_grn->chg_price);
233                         // always return due to change in currency.
234                         $mat_cost = update_average_material_cost(null, $entered_grn->item_code,
235                                 $diff, $entered_grn->this_quantity_inv, $old_date, true);
236                         // added 2008-12-08 Joe Hunt. Update the purchase data table
237                         add_or_update_purchase_data($supp_trans->supplier_id, $entered_grn->item_code, $entered_grn->chg_price); 
238                         $deliveries = get_deliveries_between($entered_grn->item_code, $old_date, Today()); // extend the period, if invoice is before any deliveries.
239                         if ($deliveries[0] != 0) // have deliveries been done during the period?
240                         {
241                                 $deliveries[1] /= $deliveries[0];
242                                 $amt = ($mat_cost - $deliveries[1]) * $deliveries[0]; // $amt in home currency
243                                 if ($amt != 0.0)
244                                 {
245                                         add_gl_trans($trans_type, $invoice_id, $date_,  $stock_gl_code["cogs_account"],
246                                                 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'], _("Cost diff."),
247                                                 $amt, null, null, null,
248                                                 "The general ledger transaction could not be added for the price variance of the inventory item");
249                                         add_gl_trans($trans_type, $invoice_id, $date_,  $stock_gl_code["inventory_account"],
250                                                 0, 0, _("Cost diff."), -$amt, null, null, null,
251                                                 "The general ledger transaction could not be added for the price variance of the inventory item");
252                                 }               
253                                 update_stock_move_pid(13, $entered_grn->item_code, $old_date, $date_, 0, $mat_cost);
254                         }
255                         update_stock_move_pid(25, $entered_grn->item_code, $old_date, $old_date, $supp_trans->supplier_id, $mat_cost);
256                 //}
257                 }
258         // ----------------------------------------------------------------------
259
260                 add_supp_invoice_item($trans_type, $invoice_id, $entered_grn->item_code,
261                         $entered_grn->item_description, 0,      $line_taxfree, $line_tax,
262                         $entered_grn->this_quantity_inv, $entered_grn->id, $entered_grn->po_detail_item, "");
263     } /* end of GRN postings */
264     /* Now the TAX account */
265     foreach ($taxes as $taxitem)
266     {
267         if ($taxitem['Net'] != 0)
268         {
269
270                 if (!$supp_trans->is_invoice)
271                         $taxitem['Value'] = -$taxitem['Value'];
272                 // here we suppose that tax is never included in price (we are company customer).
273                         add_trans_tax_details($trans_type, $invoice_id, 
274                                 $taxitem['tax_type_id'], $taxitem['rate'], 0, $taxitem['Value'],
275                                 $taxitem['Net'], $ex_rate, $date_, $supp_trans->supp_reference);
276
277                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_,
278                         $taxitem['purchasing_gl_code'], 0, 0, $taxitem['Value'],
279                         $supp_trans->supplier_id,
280                         "A general ledger transaction for the tax amount could not be added");
281         }
282     }
283         
284         /*Post a balance post if $total != 0 */
285         add_gl_balance($trans_type, $invoice_id, $date_, -$total, payment_person_types::supplier(), $supp_trans->supplier_id);  
286
287         add_comments($trans_type, $invoice_id, $date_, $supp_trans->Comments);
288
289         references::save_last($supp_trans->reference, $trans_type);
290
291         if ($invoice_no != 0)
292         {
293                 $invoice_alloc_balance = get_supp_trans_allocation_balance(20, $invoice_no);
294                 if ($invoice_alloc_balance > 0) 
295                 {       //the invoice is not already fully allocated 
296
297                         $trans = get_supp_trans($invoice_no, 20);
298                         $total = $trans['Total'];
299
300                         $allocate_amount = ($invoice_alloc_balance > $total) ? $total : $invoice_alloc_balance;
301                         /*Now insert the allocation record if > 0 */
302                         if ($allocate_amount != 0) 
303                         {
304                                 update_supp_trans_allocation(20, $invoice_no, $allocate_amount);
305                                 update_supp_trans_allocation(21, $invoice_id, $allocate_amount); // ***
306                                 add_supp_allocation($allocate_amount, 21, $invoice_id, 20, $invoice_no,
307                                         $date_);
308                                 // Exchange Variations Joe Hunt 2008-09-20 ////////////////////////////////////////
309
310                                 exchange_variation(21, $invoice_id, 20, $invoice_no, $date_,
311                                         $allocate_amount, payment_person_types::supplier());
312
313                                 ///////////////////////////////////////////////////////////////////////////
314                         }
315                 }
316         }
317         
318
319     commit_transaction();
320
321     return $invoice_id;
322 }
323
324 //----------------------------------------------------------------------------------------
325
326 // get all the invoices/credits for a given PO - quite long route to get there !
327
328 function get_po_invoices_credits($po_number)
329 {
330         $sql = "SELECT DISTINCT ".TB_PREF."supp_trans.trans_no, ".TB_PREF."supp_trans.type,
331                 ov_amount+ov_discount+ov_gst AS Total,
332                 ".TB_PREF."supp_trans.tran_date
333                 FROM ".TB_PREF."supp_trans, ".TB_PREF."supp_invoice_items, ".TB_PREF."purch_order_details, ".TB_PREF."purch_orders
334                 WHERE ".TB_PREF."supp_invoice_items.supp_trans_no = ".TB_PREF."supp_trans.trans_no
335                 AND ".TB_PREF."supp_invoice_items.po_detail_item_id = ".TB_PREF."purch_order_details.po_detail_item
336                 AND ".TB_PREF."purch_orders.supplier_id = ".TB_PREF."supp_trans.supplier_id
337                 AND ".TB_PREF."purch_order_details.order_no = $po_number";
338
339         return db_query($sql, "The invoices/credits for the po $po_number could not be retreived");
340 }
341
342 //----------------------------------------------------------------------------------------
343
344 function read_supp_invoice($trans_no, $trans_type, &$supp_trans)
345 {
346         $sql = "SELECT ".TB_PREF."supp_trans.*, supp_name FROM ".TB_PREF."supp_trans,".TB_PREF."suppliers
347                 WHERE trans_no = $trans_no AND type = $trans_type
348                 AND ".TB_PREF."suppliers.supplier_id=".TB_PREF."supp_trans.supplier_id";
349         $result = db_query($sql, "Cannot retreive a supplier transaction");
350
351         if (db_num_rows($result) == 1)
352         {
353                 $trans_row = db_fetch($result);
354
355                 $supp_trans->supplier_id = $trans_row["supplier_id"];
356                 $supp_trans->supplier_name = $trans_row["supp_name"];
357                 $supp_trans->tran_date = sql2date($trans_row["tran_date"]);
358                 $supp_trans->due_date = sql2date($trans_row["due_date"]);
359                 //$supp_trans->Comments = $trans_row["TransText"];
360                 $supp_trans->Comments = "";
361                 $supp_trans->reference = $trans_row["reference"];
362                 $supp_trans->supp_reference = $trans_row["supp_reference"];
363                 $supp_trans->ov_amount = $trans_row["ov_amount"];
364                 $supp_trans->ov_discount = $trans_row["ov_discount"];
365                 $supp_trans->ov_gst = $trans_row["ov_gst"];
366
367                 $id = $trans_row["trans_no"];
368
369                 $result = get_supp_invoice_items($trans_type, $id);
370
371                 if (db_num_rows($result) > 0)
372                 {
373
374             while ($details_row = db_fetch($result))
375             {
376
377                 if ($details_row["gl_code"] == 0)
378                 {
379                         $supp_trans->add_grn_to_trans($details_row["grn_item_id"], $details_row["po_detail_item_id"], $details_row["stock_id"],
380                                         $details_row["description"], 0, 0, $details_row["quantity"], 0, $details_row["FullUnitPrice"],
381                                         false, 0, 0);
382                 }
383                 else
384                 {
385                         $supp_trans->add_gl_codes_to_trans($details_row["gl_code"], get_gl_account_name($details_row["gl_code"]), 0, 0,
386                                         $details_row["FullUnitPrice"], $details_row["memo_"]);
387                 }
388             }
389         }
390         else
391         {
392                         return display_db_error("Invalid supptrans details for supptrans number : $trans_no and type : $trans_type", $sql, true);
393                 }
394
395         }
396         else
397         {
398                 return display_db_error("Invalid supptrans number : $trans_no and type : $trans_type", $sql, true);
399         }
400 }
401
402 //----------------------------------------------------------------------------------------
403
404 function void_supp_invoice($type, $type_no)
405 {
406         begin_transaction();
407
408         void_bank_trans($type, $type_no, true);
409
410         void_gl_trans($type, $type_no, true);
411
412         void_supp_allocations($type, $type_no);
413
414         void_supp_trans($type, $type_no);
415
416         $result = get_supp_invoice_items($type, $type_no);
417
418         // now remove this invoice/credit from any GRNs/POs that it's related to
419         if (db_num_rows($result) > 0)
420         {
421                 $date_ = Today();
422         while ($details_row = db_fetch($result))
423         {
424                 if ((int)$details_row["grn_item_id"] > 0) // it can be empty for GL items
425                 {
426                         // Changed 2008-10-17 by Joe Hunt to get the avg. material cost updated
427                                 $old = update_supp_received_items_for_invoice($details_row["grn_item_id"],
428                                         $details_row["po_detail_item_id"], -$details_row["quantity"], $details_row["FullUnitPrice"]); 
429                                 
430                                 //$diff = $details_row["FullUnitPrice"] - $old[2];
431                                 $old_date = sql2date($old[1]);
432                                 
433                                 $batch = get_grn_batch_from_item($details_row["grn_item_id"]);  
434                                 $grn = get_grn_batch($batch);
435                         if ($type == 21) // credit note 2009-06-14 Joe Hunt Must restore the po and grn
436                         {
437                                         $sql = "UPDATE ".TB_PREF."purch_order_details
438                                         SET quantity_ordered = quantity_ordered + ".-$details_row["quantity"].",
439                                     quantity_received = quantity_received + ".-$details_row["quantity"]."
440                                     WHERE po_detail_item = ".$details_row["po_detail_item_id"];
441                                         db_query($sql, "a purchase order details record could not be updated. This receipt of goods has not been processed ");
442                                         $sql = "UPDATE ".TB_PREF."grn_items SET qty_recd=qty_recd+".-$details_row["quantity"]."
443                                                 WHERE id=".$details_row["grn_item_id"];
444                                         db_query($sql);
445                         }               
446                                 $diff = get_diff_in_home_currency($grn["supplier_id"], $old_date, $date_, $old[2], 
447                                         $details_row["FullUnitPrice"]);
448                                 // Only adjust the avg for the diff
449                                 $mat_cost = update_average_material_cost(null, $details_row["stock_id"],
450                                         $diff, -$details_row["quantity"], $old_date, true);
451
452                                 $deliveries = get_deliveries_between($details_row["stock_id"], $old_date, $date_);
453                                 if ($deliveries[0] != 0) // have deliveries been done during the period?
454                                 {
455                                         update_stock_move_pid(13, $details_row["stock_id"], $old_date, $date_, 0, $mat_cost);
456                                 }
457                                 update_stock_move_pid(25, $details_row["stock_id"], $old_date, $old_date, $grn['supplier_id'], $mat_cost);
458                 }
459         }
460         }
461
462         if ($type == 21) // void the credits in stock moves
463                 void_stock_move(21, $type_no); 
464         void_supp_invoice_items($type, $type_no);
465         void_trans_tax_details($type, $type_no);
466
467         commit_transaction();
468 }
469
470 //----------------------------------------------------------------------------------------
471
472
473 ?>