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 $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))
30 if ($row['for_amount'] == 0)
32 $rate = get_exchange_rate_from_home_currency($row['bank_curr_code'], $date_);
33 $for_amount += round2($row['for_amount'] * $rate, user_price_dec());
35 $amount = get_gl_trans_from_to("", $date_, $account);
36 $diff = $amount - $for_amount;
37 if (floatcmp($diff,0))
39 // generate journal entry // FIXME: use cart?
43 $trans_no = get_next_trans_no(ST_JOURNAL);
44 $ref = $Refs->get_next(ST_JOURNAL);
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_);
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);
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);
63 function add_cust_supp_revaluation($ledger_act, $ex_act, $date, $amount, $person_type_id, $person_id, $memo)
70 $trans_no = get_next_trans_no(ST_JOURNAL);
71 $ref = $Refs->get_next(ST_JOURNAL);
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);
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);
85 function get_cust_account_curr_balances($date)
87 $to = date2sql($date);
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";
101 $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
105 function get_supp_account_curr_balances($date)
107 $to = date2sql($date);
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";
118 $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
122 function get_account_home_balance($person_id, $person_type, $rec_account, $to_date)
124 $to = date2sql($to_date);
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);
133 //------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
135 function add_exchange_variation_all($date=null, $ref="", $memo)
140 $trans_no = get_next_trans_no(ST_JOURNAL);
141 $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
142 $result = db_query($sql, "could not retreive bank accounts");
143 while ($myrow = db_fetch($result))
145 if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
146 $myrow['bank_curr_code']))
151 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
153 $ref = $Refs->get_next(ST_JOURNAL, null, $date);
154 $Refs->save(ST_JOURNAL, $trans_no, $ref);
155 add_audit_trail(ST_JOURNAL, $trans_no, $date);
158 //------------- BEGIN inserted for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
161 $exchange_act = get_company_pref('exchange_diff_act');
164 $res = get_cust_account_curr_balances($date);
166 while($row = db_fetch($res))
168 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
169 $foreign = round2($row['amount']*$exrate, user_price_dec());
170 $home = round2(get_account_home_balance($row['debtor_no'], PT_CUSTOMER, $row['receivables_account'], $date), user_price_dec());
171 if ($foreign != $home)
173 $amount = $foreign - $home;
174 add_cust_supp_revaluation($row['receivables_account'], $exchange_act, $date, $amount, PT_CUSTOMER,
175 $row['debtor_no'], $memo);
180 $res = get_supp_account_curr_balances($date);
182 while($row = db_fetch($res))
184 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
185 $foreign = round2($row['amount']*$exrate, user_price_dec());
186 $home = round2(get_account_home_balance($row['supplier_id'], PT_SUPPLIER, $row['payable_account'], $date), user_price_dec());
187 if ($foreign != $home)
189 $amount = $foreign - $home;
190 add_cust_supp_revaluation($row['payable_account'], $exchange_act, $date, $amount, PT_SUPPLIER,
191 $row['supplier_id'], $memo);
197 commit_transaction();
198 return array(($exchanged ? $trans_no : 0), $je);
200 //----------------------------------------------------------------------------------
201 // Add bank tranfer to database.
203 // $from_account - source bank account id
204 // $to_account - target bank account id
207 function add_bank_transfer($from_account, $to_account, $date_,
208 $amount, $ref, $memo_, $charge=0, $target_amount=0)
210 global $Refs, $SysPrefs;
213 $args = func_get_args(); if (count($args) < 8) $args[] = 0;
214 $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
215 'ref', 'memo_', 'charge', 'target_amount'), $args);
217 hook_db_prewrite($args, ST_BANKTRANSFER);
219 $trans_type = ST_BANKTRANSFER;
221 $currency = get_bank_account_currency($from_account);
223 $trans_no = get_next_trans_no($trans_type);
225 $fromact = get_bank_account($from_account);
226 $toact = get_bank_account($to_account);
227 $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
229 $from_gl_account = get_bank_gl_account($from_account);
230 $to_gl_account = get_bank_gl_account($to_account);
234 // do the source account postings
235 $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
236 -($amount + $charge), $currency);
238 add_bank_trans($trans_type, $trans_no, $from_account, $ref,
239 $date_, -($amount + $charge),
240 PT_MISC, $person_id, $currency,
241 "Cannot insert a source bank transaction");
242 if ($SysPrefs->auto_currency_revaluation())
244 $trans_no1 = get_next_trans_no(ST_JOURNAL);
245 if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account,
246 $currency, PT_MISC, $person_id))
251 /* Now Debit bank charge account with charges */
252 $charge_act = get_bank_charge_account($from_account);
253 $total += add_gl_trans($trans_type, $trans_no, $date_,
254 $charge_act, 0, 0, $person_id, $charge, $currency);
257 // provide backward compatibility for extension modules (target amount can be not passed)
258 $to_currency = $target_amount ? $toact['bank_curr_code'] : $currency;
259 $to_amount = $target_amount ? $target_amount : $amount;
261 // do the destination account postings
262 $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
263 $to_amount, $to_currency);
265 /*Post a balance post if $total != 0 */
266 if ($currency == $to_currency)
267 add_gl_balance($trans_type, $trans_no, $date_, -$total);
268 else // in this case those are exchange variances between bank and home rates
269 add_gl_trans($trans_type, $trans_no, $date_, get_company_pref('exchange_diff_act'),
270 0, 0, _("Exchange Variance"), -$total);
272 add_bank_trans($trans_type, $trans_no, $to_account, $ref,
273 $date_, $to_amount, PT_MISC, $person_id,
274 $to_currency, "Cannot insert a destination bank transaction");
276 if ($SysPrefs->auto_currency_revaluation())
278 $currency = get_bank_account_currency($to_account);
279 if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,
280 $currency, PT_MISC, $person_id))
283 if ($exchanged == true)
285 $ref1 = $Refs->get_next(ST_JOURNAL, null, $date_);
286 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
287 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
289 add_comments($trans_type, $trans_no, $date_, $memo_);
291 $Refs->save($trans_type, $trans_no, $ref);
292 add_audit_trail($trans_type, $trans_no, $date_);
294 $args->trans_no = $trans_no;
295 hook_db_postwrite($args, ST_BANKTRANSFER);
296 commit_transaction();
301 function check_bank_transfer($trans_no, $from_account, $to_account, $date_,
302 $amount, $target_amount=0)
304 $dbResult = get_bank_trans(ST_BANKTRANSFER, $trans_no);
306 $old_from = db_fetch($dbResult);
307 $old_to = db_fetch($dbResult);
308 if ($old_to['amount'] < 0.0) {
313 // There are four accounts to consider:
314 // 1) The original from account that is being voided. This results in funds being put back which is always fine.
315 // 2) The original to account that is being voided. This results in funds being removed which may result in a
316 // negative balance in the account at some time and therefore needs to be checked.
317 $problemTransaction = check_bank_account_history(-$old_to['amount'], $old_to['bank_act'], sql2date($old_from['trans_date']));
318 if ($problemTransaction) {
319 // If the destination account is the same as that being edited, it may be that this edit will resolve the
320 // problem of voiding.
321 if ($to_account == $old_to['bank_act'] && sql_date_comp($problemTransaction['trans_date'], date2sql($date_)) > 0) {
322 $problemTransaction['amount'] += $amount;
323 if ($problemTransaction['amount'] >= 0) {
324 $problemTransaction = null;
327 if ($problemTransaction != null) {
328 $problemTransaction['account'] = $old_to['bank_act'];
329 $problemTransaction['bank_account_name'] = $old_to['bank_account_name'];
330 return $problemTransaction;
334 // 3) The edited from account, that is having funds removed which may result in a
335 // negative balance in the account at some time and therefore needs to be checked.
337 if ($from_account == $old_from['bank_act'] && sql_date_comp(date2sql($date_), $old_from['trans_date']) >= 0) {
338 // If the edited from_account is the same as the original transaction, and the new date is later than the old date
339 // then add the amount from the original from transaction when checking the history to simulate the void that would
340 // take effect from that date.
341 $balance_offset = -$old_from['amount'];
343 $problemTransaction = check_bank_account_history(-$amount, $from_account, $date_, null, $balance_offset);
344 if ($problemTransaction != null) {
345 $problemTransaction['account'] = $old_from['bank_act'];
346 $problemTransaction['bank_account_name'] = $old_from['bank_account_name'];
347 return $problemTransaction;
349 // 4) The edited to account, that is having funds added which is always ok.
351 return $problemTransaction;
354 function update_bank_transfer(
355 $trans_no, $from_account, $to_account, $date_,
356 $amount, $ref, $memo_, $charge=0, $target_amount=0)
359 delete_comments(ST_BANKTRANSFER, $trans_no);
360 void_transaction(ST_BANKTRANSFER, $trans_no, Today(), _("Document reentered."));
361 void_gl_trans(ST_BANKTRANSFER, $trans_no, true);
362 $new_trans_no = add_bank_transfer(
363 $from_account, $to_account, $date_, $amount,
364 $ref, $memo_, $charge, $target_amount
366 commit_transaction();
367 return $new_trans_no;
370 //----------------------------------------------------------------------------------
371 // Add bank payment or deposit to database.
373 // $from_account - bank account id
374 // $items - transaction cart (line amounts in bank account's currency); negative for deposit
375 // $person_type_id - defines type of $person_id identifiers
376 // $person_id - supplier/customer/other id
377 // $person_detail_id - customer branch id or not used
378 // $settled_amount - settled amount in AR/AP (if applicable) in customer/supplier currency (always non-negative number)
380 // returns an array of (inserted trans type, trans no)
382 // FIXME -revise code for update case
384 function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
385 $person_type_id, $person_id, $person_detail_id, $ref, $memo_, $use_transaction=true, $settled_amount=null)
387 global $Refs, $SysPrefs;
389 // we can only handle type 1 (payment)and type 2 (deposit)
390 if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
391 display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
393 $do_exchange_variance = false;
395 if ($use_transaction)
398 $args = func_get_args(); if (count($args) < 11) $args[] = true;
399 $args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
400 'person_type_id', 'person_id', 'person_detail_id', 'ref', 'memo_', 'use_transaction', 'settled_amount'),
402 hook_db_prewrite($args, $trans_type);
406 $old_trans = $trans_no;
407 $Refs->restore_last($trans_type, $trans_no);
408 $aid = has_attachment($trans_type, $trans_no);
412 $currency = get_bank_account_currency($from_account);
413 $bank_gl_account = get_bank_gl_account($from_account);
415 // the gl items are already inversed/negated for type 2 (deposit)
416 $total_amount = $items->gl_items_total();
418 if ($person_type_id == PT_CUSTOMER)
420 // we need to add a customer transaction record
421 // convert to customer currency
422 if (!isset($settled_amount)) // leaved for backward/ext compatibility
423 $cust_amount = exchange_from_to(abs($total_amount), $currency, get_customer_currency($person_id), $date_);
425 $cust_amount = $settled_amount;
427 if ($trans_type == ST_BANKPAYMENT)
428 $cust_amount = -$cust_amount;
430 $trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
433 move_trans_attachments($trans_type, $old_trans, $trans_no);
435 elseif ($person_type_id == PT_SUPPLIER)
437 // we need to add a supplier transaction record
438 // convert to supp currency
439 if (!isset($settled_amount)) // leaved for for backward/ext compatibility
440 $supp_amount = exchange_from_to(abs($total_amount), $currency, get_supplier_currency($person_id), $date_);
442 $supp_amount = $settled_amount;
444 if ($trans_type == ST_BANKPAYMENT)
445 $supp_amount = -$supp_amount;
447 $trans_no = write_supp_trans($trans_type, 0, $person_id, $date_, '',
448 $ref, "", $supp_amount, 0, 0);
450 move_trans_attachments($trans_type, $old_trans, $trans_no);
454 $trans_no = get_next_trans_no($trans_type);
455 $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
456 if ($do_exchange_variance)
457 $trans_no1 = get_next_trans_no(ST_JOURNAL);
461 $row = get_attachment($aid);
462 update_attachment($aid, $row['type_no'], $trans_no, $row['description'],
463 $row['filename'], $row['unique_name'], $row['filesize'], $row['filetype']);
465 // do the source account postings
467 add_bank_trans($trans_type, $trans_no, $from_account, $ref,
468 $date_, -$total_amount,
469 $person_type_id, $person_id,
471 "Cannot insert a source bank transaction");
473 foreach ($items->gl_items as $gl_item)
475 $is_bank_to = is_bank_account($gl_item->code_id);
477 if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
479 // we don't allow payments to go to a bank account. use transfer for this !
480 display_db_error("invalid payment entered. Cannot pay to another bank account", "");
483 // do the destination account postings
484 $total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
485 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
486 $gl_item->amount, $currency, $person_type_id, $person_id);
490 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
491 $date_, $gl_item->amount,
492 $person_type_id, $person_id, $currency,
493 "Cannot insert a destination bank transaction");
494 if ($do_exchange_variance)
496 add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id,
497 $currency, $person_type_id, $person_id);
500 // store tax details if the gl account is a tax account
502 $amount = $gl_item->amount;
503 $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
505 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
506 $ex_rate, $date_, $memo_);
509 // do the source account postings
510 add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, $gl_item->dimension_id, $gl_item->dimension2_id, $memo_,
511 -$total, null, $person_type_id, $person_id);
513 if ($do_exchange_variance)
515 if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account,
516 $currency, $person_type_id, $person_id))
518 $ref1 = $Refs->get_next(ST_JOURNAL, null, $date_);
519 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
520 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
524 add_comments($trans_type, $trans_no, $date_, $memo_);
526 $Refs->save($trans_type, $trans_no, $ref);
527 add_audit_trail($trans_type, $trans_no, $date_);
529 // old transaction can be voided only after new transaction is entered,
530 // otherwise the operation could fail for cash accounts due to temporary negative balance
533 $msg = void_transaction($trans_type, $old_trans, Today(), _("Document reentered."));
542 $args->trans_no = $trans_no;
543 hook_db_postwrite($args, $trans_type);
544 if ($use_transaction)
545 commit_transaction();
547 return array($trans_type, $trans_no);