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         // 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))
  30         {
  31                 if ($row['for_amount'] == 0)
  32                         continue;
  33                 $rate = get_exchange_rate_from_home_currency($row['bank_curr_code'], $date_);
  34                 $for_amount += round2($row['for_amount'] * $rate, user_price_dec());
  35         }
  36         $amount = get_gl_trans_from_to("", $date_, $account);
  37         $diff = $amount - $for_amount;
  38         if ($diff != 0)
  39         {
  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);
  48         }
  49         return ($diff != 0);
  50 }
  51
  52 //------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
  53 function add_cust_supp_revaluation($ledger_act, $ex_act, $date, $amount, $person_type_id, $person_id, $memo)
  54 {
  55         global $Refs;
  56         if ($amount == 0)
  57                 return;
  58         $trans_no = get_next_trans_no(ST_JOURNAL);
  59         add_gl_trans(ST_JOURNAL, $trans_no, $date, $ledger_act, 0, 0, _("Exchange Variance"),
  60                 $amount, null, $person_type_id, $person_id);
  61         add_gl_trans(ST_JOURNAL, $trans_no, $date, $ex_act, 0, 0,
  62                 _("Exchange Variance"), -$amount, null, $person_type_id, $person_id);
  63         add_comments(ST_JOURNAL, $trans_no, $date, $memo);
  64         $ref = $Refs->get_next(ST_JOURNAL);
  65         $Refs->save(ST_JOURNAL, $trans_no, $ref);
  66         add_audit_trail(ST_JOURNAL, $trans_no, $date);
  67 }
  68
  69 function get_cust_account_curr_balances($date)
  70 {
  71         $to = date2sql($date);
  72
  73     $sql = "SELECT SUM(IF(t.type =".ST_CUSTCREDIT." OR t.type = ".ST_CUSTPAYMENT." OR t.type = ".ST_BANKDEPOSIT.",
  74                         -(t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount),
  75                 (t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount))) AS amount,
  76                 dt.debtor_no, dt.name, dt.curr_code, b.receivables_account
  77                 FROM ".TB_PREF."debtor_trans t
  78                         LEFT JOIN ".TB_PREF."debtors_master dt ON t.debtor_no = dt.debtor_no
  79                         LEFT JOIN ".TB_PREF."cust_branch b ON t.debtor_no = b.debtor_no
  80                         LEFT JOIN ".TB_PREF."voided as v ON v.type = t.type and v.id=t.trans_no
  81         WHERE ISNULL(v.date_) AND t.type <> ".ST_CUSTDELIVERY." AND t.tran_date <= '$to'
  82                 AND t.branch_code=b.branch_code AND dt.curr_code<>'".get_company_pref('curr_default')."'
  83                 GROUP BY t.debtor_no, b.receivables_account";
  84
  85     $result = db_query($sql,"Open balances in foreign currency for cannot be retrieved");
  86         return  $result;
  87 }
  88
  89 function get_cust_account_home_balance($debtor_no, $rec_account, $to_date)
  90 {
  91         $to = date2sql($to_date);
  92
  93     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans t
  94         LEFT JOIN ".TB_PREF."debtors_master d ON t.person_id = d.debtor_no
  95         LEFT JOIN ".TB_PREF."debtor_trans dt ON (t.type=dt.type AND t.type_no=dt.trans_no)
  96         LEFT JOIN ".TB_PREF."cust_branch br ON dt.branch_code = br.branch_code
  97                         WHERE br.debtor_no=".db_escape($debtor_no)." AND t.account=br.receivables_account AND t.account='$rec_account'
  98                         AND person_id=br.debtor_no AND person_type_id=".PT_CUSTOMER."
  99                         AND t.tran_date <= '$to'";
 100         $result = db_query($sql, "The AR balance for customer $debtor_no could not be calculated");
 101         $row = db_fetch_row($result);
 102         return $row[0];
 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_supp_account_home_balance($supplier_id, $rec_account, $to_date)
 123 {
 124         $to = date2sql($to_date);
 125
 126     $sql = "SELECT SUM(amount) FROM ".TB_PREF."gl_trans t
 127                         WHERE t.person_id=".db_escape($supplier_id)." AND t.account='$rec_account'
 128                         AND person_type_id=".PT_SUPPLIER." AND t.tran_date <= '$to'";
 129         $result = db_query($sql, "The AP balance for customer $supplier_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
 136 function add_exchange_variation_all($date=null, $ref="", $memo)
 137 {
 138         global $Refs;
 139         begin_transaction();
 140         $exchanged = false;
 141         $trans_no = get_next_trans_no(ST_JOURNAL);
 142         $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
 143         $result = db_query($sql, "could not retreive bank accounts");
 144         while ($myrow = db_fetch($result))
 145         {
 146                 if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
 147                         $myrow['bank_curr_code']))
 148                         $exchanged = true;
 149         }
 150         if ($exchanged)
 151         {
 152                 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
 153                 if ($ref == "")
 154                         $ref = $Refs->get_next(ST_JOURNAL);
 155                 $Refs->save(ST_JOURNAL, $trans_no, $ref);
 156                 add_audit_trail(ST_JOURNAL, $trans_no, $date);
 157         }
 158
 159         //------------- BEGIN inserted for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
 160         if ($date == null)
 161                 $date = Today();
 162         // debtors
 163         $exchange_act = get_company_pref('exchange_diff_act');
 164         $res = get_cust_account_curr_balances($date);
 165
 166         while($row = db_fetch($res))
 167         {
 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_cust_account_home_balance($row['debtor_no'], $row['receivables_account'], $date), user_price_dec());
 171                 if ($foreign != $home)
 172                 {
 173                         $amount = $foreign - $home;
 174                         add_cust_supp_revaluation($row['receivables_account'], $exchange_act, $date, $amount, PT_CUSTOMER,
 175                                 $row['debtor_no'], $memo);
 176                 }
 177         }
 178         // creditors
 179         $res = get_supp_account_curr_balances($date);
 180
 181         while($row = db_fetch($res))
 182         {
 183                 $exrate = get_exchange_rate_from_home_currency($row['curr_code'], $date);
 184                 $foreign = round2($row['amount']*$exrate, user_price_dec());
 185                 $home = round2(get_supp_account_home_balance($row['supplier_id'], $row['payable_account'], $date), user_price_dec());
 186                 if ($foreign != $home)
 187                 {
 188                         $amount = $foreign - $home;
 189                         add_cust_supp_revaluation($row['payable_account'], $exchange_act, $date, $amount, PT_SUPPLIER,
 190                                 $row['supplier_id'], $memo);
 191                 }
 192         }
 193         //------------- END
 194
 195         commit_transaction();
 196         return ($exchanged ? $trans_no : 0);
 197 }
 198 //----------------------------------------------------------------------------------
 199 //      Add bank tranfer to database.
 200 //
 201 //      $from_account - source bank account id
 202 //      $to_account   - target bank account id
 203 //
 204
 205 function add_bank_transfer($from_account, $to_account, $date_,
 206         $amount, $ref, $memo_, $charge=0)
 207 {
 208         global $Refs, $SysPrefs;
 209
 210         begin_transaction();
 211         $args = func_get_args(); if (count($args) < 7) $args[] = 0;
 212         $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
 213                 'ref', 'memo_', 'charge'), $args);
 214         $args->trans_no = 0;
 215         hook_db_prewrite($args, ST_BANKTRANSFER);
 216
 217         $trans_type = ST_BANKTRANSFER;
 218
 219         $currency = get_bank_account_currency($from_account);
 220
 221         $trans_no = get_next_trans_no($trans_type);
 222
 223     $fromact = get_bank_account($from_account);
 224     $toact = get_bank_account($to_account);
 225     $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
 226
 227         $from_gl_account = get_bank_gl_account($from_account);
 228         $to_gl_account = get_bank_gl_account($to_account);
 229
 230         $exchanged = false;
 231         $total = 0;
 232         // do the source account postings
 233     $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
 234                 -($amount + $charge), $currency);
 235
 236     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
 237                 $date_, -($amount + $charge),
 238                 PT_MISC, $person_id, $currency,
 239                 "Cannot insert a source bank transaction");
 240         if ($SysPrefs->auto_currency_revaluation())
 241         {
 242                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
 243                 if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account,
 244                         $currency, PT_MISC, $person_id))
 245                         $exchanged = true;
 246         }
 247         if ($charge != 0)
 248         {
 249                 /* Now Debit bank charge account with charges */
 250                 $charge_act = get_company_pref('bank_charge_act');
 251                 $total += add_gl_trans($trans_type, $trans_no, $date_,
 252                         $charge_act, 0, 0, $person_id, $charge, $currency);
 253         }
 254         // do the destination account postings
 255         $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
 256                 $amount, $currency);
 257
 258         /*Post a balance post if $total != 0 */
 259         add_gl_balance($trans_type, $trans_no, $date_, -$total);
 260
 261         add_bank_trans($trans_type, $trans_no, $to_account, $ref,
 262                 $date_, $amount, PT_MISC, $person_id,
 263                 $currency, "Cannot insert a destination bank transaction");
 264
 265         if ($SysPrefs->auto_currency_revaluation())
 266         {
 267                 $currency = get_bank_account_currency($to_account);
 268
 269                 if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,
 270                         $currency, PT_MISC, $person_id))
 271                         $exchanged = true;
 272         }
 273         if ($exchanged == true)
 274         {
 275                 $ref1 = $Refs->get_next(ST_JOURNAL);
 276                 $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
 277                 add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
 278         }
 279         add_comments($trans_type, $trans_no, $date_, $memo_);
 280
 281         $Refs->save($trans_type, $trans_no, $ref);
 282         add_audit_trail($trans_type, $trans_no, $date_);
 283
 284         $args->trans_no = $trans_no;
 285         hook_db_postwrite($args, ST_BANKTRANSFER);
 286         commit_transaction();
 287
 288         return $trans_no;
 289 }
 290 //----------------------------------------------------------------------------------
 291 //      Add bank payment or deposit to database.
 292 //
 293 //      $from_account - bank account id
 294 //  $item - transaction cart (line item's amounts in bank account's currency)
 295 //  $person_type_id - defines type of $person_id identifiers
 296 //  $person_id  - supplier/customer/other id
 297 // $person_detail_id - customer branch id or not used
 298 //
 299 // returns an array of (inserted trans type, trans no)
 300 //
 301 // FIXME -revise code for update case
 302 //
 303 function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
 304         $person_type_id, $person_id, $person_detail_id, $ref, $memo_, $use_transaction=true)
 305 {
 306         global $Refs, $SysPrefs;
 307
 308         // we can only handle type 1 (payment)and type 2 (deposit)
 309         if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
 310                 display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
 311
 312         $do_exchange_variance = false;
 313         $exchanged = false;
 314         if ($use_transaction)
 315                 begin_transaction();
 316
 317         $args = func_get_args(); if (count($args) < 11) $args[] = true;
 318         $args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
 319                 'person_type_id', 'person_id', 'person_detail_id', 'ref', 'memo_', 'use_transaction'),
 320                 $args);
 321         hook_db_prewrite($args, $trans_type);
 322
 323         if ($trans_no)
 324                 clear_bank_transaction($_SESSION['pay_items']->trans_type, $_SESSION['pay_items']->order_id);
 325
 326         $currency = get_bank_account_currency($from_account);
 327         $bank_gl_account = get_bank_gl_account($from_account);
 328
 329         // the gl items are already inversed/negated for type 2 (deposit)
 330         $total_amount = $items->gl_items_total();
 331
 332     if ($person_type_id == PT_CUSTOMER)
 333     {
 334         // we need to add a customer transaction record
 335
 336                 // convert to customer currency
 337                 $cust_amount = exchange_from_to($total_amount, $currency, get_customer_currency($person_id), $date_);
 338                 // we need to negate it too
 339                 $cust_amount = -$cust_amount;
 340
 341                 $trans_no = write_customer_trans($trans_type, $trans_no, $person_id, $person_detail_id, $date_,
 342                 $ref, $cust_amount);
 343
 344     }
 345     elseif ($person_type_id == PT_SUPPLIER)
 346     {
 347         // we need to add a supplier transaction record
 348                 // convert to supp currency
 349                 $supp_amount = exchange_from_to($total_amount, $currency, get_supplier_currency($person_id), $date_);
 350
 351                 // we need to negate it too
 352                 $supp_amount = -$supp_amount;
 353
 354                 $trans_no = write_supp_trans($trans_type, $trans_no, $person_id, $date_, '',
 355                         $ref, "", $supp_amount, 0, 0);
 356
 357     }
 358     else
 359     {
 360         if (!$trans_no)
 361                 $trans_no = get_next_trans_no($trans_type);
 362         $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
 363         if ($do_exchange_variance)
 364                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
 365     }
 366
 367         // do the source account postings
 368
 369     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
 370         $date_, -$total_amount,
 371         $person_type_id, $person_id,
 372         $currency,
 373         "Cannot insert a source bank transaction");
 374         $total = 0;
 375         foreach ($items->gl_items as $gl_item)
 376         {
 377                 $is_bank_to = is_bank_account($gl_item->code_id);
 378
 379                 if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
 380                 {
 381                         // we don't allow payments to go to a bank account. use transfer for this !
 382                         display_db_error("invalid payment entered. Cannot pay to another bank account", "");
 383                 }
 384
 385         // do the destination account postings
 386         $total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
 387                 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
 388                 $gl_item->amount, $currency, $person_type_id, $person_id);
 389
 390         if ($is_bank_to)
 391         {
 392                 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
 393                         $date_, $gl_item->amount,
 394                         $person_type_id, $person_id, $currency,
 395                         "Cannot insert a destination bank transaction");
 396                 if ($do_exchange_variance)
 397                 {
 398                         add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id,
 399                                 $currency, $person_type_id, $person_id);
 400                 }
 401         }
 402                 // store tax details if the gl account is a tax account
 403
 404                 $amount = $gl_item->amount;
 405                 $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
 406
 407                 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
 408                         $ex_rate, $date_, $memo_);
 409         }
 410
 411         // do the source account postings
 412     add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
 413         -$total, null, $person_type_id, $person_id);
 414
 415     if ($do_exchange_variance)
 416     {
 417         if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account,
 418                 $currency, $person_type_id, $person_id))
 419         {
 420                         $ref1 = $Refs->get_next(ST_JOURNAL);
 421                         $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
 422                         add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
 423                 }
 424         }
 425
 426         add_comments($trans_type, $trans_no, $date_, $memo_);
 427
 428         $Refs->save($trans_type, $trans_no, $ref);
 429         add_audit_trail($trans_type, $trans_no, $date_);
 430
 431         $args->trans_no = $trans_no;
 432         hook_db_postwrite($args, $trans_type);
 433         if ($use_transaction)
 434                 commit_transaction();
 435
 436         return array($trans_type, $trans_no);
 437 }
 438 //----------------------------------------------------------------------------------------
 439
 440 function clear_bank_transaction($type, $type_no)
 441 {
 442
 443         hook_db_prevoid($type, $type_no);
 444
 445         $sql = "DELETE FROM ".TB_PREF."bank_trans
 446                 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 447
 448         $result = db_query($sql, "could not clear bank transactions for type=$type and trans_no=$type_no");
 449
 450         clear_gl_trans($type, $type_no, true);
 451
 452         // in case it's a customer trans - probably better to check first
 453         void_cust_allocations($type, $type_no);
 454
 455         // in case it's a supplier trans - probably better to check first
 456         void_supp_allocations($type, $type_no);
 457         clear_supp_trans($type, $type_no);
 458
 459         clear_trans_tax_details($type, $type_no);
 460
 461         delete_comments($type, $type_no);
 462 }
 463
 464 ?>