Fixed sales database design to ensure document relations consistency on line level.
[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='.$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)
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) {
76         $trans_no = get_next_trans_no($trans_type);
77
78         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
79                 trans_no, type,
80                 debtor_no, branch_code,
81                 tran_date, due_date,
82                 reference, tpe,
83                 order_, ov_amount, ov_discount,
84                 ov_gst, ov_freight, ov_freight_tax,
85                 rate, ship_via, alloc,
86                 dimension_id, dimension2_id, payment_terms
87                 ) VALUES ($trans_no, ".db_escape($trans_type).",
88                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
89                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
90                 ".db_escape($sales_type).", ".db_escape($order_no).", $Total, ".db_escape($discount).", $Tax,
91                 ".db_escape($Freight).",
92                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt,
93                 ".db_escape($dimension_id).", ".db_escape($dimension2_id).", "
94                 .db_escape($payment_terms).")";
95         } else {        // may be optional argument should stay unchanged ?
96         $sql = "UPDATE ".TB_PREF."debtor_trans SET
97                 debtor_no=".db_escape($debtor_no)." , branch_code=".db_escape($BranchNo).",
98                 tran_date='$SQLDate', due_date='$SQLDueDate',
99                 reference=".db_escape($reference).", tpe=".db_escape($sales_type).", order_=".db_escape($order_no).",
100                 ov_amount=$Total, ov_discount=".db_escape($discount).", ov_gst=$Tax,
101                 ov_freight=".db_escape($Freight).", ov_freight_tax=$FreightTax, rate=$rate,
102                 ship_via=".db_escape($ship_via).", alloc=$AllocAmt,
103                 dimension_id=".db_escape($dimension_id).", dimension2_id=".db_escape($dimension2_id).",
104                 payment_terms=".db_escape($payment_terms)."
105                 WHERE trans_no=$trans_no AND type=".db_escape($trans_type);
106         }
107         db_query($sql, "The debtor transaction record could not be inserted");
108
109         add_audit_trail($trans_type, $trans_no, $date_, $new ? '': _("Updated."));
110
111         return $trans_no;
112 }
113
114 //----------------------------------------------------------------------------------------
115
116 function reinsert_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
117         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
118         $sales_type=0, $order_no=0, $ship_via=0, $due_date="",
119         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0)
120 {
121         if ($trans_no == '')
122                 display_db_error('Invalid call to function reinsert_customer_trans');
123                 
124         $curr = get_customer_currency($debtor_no);
125         if ($rate == 0)
126                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
127
128         $SQLDate = date2sql($date_);
129         if ($due_date == "")
130                 $SQLDueDate = "0000-00-00";
131         else
132                 $SQLDueDate = date2sql($due_date);
133         
134         if ($trans_type == ST_BANKPAYMENT)
135                 $Total = -$Total;
136
137         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
138                 trans_no, type,
139                 debtor_no, branch_code,
140                 tran_date, due_date,
141                 reference, tpe,
142                 order_, ov_amount, ov_discount,
143                 ov_gst, ov_freight, ov_freight_tax,
144                 rate, ship_via, alloc,
145                 dimension_id, dimension2_id
146                 ) VALUES ($trans_no, ".db_escape($trans_type).",
147                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
148                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
149                 ".db_escape($sales_type).", ".db_escape($order_no).", $Total, ".db_escape($discount).", $Tax,
150                 ".db_escape($Freight).",
151                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt,
152                 ".db_escape($dimension_id).", ".db_escape($dimension2_id).")";
153
154         db_query($sql, "The debtor transaction record could not be inserted");
155
156         add_audit_trail($trans_type, $trans_no, $date_, _("Updated."));
157
158         return $trans_no;
159 }
160
161 //----------------------------------------------------------------------------------------
162
163 function get_customer_trans($trans_id, $trans_type)
164 {
165         $sql = "SELECT trans.*,"
166                 ."ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,"
167                 ."cust.name AS DebtorName, cust.address, "
168                 ."cust.curr_code, "
169                 ."cust.tax_id ";
170
171         if ($trans_type == ST_CUSTPAYMENT) {
172                 // it's a payment so also get the bank account
173                 $sql .= ", ".TB_PREF."bank_accounts.bank_name, ".TB_PREF."bank_accounts.bank_account_name,
174                         ".TB_PREF."bank_accounts.account_type AS BankTransType ";
175         }
176
177         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
178                 // it's an invoice so also get the shipper and salestype
179                 $sql .= ", ".TB_PREF."shippers.shipper_name, "
180                 .TB_PREF."sales_types.sales_type, "
181                 .TB_PREF."sales_types.tax_included, "
182                 ."branch.*, "
183                 ."cust.discount, "
184                 .TB_PREF."tax_groups.name AS tax_group_name, "
185                 .TB_PREF."tax_groups.id AS tax_group_id ";
186         }
187
188         $sql .= " FROM ".TB_PREF."debtor_trans trans, ".TB_PREF."debtors_master cust";
189
190         if ($trans_type == ST_CUSTPAYMENT) {
191                 // it's a payment so also get the bank account
192                 $sql .= ", ".TB_PREF."bank_trans, ".TB_PREF."bank_accounts";
193         }
194
195         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
196                 // it's an invoice so also get the shipper, salestypes
197                 $sql .= ", ".TB_PREF."shippers, "
198                 .TB_PREF."sales_types, "
199                 .TB_PREF."cust_branch branch, "
200                 .TB_PREF."tax_groups ";
201         }
202
203         $sql .= " WHERE trans.trans_no=".db_escape($trans_id)."
204                 AND trans.type=".db_escape($trans_type)."
205                 AND trans.debtor_no=cust.debtor_no";
206
207         if ($trans_type == ST_CUSTPAYMENT) {
208                 // it's a payment so also get the bank account
209                 $sql .= " AND ".TB_PREF."bank_trans.trans_no =$trans_id
210                         AND ".TB_PREF."bank_trans.type=$trans_type
211                         AND ".TB_PREF."bank_accounts.id=".TB_PREF."bank_trans.bank_act ";
212         }
213         if ($trans_type == ST_SALESINVOICE || $trans_type == ST_CUSTCREDIT || $trans_type == ST_CUSTDELIVERY) {
214                 // it's an invoice so also get the shipper
215                 $sql .= " AND ".TB_PREF."shippers.shipper_id=trans.ship_via
216                         AND ".TB_PREF."sales_types.id = trans.tpe
217                         AND branch.branch_code = trans.branch_code
218                         AND branch.tax_group_id = ".TB_PREF."tax_groups.id ";
219         }
220
221         $result = db_query($sql, "Cannot retreive a debtor transaction");
222
223         if (db_num_rows($result) == 0) {
224                 // can't return nothing
225                 display_db_error("no debtor trans found for given params", $sql, true);
226                 exit;
227         }
228
229         if (db_num_rows($result) > 1) {
230                 // can't return multiple
231                 display_db_error("duplicate debtor transactions found for given params", $sql, true);
232                 exit;
233         }
234
235         $row = db_fetch($result);
236         return $row;
237 }
238
239 //----------------------------------------------------------------------------------------
240
241 function exists_customer_trans($type, $type_no)
242 {
243         $sql = "SELECT trans_no FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)."
244                 AND trans_no=".db_escape($type_no);
245
246         $result = db_query($sql, "Cannot retreive a debtor transaction");
247
248         return (db_num_rows($result) > 0);
249 }
250
251 //----------------------------------------------------------------------------------------
252
253 // retreives the related sales order for a given trans
254
255 function get_customer_trans_order($type, $type_no)
256 {
257         $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
258
259         $result = db_query($sql, "The debtor transaction could not be queried");
260
261         $row = db_fetch_row($result);
262
263         return $row[0];
264 }
265
266 //----------------------------------------------------------------------------------------
267
268 function get_customer_details_from_trans($type, $type_no)
269 {
270         $sql = "SELECT ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code, ".TB_PREF."cust_branch.br_name
271                 FROM ".TB_PREF."debtors_master,".TB_PREF."cust_branch,".TB_PREF."debtor_trans
272                 WHERE ".TB_PREF."debtor_trans.type=".db_escape($type)." AND ".TB_PREF."debtor_trans.trans_no=".db_escape($type_no)."
273                 AND ".TB_PREF."debtors_master.debtor_no = ".TB_PREF."debtor_trans.debtor_no
274                 AND     ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code";
275
276         $result = db_query($sql, "could not get customer details from trans");
277         return db_fetch($result);
278 }
279
280 //----------------------------------------------------------------------------------------
281
282 function void_customer_trans($type, $type_no)
283 {
284         // clear all values and mark as void
285         $sql = "UPDATE ".TB_PREF."debtor_trans SET ov_amount=0, ov_discount=0, ov_gst=0, ov_freight=0,
286                 ov_freight_tax=0, alloc=0, version=version+1 WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
287
288         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
289 }
290
291 //----------------------------------------------------------------------------------------
292
293 function clear_customer_trans($type, $type_no)
294 {
295         // Delete
296         $sql = "DELETE FROM ".TB_PREF."debtor_trans WHERE type=".db_escape($type)." AND trans_no=".db_escape($type_no);
297
298         db_query($sql, "could not clear debtor transactions for type=$type and trans_no=$type_no");
299 }
300 //----------------------------------------------------------------------------------------
301
302 function post_void_customer_trans($type, $type_no)
303 {
304         switch ($type) {
305                 case ST_SALESINVOICE :
306                 case ST_CUSTCREDIT   :
307                         void_sales_invoice($type, $type_no);
308                         break;
309                 case ST_CUSTDELIVERY :
310                         void_sales_delivery($type, $type_no);
311                         break;
312                 case ST_CUSTPAYMENT :
313                         void_customer_payment($type, $type_no);
314                         break;
315         }
316 }
317
318 //----------------------------------------------------------------------------------------
319
320 function get_sql_for_customer_inquiry()
321 {
322     $date_after = date2sql($_POST['TransAfterDate']);
323     $date_to = date2sql($_POST['TransToDate']);
324
325         $sql = "SELECT 
326                 trans.type, 
327                 trans.trans_no, 
328                 trans.order_, 
329                 trans.reference,
330                 trans.tran_date, 
331                 trans.due_date, 
332                 debtor.name, 
333                 branch.br_name,
334                 debtor.curr_code,
335                 (trans.ov_amount + trans.ov_gst + trans.ov_freight 
336                         + trans.ov_freight_tax + trans.ov_discount)     AS TotalAmount, "; 
337         if ($_POST['filterType'] != ALL_TEXT)
338                 $sql .= "@bal := @bal+(trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), ";
339
340 //      else
341 //              $sql .= "IF(trans.type=".ST_CUSTDELIVERY.",'', IF(trans.type=".ST_SALESINVOICE." OR trans.type=".ST_BANKPAYMENT.",@bal := @bal+
342 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount), @bal := @bal-
343 //                      (trans.ov_amount + trans.ov_gst + trans.ov_freight + trans.ov_freight_tax + trans.ov_discount))) , ";
344                 $sql .= "trans.alloc AS Allocated,
345                 ((trans.type = ".ST_SALESINVOICE.")
346                         AND trans.due_date < '" . date2sql(Today()) . "') AS OverDue ,
347                 Sum(line.quantity-line.qty_done) AS Outstanding
348                 FROM "
349                         .TB_PREF."debtor_trans as trans
350                         LEFT JOIN ".TB_PREF."debtor_trans_details as line
351                                 ON trans.trans_no=line.debtor_trans_no AND trans.type=line.debtor_trans_type,"
352                         .TB_PREF."debtors_master as debtor, "
353                         .TB_PREF."cust_branch as branch
354                 WHERE debtor.debtor_no = trans.debtor_no
355                         AND trans.tran_date >= '$date_after'
356                         AND trans.tran_date <= '$date_to'
357                         AND trans.branch_code = branch.branch_code";
358
359         if ($_POST['customer_id'] != ALL_TEXT)
360                 $sql .= " AND trans.debtor_no = ".db_escape($_POST['customer_id']);
361
362         if ($_POST['filterType'] != ALL_TEXT)
363         {
364                 if ($_POST['filterType'] == '1')
365                 {
366                         $sql .= " AND (trans.type = ".ST_SALESINVOICE." OR trans.type = ".ST_BANKPAYMENT.") ";
367                 }
368                 elseif ($_POST['filterType'] == '2')
369                 {
370                         $sql .= " AND (trans.type = ".ST_SALESINVOICE.") ";
371                 }
372                 elseif ($_POST['filterType'] == '3')
373                 {
374                         $sql .= " AND (trans.type = " . ST_CUSTPAYMENT 
375                                         ." OR trans.type = ".ST_BANKDEPOSIT.") ";
376                 }
377                 elseif ($_POST['filterType'] == '4')
378                 {
379                         $sql .= " AND trans.type = ".ST_CUSTCREDIT." ";
380                 }
381                 elseif ($_POST['filterType'] == '5')
382                 {
383                         $sql .= " AND trans.type = ".ST_CUSTDELIVERY." ";
384                 }
385
386         if ($_POST['filterType'] == '2')
387         {
388                 $today =  date2sql(Today());
389                 $sql .= " AND trans.due_date < '$today'
390                                 AND (trans.ov_amount + trans.ov_gst + trans.ov_freight_tax + 
391                                 trans.ov_freight + trans.ov_discount - trans.alloc > 0) ";
392         }
393         }
394         $sql .= " GROUP BY trans.trans_no, trans.type";
395
396         return $sql;
397 }
398
399 function get_sql_for_sales_deliveries_view($selected_customer, $selected_stock_item=null)
400 {
401         $sql = "SELECT trans.trans_no,
402                         debtor.name,
403                         branch.branch_code,
404                         branch.br_name,
405                         sorder.deliver_to,
406                         trans.reference,
407                         sorder.customer_ref,
408                         trans.tran_date,
409                         trans.due_date,
410                         (ov_amount+ov_gst+ov_freight+ov_freight_tax) AS DeliveryValue,
411                         debtor.curr_code,
412                         Sum(line.quantity-line.qty_done) AS Outstanding,
413                         Sum(line.qty_done) AS Done
414                 FROM "
415                  .TB_PREF."sales_orders as sorder, "
416                  .TB_PREF."debtor_trans as trans, "
417                  .TB_PREF."debtor_trans_details as line, "
418                  .TB_PREF."debtors_master as debtor, "
419                  .TB_PREF."cust_branch as branch
420                         WHERE
421                         sorder.order_no = trans.order_ AND
422                         trans.debtor_no = debtor.debtor_no
423                                 AND trans.type = ".ST_CUSTDELIVERY."
424                                 AND line.debtor_trans_no = trans.trans_no
425                                 AND line.debtor_trans_type = trans.type
426                                 AND trans.branch_code = branch.branch_code
427                                 AND trans.debtor_no = branch.debtor_no ";
428
429         if ($_POST['OutstandingOnly'] == true) {
430                  $sql .= " AND line.qty_done < line.quantity ";
431         }
432
433         //figure out the sql required from the inputs available
434         if (isset($_POST['DeliveryNumber']) && $_POST['DeliveryNumber'] != "")
435         {
436                 $delivery = "%".$_POST['DeliveryNumber'];
437                 $sql .= " AND trans.trans_no LIKE ".db_escape($delivery);
438                 $sql .= " GROUP BY trans.trans_no";
439         }
440         else
441         {
442                 $sql .= " AND trans.tran_date >= '".date2sql($_POST['DeliveryAfterDate'])."'";
443                 $sql .= " AND trans.tran_date <= '".date2sql($_POST['DeliveryToDate'])."'";
444
445                 if ($selected_customer != -1)
446                         $sql .= " AND trans.debtor_no=".db_escape($selected_customer)." ";
447
448                 if (isset($selected_stock_item))
449                         $sql .= " AND line.stock_id=".db_escape($selected_stock_item)." ";
450
451                 if (isset($_POST['StockLocation']) && $_POST['StockLocation'] != ALL_TEXT)
452                         $sql .= " AND sorder.from_stk_loc = ".db_escape($_POST['StockLocation'])." ";
453
454                 $sql .= " GROUP BY trans.trans_no ";
455
456         } //end no delivery number selected
457         return $sql;
458 }
459 ?>