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 function add_exchange_variation_all($date=null, $ref="", $memo)
  53 {
  54         global $Refs;
  55         begin_transaction();
  56         $exchanged = false;
  57         $trans_no = get_next_trans_no(ST_JOURNAL);
  58         $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
  59         $result = db_query($sql, "could not retreive bank accounts");
  60         while ($myrow = db_fetch($result))
  61         {
  62                 if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
  63                         $myrow['bank_curr_code']))
  64                         $exchanged = true;
  65         }
  66         if ($exchanged)
  67         {
  68                 add_comments(ST_JOURNAL, $trans_no, $date, $memo);
  69                 if ($ref == "")
  70                         $ref = $Refs->get_next(ST_JOURNAL);
  71                 $Refs->save(ST_JOURNAL, $trans_no, $ref);
  72                 add_audit_trail(ST_JOURNAL, $trans_no, $date);
  73         }
  74         commit_transaction();
  75         return ($exchanged ? $trans_no : 0);
  76 }
  77 //----------------------------------------------------------------------------------
  78 //      Add bank tranfer to database.
  79 //
  80 //      $from_account - source bank account id
  81 //      $to_account   - target bank account id
  82 //
  83
  84 function add_bank_transfer($from_account, $to_account, $date_,
  85         $amount, $ref, $memo_, $charge=0)
  86 {
  87         global $Refs, $SysPrefs;
  88
  89         begin_transaction();
  90         $args = func_get_args(); if (count($args) < 7) $args[] = 0;
  91         $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
  92                 'ref', 'memo_', 'charge'), $args);
  93         $args->trans_no = 0;
  94         hook_db_prewrite($args, ST_BANKTRANSFER);
  95
  96         $trans_type = ST_BANKTRANSFER;
  97
  98         $currency = get_bank_account_currency($from_account);
  99
 100         $trans_no = get_next_trans_no($trans_type);
 101
 102     $fromact = get_bank_account($from_account);
 103     $toact = get_bank_account($to_account);
 104     $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
 105
 106         $from_gl_account = get_bank_gl_account($from_account);
 107         $to_gl_account = get_bank_gl_account($to_account);
 108
 109         $exchanged = false;
 110         $total = 0;
 111         // do the source account postings
 112     $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
 113                 -($amount + $charge), $currency);
 114
 115     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
 116                 $date_, -($amount + $charge),
 117                 PT_MISC, $person_id, $currency,
 118                 "Cannot insert a source bank transaction");
 119         if ($SysPrefs->auto_currency_revaluation())
 120         {
 121                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
 122                 if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account,
 123                         $currency, PT_MISC, $person_id))
 124                         $exchanged = true;
 125         }
 126         if ($charge != 0)
 127         {
 128                 /* Now Debit bank charge account with charges */
 129                 $charge_act = get_company_pref('bank_charge_act');
 130                 $total += add_gl_trans($trans_type, $trans_no, $date_,
 131                         $charge_act, 0, 0, $person_id, $charge, $currency);
 132         }
 133         // do the destination account postings
 134         $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
 135                 $amount, $currency);
 136
 137         /*Post a balance post if $total != 0 */
 138         add_gl_balance($trans_type, $trans_no, $date_, -$total);
 139
 140         add_bank_trans($trans_type, $trans_no, $to_account, $ref,
 141                 $date_, $amount, PT_MISC, $person_id,
 142                 $currency, "Cannot insert a destination bank transaction");
 143
 144         if ($SysPrefs->auto_currency_revaluation())
 145         {
 146                 $currency = get_bank_account_currency($to_account);
 147
 148                 if ($exchanged || add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,
 149                         $currency, PT_MISC, $person_id))
 150                 {
 151                         $ref1 = $Refs->get_next(ST_JOURNAL);
 152                         $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
 153                         add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
 154                 }
 155         }
 156         add_comments($trans_type, $trans_no, $date_, $memo_);
 157
 158         $Refs->save($trans_type, $trans_no, $ref);
 159         add_audit_trail($trans_type, $trans_no, $date_);
 160
 161         $args->trans_no = $trans_no;
 162         hook_db_postwrite($args, ST_BANKTRANSFER);
 163         commit_transaction();
 164
 165         return $trans_no;
 166 }
 167 //----------------------------------------------------------------------------------
 168 //      Add bank payment or deposit to database.
 169 //
 170 //      $from_account - bank account id
 171 //  $item - transaction cart (line item's amounts in bank account's currency)
 172 //  $person_type_id - defines type of $person_id identifiers
 173 //  $person_id  - supplier/customer/other id
 174 // $person_detail_id - customer branch id or not used
 175 //
 176 // returns an array of (inserted trans type, trans no)
 177 //
 178 // FIXME -revise code for update case
 179 //
 180 function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
 181         $person_type_id, $person_id, $person_detail_id, $ref, $memo_, $use_transaction=true)
 182 {
 183         global $Refs, $SysPrefs;
 184
 185         // we can only handle type 1 (payment)and type 2 (deposit)
 186         if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
 187                 display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
 188
 189         $do_exchange_variance = false;
 190         $exchanged = false;
 191         if ($use_transaction)
 192                 begin_transaction();
 193
 194         $args = func_get_args(); if (count($args) < 11) $args[] = true;
 195         $args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
 196                 'person_type_id', 'person_id', 'person_detail_id', 'ref', 'memo_', 'use_transaction'),
 197                 $args);
 198         hook_db_prewrite($args, $trans_type);
 199
 200         if ($trans_no)
 201                 clear_bank_transaction($_SESSION['pay_items']->trans_type, $_SESSION['pay_items']->order_id);
 202
 203         $currency = get_bank_account_currency($from_account);
 204         $bank_gl_account = get_bank_gl_account($from_account);
 205
 206         // the gl items are already inversed/negated for type 2 (deposit)
 207         $total_amount = $items->gl_items_total();
 208
 209     if ($person_type_id == PT_CUSTOMER)
 210     {
 211         // we need to add a customer transaction record
 212
 213                 // convert to customer currency
 214                 $cust_amount = exchange_from_to($total_amount, $currency, get_customer_currency($person_id), $date_);
 215                 // we need to negate it too
 216                 $cust_amount = -$cust_amount;
 217
 218                 $trans_no = write_customer_trans($trans_type, $trans_no, $person_id, $person_detail_id, $date_,
 219                 $ref, $cust_amount);
 220
 221     }
 222     elseif ($person_type_id == PT_SUPPLIER)
 223     {
 224         // we need to add a supplier transaction record
 225                 // convert to supp currency
 226                 $supp_amount = exchange_from_to($total_amount, $currency, get_supplier_currency($person_id), $date_);
 227
 228                 // we need to negate it too
 229                 $supp_amount = -$supp_amount;
 230
 231                 $trans_no = write_supp_trans($trans_type, $trans_no, $person_id, $date_, '',
 232                         $ref, "", $supp_amount, 0, 0);
 233
 234     }
 235     else
 236     {
 237         if (!$trans_no)
 238                 $trans_no = get_next_trans_no($trans_type);
 239         $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
 240         if ($do_exchange_variance)
 241                 $trans_no1 = get_next_trans_no(ST_JOURNAL);
 242     }
 243
 244         // do the source account postings
 245
 246     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
 247         $date_, -$total_amount,
 248         $person_type_id, $person_id,
 249         $currency,
 250         "Cannot insert a source bank transaction");
 251         $total = 0;
 252         foreach ($items->gl_items as $gl_item)
 253         {
 254                 $is_bank_to = is_bank_account($gl_item->code_id);
 255
 256                 if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
 257                 {
 258                         // we don't allow payments to go to a bank account. use transfer for this !
 259                         display_db_error("invalid payment entered. Cannot pay to another bank account", "");
 260                 }
 261
 262         // do the destination account postings
 263         $total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
 264                 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
 265                 $gl_item->amount, $currency, $person_type_id, $person_id);
 266
 267         if ($is_bank_to)
 268         {
 269                 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
 270                         $date_, $gl_item->amount,
 271                         $person_type_id, $person_id, $currency,
 272                         "Cannot insert a destination bank transaction");
 273                 if ($do_exchange_variance)
 274                 {
 275                         add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id,
 276                                 $currency, $person_type_id, $person_id);
 277                 }
 278         }
 279                 // store tax details if the gl account is a tax account
 280
 281                 $amount = $gl_item->amount;
 282                 $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
 283
 284                 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
 285                         $ex_rate, $date_, $memo_);
 286         }
 287
 288         // do the source account postings
 289     add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
 290         -$total, null, $person_type_id, $person_id);
 291
 292     if ($do_exchange_variance)
 293     {
 294         if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account,
 295                 $currency, $person_type_id, $person_id))
 296         {
 297                         $ref1 = $Refs->get_next(ST_JOURNAL);
 298                         $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
 299                         add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
 300                 }
 301         }
 302
 303         add_comments($trans_type, $trans_no, $date_, $memo_);
 304
 305         $Refs->save($trans_type, $trans_no, $ref);
 306         add_audit_trail($trans_type, $trans_no, $date_);
 307
 308         $args->trans_no = $trans_no;
 309         hook_db_postwrite($args, $trans_type);
 310         if ($use_transaction)
 311                 commit_transaction();
 312
 313         return array($trans_type, $trans_no);
 314 }
 315 //----------------------------------------------------------------------------------------
 316
 317 function clear_bank_transaction($type, $type_no)
 318 {
 319
 320         hook_db_prevoid($type, $type_no);
 321
 322         $sql = "DELETE FROM ".TB_PREF."bank_trans
 323                 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 324
 325         $result = db_query($sql, "could not clear bank transactions for type=$type and trans_no=$type_no");
 326
 327         clear_gl_trans($type, $type_no, true);
 328
 329         // in case it's a customer trans - probably better to check first
 330         void_cust_allocations($type, $type_no);
 331
 332         // in case it's a supplier trans - probably better to check first
 333         void_supp_allocations($type, $type_no);
 334         clear_supp_trans($type, $type_no);
 335
 336         clear_trans_tax_details($type, $type_no);
 337
 338         delete_comments($type, $type_no);
 339 }
 340
 341 ?>