Additonal fixes to tax on foreign currency transactions.
[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 Affero General Public License,
5         AGPL, as published by the Free Software Foundation, either version 
6         3 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/agpl-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         $tax_total += $taxitem['Value'];
131     }
132
133     $invoice_items_total = $supp_trans->get_total_charged($supp_trans->tax_group_id);
134
135         if ($supp_trans->is_invoice)
136                 $trans_type = 20;
137         else
138         {
139                 $trans_type = 21;
140                 // let's negate everything because it's a credit note
141                 $invoice_items_total = -$invoice_items_total;
142                 $tax_total = -$tax_total;
143                 $supp_trans->ov_discount = -$supp_trans->ov_discount; // this isn't used at all...
144         }
145
146     $date_ = $supp_trans->tran_date;
147         $ex_rate = get_exchange_rate_from_home_currency(get_supplier_currency($supp_trans->supplier_id), $date_);
148
149     /*First insert the invoice into the supp_trans table*/
150         $invoice_id = add_supp_trans($trans_type, $supp_trans->supplier_id, $date_, $supp_trans->due_date,
151                 $supp_trans->reference, $supp_trans->supp_reference,
152                 $invoice_items_total, $tax_total, $supp_trans->ov_discount);
153
154         $total = 0;
155     /* Now the control account */
156     $supplier_accounts = get_supplier_accounts($supp_trans->supplier_id);
157     $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $supplier_accounts["payable_account"], 0, 0,
158                 -($invoice_items_total +  $tax_total + $supp_trans->ov_discount),
159                 $supp_trans->supplier_id,
160                 "The general ledger transaction for the control total could not be added");
161
162     /*Loop through the GL Entries and create a debit posting for each of the accounts entered */
163
164     /*the postings here are a little tricky, the logic goes like this:
165     if its a general ledger amount it goes straight to the account specified
166
167     if its a GRN amount invoiced then :
168
169     The cost as originally credited to GRN suspense on arrival of items is debited to GRN suspense. Any difference
170     between the std cost and the currency cost charged as converted at the ex rate of of the invoice is written off
171     to the purchase price variance account applicable to the item being invoiced.
172     */
173     foreach ($supp_trans->gl_codes as $entered_gl_code)
174     {
175
176             /*GL Items are straight forward - just do the debit postings to the GL accounts specified -
177             the credit is to creditors control act  done later for the total invoice value + tax*/
178
179                 if (!$supp_trans->is_invoice)
180                         $entered_gl_code->amount = -$entered_gl_code->amount;
181
182                 $memo_ = $entered_gl_code->memo_;
183                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $entered_gl_code->gl_code,
184                         $entered_gl_code->gl_dim, $entered_gl_code->gl_dim2, $entered_gl_code->amount, $supp_trans->supplier_id);
185
186                 add_supp_invoice_gl_item($trans_type, $invoice_id, $entered_gl_code->gl_code,
187                         $entered_gl_code->amount, $memo_);
188
189                 // store tax details if the gl account is a tax account
190                 add_gl_tax_details($entered_gl_code->gl_code, 
191                         $trans_type, $invoice_id, $entered_gl_code->amount,
192                         $ex_rate, $date_, $supp_trans->supp_reference);
193     }
194     foreach ($supp_trans->grn_items as $entered_grn)
195     {
196
197         if (!$supp_trans->is_invoice)
198         {
199                         $entered_grn->this_quantity_inv = -$entered_grn->this_quantity_inv;
200                         set_grn_item_credited($entered_grn, $supp_trans->supplier_id, $invoice_id, $date_);
201         }
202
203                 $line_taxfree = $entered_grn->taxfree_charge_price($supp_trans->tax_group_id);
204                 $line_tax = $entered_grn->full_charge_price($supp_trans->tax_group_id) - $line_taxfree;
205                 $stock_gl_code = get_stock_gl_code($entered_grn->item_code);
206
207                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_, $stock_gl_code["inventory_account"],
208                         $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'],
209                         $entered_grn->this_quantity_inv * $line_taxfree, $supp_trans->supplier_id);
210         // -------------- if price changed since po received. 16 Aug 2008 Joe Hunt
211         if($supp_trans->is_invoice)
212         {
213                 $old = update_supp_received_items_for_invoice($entered_grn->id, $entered_grn->po_detail_item,
214                         $entered_grn->this_quantity_inv, $entered_grn->chg_price);
215                         // Since the standard cost is always calculated on basis of the po unit_price,
216                         // this is also the price that should be the base of calculating the price diff.
217                         // In cases where there is two different po invoices on the same delivery with different unit prices this will not work either
218
219                         //$old_price = $old[0];
220                          
221                         $old_price = $old[2];
222
223                         /*
224                         If statement is removed. Should always check for deliveries nomatter if there has been a price change. 
225                         */
226                         //if ($old_price != $entered_grn->chg_price) // price-change, so update
227                         //{
228                         //$diff = $entered_grn->chg_price - $old_price;
229                         $old_date = sql2date($old[1]);
230                         $diff = get_diff_in_home_currency($supp_trans->supplier_id, $old_date, $date_, $old_price, 
231                                 $entered_grn->chg_price);
232                         // always return due to change in currency.
233                         $mat_cost = update_average_material_cost(null, $entered_grn->item_code,
234                                 $diff, $entered_grn->this_quantity_inv, $old_date, true);
235                         // added 2008-12-08 Joe Hunt. Update the purchase data table
236                         add_or_update_purchase_data($supp_trans->supplier_id, $entered_grn->item_code, $entered_grn->chg_price); 
237                         $deliveries = get_deliveries_between($entered_grn->item_code, $old_date, Today()); // extend the period, if invoice is before any deliveries.
238                         if ($deliveries[0] != 0) // have deliveries been done during the period?
239                         {
240                                 $deliveries[1] /= $deliveries[0];
241                                 $amt = ($mat_cost - $deliveries[1]) * $deliveries[0]; // $amt in home currency
242                                 if ($amt != 0.0)
243                                 {
244                                         add_gl_trans($trans_type, $invoice_id, $date_,  $stock_gl_code["cogs_account"],
245                                                 $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'], _("Cost diff."),
246                                                 $amt, null, null, null,
247                                                 "The general ledger transaction could not be added for the price variance of the inventory item");
248                                         add_gl_trans($trans_type, $invoice_id, $date_,  $stock_gl_code["inventory_account"],
249                                                 0, 0, _("Cost diff."), -$amt, null, null, null,
250                                                 "The general ledger transaction could not be added for the price variance of the inventory item");
251                                 }               
252                                 update_stock_move_pid(13, $entered_grn->item_code, $old_date, $date_, 0, $mat_cost);
253                         }
254                         update_stock_move_pid(25, $entered_grn->item_code, $old_date, $old_date, $supp_trans->supplier_id, $mat_cost);
255                 //}
256                 }
257         // ----------------------------------------------------------------------
258
259                 add_supp_invoice_item($trans_type, $invoice_id, $entered_grn->item_code,
260                         $entered_grn->item_description, 0,      $line_taxfree, $line_tax,
261                         $entered_grn->this_quantity_inv, $entered_grn->id, $entered_grn->po_detail_item, "");
262     } /* end of GRN postings */
263     /* Now the TAX account */
264     foreach ($taxes as $taxitem)
265     {
266         if ($taxitem['Net'] != 0)
267         {
268
269                 if (!$supp_trans->is_invoice)
270                         $taxitem['Value'] = -$taxitem['Value'];
271                 // here we suppose that tax is never included in price (we are company customer).
272                         add_trans_tax_details($trans_type, $invoice_id, 
273                                 $taxitem['tax_type_id'], $taxitem['rate'], 0, $taxitem['Value'],
274                                 $taxitem['Net'], $ex_rate, $date_, $supp_trans->supp_reference);
275
276                 $total += add_gl_trans_supplier($trans_type, $invoice_id, $date_,
277                         $taxitem['purchasing_gl_code'], 0, 0, $taxitem['Value'],
278                         $supp_trans->supplier_id,
279                         "A general ledger transaction for the tax amount could not be added");
280         }
281     }
282         
283         /*Post a balance post if $total != 0 */
284         add_gl_balance($trans_type, $invoice_id, $date_, -$total, payment_person_types::supplier(), $supp_trans->supplier_id);  
285
286         add_comments($trans_type, $invoice_id, $date_, $supp_trans->Comments);
287
288         references::save_last($supp_trans->reference, $trans_type);
289
290         if ($invoice_no != 0)
291         {
292                 $invoice_alloc_balance = get_supp_trans_allocation_balance(20, $invoice_no);
293                 if ($invoice_alloc_balance > 0) 
294                 {       //the invoice is not already fully allocated 
295
296                         $trans = get_supp_trans($invoice_no, 20);
297                         $total = $trans['Total'];
298
299                         $allocate_amount = ($invoice_alloc_balance > $total) ? $total : $invoice_alloc_balance;
300                         /*Now insert the allocation record if > 0 */
301                         if ($allocate_amount != 0) 
302                         {
303                                 update_supp_trans_allocation(20, $invoice_no, $allocate_amount);
304                                 update_supp_trans_allocation(21, $invoice_id, $allocate_amount); // ***
305                                 add_supp_allocation($allocate_amount, 21, $invoice_id, 20, $invoice_no,
306                                         $date_);
307                                 // Exchange Variations Joe Hunt 2008-09-20 ////////////////////////////////////////
308
309                                 exchange_variation(21, $invoice_id, 20, $invoice_no, $date_,
310                                         $allocate_amount, payment_person_types::supplier());
311
312                                 ///////////////////////////////////////////////////////////////////////////
313                         }
314                 }
315         }
316         
317
318     commit_transaction();
319
320     return $invoice_id;
321 }
322
323 //----------------------------------------------------------------------------------------
324
325 // get all the invoices/credits for a given PO - quite long route to get there !
326
327 function get_po_invoices_credits($po_number)
328 {
329         $sql = "SELECT DISTINCT ".TB_PREF."supp_trans.trans_no, ".TB_PREF."supp_trans.type,
330                 ov_amount+ov_discount+ov_gst AS Total,
331                 ".TB_PREF."supp_trans.tran_date
332                 FROM ".TB_PREF."supp_trans, ".TB_PREF."supp_invoice_items, ".TB_PREF."purch_order_details
333                 WHERE ".TB_PREF."supp_invoice_items.supp_trans_no = ".TB_PREF."supp_trans.trans_no
334                 AND ".TB_PREF."supp_invoice_items.po_detail_item_id = ".TB_PREF."purch_order_details.po_detail_item
335                 AND ".TB_PREF."purch_order_details.order_no = $po_number";
336
337         return db_query($sql, "The invoices/credits for the po $po_number could not be retreived");
338 }
339
340 //----------------------------------------------------------------------------------------
341
342 function read_supp_invoice($trans_no, $trans_type, &$supp_trans)
343 {
344         $sql = "SELECT ".TB_PREF."supp_trans.*, supp_name FROM ".TB_PREF."supp_trans,".TB_PREF."suppliers
345                 WHERE trans_no = $trans_no AND type = $trans_type
346                 AND ".TB_PREF."suppliers.supplier_id=".TB_PREF."supp_trans.supplier_id";
347         $result = db_query($sql, "Cannot retreive a supplier transaction");
348
349         if (db_num_rows($result) == 1)
350         {
351                 $trans_row = db_fetch($result);
352
353                 $supp_trans->supplier_id = $trans_row["supplier_id"];
354                 $supp_trans->supplier_name = $trans_row["supp_name"];
355                 $supp_trans->tran_date = sql2date($trans_row["tran_date"]);
356                 $supp_trans->due_date = sql2date($trans_row["due_date"]);
357                 //$supp_trans->Comments = $trans_row["TransText"];
358                 $supp_trans->Comments = "";
359                 $supp_trans->reference = $trans_row["reference"];
360                 $supp_trans->supp_reference = $trans_row["supp_reference"];
361                 $supp_trans->ov_amount = $trans_row["ov_amount"];
362                 $supp_trans->ov_discount = $trans_row["ov_discount"];
363                 $supp_trans->ov_gst = $trans_row["ov_gst"];
364
365                 $id = $trans_row["trans_no"];
366
367                 $result = get_supp_invoice_items($trans_type, $id);
368
369                 if (db_num_rows($result) > 0)
370                 {
371
372             while ($details_row = db_fetch($result))
373             {
374
375                 if ($details_row["gl_code"] == 0)
376                 {
377                         $supp_trans->add_grn_to_trans($details_row["grn_item_id"], $details_row["po_detail_item_id"], $details_row["stock_id"],
378                                         $details_row["description"], 0, 0, $details_row["quantity"], 0, $details_row["FullUnitPrice"],
379                                         false, 0, 0);
380                 }
381                 else
382                 {
383                         $supp_trans->add_gl_codes_to_trans($details_row["gl_code"], get_gl_account_name($details_row["gl_code"]), 0, 0,
384                                         $details_row["FullUnitPrice"], $details_row["memo_"]);
385                 }
386             }
387         }
388         else
389         {
390                         return display_db_error("Invalid supptrans details for supptrans number : $trans_no and type : $trans_type", $sql, true);
391                 }
392
393         }
394         else
395         {
396                 return display_db_error("Invalid supptrans number : $trans_no and type : $trans_type", $sql, true);
397         }
398 }
399
400 //----------------------------------------------------------------------------------------
401
402 function void_supp_invoice($type, $type_no)
403 {
404         begin_transaction();
405
406         void_bank_trans($type, $type_no, true);
407
408         void_gl_trans($type, $type_no, true);
409
410         void_supp_allocations($type, $type_no);
411
412         void_supp_trans($type, $type_no);
413
414         $result = get_supp_invoice_items($type, $type_no);
415
416         // now remove this invoice/credit from any GRNs/POs that it's related to
417         if (db_num_rows($result) > 0)
418         {
419                 $date_ = Today();
420         while ($details_row = db_fetch($result))
421         {
422                 if ((int)$details_row["grn_item_id"] > 0) // it can be empty for GL items
423                 {
424                         // Changed 2008-10-17 by Joe Hunt to get the avg. material cost updated
425                                 $old = update_supp_received_items_for_invoice($details_row["grn_item_id"],
426                                         $details_row["po_detail_item_id"], -$details_row["quantity"], $details_row["FullUnitPrice"]); 
427                                 
428                                 //$diff = $details_row["FullUnitPrice"] - $old[2];
429                                 $old_date = sql2date($old[1]);
430                                 
431                                 $batch = get_grn_batch_from_item($details_row["grn_item_id"]);  
432                                 $grn = get_grn_batch($batch);
433                                 
434                                 $diff = get_diff_in_home_currency($grn["supplier_id"], $old_date, $date_, $old[2], 
435                                         $details_row["FullUnitPrice"]);
436                                 // Only adjust the avg for the diff
437                                 $mat_cost = update_average_material_cost(null, $details_row["stock_id"],
438                                         $diff, -$details_row["quantity"], $date_, true);
439
440                                 $deliveries = get_deliveries_between($details_row["stock_id"], $old_date, $date_);
441                                 if ($deliveries[0] != 0) // have deliveries been done during the period?
442                                 {
443                                         $deliveries[1] /= $deliveries[0];
444                                         $amt = ($mat_cost - $deliveries[1]) * $deliveries[0]; // $amt in home currency
445                                         if ($amt != 0.0)
446                                         {
447                                                 $stock_gl_code = get_stock_gl_code($details_row["stock_id"]);
448                                                 add_gl_trans($type, $type_no, $date_,   $stock_gl_code["cogs_account"],
449                                                         $stock_gl_code['dimension_id'], $stock_gl_code['dimension2_id'], _("Cost diff."),
450                                                         -$amt, null, null, null,
451                                                         "The general ledger transaction could not be added for the price variance of the inventory item");
452                                                 add_gl_trans($type, $type_no, $date_, $stock_gl_code["inventory_account"],
453                                                         0, 0, _("Cost diff."), $amt, null, null, null,
454                                                         "The general ledger transaction could not be added for the price variance of the inventory item");
455                                         }               
456                                         update_stock_move_pid(13, $details_row["stock_id"], $old_date, $date_, 0, $mat_cost);
457                                 }
458                                 update_stock_move_pid(25, $details_row["stock_id"], $old_date, $old_date, $grn['supplier_id'], $mat_cost);
459
460                 }
461         }
462         }
463
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 ?>