Minor fix in bank account transfer (currencies)
[fa-stable.git] / gl / includes / db / gl_db_banking.inc
index 237626a4f76973153c33d2b98a8e6d427aa199b0..0801e90445fe5aab70f551408c140a0db92fb5f6 100644 (file)
 <?php
-
-//----------------------------------------------------------------------------------
-function add_exchange_variation($trans_type, $trans_no, $date_, $account,
+/**********************************************************************
+    Copyright (C) FrontAccounting, LLC.
+       Released under the terms of the GNU General Public License, GPL, 
+       as published by the Free Software Foundation, either version 3 
+       of the License, or (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+    See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
+function add_exchange_variation($trans_no, $date_, $acc_id, $account,
     $currency, $person_type_id=null, $person_id = "")
 {
        if (is_company_currency($currency))
-               return;
+               return false;
        if ($date_ == null)
                $date_ = Today();
-       $rate = get_exchange_rate_from_home_currency($currency, $date_);        
-       $result = db_query("SELECT SUM(amount) FROM ".TB_PREF."bank_trans WHERE 
-               bank_act='$account' AND trans_date<='".date2sql($date_)."'", 
-               "Transactions for account $account could not be calculated");
-       $row = db_fetch_row($result);
-       $foreign_amount = $row[0];
+       $for_amount = 0;
+
+       // We have to calculate all the currency accounts belonging to the GL account
+       // upto $date_ and calculate with the exchange rates. And then compare with the GL account balance.
+       // 2010-02-23 Joe Hunt with help of Ary Wibowo
+       $sql = "SELECT SUM(bt.amount) AS for_amount, ba.bank_curr_code          
+               FROM ".TB_PREF."bank_trans bt, ".TB_PREF."bank_accounts ba
+               WHERE ba.id = bt.bank_act AND ba.account_code = ".db_escape($account)." AND bt.trans_date<='".date2sql($date_)."'
+               GROUP BY ba.bank_curr_code";    
+       $result = db_query($sql, "Transactions for bank account $acc_id could not be calculated");
+       while ($row = db_fetch($result))
+       {
+               if ($row['for_amount'] == 0)
+                       continue;
+               $rate = get_exchange_rate_from_home_currency($row['bank_curr_code'], $date_);
+               $for_amount += round2($row['for_amount'] * $rate, user_price_dec());
+       }       
        $amount = get_gl_trans_from_to("", $date_, $account);
-       $diff = $amount - (round2($foreign_amount * $rate, user_price_dec()));
+       $diff = $amount - $for_amount;
        if ($diff != 0)
        {
-               if ($trans_type == null)
-                       $trans_type = systypes::journal_entry();
                if ($trans_no == null)
-                       $trans_no = get_next_trans_no($trans_type);
+                       $trans_no = get_next_trans_no(ST_JOURNAL);
                if ($person_type_id == null)
-                       $person_type_id = payment_person_types::misc();
-               add_gl_trans($trans_type, $trans_no, $date_, $account, 0, 0, "",
+                       $person_type_id = PT_MISC;
+               add_gl_trans(ST_JOURNAL, $trans_no, $date_, $account, 0, 0, _("Exchange Variance"),
                -$diff, null, $person_type_id, $person_id);
-       add_gl_trans($trans_type, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0, "",
-               $diff, null, $person_type_id, $person_id);
-       }       
+       add_gl_trans(ST_JOURNAL, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0, 
+               _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
+       }
+       return ($diff != 0);
 }
 
-function add_exchange_variation_all()
+function add_exchange_variation_all($date=null, $ref="", $memo)
 {
-       $trans_no = get_next_trans_no(0);
+       global $Refs;
+       begin_transaction();
+       $exchanged = false;
+       $trans_no = get_next_trans_no(ST_JOURNAL);
        $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
        $result = db_query($sql, "could not retreive bank accounts");
        while ($myrow = db_fetch($result))
-               add_exchange_variation(0, $trans_no, null, $myrow['account_code'],
-                       $myrow['currency_code']);
+       {
+               if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
+                       $myrow['bank_curr_code']))
+                       $exchanged = true;
+       }
+       if ($exchanged)
+       {
+               add_comments(ST_JOURNAL, $trans_no, $date, $memo);
+               if ($ref == "")
+                       $ref = $Refs->get_next(ST_JOURNAL);
+               $Refs->save(ST_JOURNAL, $trans_no, $ref);
+               add_audit_trail(ST_JOURNAL, $trans_no, $date);
+       }       
+       commit_transaction();
+       return ($exchanged ? $trans_no : 0);
 }
 //----------------------------------------------------------------------------------
+//     Add bank tranfer to database.
+//
+//     $from_account - source bank account id
+//     $to_account   - target bank account id
+//     
 
 function add_bank_transfer($from_account, $to_account, $date_,
-       $amount, $payment_type, $ref, $memo_)
+       $amount, $ref, $memo_, $charge=0)
 {
+       global $Refs, $SysPrefs;
+       
        begin_transaction();
+       $args = func_get_args(); if (count($args) < 7) $args[] = 0;
+       $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
+               'ref', 'memo_', 'charge'), $args);
+       $args->trans_no = 0;
+       hook_db_prewrite($args, ST_BANKTRANSFER);
 
-       $trans_type = systypes::bank_transfer();
+       $trans_type = ST_BANKTRANSFER;
 
        $currency = get_bank_account_currency($from_account);
 
        $trans_no = get_next_trans_no($trans_type);
+       
+    $fromact = get_bank_account($from_account);
+    $toact = get_bank_account($to_account);
+    $person_id = _("From")." ".$fromact['bank_account_name']." "._("To")." ".$toact['bank_account_name'];
 
+       $from_gl_account = get_bank_gl_account($from_account);
+       $to_gl_account = get_bank_gl_account($to_account);
+       
+       $exchanged = false;
        $total = 0;
        // do the source account postings
-    $total += add_gl_trans($trans_type, $trans_no, $date_, $from_account, 0, 0, "",
-               -$amount, $currency);
+    $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
+               -($amount + $charge), $currency);
 
     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
-               $date_, $payment_type, -$amount,
-               payment_person_types::misc(), "", $currency,
+               $date_, -($amount + $charge),
+               PT_MISC, $person_id, $currency,
                "Cannot insert a source bank transaction");
-
-       add_exchange_variation($trans_type, $trans_no, $date_, $from_account, 
-               $currency, payment_person_types::misc(), "");
-
+       if ($SysPrefs->auto_currency_revaluation())
+       {
+               $trans_no1 = get_next_trans_no(ST_JOURNAL);
+               if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account, 
+                       $currency, PT_MISC, $person_id))
+                       $exchanged = true;
+       }
+       if ($charge != 0)
+       {
+               /* Now Debit bank charge account with charges */
+               $charge_act = get_company_pref('bank_charge_act');
+               $total += add_gl_trans($trans_type, $trans_no, $date_,
+                       $charge_act, 0, 0, $person_id, $charge, $currency);
+       }
        // do the destination account postings
