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