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 = "")
15 if (is_company_currency($currency))
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 // 2010-02-23 Joe Hunt with help of Ary Wibowo
24 $sql = "SELECT SUM(bt.amount) AS for_amount, ba.bank_curr_code
25 FROM ".TB_PREF."bank_trans bt, ".TB_PREF."bank_accounts ba
26 WHERE ba.id = bt.bank_act AND ba.account_code = ".db_escape($account)." AND bt.trans_date<='".date2sql($date_)."'
27 GROUP BY ba.bank_curr_code";
28 $result = db_query($sql, "Transactions for bank account $acc_id could not be calculated");
29 while ($row = db_fetch($result))
31 if ($row['for_amount'] == 0)
33 $rate = get_exchange_rate_from_home_currency($row['bank_curr_code'], $date_);
34 $for_amount += round2($row['for_amount'] * $rate, user_price_dec());
36 $amount = get_gl_trans_from_to("", $date_, $account);
37 $diff = $amount - $for_amount;
38 if (floatcmp($diff,0))
40 if ($trans_no == null)
41 $trans_no = get_next_trans_no(ST_JOURNAL);
42 if ($person_type_id == null)
43 $person_type_id = PT_MISC;
44 add_gl_trans(ST_JOURNAL, $trans_no, $date_, $account, 0, 0, _("Exchange Variance"),
45 -$diff, null, $person_type_id, $person_id);
46 add_gl_trans(ST_JOURNAL, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0,
47 _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
53 //------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
54 function add_cust_supp_revaluation($ledger_act, $ex_act, $date, $amount, $person_type_id, $person_id, $memo)
59 $trans_no = get_next_trans_no(ST_JOURNAL);
60 add_gl_trans(ST_JOURNAL, $trans_no, $date, $ledger_act, 0, 0, _("Exchange Variance"),
61 $amount, null, $person_type_id, $person_id);
62 add_gl_trans(ST_JOURNAL, $trans_no, $date, $ex_act, 0, 0,
63 _("Exchange Variance"), -$amount, null, $person_type_id, $person_id);
64 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
65 $ref = $Refs->get_next(ST_JOURNAL);
66 $Refs->save(ST_JOURNAL, $trans_no, $ref);
67 add_audit_trail(ST_JOURNAL, $trans_no, $date);
70 function get_cust_account_curr_balances($date)
72 $to = date2sql($date);
74 $sql = "SELECT SUM(IF(t.type =".ST_CUSTCREDIT." OR t.type = ".ST_CUSTPAYMENT." OR t.type = ".ST_BANKDEPOSIT.",
75 -(t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount),
76 (t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount))) AS amount,
77 dt.debtor_no, dt.name, dt.curr_code, b.receivables_account
78 FROM ".TB_PREF."debtor_trans t
79 LEFT JOIN ".TB_PREF."debtors_master dt ON t.debtor_no = dt.debtor_no
80 LEFT JOIN ".TB_PREF."cust_branch b ON t.debtor_no = b.debtor_no
81 LEFT JOIN ".TB_PREF."voided as v ON v.type = t.type and v.id=t.trans_no
82 WHERE ISNULL(v.date_) AND t.type <> ".ST_CUSTDELIVERY." AND t.tran_date <= '$to'
83 AND t.branch_code=b.branch_code AND dt.curr_code<>'".get_company_pref('curr_default')."'
84 GROUP BY t.debtor_no, b.receivables_account";
86 $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
90 function get_supp_account_curr_balances($date)
92 $to = date2sql($date);
94 $sql = "SELECT SUM(-(t.ov_amount + t.ov_gst + t.ov_discount)) AS amount,
95 supp.supplier_id, supp.supp_name, supp.curr_code, supp.payable_account
96 FROM ".TB_PREF."supp_trans t
97 LEFT JOIN ".TB_PREF."suppliers supp ON t.supplier_id = supp.supplier_id
98 LEFT JOIN ".TB_PREF."voided as v ON v.type = t.type and v.id=t.trans_no
99 WHERE ISNULL(v.date_) AND t.tran_date <= '$to'
100 AND supp.curr_code<>'".get_company_pref('curr_default')."'
101 GROUP BY t.supplier_id";
103 $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
107 function get_account_home_balance($person_id, $person_type, $rec_account, $to_date)
109 $to = date2sql($to_date);
111 $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans
112 WHERE person_id=".db_escape($person_id)." AND account='$rec_account'
113 AND person_type_id=$person_type AND tran_date <= '$to'";
114 $result = db_query($sql, "The AR/AP balance for customer $person_id could not be calculated");
115 $row = db_fetch_row($result);
118 //------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
120 function add_exchange_variation_all($date=null, $ref="", $memo)
125 $trans_no = get_next_trans_no(ST_JOURNAL);
126 $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
127 $result = db_query($sql, "could not retreive bank accounts");
128 while ($myrow = db_fetch($result))
130 if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
131 $myrow['bank_curr_code']))
136 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
138 $ref = $Refs->get_next(ST_JOURNAL);
139 $Refs->save(ST_JOURNAL, $trans_no, $ref);
140 add_audit_trail(ST_JOURNAL, $trans_no, $date);
143 //------------- BEGIN inserted for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
146 $exchange_act = get_company_pref('exchange_diff_act');
149 $res = get_cust_account_curr_balances($date);
151 while($row = db_fetch($res))
153 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
154 $foreign = round2($row['amount']*$exrate, user_price_dec());
155 $home = round2(get_account_home_balance($row['debtor_no'], PT_CUSTOMER, $row['receivables_account'], $date), user_price_dec());
156 if ($foreign != $home)
158 $amount = $foreign - $home;
159 add_cust_supp_revaluation($row['receivables_account'], $exchange_act, $date, $amount, PT_CUSTOMER,
160 $row['debtor_no'], $memo);
165 $res = get_supp_account_curr_balances($date);
167 while($row = db_fetch($res))
169 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
170 $foreign = round2($row['amount']*$exrate, user_price_dec());
171 $home = round2(get_account_home_balance($row['supplier_id'], PT_SUPPLIER, $row['payable_account'], $date), user_price_dec());
172 if ($foreign != $home)
174 $amount = $foreign - $home;
175 add_cust_supp_revaluation($row['payable_account'], $exchange_act, $date, $amount, PT_SUPPLIER,
176 $row['supplier_id'], $memo);
182 commit_transaction();
183 return array(($exchanged ? $trans_no : 0), $je);
185 //----------------------------------------------------------------------------------
186 // Add bank tranfer to database.
188 // $from_account - source bank account id
189 // $to_account - target bank account id
192 function add_bank_transfer($from_account, $to_account, $date_,
193 $amount, $ref, $memo_, $charge=0, $target_amount=0)
195 global $Refs, $SysPrefs;
198 $args = func_get_args(); if (count($args) < 8) $args[] = 0;
199 $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
200 'ref', 'memo_', 'charge', 'target_amount'), $args);
202 hook_db_prewrite($args, ST_BANKTRANSFER);
204 $trans_type = ST_BANKTRANSFER;
206 $currency = get_bank_account_currency($from_account);
208 $trans_no = get_next_trans_no($trans_type);
210 $fromact = get_bank_account($from_account);
211 $toact = get_bank_account($to_account);
212 $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
214 $from_gl_account = get_bank_gl_account($from_account);
215 $to_gl_account = get_bank_gl_account($to_account);
219 // do the source account postings
220 $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
221 -($amount + $charge), $currency);
223 add_bank_trans($trans_type, $trans_no, $from_account, $ref,
224 $date_, -($amount + $charge),
225 PT_MISC, $person_id, $currency,
226 "Cannot insert a source bank transaction");
227 if ($SysPrefs->auto_currency_revaluation())
229 $trans_no1 = get_next_trans_no(ST_JOURNAL);
230 if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account,
231 $currency, PT_MISC, $person_id))
236 /* Now Debit bank charge account with charges */
237 $charge_act = get_bank_charge_account($from_account);
238 $total += add_gl_trans($trans_type, $trans_no, $date_,
239 $charge_act, 0, 0, $person_id, $charge, $currency);
242 // provide backward compatibility for extension modules (target amount can be not passed)
243 $to_currency = $target_amount ? $toact['bank_curr_code'] : $currency;
244 $to_amount = $target_amount ? $target_amount : $amount;
246 // do the destination account postings
247 $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
248 $to_amount, $to_currency);
250 /*Post a balance post if $total != 0 */
251 if ($currency == $to_currency)
252 add_gl_balance($trans_type, $trans_no, $date_, -$total);
253 else // in this case those are exchange variances between bank and home rates
254 add_gl_trans($trans_type, $trans_no, $date_, get_company_pref('exchange_diff_act'),
255 0, 0, _("Exchange Variance"), -$total);
257 add_bank_trans($trans_type, $trans_no, $to_account, $ref,
258 $date_, $to_amount, PT_MISC, $person_id,
259 $to_currency, "Cannot insert a destination bank transaction");
261 if ($SysPrefs->auto_currency_revaluation())
263 $currency = get_bank_account_currency($to_account);
264 if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,
265 $currency, PT_MISC, $person_id))
268 if ($exchanged == true)
270 $ref1 = $Refs->get_next(ST_JOURNAL);
271 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
272 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
274 add_comments($trans_type, $trans_no, $date_, $memo_);
276 $Refs->save($trans_type, $trans_no, $ref);
277 add_audit_trail($trans_type, $trans_no, $date_);
279 $args->trans_no = $trans_no;
280 hook_db_postwrite($args, ST_BANKTRANSFER);
281 commit_transaction();
286 function check_bank_transfer(
287 $trans_no, $from_account, $to_account, $date_,
288 $amount, $target_amount=0)
290 $dbResult = get_bank_trans(ST_BANKTRANSFER, $trans_no);
291 if (2 != db_num_rows($dbResult)) {
292 // How are errors handled? Throw an exception would be nice. CP 2014-10
295 $old_from = db_fetch($dbResult);
296 $old_to = db_fetch($dbResult);
297 if ($old_to['amount'] < 0.0) {
302 // There are four accounts to consider:
303 // 1) The original from account that is being voided. This results in funds being put back which is always fine.
304 // 2) The original to account that is being voided. This results in funds being removed which may result in a
305 // negative balance in the account at some time and therefore needs to be checked.
306 $problemTransaction = check_bank_account_history(-$old_to['amount'], $old_to['bank_act'], sql2date($old_to['trans_date']));
307 if ($problemTransaction) {
308 // If the destination account is the same as that being edited, it may be that this edit will resolve the
309 // problem of voiding.
310 if ($to_account == $old_to['bank_act'] && sql_date_comp($problemTransaction['trans_date'], date2sql($date_)) >= 0) {
311 $problemTransaction = check_bank_account_history($target_amount-$old_to['amount'], $to_account, $date_);
314 if (null != $problemTransaction) {
315 $problemTransaction['account'] = $old_to['bank_act'];
316 $problemTransaction['bank_account_name'] = $old_to['bank_account_name'];
317 return $problemTransaction;
320 // 3) The edited from account, that is having funds removed which may result in a
321 // negative balance in the account at some time and therefore needs to be checked.
322 $problemTransaction = check_bank_account_history(-$amount, $from_account, $date_);
323 if ($problemTransaction) {
324 // If the target account is the same as that being edited, it may be that voiding old transfer will
325 // solve balance problem.
327 if ($from_account == $old_from['bank_act'] && sql_date_comp($problemTransaction['trans_date'], $old_from['trans_date']) >=0 ) {
328 $problemTransaction = check_bank_account_history(-$amount-$old_from['amount'], $from_account, $date_);
332 if (null != $problemTransaction) {
333 $problemTransaction['account'] = $old_from['bank_act'];
334 $problemTransaction['bank_account_name'] = $old_from['bank_account_name'];
335 return $problemTransaction;
337 // 4) The edited to account, that is having funds added which is always ok.
339 return $problemTransaction;
343 function update_bank_transfer(
344 $trans_no, $from_account, $to_account, $date_,
345 $amount, $ref, $memo_, $charge=0, $target_amount=0)
348 delete_comments(ST_BANKTRANSFER, $trans_no);
349 void_bank_trans(ST_BANKTRANSFER, $trans_no, true);
350 void_gl_trans(ST_BANKTRANSFER, $trans_no, true);
351 $new_trans_no = add_bank_transfer(
352 $from_account, $to_account, $date_, $amount,
353 $ref, $memo_, $charge, $target_amount
355 commit_transaction();
356 return $new_trans_no;
359 //----------------------------------------------------------------------------------
360 // Add bank payment or deposit to database.
362 // $from_account - bank account id
363 // $items - transaction cart (line amounts in bank account's currency); negative for deposit
364 // $person_type_id - defines type of $person_id identifiers
365 // $person_id - supplier/customer/other id
366 // $person_detail_id - customer branch id or not used
367 // $settled_amount - settled amount in AR/AP (if applicable) in customer/supplier currency (always non-negative number)
369 // returns an array of (inserted trans type, trans no)
371 // FIXME -revise code for update case
373 function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
374 $person_type_id, $person_id, $person_detail_id, $ref, $memo_, $use_transaction=true, $settled_amount=null)
376 global $Refs, $SysPrefs;
378 // we can only handle type 1 (payment)and type 2 (deposit)
379 if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
380 display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
382 $do_exchange_variance = false;
384 if ($use_transaction)
387 $args = func_get_args(); if (count($args) < 11) $args[] = true;
388 $args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
389 'person_type_id', 'person_id', 'person_detail_id', 'ref', 'memo_', 'use_transaction', 'settled_amount'),
391 hook_db_prewrite($args, $trans_type);
395 $old_trans = $trans_no;
396 $Refs->restore_last($trans_type, $trans_no);
397 $aid = has_attachment($trans_type, $trans_no);
400 $currency = get_bank_account_currency($from_account);
401 $bank_gl_account = get_bank_gl_account($from_account);
403 // the gl items are already inversed/negated for type 2 (deposit)
404 $total_amount = $items->gl_items_total();
406 if ($person_type_id == PT_CUSTOMER)
408 // we need to add a customer transaction record
409 // convert to customer currency
410 if (!isset($settled_amount)) // leaved for backward/ext compatibility
411 $cust_amount = exchange_from_to(abs($total_amount), $currency, get_customer_currency($person_id), $date_);
413 $cust_amount = $settled_amount;
415 if ($trans_type == ST_BANKPAYMENT)
416 $cust_amount = -$cust_amount;
418 $trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
422 elseif ($person_type_id == PT_SUPPLIER)
424 // we need to add a supplier transaction record
425 // convert to supp currency
426 if (!isset($settled_amount)) // leaved for for backward/ext compatibility
427 $supp_amount = exchange_from_to(abs($total_amount), $currency, get_supplier_currency($person_id), $date_);
429 $supp_amount = $settled_amount;
431 if ($trans_type == ST_BANKPAYMENT)
432 $supp_amount = -$supp_amount;
434 $trans_no = write_supp_trans($trans_type, 0, $person_id, $date_, '',
435 $ref, "", $supp_amount, 0, 0);
440 $trans_no = get_next_trans_no($trans_type);
441 $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
442 if ($do_exchange_variance)
443 $trans_no1 = get_next_trans_no(ST_JOURNAL);
447 $row = get_attachment($aid);
448 update_attachment($aid, $row['type_no'], $trans_no, $row['description'],
449 $row['filename'], $row['unique_name'], $row['filesize'], $row['filetype']);
451 // do the source account postings
453 add_bank_trans($trans_type, $trans_no, $from_account, $ref,
454 $date_, -$total_amount,
455 $person_type_id, $person_id,
457 "Cannot insert a source bank transaction");
459 foreach ($items->gl_items as $gl_item)
461 $is_bank_to = is_bank_account($gl_item->code_id);
463 if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
465 // we don't allow payments to go to a bank account. use transfer for this !
466 display_db_error("invalid payment entered. Cannot pay to another bank account", "");
469 // do the destination account postings
470 $total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
471 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
472 $gl_item->amount, $currency, $person_type_id, $person_id);
476 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
477 $date_, $gl_item->amount,
478 $person_type_id, $person_id, $currency,
479 "Cannot insert a destination bank transaction");
480 if ($do_exchange_variance)
482 add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id,
483 $currency, $person_type_id, $person_id);
486 // store tax details if the gl account is a tax account
488 $amount = $gl_item->amount;
489 $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
491 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
492 $ex_rate, $date_, $memo_);
495 // do the source account postings
496 add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
497 -$total, null, $person_type_id, $person_id);
499 if ($do_exchange_variance)
501 if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account,
502 $currency, $person_type_id, $person_id))
504 $ref1 = $Refs->get_next(ST_JOURNAL);
505 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
506 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
510 add_comments($trans_type, $trans_no, $date_, $memo_);
512 $Refs->save($trans_type, $trans_no, $ref);
513 add_audit_trail($trans_type, $trans_no, $date_);
515 // old transaction can be voided only after new transaction is entered,
516 // otherwise the operation could fail for cash accounts due to temporary negative balance
518 void_transaction($trans_type, $old_trans, Today(), _("Document reentered."));
520 $args->trans_no = $trans_no;
521 hook_db_postwrite($args, $trans_type);
522 if ($use_transaction)
523 commit_transaction();
525 return array($trans_type, $trans_no);