-       $total += add_gl_trans($trans_type, $trans_no, $date_, $to_account, 0, 0, "",
+       $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, $person_id,
                $amount, $currency);
                
        /*Post a balance post if $total != 0 */
        add_gl_balance($trans_type, $trans_no, $date_, -$total);        
        
        add_bank_trans($trans_type, $trans_no, $to_account, $ref,
-               $date_, $payment_type, $amount,
-               payment_person_types::misc(), "",
-               $currency,
-               "Cannot insert a destination bank transaction");
+               $date_, $amount, PT_MISC, $person_id,
+               $currency, "Cannot insert a destination bank transaction");
 
-       add_exchange_variation($trans_type, $trans_no, $date_, $from_account, 
-               $currency, payment_person_types::misc(), "");
+       if ($SysPrefs->auto_currency_revaluation())
+       {
+               $currency = get_bank_account_currency($to_account);
        
+               if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,     
+                       $currency, PT_MISC, $person_id))
+                       $exchanged = true;
+       }
+       if ($exchanged == true)
+       {
+               $ref1 = $Refs->get_next(ST_JOURNAL);
+               $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
+               add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
+       }
        add_comments($trans_type, $trans_no, $date_, $memo_);
 
-       references::save_last($ref, $trans_type);
+       $Refs->save($trans_type, $trans_no, $ref);
+       add_audit_trail($trans_type, $trans_no, $date_);
 
