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