Added missing field for bank charges in bank_trans, rewritten bank transaction views...
[fa-stable.git] / gl / includes / db / gl_db_banking.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 function add_exchange_variation($trans_no, $date_, $acc_id, $account,
13     $currency, $person_type_id=null, $person_id = "")
14 {
15         if (is_company_currency($currency))
16                 return false;
17         if ($date_ == null)
18                 $date_ = Today();
19         $for_amount = 0;
20
21         // We have to calculate all the currency accounts belonging to the GL account
22         // upto $date_ and calculate with the exchange rates. And then compare with the GL account balance.
23         $sql = "SELECT SUM(bt.amount) AS for_amount, ba.bank_curr_code          
24                 FROM ".TB_PREF."bank_trans bt, ".TB_PREF."bank_accounts ba
25                 WHERE ba.id = bt.bank_act AND ba.account_code = ".db_escape($account)." AND bt.trans_date<='".date2sql($date_)."'
26                 GROUP BY ba.bank_curr_code";    
27         $result = db_query($sql, "Transactions for bank account $acc_id could not be calculated");
28         while ($row = db_fetch($result))
29         {
30                 if ($row['for_amount'] == 0)
31                         continue;
32                 $rate = get_exchange_rate_from_home_currency($row['bank_curr_code'], $date_);
33                 $for_amount += round2($row['for_amount'] * $rate, user_price_dec());
34         }       
35         $amount = get_gl_trans_from_to("", $date_, $account);
36         $diff = $amount - $for_amount;
37         if (floatcmp($diff,0))
38         {
39                 // generate journal entry // FIXME: use cart?
40                 global $Refs;
41
42                 begin_transaction();
43                 $trans_no = get_next_trans_no(ST_JOURNAL);
44                 $ref = $Refs->get_next(ST_JOURNAL);
45
46                 add_journal(ST_JOURNAL, $trans_no, $diff, $date_ , get_company_currency(), $ref, '', 1, $date_, $date_);
47                 $Refs->save(ST_JOURNAL, $trans_no, $ref);
48                 add_audit_trail(ST_JOURNAL, $trans_no, $date_);
49
50                 if ($person_type_id == null)
51                         $person_type_id = PT_MISC;
52                 add_gl_trans(ST_JOURNAL, $trans_no, $date_, $account, 0, 0, _("Exchange Variance"),
53                 -$diff, null, $person_type_id, $person_id);
54
55         add_gl_trans(ST_JOURNAL, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0, 
56                 _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
57                 commit_transaction();
58                 return true;
59         }
60         return false;
61 }
62
63 function add_cust_supp_revaluation($ledger_act, $ex_act, $date, $amount, $person_type_id, $person_id, $memo)
64 {
65         global $Refs;
66         if ($amount == 0)
67                 return;
68
69         begin_transaction();
70         $trans_no = get_next_trans_no(ST_JOURNAL);
71         $ref = $Refs->get_next(ST_JOURNAL);
72
73         add_journal(ST_JOURNAL, $trans_no, $amount, $date, get_company_currency(), $ref, '', 1, $date, $date);
74         $Refs->save(ST_JOURNAL, $trans_no, $ref);
75         add_audit_trail(ST_JOURNAL, $trans_no, $date);
76
77         add_gl_trans(ST_JOURNAL, $trans_no, $date, $ledger_act, 0, 0, _("Exchange Variance"),
78                 $amount, null, $person_type_id, $person_id);
79         add_gl_trans(ST_JOURNAL, $trans_no, $date, $ex_act, 0, 0, 
80                 _("Exchange Variance"), -$amount, null, $person_type_id, $person_id);
81         add_comments(ST_JOURNAL, $trans_no, $date, $memo);
82         commit_transaction();
83 }
84
85 function get_cust_account_curr_balances($date)
86 {
87         $to = date2sql($date);
88
89     $sql = "SELECT SUM(IF(t.type IN(". implode(',', array(ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_BANKDEPOSIT, ST_JOURNAL))."),
90                         -(t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount), 
91                 (t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount))) AS amount,
92                 dt.debtor_no, dt.name, dt.curr_code, b.receivables_account
93                 FROM ".TB_PREF."debtor_trans t 
94                         LEFT JOIN ".TB_PREF."debtors_master dt ON t.debtor_no = dt.debtor_no
95                         LEFT JOIN ".TB_PREF."cust_branch b ON t.debtor_no = b.debtor_no
96                         LEFT JOIN ".TB_PREF."voided as v ON v.type = t.type and v.id=t.trans_no
97         WHERE ISNULL(v.date_) AND t.type <> ".ST_CUSTDELIVERY." AND t.tran_date <= '$to' 
98                 AND t.branch_code=b.branch_code AND dt.curr_code<>'".get_company_pref('curr_default')."' 
99                 GROUP BY t.debtor_no, b.receivables_account";
100
101     $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
102         return  $result;
103 }
104
105 function get_supp_account_curr_balances($date)
106 {
107         $to = date2sql($date);
108
109     $sql = "SELECT SUM(-(t.ov_amount + t.ov_gst + t.ov_discount)) AS amount,
110                 supp.supplier_id, supp.supp_name, supp.curr_code, supp.payable_account
111                 FROM ".TB_PREF."supp_trans t 
112                         LEFT JOIN ".TB_PREF."suppliers supp ON t.supplier_id = supp.supplier_id
113                         LEFT JOIN ".TB_PREF."voided as v ON v.type = t.type and v.id=t.trans_no
114         WHERE ISNULL(v.date_) AND t.tran_date <= '$to' 
115                 AND supp.curr_code<>'".get_company_pref('curr_default')."' 
116                 GROUP BY t.supplier_id";
117
118     $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
119         return  $result;
120 }
121
122 function get_account_home_balance($person_id, $person_type, $rec_account, $to_date)
123 {
124         $to = date2sql($to_date);
125
126     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans  
127                         WHERE person_id=".db_escape($person_id)." AND account='$rec_account' 
128                         AND person_type_id=$person_type AND tran_date <= '$to'";
129         $result = db_query($sql, "The AR/AP balance for customer $person_id could not be calculated");
130         $row = db_fetch_row($result);
131         return $row[0];
132 }
133 //------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
134
135 function add_exchange_variation_all($date=null, $ref="", $memo)
136 {
137         global $Refs;
138
139         begin_transaction(__FUNCTION__, func_get_args());
140
141         $exchanged = false;
142         $trans_no = get_next_trans_no(ST_JOURNAL);
143         $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
144         $result = db_query($sql, "could not retreive bank accounts");
145         while ($myrow = db_fetch($result))
146         {
147                 if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
148                         $myrow['bank_curr_code']))
149                         $exchanged = true;
150         }
151         if ($exchanged)
152         {
153                 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
154                 if ($ref == "")
155                         $ref = $Refs->get_next(ST_JOURNAL, null, $date);
156                 $Refs->save(ST_JOURNAL, $trans_no, $ref);
157                 add_audit_trail(ST_JOURNAL, $trans_no, $date);
158         }       
159
160         //------------- BEGIN inserted for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
161         if ($date == null)
162                 $date = Today();
163         $exchange_act = get_company_pref('exchange_diff_act');
164         $je = 0;
165         // debtors
166         $res = get_cust_account_curr_balances($date);
167         
168         while($row = db_fetch($res)) 
169         {
170                 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
171                 $foreign = round2($row['amount']*$exrate, user_price_dec());
172                 $home = round2(get_account_home_balance($row['debtor_no'], PT_CUSTOMER, $row['receivables_account'], $date), user_price_dec());
173                 if ($foreign != $home) 
174                 {
175                         $amount = $foreign - $home;     
176                         add_cust_supp_revaluation($row['receivables_account'], $exchange_act, $date, $amount, PT_CUSTOMER, 
177                                 $row['debtor_no'], $memo);
178                         $je++;  
179                 }
180         }
181         // creditors
182         $res = get_supp_account_curr_balances($date);
183         
184         while($row = db_fetch($res)) 
185         {
186                 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
187                 $foreign = round2($row['amount']*$exrate, user_price_dec());
188                 $home = round2(get_account_home_balance($row['supplier_id'], PT_SUPPLIER, $row['payable_account'], $date), user_price_dec());
189                 if ($foreign != $home) 
190                 {
191                         $amount = $foreign - $home;     
192                         add_cust_supp_revaluation($row['payable_account'], $exchange_act, $date, $amount, PT_SUPPLIER, 
193                                 $row['supplier_id'], $memo);
194                         $je++;  
195                 }
196         }
197         //------------- END
198
199         commit_transaction();
200         return array(($exchanged ? $trans_no : 0), $je);
201 }
202 //----------------------------------------------------------------------------------
203 //      Add bank tranfer to database.
204 //
205 //      $from_account - source bank account id
206 //      $to_account   - target bank account id
207 //      
208
209 function add_bank_transfer($from_account, $to_account, $date_,
210         $amount, $ref, $memo_, $charge=0, $target_amount=0)
211 {
212         global $Refs, $SysPrefs;
213
214         begin_transaction(__FUNCTION__, func_get_args());
215
216         $args = func_get_args(); if (count($args) < 8) $args[] = 0;
217         $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
218                 'ref', 'memo_', 'charge', 'target_amount'), $args);
219         $args->trans_no = 0;
220         hook_db_prewrite($args, ST_BANKTRANSFER);
221
222         $trans_type = ST_BANKTRANSFER;
223
224         $currency = get_bank_account_currency($from_account);
225
226         $trans_no = get_next_trans_no($trans_type);
227         
228     $fromact = get_bank_account($from_account);
229     $toact = get_bank_account($to_account);
230     $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
231
232         $from_gl_account = get_bank_gl_account($from_account);
233         $to_gl_account = get_bank_gl_account($to_account);
234         
235         $exchanged = false;
236         $total = 0;
237         // do the source account postings
238     $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
239                 -($amount + $charge), $currency);
240
241     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
242                 $date_, -$amount, -$charge,
243                 PT_MISC, $person_id, $currency);
244         if ($SysPrefs->auto_currency_revaluation())
245         {
246                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
247                 if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account, 
248                         $currency, PT_MISC, $person_id))
249                         $exchanged = true;
250         }
251         if ($charge != 0)
252         {
253                 /* Now Debit bank charge account with charges */
254                 $charge_act = get_bank_charge_account($from_account);
255                 $total += add_gl_trans($trans_type, $trans_no, $date_,
256                         $charge_act, 0, 0, $person_id, $charge, $currency);
257         }
258
259         // provide backward compatibility for extension modules (target amount can be not passed)
260         $to_currency = $target_amount ? $toact['bank_curr_code'] : $currency;
261         $to_amount = $target_amount ? $target_amount : $amount;
262
263         // do the destination account postings
264         $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
265                 $to_amount, $to_currency);
266                 
267         /*Post a balance post if $total != 0 */
268         if ($currency == $to_currency)
269                 add_gl_balance($trans_type, $trans_no, $date_, -$total);
270         else    // in this case those are exchange variances between bank and home rates
271                 add_gl_trans($trans_type, $trans_no, $date_, get_company_pref('exchange_diff_act'),
272                         0, 0, _("Exchange Variance"), -$total);
273         
274         add_bank_trans($trans_type, $trans_no, $to_account, $ref,
275                 $date_, $to_amount, 0, PT_MISC, $person_id);
276
277         if ($SysPrefs->auto_currency_revaluation())
278         {
279                 $currency = get_bank_account_currency($to_account);
280                 if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,     
281                         $currency, PT_MISC, $person_id))
282                         $exchanged = true;
283         }
284         if ($exchanged == true)
285         {
286                 $ref1 = $Refs->get_next(ST_JOURNAL, null, $date_);
287                 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
288                 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
289         }
290         add_comments($trans_type, $trans_no, $date_, $memo_);
291
292         $Refs->save($trans_type, $trans_no, $ref);
293         add_audit_trail($trans_type, $trans_no, $date_);
294
295         $args->trans_no = $trans_no;
296         hook_db_postwrite($args, ST_BANKTRANSFER);
297         commit_transaction();
298
299         return $trans_no;
300 }
301
302 function check_bank_transfer($trans_no, $from_account, $to_account, $date_,
303     $amount, $target_amount=0)
304 {
305         $dbResult = get_bank_trans(ST_BANKTRANSFER, $trans_no);
306
307         $old_from = db_fetch($dbResult);
308         $old_to = db_fetch($dbResult);
309         if ($old_to['amount'] < 0.0) {
310                 $tmp = $old_from;
311                 $old_from = $old_to;
312                 $old_to = $tmp;
313         }
314         // There are four accounts to consider:
315         // 1) The original from account that is being voided. This results in funds being put back which is always fine.
316         // 2) The original to account that is being voided. This results in funds being removed which may result in a
317         //    negative balance in the account at some time and therefore needs to be checked.
318         $problemTransaction = check_bank_account_history(-$old_to['amount'], $old_to['bank_act'], sql2date($old_from['trans_date']));
319         if ($problemTransaction) {
320                 // If the destination account is the same as that being edited, it may be that this edit will resolve the
321                 // problem of voiding.
322                 if ($to_account == $old_to['bank_act'] && sql_date_comp($problemTransaction['trans_date'], date2sql($date_)) > 0) {
323                         $problemTransaction['amount'] += $amount;
324                         if ($problemTransaction['amount'] >= 0) {
325                                 $problemTransaction = null;
326                         }
327                 }
328                 if ($problemTransaction != null) {
329                         $problemTransaction['account'] = $old_to['bank_act'];
330                         $problemTransaction['bank_account_name'] = $old_to['bank_account_name'];
331                         return $problemTransaction;
332                 }
333         }
334
335         // 3) The edited from account, that is having funds removed which may result in a
336         //    negative balance in the account at some time and therefore needs to be checked.
337         $balance_offset = 0;
338         if ($from_account == $old_from['bank_act'] && sql_date_comp(date2sql($date_), $old_from['trans_date']) >= 0) {
339                 // If the edited from_account is the same as the original transaction, and the new date is later than the old date
340                 // then add the amount from the original from transaction when checking the history to simulate the void that would
341                 // take effect from that date.
342                 $balance_offset = -$old_from['amount'];
343         }
344         $problemTransaction = check_bank_account_history(-$amount, $from_account, $date_, null, $balance_offset);
345         if ($problemTransaction != null) {
346                 $problemTransaction['account'] = $old_from['bank_act'];
347                 $problemTransaction['bank_account_name'] = $old_from['bank_account_name'];
348                 return $problemTransaction;
349         }
350         // 4) The edited to account, that is having funds added which is always ok.
351
352         return $problemTransaction;
353 }
354
355 function update_bank_transfer(
356         $trans_no, $from_account, $to_account, $date_,
357         $amount, $ref, $memo_, $charge=0, $target_amount=0)
358 {
359         begin_transaction(__FUNCTION__, func_get_args());
360         delete_comments(ST_BANKTRANSFER, $trans_no);
361         void_transaction(ST_BANKTRANSFER, $trans_no, Today(), _("Document reentered."));
362         void_gl_trans(ST_BANKTRANSFER, $trans_no, true);
363         $new_trans_no = add_bank_transfer(
364                 $from_account, $to_account, $date_, $amount, $charge,
365                 $ref, $memo_, $charge, $target_amount
366         );
367         commit_transaction();
368         return $new_trans_no;
369 }
370
371 //----------------------------------------------------------------------------------
372 //      Add bank payment or deposit to database.
373 //
374 //      $from_account - bank account id
375 //  $items - transaction cart (line amounts in bank account's currency); negative for deposit
376 //  $person_type_id - defines type of $person_id identifiers
377 //  $person_id  - supplier/customer/other id
378 //  $person_detail_id - customer branch id or not used
379 //  $settled_amount - settled amount in AR/AP (if applicable) in customer/supplier currency (always non-negative number)
380 //
381 // returns an array of (inserted trans type, trans no)
382 //
383 // FIXME -revise code for update case
384 //
385 function write_bank_transaction(&$cart)
386 {
387         global $Refs, $SysPrefs;
388
389         $trans_type = $cart->trans_type;
390         $trans_no = $cart->order_id;
391         $from_account = $cart->bank_act;
392         $person_type_id = $cart->person_type_id;
393         $person_id = $cart->person_id;
394         $ref = $cart->reference;
395
396         $do_exchange_variance = false;
397         $exchanged = false;
398
399         begin_transaction(__FUNCTION__, $args = func_get_args());
400
401         hook_db_prewrite($args, $trans_type);
402
403         $aid = 0;
404         if ($trans_no) {
405                 $old_trans = $trans_no;
406                 $Refs->restore_last($trans_type, $trans_no);
407                 $aid = has_attachment($trans_type, $trans_no);
408         } else
409                 $old_trans = false;
410
411         $currency = get_bank_account_currency($from_account);
412         $bank_gl_account = get_bank_gl_account($from_account);
413
414         // the gl items are already inversed/negated for type 2 (deposit)
415         $total_amount = $cart->gl_items_total();
416
417     if ($person_type_id == PT_CUSTOMER)
418     {
419         // we need to add a customer transaction record
420                 // convert to customer currency
421                 if (!isset($cart->settled_amount)) // leaved for backward/ext compatibility 
422                         $cust_amount = exchange_from_to(abs($total_amount), $currency, get_customer_currency($person_id), $cart->tran_date);
423                 else
424                         $cust_amount = $cart->settled_amount;
425
426                 if ($trans_type == ST_BANKPAYMENT)
427                         $cust_amount = -$cust_amount;
428
429                 $trans_no = write_customer_trans($trans_type, 0, $person_id, $cart->person_detail_id, $cart->tran_date,
430                 $ref, $cust_amount);
431                 if ($old_trans)
432                         move_trans_attachments($trans_type, $old_trans, $trans_no);
433     }
434     elseif ($person_type_id == PT_SUPPLIER)
435     {
436         // we need to add a supplier transaction record
437                 // convert to supp currency
438                 if (!isset($cart->settled_amount)) // leaved for for backward/ext compatibility 
439                         $supp_amount = exchange_from_to(abs($total_amount), $currency, get_supplier_currency($person_id), $cart->tran_date);
440                 else
441                         $supp_amount = $cart->settled_amount;
442
443                 if ($trans_type == ST_BANKPAYMENT)
444                         $supp_amount = -$supp_amount;
445
446                 $trans_no = write_supp_trans($trans_type, 0, $person_id, $cart->tran_date, '',
447                         $ref, "", $supp_amount, 0, 0);
448                 if ($old_trans)
449                         move_trans_attachments($trans_type, $old_trans, $trans_no);
450     }
451     else
452     {
453                 $trans_no = get_next_trans_no($trans_type);
454         $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
455         if ($do_exchange_variance)
456                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
457     }
458         if ($aid != 0)
459         {
460                 $row = get_attachment($aid);
461                 update_attachment($aid, $row['type_no'], $trans_no, $row['description'],
462                         $row['filename'], $row['unique_name'], $row['filesize'], $row['filetype']);
463         }
464         // do the source account postings
465
466     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
467         $cart->tran_date, -$total_amount, 0,
468         $person_type_id, $person_id,
469         $currency);
470         $total = 0;
471         foreach ($cart->gl_items as $gl_item)
472         {
473                 $is_bank_to = is_bank_account($gl_item->code_id);
474
475                 if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
476                 {
477                         // we don't allow payments to go to a bank account. use transfer for this !
478                         display_db_error("invalid payment entered. Cannot pay to another bank account", "");
479                 }
480
481         // do the destination account postings
482         $total += add_gl_trans($trans_type, $trans_no, $cart->tran_date, $gl_item->code_id,
483                 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
484                 $gl_item->amount, $currency, $person_type_id, $person_id);
485
486         if ($is_bank_to)
487         {
488                 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
489                         $cart->tran_date, $gl_item->amount, 0,
490                         $person_type_id, $person_id, $currency);
491                 if ($do_exchange_variance)
492                 {
493                         add_exchange_variation($trans_no1, $cart->tran_date, $is_bank_to, $gl_item->code_id, 
494                                 $currency, $person_type_id, $person_id);
495                 }
496         }
497                 // store tax details if the gl account is a tax account
498
499                 $amount = $gl_item->amount;
500                 $ex_rate = get_exchange_rate_from_home_currency($currency, $cart->tran_date);
501
502                 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
503                         $ex_rate, $cart->tran_date, $cart->memo_);
504         }
505
506         // do the source account postings
507     add_gl_trans($trans_type, $trans_no, $cart->tran_date, $bank_gl_account, 0, 0, $cart->memo_,
508         -$total, null, $person_type_id, $person_id);
509
510     if ($do_exchange_variance)
511     {
512         if ($exchanged || add_exchange_variation($trans_no1, $cart->tran_date, $from_account, $bank_gl_account, 
513                 $currency, $person_type_id, $person_id))
514         {
515                         $ref1 = $Refs->get_next(ST_JOURNAL, null, $cart->tran_date);
516                         $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
517                         add_audit_trail(ST_JOURNAL, $trans_no1, $cart->tran_date);
518                 }
519         }
520
521         add_comments($trans_type, $trans_no, $cart->tran_date, $cart->memo_);
522
523         $Refs->save($trans_type, $trans_no, $ref);
524         add_audit_trail($trans_type, $trans_no, $cart->tran_date);
525
526         // old transaction can be voided only after new transaction is entered,
527         //  otherwise the operation could fail for cash accounts due to temporary negative balance
528         if ($old_trans) 
529         {
530                 $msg = void_transaction($trans_type, $old_trans, Today(), _("Document reentered."));
531                 if ($msg)
532                 {
533                         display_error($msg);
534                         return false;
535                 }
536         }
537
538         $cart->order_id = $trans_no;
539         hook_db_postwrite($args, $trans_type);
540
541         commit_transaction();
542
543 }