Cleanup: removed all closing tags in php files.
[fa-stable.git] / sales / includes / db / cust_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 // Mark changes in debtor_trans_details
14 //
15 function update_customer_trans_version($type, $versions) {
16
17         $sql= 'UPDATE '.TB_PREF. 'debtor_trans SET version=version+1
18                         WHERE type='.db_escape($type).' AND (';
19
20         foreach ($versions as $trans_no=>$version)
21                 $where[] =      '(trans_no='.db_escape($trans_no).' AND version='.$version.')';
22
23                 $sql .= implode(' OR ', $where) .')';
24
25         return  db_query($sql, 'Concurrent editing conflict');
26 }
27
28 //----------------------------------------------------------------------------------------
29 // Gets document header versions for transaction set of type $type
30 // $trans_no = array(num1, num2,...);
31 // returns array(num1=>ver1, num2=>ver2...)
32 //
33 function get_customer_trans_version($type, $trans_no) {
34         if (!is_array($trans_no))
35                 $trans_no = array( $trans_no );
36
37         $sql= 'SELECT trans_no, version FROM '.TB_PREF. 'debtor_trans
38                         WHERE type='.db_escape($type).' AND (';
39
40         foreach ($trans_no as $key=>$trans)
41                 $trans_no[$key] =       'trans_no='.db_escape($trans_no[$key]);
42
43         $sql .= implode(' OR ', $trans_no) . ')';
44
45         $res = db_query($sql, 'document version retreival');
46
47         $vers = array();
48         while($mysql=db_fetch($res)) {
49                 $vers[$mysql['trans_no']] = $mysql['version'];
50         }
51         return $vers;
52 }
53 //----------------------------------------------------------------------------------------
54 // $Total, $Tax, $Freight, $discount all in customer's currency
55 // date_ is display date (non-sql)
56 function write_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
57         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
58         $sales_type=0, $order_no=0, $ship_via=0, $due_date="",
59         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0, $payment_terms=null, $tax_included=0, $prep_amount=0)
60 {
61         $new = $trans_no==0;
62         $curr = get_customer_currency($debtor_no);
63         if ($rate == 0)
64                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
65
66         $SQLDate = date2sql($date_);
67         if ($due_date == "")
68                 $SQLDueDate = "0000-00-00";
69         else
70                 $SQLDueDate = date2sql($due_date);
71         
72         if ($trans_type == ST_BANKPAYMENT)
73                 $Total = -$Total;
74
75     if ($new || !exists_customer_trans($trans_type, $trans_no))
76     {
77         if ($new)
78         $trans_no = get_next_trans_no($trans_type);
79
80         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
81                 trans_no, type,
82                 debtor_no, branch_code,
83                 tran_date, due_date,
84                 reference, tpe,
85                 order_, ov_amount, ov_discount,
86                 ov_gst, ov_freight, ov_freight_tax,
87                 rate, ship_via, alloc,
88                 dimension_id, dimension2_id, payment_terms, tax_included, prep_amount
89                 ) VALUES (".db_escape($trans_no).", ".db_escape($trans_type).",
90                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
91                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
92                 ".db_escape($sales_type).", ".db_escape($order_no).", $Total, ".db_escape($discount).", $Tax,
93                 ".db_escape($Freight).",
94                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt,
95                 ".db_escape($dimension_id).", ".db_escape($dimension2_id).", "
96                 .db_escape($payment_terms, true).", "
97                 .db_escape($tax_included).", ".db_escape($prep_amount).")";
98         } else {        // may be optional argument should stay unchanged ?
99         $sql = "UPDATE ".TB_PREF."debtor_trans SET
100                 debtor_no=".db_escape($debtor_no)." , branch_code=".db_escape($BranchNo).",
101                 tran_date='$SQLDate', due_date='$SQLDueDate',
102                 reference=".db_escape($reference).", tpe=".db_escape($sales_type).", order_=".db_escape($order_no).",
103                 ov_amount=$Total, ov_discount=".db_escape($discount).", ov_gst=$Tax,
104                 ov_freight=".db_escape($Freight).", ov_freight_tax=$FreightTax, rate=$rate,
105                 ship_via=".db_escape($ship_via).", alloc=$AllocAmt,
106                 dimension_id=".db_escape($dimension_id).", dimension2_id=".db_escape($dimension2_id).",
107                 payment_terms=".db_escape($payment_terms, true).",
108                 tax_included=".db_escape($tax_included).",
109                 prep_amount =".db_escape($prep_amount)."
110                 WHERE trans_no=".db_escape($trans_no)." AND type=".db_escape($trans_type);
111         }
112         db_query($sql, "The debtor transaction record could not be inserted");
113
114         add_audit_trail($trans_type, $trans_no, $date_, $new ? '': _("Updated."));
115
116         return $trans_no;
117 }
118 //----------------------------------------------------------------------------------------
119
120 function get_customer_trans($trans_id, $trans_type)
121 {
122         global $go_debug;
123
124         $sql = "SELECT trans.*,"
125                 ."ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,"
126                 ."cust.name AS DebtorName, cust.address, "
127                 ."cust.curr_code, "
128                 ."cust.tax_id,
129                 trans.prep_amount>0 as prepaid,"
130                 ."com.memo_";
131
132         if ($trans_type == ST_CUSTPAYMENT || $trans_type == ST_BANKDEPOSIT) {
133                 // it's a payment so also get the bank account
134                 // Chaitanya : Added bank_act to support Customer Payment Edit
135                 $sql .= ",bank_act,".TB_PREF."bank_accounts.bank_name, ".TB_PREF."bank_accounts.bank_account_name,
136                         ".TB_PREF."bank_accounts.account_type AS BankTransType,
137                         ".TB_PREF."bank_accounts.bank_curr_code,
138                         ".TB_PREF."bank_trans.amount as bank_amount";
139         }
140
141         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
142                 // it's an invoice so also get the shipper and salestype
143                 $sql .= ", ".TB_PREF."shippers.shipper_name, "
144                 .TB_PREF."sales_types.sales_type, "
145                 .TB_PREF."sales_types.tax_included, "
146                 ."branch.*, "
147                 ."cust.discount, "
148                 .TB_PREF."tax_groups.name AS tax_group_name, "
149                 .TB_PREF."tax_groups.id AS tax_group_id ";
150         }
151
152         $sql .= " FROM ".TB_PREF."debtor_trans trans
153                                         LEFT JOIN ".TB_PREF."comments com ON trans.type=com.type AND trans.trans_no=com.id
154                                         LEFT JOIN ".TB_PREF."shippers ON ".TB_PREF."shippers.shipper_id=trans.ship_via, 
155                                         ".TB_PREF."debtors_master cust";
156
157         if ($trans_type == ST_CUSTPAYMENT || $trans_type == ST_BANKDEPOSIT) {
158                 // it's a payment so also get the bank account
159                 $sql .= ", ".TB_PREF."bank_trans, ".TB_PREF."bank_accounts";
160         }
161
162         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
163                 // it's an invoice so also get the shipper, salestypes
164                 $sql .= ", ".TB_PREF."sales_types, "
165                 .TB_PREF."cust_branch branch, "
166                 .TB_PREF."tax_groups ";
167         }
168
169         $sql .= " WHERE trans.trans_no=".db_escape($trans_id)."
170                 AND trans.type=".db_escape($trans_type)."
171                 AND trans.debtor_no=cust.debtor_no";
172
173         if ($trans_type == ST_CUSTPAYMENT || $trans_type == ST_BANKDEPOSIT) {
174                 // it's a payment so also get the bank account
175                 $sql .= " AND ".TB_PREF."bank_trans.trans_no =".db_escape($trans_id)."
176                         AND ".TB_PREF."bank_trans.type=$trans_type
177                         AND ".TB_PREF."bank_trans.amount != 0
178                         AND ".TB_PREF."bank_accounts.id=".TB_PREF."bank_trans.bank_act ";
179         }
180         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
181                 // it's an invoice so also get the shipper
182                 $sql .= " AND ".TB_PREF."sales_types.id = trans.tpe
183                         AND branch.branch_code = trans.branch_code
184                         AND branch.tax_group_id = ".TB_PREF."tax_groups.id ";
185         }
186
187         $result = db_query($sql, "Cannot retreive a debtor transaction");
188
189         if (db_num_rows($result) == 0) {
190                 // can't return nothing
191                 if($go_debug)
192                         display_backtrace();
193                 display_db_error("no debtor trans found for given params", $sql, true);
194                 exit;
195         }
196         if (db_num_rows($result) > 1) {
197                 // can't return multiple
198                 if($go_debug)
199                         display_backtrace();
200                 display_db_error("duplicate debtor transactions found for given params", $sql, true);
201                 exit;
202         }
203
204         $row = db_fetch($result);
205         return $row;
206 }
207
208 //----------------------------------------------------------------------------------------
209
210 function exists_customer_trans($type, $type_no)
211 {
212         $sql = "SELECT trans_no FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)."
213                 AND trans_no=".db_escape($type_no);
214
215         $result = db_query($sql, "Cannot retreive a debtor transaction");
216
217         return (db_num_rows($result) > 0);
218 }
219
220 //----------------------------------------------------------------------------------------
221
222 // retreives the related sales order for a given trans
223
224 function get_customer_trans_order($type, $type_no)
225 {
226         $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
227
228         $result = db_query($sql, "The debtor transaction could not be queried");
229
230         $row = db_fetch_row($result);
231
232         return $row[0];
233 }
234
235 //----------------------------------------------------------------------------------------
236
237 function get_customer_details_from_trans($type, $type_no)
238 {
239         $sql = "SELECT ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code, ".TB_PREF."cust_branch.br_name
240                 FROM ".TB_PREF."debtors_master,".TB_PREF."cust_branch,".TB_PREF."debtor_trans
241                 WHERE ".TB_PREF."debtor_trans.type=".db_escape($type)." AND ".TB_PREF."debtor_trans.trans_no=".db_escape($type_no)."
242                 AND ".TB_PREF."debtors_master.debtor_no = ".TB_PREF."debtor_trans.debtor_no
243                 AND     ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code";
244
245         $result = db_query($sql, "could not get customer details from trans");
246         return db_fetch($result);
247 }
248
249 //----------------------------------------------------------------------------------------
250
251 function void_customer_trans($type, $type_no)
252 {
253         // clear all values and mark as void
254         $sql = "UPDATE ".TB_PREF."debtor_trans SET ov_amount=0, ov_discount=0, ov_gst=0, ov_freight=0,
255                 ov_freight_tax=0, alloc=0, prep_amount=0, version=version+1 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
256
257         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
258 }
259
260 //----------------------------------------------------------------------------------------
261
262 function clear_customer_trans($type, $type_no)
263 {
264         // Delete
265         $sql = "DELETE FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
266
267         db_query($sql, "could not clear debtor transactions for type=$type and trans_no=$type_no");
268 }
269 //----------------------------------------------------------------------------------------
270
271 function post_void_customer_trans($type, $type_no)
272 {
273         switch ($type) {
274                 case ST_SALESINVOICE :
275                 case ST_CUSTCREDIT   :
276                         void_sales_invoice($type, $type_no);
277                         break;
278                 case ST_CUSTDELIVERY :
279                         void_sales_delivery($type, $type_no);
280                         break;
281                 case ST_CUSTPAYMENT :
282                         void_customer_payment($type, $type_no);
283                         break;
284         }
285 }
286
287 //----------------------------------------------------------------------------------------
288 function get_sql_for_customer_inquiry($from, $to, $cust_id = ALL_TEXT, $filter = ALL_TEXT)
289 {
290     $date_after = date2sql($from);
291     $date_to = date2sql($to);
292
293         $sql = "SELECT 
294                 trans.type, 
295                 trans.trans_no, 
296                 trans.order_, 
297                 trans.reference,
298                 trans.tran_date, 
299                 trans.due_date, 
300                 debtor.name, 
301                 branch.br_name,
302                 debtor.curr_code,
303                 (trans.ov_amount + trans.ov_gst + trans.ov_freight 
304                         + trans.ov_freight_tax + trans.ov_discount)     AS TotalAmount, "; 
305         if ($filter != ALL_TEXT)
306                 $sql .= "@bal := @bal+(trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), ";
307
308 //      else
309 //              $sql .= "IF(trans.type=".ST_CUSTDELIVERY.",'', IF(trans.type=".ST_SALESINVOICE." OR trans.type=".ST_BANKPAYMENT.",@bal := @bal+
310 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), @bal := @bal-
311 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount))) , ";
312                 $sql .= "trans.alloc AS Allocated,
313                 ((trans.type = ".ST_SALESINVOICE.")
314                         AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue ,
315                 Sum(line.quantity-line.qty_done) AS Outstanding
316                 FROM "
317                         .TB_PREF."debtor_trans as trans
318                         LEFT JOIN ".TB_PREF."debtor_trans_details as line
319                                 ON trans.trans_no=line.debtor_trans_no AND trans.type=line.debtor_trans_type,"
320                         .TB_PREF."debtors_master as debtor, "
321                         .TB_PREF."cust_branch as branch
322                 WHERE debtor.debtor_no = trans.debtor_no
323                         AND trans.tran_date >= '$date_after'
324                         AND trans.tran_date <= '$date_to'
325                         AND trans.branch_code = branch.branch_code";
326
327         if ($cust_id != ALL_TEXT)
328                 $sql .= " AND trans.debtor_no = ".db_escape($cust_id);
329
330         if ($filter != ALL_TEXT)
331         {
332                 if ($filter == '1')
333                 {
334                         $sql .= " AND (trans.type = ".ST_SALESINVOICE.") ";
335                 }
336                 elseif ($filter == '2')
337                 {
338                         $sql .= " AND (trans.type = ".ST_SALESINVOICE.") ";
339                 }
340                 elseif ($filter == '3')
341                 {
342                         $sql .= " AND (trans.type = " . ST_CUSTPAYMENT 
343                                         ." OR trans.type = ".ST_BANKDEPOSIT." OR trans.type = ".ST_BANKPAYMENT.") ";
344                 }
345                 elseif ($filter == '4')
346                 {
347                         $sql .= " AND trans.type = ".ST_CUSTCREDIT." ";
348                 }
349                 elseif ($filter == '5')
350                 {
351                         $sql .= " AND trans.type = ".ST_CUSTDELIVERY." ";
352                 }
353
354         if ($filter == '2')
355         {
356                 $today =  date2sql(Today());
357                 $sql .= " AND trans.due_date < '$today'
358                                 AND (trans.ov_amount + trans.ov_gst + trans.ov_freight_tax + 
359                                 trans.ov_freight + trans.ov_discount - trans.alloc > 0) ";
360         }
361         }
362         $sql .= " GROUP BY trans.trans_no, trans.type";
363
364         return $sql;
365 }
366
367 function get_sql_for_sales_deliveries_view($from, $to, $customer_id, $stock_item, $location, $delivery, $outstanding=false)
368 {
369         $sql = "SELECT trans.trans_no,
370                         debtor.name,
371                         branch.branch_code,
372                         branch.br_name,
373                         sorder.deliver_to,
374                         trans.reference,
375                         sorder.customer_ref,
376                         trans.tran_date,
377                         trans.due_date,
378                         (ov_amount+ov_gst+ov_freight+ov_freight_tax) AS DeliveryValue,
379                         debtor.curr_code,
380                         Sum(line.quantity-line.qty_done) AND sorder.prep_amount=0 AS Outstanding,
381                         Sum(line.qty_done) AS Done
382                 FROM "
383                  .TB_PREF."sales_orders as sorder, "
384                  .TB_PREF."debtor_trans as trans, "
385                  .TB_PREF."debtor_trans_details as line, "
386                  .TB_PREF."debtors_master as debtor, "
387                  .TB_PREF."cust_branch as branch
388                         WHERE
389                         sorder.order_no = trans.order_ AND
390                         trans.debtor_no = debtor.debtor_no
391                                 AND trans.type = ".ST_CUSTDELIVERY."
392                                 AND line.debtor_trans_no = trans.trans_no
393                                 AND line.debtor_trans_type = trans.type
394                                 AND trans.branch_code = branch.branch_code
395                                 AND trans.debtor_no = branch.debtor_no ";
396
397         if ($outstanding == true) {
398                  $sql .= " AND line.qty_done < line.quantity ";
399         }
400
401         //figure out the sql required from the inputs available
402         if ($delivery)
403         {
404                 $sql .= " AND trans.trans_no LIKE %".db_escape($delivery);
405                 $sql .= " GROUP BY trans.trans_no";
406         }
407         else
408         {
409                 $sql .= " AND trans.tran_date >= '".date2sql($from)."'";
410                 $sql .= " AND trans.tran_date <= '".date2sql($to)."'";
411
412                 if ($stock_item)
413                         $sql .= " AND line.stock_id=".db_escape($stock_item)." ";
414
415                 if ($location != ALL_TEXT)
416                         $sql .= " AND sorder.from_stk_loc = ".db_escape($location)." ";
417
418                 if ($customer_id != ALL_TEXT)
419                         $sql .= " AND trans.debtor_no = ".db_escape($customer_id);
420
421                 $sql .= " GROUP BY trans.trans_no ";
422
423         } //end no delivery number selected
424         return $sql;
425 }