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