gl/includes/db/gl_db_bank_trans.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 //----------------------------------------------------------------------------------
  13
  14 // add a bank transaction
  15 // $amount is in $currency
  16 // $date_ is display date (non-sql)
  17
  18 function add_bank_trans($type, $trans_no, $bank_act, $ref, $date_,
  19         $amount, $person_type_id, $person_id, $currency="", $err_msg="", $rate=0)
  20 {
  21         $sqlDate = date2sql($date_);
  22
  23         // convert $amount to the bank's currency
  24         if ($currency != "")
  25         {
  26         $bank_account_currency = get_bank_account_currency($bank_act);
  27         if ($rate == 0)
  28                 $to_bank_currency = get_exchange_rate_from_to($currency, $bank_account_currency, $date_);
  29         else
  30                 $to_bank_currency = 1 / $rate;
  31         $amount_bank = ($amount / $to_bank_currency);
  32         }
  33         else
  34                 $amount_bank = $amount;
  35         $amount_bank = round2($amount_bank, user_price_dec());
  36
  37         $sql = "INSERT INTO ".TB_PREF."bank_trans (type, trans_no, bank_act, ref,
  38                 trans_date, amount, person_type_id, person_id) ";
  39
  40         $sql .= "VALUES ($type, $trans_no, '$bank_act', ".db_escape($ref).", '$sqlDate',
  41                 ".db_escape($amount_bank).", ".db_escape($person_type_id)
  42                 .", ". db_escape($person_id).")";
  43
  44         if ($err_msg == "")
  45                 $err_msg = "The bank transaction could not be inserted";
  46
  47         db_query($sql, $err_msg);
  48 }
  49
  50 //----------------------------------------------------------------------------------------
  51
  52 function exists_bank_trans($type, $type_no)
  53 {
  54         $sql = "SELECT trans_no
  55                 FROM ".TB_PREF."bank_trans
  56                 WHERE type=".db_escape($type)
  57                 ." AND trans_no=".db_escape($type_no);
  58         $result = db_query($sql, "Cannot retreive a bank transaction");
  59
  60     return (db_num_rows($result) > 0);
  61 }
  62
  63 //----------------------------------------------------------------------------------------
  64
  65 function get_bank_trans($type, $trans_no=null, $person_type_id=null, $person_id=null)
  66 {
  67         $sql = "SELECT bt.*, act.*,
  68                 IFNULL(abs(dt.ov_amount), IFNULL(ABS(st.ov_amount), bt.amount)) settled_amount,
  69                 IFNULL(abs(dt.ov_amount/bt.amount), IFNULL(ABS(st.ov_amount/bt.amount), 1)) settle_rate,
  70                 IFNULL(debtor.curr_code, IFNULL(supplier.curr_code, act.bank_curr_code)) settle_curr
  71
  72                 FROM ".TB_PREF."bank_trans bt
  73                                  LEFT JOIN ".TB_PREF."debtor_trans dt ON dt.type=bt.type AND dt.trans_no=bt.trans_no
  74                                  LEFT JOIN ".TB_PREF."debtors_master debtor ON debtor.debtor_no = dt.debtor_no
  75                                  LEFT JOIN ".TB_PREF."supp_trans st ON st.type=bt.type AND st.trans_no=bt.trans_no
  76                                  LEFT JOIN ".TB_PREF."suppliers supplier ON supplier.supplier_id = st.supplier_id,
  77                          ".TB_PREF."bank_accounts act
  78                 WHERE act.id=bt.bank_act ";
  79         if (isset($type))
  80                 $sql .= " AND bt.type=".db_escape($type);
  81         if (isset($trans_no))
  82                 $sql .= " AND bt.trans_no = ".db_escape($trans_no);
  83         if (isset($person_type_id))
  84                 $sql .= " AND bt.person_type_id = ".db_escape($person_type_id);
  85         if (isset($person_id))
  86                 $sql .= " AND bt.person_id = ".db_escape($person_id);
  87         $sql .= " ORDER BY trans_date, bt.id";
  88
  89         return db_query($sql, "query for bank transaction");
  90 }
  91
  92 //----------------------------------------------------------------------------------------
  93
  94 function get_bank_trans_for_bank_account($bank_account, $from, $to)
  95 {
  96         $from = date2sql($from);
  97         $to = date2sql($to);
  98         $sql = "SELECT t.*
  99                 FROM ".TB_PREF."bank_trans t
 100                         LEFT JOIN ".TB_PREF."voided v ON t.type=v.type AND t.trans_no=v.id
 101                 WHERE t.bank_act = ".db_escape($bank_account) . "
 102                         AND ISNULL(v.date_)
 103                         AND trans_date >= '$from'
 104                         AND trans_date <= '$to'
 105                         AND amount != 0
 106                 ORDER BY trans_date, t.id";
 107
 108         return db_query($sql,"The transactions for '" . $bank_account . "' could not be retrieved");
 109 }
 110
 111 //----------------------------------------------------------------------------------------
 112
 113 function get_balance_before_for_bank_account($bank_account, $from)
 114 {
 115         $from = date2sql($from);
 116         $sql = "SELECT SUM(amount)
 117                 FROM ".TB_PREF."bank_trans
 118                 WHERE bank_act=".db_escape($bank_account) . "
 119                         AND trans_date < '$from'";
 120         $before_qty = db_query($sql, "The starting balance on hand could not be calculated");
 121         $bfw_row = db_fetch_row($before_qty);
 122         return $bfw_row[0];
 123 }
 124 //----------------------------------------------------------------------------------------
 125
 126 function get_gl_trans_value($account, $type, $trans_no)
 127 {
 128         $sql = "SELECT SUM(amount)
 129                 FROM ".TB_PREF."gl_trans
 130                 WHERE account=".db_escape($account)
 131                         ." AND type=".db_escape($type)
 132                         ." AND type_no=".db_escape($trans_no);
 133
 134         $result = db_query($sql, "query for gl trans value");
 135
 136         $row = db_fetch_row($result);
 137         return $row[0];
 138 }
 139
 140 //----------------------------------------------------------------------------------------
 141
 142 function void_bank_trans($type, $type_no, $nested=false)
 143 {
 144
 145         if (!$nested)
 146                 begin_transaction();
 147
 148         $sql = "UPDATE ".TB_PREF."bank_trans
 149                         SET amount=0
 150                         WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
 151
 152         db_query($sql, "could not void bank transactions for type=$type and trans_no=$type_no");
 153
 154         void_gl_trans($type, $type_no, true);
 155
 156         // in case it's a customer trans - probably better to check first
 157         void_cust_allocations($type, $type_no);
 158         void_customer_trans($type, $type_no);
 159
 160         // in case it's a supplier trans - probably better to check first
 161         void_supp_allocations($type, $type_no);
 162         void_supp_trans($type, $type_no);
 163
 164         void_trans_tax_details($type, $type_no);
 165
 166         if (!$nested)
 167                 commit_transaction();
 168 }
 169
 170 /**
 171 *       Check account history to find transaction which would exceed authorized overdraft for given account.
 172 *       Returns null or transaction in conflict. Running balance is checked on daily basis only, to enable ID change after edition.
 173 *       $delta_amount - tested change in bank balance at $date.
 174 **/
 175 function check_bank_account_history($delta_amount, $bank_account, $date=null, $user=null, $balance_offset = 0)
 176 {
 177         if ($delta_amount >= 0 && isset($date))
 178                  return null;   // amount increase is always safe
 179
 180         $balance = $date ? get_bank_account_limit($bank_account, $date, $user) : 0;
 181
 182         if (!isset($balance) && isset($date))
 183                 return null;    // unlimited account
 184
 185         $balance += $balance_offset;
 186         if (floatcmp($balance, -$delta_amount) < 0)
 187                 return array('amount' => $balance + $delta_amount, 'trans_date'=> date2sql($date));
 188
 189         $balance += $delta_amount;
 190
 191         $sql = "SELECT sum(amount) as amount, trans_date
 192                         FROM ".TB_PREF."bank_trans
 193                         WHERE bank_act=".db_escape($bank_account);
 194         if ($date)
 195         {
 196                 $date = date2sql($date);
 197                 $sql .= " AND trans_date > '$date'";
 198         }
 199         $sql .= " GROUP BY trans_date ORDER BY trans_date ASC";
 200
 201         $history = db_query($sql, "cannot retrieve cash account history");
 202
 203         while ($trans = db_fetch($history)) {
 204                 $balance += $trans['amount'];
 205                 if ($balance < 0)
 206                 {
 207                         $trans['amount'] = $balance;
 208                         return $trans;
 209                 }
 210         }
 211
 212         return null;
 213 }
 214
 215 /**
 216 *       Check bank transfer, deposit or customer deposit before voiding.
 217 **/
 218 function check_void_bank_trans($type, $type_no)
 219 {
 220         $moves = get_bank_trans($type, $type_no);
 221         while ($trans = db_fetch($moves)) {
 222                 if ($trans['amount'] > 0) { // skip transfer input part
 223                         return check_bank_account_history(-$trans['amount'], $trans['bank_act'], sql2date($trans['trans_date'])) == null;
 224                 }
 225         }
 226         return true;
 227 }
 228