+       $args->trans_no = $trans_no;
+       hook_db_postwrite($args, ST_BANKTRANSFER);
        commit_transaction();
 
        return $trans_no;
 }
-
 //----------------------------------------------------------------------------------
-
-// $amount is in $from_account's currency
-
+//     Add bank payment or deposit to database.
+//
+//     $from_account - bank account id
+//  $item - transaction cart (line item's amounts in bank account's currency)
+//  $person_type_id - defines type of $person_id identifiers
+//  $person_id - supplier/customer/other id
+// $person_detail_id - customer branch id or not used
+//
 // returns an array of (inserted trans type, trans no)
-
-function add_bank_transaction($trans_type, $from_account, $items, $date_,
-       $person_type_id, $person_id, $person_detail_id, $type, $ref, $memo_)
+//
+// FIXME -revise code for update case
+//
+function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $date_,
+       $person_type_id, $person_id, $person_detail_id, $ref, $memo_, $use_transaction=true)
 {
+       global $Refs, $SysPrefs;
+
        // we can only handle type 1 (payment)and type 2 (deposit)
-       if ($trans_type != systypes::bank_payment() && $trans_type != systypes::bank_deposit())
+       if ($trans_type != ST_BANKPAYMENT && $trans_type != ST_BANKDEPOSIT)
                display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
 
        $do_exchange_variance = false;
-       
-       begin_transaction();
+       $exchanged = false;
+       if ($use_transaction)
+               begin_transaction();
+
+       $args = func_get_args(); if (count($args) < 11) $args[] = true;
+       $args = (object)array_combine(array('trans_type', 'trans_no', 'from_account', 'items', 'date_',
+               'person_type_id', 'person_id', 'person_detail_id', 'ref', 'memo_', 'use_transaction'),
+               $args);
+       hook_db_prewrite($args, $trans_type);
+
+       if ($trans_no)
+               clear_bank_transaction($_SESSION['pay_items']->trans_type, $_SESSION['pay_items']->order_id);
 
        $currency = get_bank_account_currency($from_account);
+       $bank_gl_account = get_bank_gl_account($from_account);
 
        // the gl items are already inversed/negated for type 2 (deposit)
        $total_amount = $items->gl_items_total();
 
-    if ($person_type_id == payment_person_types::customer())
+    if ($person_type_id == PT_CUSTOMER)
     {
        // we need to add a customer transaction record
 
@@ -122,11 +217,11 @@ function add_bank_transaction($trans_type, $from_account, $items, $date_,
                // we need to negate it too
                $cust_amount = -$cust_amount;
 
-               $trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
+               $trans_no = write_customer_trans($trans_type, $trans_no, $person_id, $person_detail_id, $date_,
                $ref, $cust_amount);
 
     }
-    elseif ($person_type_id == payment_person_types::supplier())
+    elseif ($person_type_id == PT_SUPPLIER)
     {
        // we need to add a supplier transaction record
                // convert to supp currency
@@ -135,18 +230,23 @@ function add_bank_transaction($trans_type, $from_account, $items, $date_,
                // we need to negate it too
                $supp_amount = -$supp_amount;
 
-               $trans_no = add_supp_trans($trans_type, $person_id, $date_, '',
-               $ref, "", $supp_amount, 0, 0);
+               $trans_no = write_supp_trans($trans_type, $trans_no, $person_id, $date_, '',
+                       $ref, "", $supp_amount, 0, 0);
 
     }
     else
     {
-       $trans_no = get_next_trans_no($trans_type);
-       $do_exchange_variance = true;
+       if (!$trans_no)
+               $trans_no = get_next_trans_no($trans_type);
+       $do_exchange_variance = $SysPrefs->auto_currency_revaluation();
+       if ($do_exchange_variance)
+               $trans_no1 = get_next_trans_no(ST_JOURNAL);
     }
 
+       // do the source account postings
+
     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
-       $date_, $type, -$total_amount,
+       $date_, -$total_amount,
        $person_type_id, $person_id,
        $currency,
        "Cannot insert a source bank transaction");
@@ -155,7 +255,7 @@ function add_bank_transaction($trans_type, $from_account, $items, $date_,
        {
                $is_bank_to = is_bank_account($gl_item->code_id);
 
-               if ($trans_type == 1 AND $is_bank_to)
+               if ($trans_type == ST_BANKPAYMENT AND $is_bank_to)
                {
                        // we don't allow payments to go to a bank account. use transfer for this !
                        display_db_error("invalid payment entered. Cannot pay to another bank account", "");
@@ -168,33 +268,76 @@ function add_bank_transaction($trans_type, $from_account, $items, $date_,
 
        if ($is_bank_to)
        {
-               add_bank_trans($trans_type, $trans_no, $gl_item->code_id, $ref,
-                       $date_, $type, $gl_item->amount,
+               add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
+                       $date_, $gl_item->amount,
                        $person_type_id, $person_id, $currency,
                        "Cannot insert a destination bank transaction");
                if ($do_exchange_variance)
-                       add_exchange_variation($trans_type, $trans_no, $date_, $gl_item->code_id, 
+               {
+                       add_exchange_variation($trans_no1, $date_, $is_bank_to, $gl_item->code_id, 
                                $currency, $person_type_id, $person_id);
+               }               
        }
+               // store tax details if the gl account is a tax account
+
+               $amount = $gl_item->amount;
+               $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
+                       
+               add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, -$amount,
+                       $ex_rate, $date_, $memo_);
        }
 
        // do the source account postings
-    add_gl_trans($trans_type, $trans_no, $date_, $from_account, 0, 0, "",
+    add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
        -$total, null, $person_type_id, $person_id);
 
     if ($do_exchange_variance)
-       add_exchange_variation($trans_type, $trans_no, $date_, $from_account, 
-               $currency, $person_type_id, $person_id);
+    {
+       if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account, 
+               $currency, $person_type_id, $person_id))
+       {       
+                       $ref1 = $Refs->get_next(ST_JOURNAL);
+                       $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
+                       add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
+               }       
+       }
 
        add_comments($trans_type, $trans_no, $date_, $memo_);
 
-       references::save_last($ref, $trans_type);
+       $Refs->save($trans_type, $trans_no, $ref);
+       add_audit_trail($trans_type, $trans_no, $date_);
 
-       commit_transaction();
+       $args->trans_no = $trans_no;
+       hook_db_postwrite($args, $trans_type);
+       if ($use_transaction)
+               commit_transaction();
 
        return array($trans_type, $trans_no);
 }
-
 //----------------------------------------------------------------------------------------
 
+function clear_bank_transaction($type, $type_no)
+{
+
+       hook_db_prevoid($type, $type_no);
+
+       $sql = "DELETE FROM ".TB_PREF."bank_trans 
+               WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
+
+       $result = db_query($sql, "could not clear bank transactions for type=$type and trans_no=$type_no");
+
+       clear_gl_trans($type, $type_no, true);
+
+       // in case it's a customer trans - probably better to check first
+       void_cust_allocations($type, $type_no);
+
+       // in case it's a supplier trans - probably better to check first
+       void_supp_allocations($type, $type_no);
+       clear_supp_trans($type, $type_no);
+
+       clear_trans_tax_details($type, $type_no);
+
+       delete_comments($type, $type_no);
+}
+
 ?>
\ No newline at end of file