Passing error message parameter err_msg to low level db functions from caller does...
[fa-stable.git] / purchasing / includes / db / supp_trans_db.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 //      FIXME - this should be revised for transaction update case.
15 //
16 function write_supp_trans($type, $trans_no, $supplier_id, $date_, $due_date, $reference, $supp_reference,
17         $amount, $amount_tax, $discount, $rate=0, $included=0)
18 {
19         $new = $trans_no==0;
20         $date = date2sql($date_);
21         if ($due_date == "")
22                 $due_date = "0000-00-00";
23         else
24                 $due_date = date2sql($due_date);
25
26         if ($new)
27                 $trans_no = get_next_trans_no($type);
28
29         $curr = get_supplier_currency($supplier_id);
30         
31         if ($rate == 0)
32                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
33
34
35         $sql = "INSERT INTO ".TB_PREF."supp_trans (trans_no, type, supplier_id, tran_date, due_date,
36                 reference, supp_reference, ov_amount, ov_gst, rate, ov_discount, tax_included) ";
37         $sql .= "VALUES (".db_escape($trans_no).", ".db_escape($type)
38         .", ".db_escape($supplier_id).", '$date', '$due_date',
39                 ".db_escape($reference).", ".db_escape($supp_reference).", ".db_escape($amount)
40                 .", ".db_escape($amount_tax).", ".db_escape($rate).", ".db_escape($discount).", ".db_escape($included).")";
41
42         db_query($sql, "Cannot insert a supplier transaction record");
43         add_audit_trail($type, $trans_no, $date_);
44
45         return $trans_no;
46 }
47 /*
48         Helper for final supplier trans header summaries update.
49 */
50 function update_supp_trans_sums($trans_type, $trans_no, $amount, $tax, $discount=0)
51 {
52         $sql = "UPDATE ".TB_PREF."supp_trans 
53                 SET     ov_amount=".db_escape($amount).",
54                         ov_gst=".db_escape($tax).",
55                         ov_discount=".db_escape($discount)."
56                 WHERE trans_no=".db_escape($trans_no)." AND type=".db_escape($trans_type);
57
58         return db_query($sql, "Cannot update supplier transaction summaries");
59 }
60
61 //-------------------------------------------------------------------------------------------------------------
62
63 function get_supp_trans($trans_no, $trans_type=-1, $supplier_id=null)
64 {
65         $sql = "SELECT trans.*, (trans.ov_amount+trans.ov_gst+trans.ov_discount) AS Total,
66                 supplier.supp_name AS supplier_name, supplier.curr_code AS curr_code ";
67
68         if ($trans_type == ST_SUPPAYMENT || $trans_type == ST_BANKPAYMENT)
69         {
70                 // it's a payment so also get the bank account
71                 $sql .= ", account.bank_name, account.bank_account_name, account.bank_curr_code,
72                         account.account_type AS BankTransType, bank_trans.amount AS bank_amount,
73                         bank_trans.ref ";
74         }
75
76         $sql .= " FROM ".TB_PREF."supp_trans trans,"
77                         .TB_PREF."suppliers supplier";
78
79         if ($trans_type == ST_SUPPAYMENT || $trans_type == ST_BANKPAYMENT)
80         {
81                 // it's a payment so also get the bank account
82                 $sql .= ", "
83                         .TB_PREF."bank_trans bank_trans,"
84                         .TB_PREF."bank_accounts account";
85         }
86
87         $sql .= " WHERE trans.trans_no=".db_escape($trans_no)."
88                 AND trans.supplier_id=supplier.supplier_id";
89
90         if (isset($supplier_id))
91                 $sql .= " AND trans.supplier_id=".db_escape($supplier_id);
92
93         if ($trans_type > -1)
94                 $sql .= " AND trans.type=".db_escape($trans_type);
95
96         if ($trans_type == ST_SUPPAYMENT || $trans_type == ST_BANKPAYMENT)
97         {
98                 // it's a payment so also get the bank account
99                 $sql .= " AND bank_trans.trans_no =".db_escape($trans_no)."
100                         AND bank_trans.type=".db_escape($trans_type)."
101                         AND account.id=bank_trans.bank_act ";
102         }
103
104         $result = db_query($sql, "Cannot retreive a supplier transaction");
105
106     if (db_num_rows($result) == 0)
107     {
108        // can't return nothing
109        display_db_error("no supplier trans found for given params", $sql, true);
110        exit;
111     }
112
113     if (db_num_rows($result) > 1)
114     {
115        // can't return multiple
116        display_db_error("duplicate supplier transactions found for given params", $sql, true);
117        exit;
118     }
119     return db_fetch($result);
120 }
121
122
123 //----------------------------------------------------------------------------------------
124
125 function get_supp_payment_before($supplier_id, $date)
126 {
127         $sql = "SELECT "
128         . TB_PREF . "supp_trans.trans_no,"
129         . TB_PREF . "supp_trans.type,"
130         . TB_PREF . "supp_trans.supplier_id,"
131         . TB_PREF . "supp_trans.tran_date,"
132         . TB_PREF . "supp_trans.ov_amount,"
133         . TB_PREF . "bank_trans.ref AS bank_ref,"
134         . TB_PREF . "bank_trans.amount AS bank_amount,"
135         . TB_PREF . "bank_accounts.id AS bank_id,"
136         . TB_PREF . "bank_accounts.bank_name,"
137         . TB_PREF . "bank_accounts.bank_account_name,"
138         . TB_PREF . "bank_accounts.bank_curr_code "
139         . "FROM "
140         . TB_PREF . "supp_trans,"
141         . TB_PREF . "bank_trans,"
142         . TB_PREF . "bank_accounts "
143         . "WHERE "
144         . TB_PREF . "supp_trans.supplier_id=" . $supplier_id . " "
145         . "AND " . TB_PREF . "supp_trans.tran_date<'" . $date . "' "
146         . "AND " . TB_PREF . "supp_trans.type=" . ST_SUPPAYMENT . " "
147         . "AND " . TB_PREF . "supp_trans.trans_no=" . TB_PREF . "bank_trans.trans_no "
148         . "AND " . TB_PREF . "supp_trans.type=" . TB_PREF . "bank_trans.type "
149         . "AND " . TB_PREF . "bank_accounts.id=" . TB_PREF . "bank_trans.bank_act "
150         . "ORDER BY "
151         . TB_PREF . "supp_trans.tran_date DESC "
152         . "LIMIT 1 "
153         ;
154
155         $result = db_query($sql, "Cannot retreive a previous supplier payment");
156
157         if (db_num_rows($result) == 0)
158         {
159                 return false;
160         }
161
162         return db_fetch($result);
163 }
164
165 //----------------------------------------------------------------------------------------
166
167 function exists_supp_trans($type, $type_no)
168 {
169         if ($type == ST_SUPPRECEIVE)
170                 return exists_grn($type_no);
171
172         $sql = "SELECT trans_no FROM ".TB_PREF."supp_trans WHERE type=".db_escape($type)."
173                 AND trans_no=".db_escape($type_no);
174         $result = db_query($sql, "Cannot retreive a supplier transaction");
175
176     return (db_num_rows($result) > 0);
177 }
178
179 //----------------------------------------------------------------------------------------
180
181 function void_supp_trans($type, $type_no)
182 {
183         $sql = "UPDATE ".TB_PREF."supp_trans SET ov_amount=0, ov_discount=0, ov_gst=0,
184                 alloc=0 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
185
186         db_query($sql, "could not void supp transactions for type=$type and trans_no=$type_no");
187 }
188
189 //----------------------------------------------------------------------------------------
190
191 function clear_supp_trans($type, $type_no)
192 {
193         $sql = "DELETE FROM ".TB_PREF."supp_trans 
194                         WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
195
196         db_query($sql, "could not clear supp transactions for type=$type and trans_no=$type_no");
197 }
198 //----------------------------------------------------------------------------------------
199
200 function post_void_supp_trans($type, $type_no)
201 {
202         if ($type == ST_SUPPAYMENT)
203         {
204                 void_supp_payment($type, $type_no);
205                 return true;
206         }
207
208         if ($type == ST_SUPPINVOICE || $type == ST_SUPPCREDIT)
209         {
210                 void_supp_invoice($type, $type_no);
211                 return true;
212         }
213
214         if ($type == ST_SUPPRECEIVE)
215         {
216                 return void_grn($type_no);
217         }
218
219         return false;
220 }
221
222 //----------------------------------------------------------------------------------------
223
224 function get_sql_for_supplier_inquiry($filter, $after_date, $to_date, $supplier_id=ALL_TEXT)
225 {
226     $date_after = date2sql($after_date);
227     $date_to = date2sql($to_date);
228
229     $sql = "SELECT trans.type, 
230                 trans.trans_no,
231                 trans.reference, 
232                 supplier.supp_name, 
233                 trans.supp_reference,
234         trans.tran_date, 
235                 trans.due_date,
236                 supplier.curr_code, 
237         (trans.ov_amount + trans.ov_gst  + trans.ov_discount) AS TotalAmount,
238
239         IF (trans.type=".ST_SUPPINVOICE." OR trans.type=".ST_BANKDEPOSIT."
240         OR (trans.type=".ST_JOURNAL." AND (trans.ov_amount + trans.ov_gst + trans.ov_discount)>0), 1, -1)*
241                 (ABS(trans.ov_amount + trans.ov_gst + trans.ov_discount) - trans.alloc) Balance,
242                 trans.alloc AS Allocated,
243                 ((trans.type = ".ST_SUPPINVOICE." OR trans.type = ".ST_SUPPCREDIT.") AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue,
244         (ABS(trans.ov_amount + trans.ov_gst  + trans.ov_discount) - trans.alloc <= ".FLOAT_COMP_DELTA.") AS Settled
245         FROM ".TB_PREF."supp_trans as trans, ".TB_PREF."suppliers as supplier
246         WHERE supplier.supplier_id = trans.supplier_id
247                 AND trans.ov_amount != 0";      // exclude voided transactions
248
249         $sql2 = "SELECT ".ST_SUPPRECEIVE." as type, 
250                 trans.id as trans_no,
251                 trans.reference, 
252                 supplier.supp_name, 
253                 po.supp_reference,
254         delivery_date as tran_date, 
255                 '' as due_date,
256                 supplier.curr_code, 
257                 0 as Balance, 
258         '' AS TotalAmount,
259                 '' AS Allocated,
260                 0 as OverDue,
261         1 as Settled
262         FROM ".TB_PREF."grn_batch as trans, ".TB_PREF."suppliers as supplier, ".TB_PREF."purch_orders as po
263         WHERE supplier.supplier_id = trans.supplier_id
264         AND trans.purch_order_no = po.order_no";
265
266         if ($filter == '2')
267                 $sql .= " AND ABS(trans.ov_amount + trans.ov_gst + trans.ov_discount) - trans.alloc>".FLOAT_COMP_DELTA;
268         else {
269                 $sql .= " AND trans.tran_date >= '$date_after'
270                         AND trans.tran_date <= '$date_to'";
271                 $sql2 .= " AND trans.delivery_date >= '$date_after'
272             AND trans.delivery_date <= '$date_to'";
273         }
274
275         if ($supplier_id != ALL_TEXT) {
276                 $sql .= " AND trans.supplier_id = ".db_escape($supplier_id);
277                 $sql2 .= " AND trans.supplier_id = ".db_escape($supplier_id);
278         }
279         if (($filter == '6')) 
280         {
281                         $sql = $sql2;
282         } 
283         elseif (!isset($filter) || $filter == ALL_TEXT) {
284                 $sql = "SELECT * FROM (($sql) UNION ($sql2)) as tr WHERE 1";
285         }
286
287         if (isset($filter) && $filter != ALL_TEXT)
288         {
289                 if (($filter == '1')) 
290                 {
291                         $sql .= " AND (trans.type = ".ST_SUPPINVOICE." OR trans.type = ".ST_BANKDEPOSIT.")";
292                 } 
293                 elseif ($filter == '3') 
294                 {
295                         $sql .= " AND (trans.type = ".ST_SUPPAYMENT." OR trans.type = ".ST_BANKPAYMENT.") ";
296                 } 
297                 elseif (($filter == '4') || ($filter == '5')) 
298                 {
299                         $sql .= " AND trans.type = ".ST_SUPPCREDIT."  ";
300                 }
301
302                 if (($filter == '2') || ($filter == '5')) 
303                 {
304                         $today =  date2sql(Today());
305                         $sql .= " AND trans.due_date < '$today' ";
306                 }
307         }
308         return $sql;
309 }