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