Merging version 2.1 RC to main trunk.
[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 //      Retreive parent document number(s) for given transaction
14 //
15 function get_parent_trans($trans_type, $trans_no) {
16
17         $sql = 'SELECT trans_link FROM
18                         '.TB_PREF.'debtor_trans WHERE
19                         (trans_no=' .$trans_no. ' AND type='.$trans_type.' AND trans_link!=0)';
20
21         $result = db_query($sql, 'Parent document numbers cannot be retrieved');
22
23         if (db_num_rows($result)) {
24                 $link = db_fetch($result);
25                 return array($link['trans_link']);
26         }
27         if ($trans_type!=10) return 0;  // this is credit note with no parent invoice
28         // invoice: find batch invoice parent trans.
29         $sql = 'SELECT trans_no FROM
30                         '.TB_PREF.'debtor_trans WHERE
31                         (trans_link='.$trans_no.' AND type='. get_parent_type($trans_type) .')';
32
33         $result = db_query($sql, 'Delivery links cannot be retrieved');
34
35         $delivery = array();
36         if(db_num_rows($result)>0) {
37                 while($link = db_fetch($result)) {
38                         $delivery[] = $link['trans_no'];
39                 }
40         }
41         return count($delivery) ? $delivery : 0;
42 }
43
44 //----------------------------------------------------------------------------------------
45 // Mark changes in debtor_trans_details
46 //
47 function update_customer_trans_version($type, $versions) {
48
49         $sql= 'UPDATE '.TB_PREF. 'debtor_trans SET version=version+1
50                         WHERE type='.$type. ' AND (';
51
52         foreach ($versions as $trans_no=>$version)
53                 $where[] =      '(trans_no='.$trans_no.
54                         ' AND version='.$version.')';
55
56                 $sql .= implode(' OR ', $where) .')';
57
58         return  db_query($sql, 'Concurrent editing conflict');
59 }
60
61 //----------------------------------------------------------------------------------------
62 // Gets document header versions for transaction set of type $type
63 // $trans_no = array(num1, num2,...);
64 // returns array(num1=>ver1, num2=>ver2...)
65 //
66 function get_customer_trans_version($type, $trans_no) {
67         if (!is_array($trans_no))
68                 $trans_no = array( $trans_no );
69
70         $sql= 'SELECT trans_no, version FROM '.TB_PREF. 'debtor_trans
71                         WHERE type='.$type.' AND (';
72
73         foreach ($trans_no as $key=>$trans)
74                 $trans_no[$key] =       'trans_no='.$trans_no[$key];
75
76         $sql .= implode(' OR ', $trans_no) . ')';
77
78         $res = db_query($sql, 'document version retreival');
79
80         $vers = array();
81         while($mysql=db_fetch($res)) {
82                 $vers[$mysql['trans_no']] = $mysql['version'];
83         }
84         return $vers;
85 }
86 //----------------------------------------------------------------------------------------
87 // $Total, $Tax, $Freight, $discount all in customer's currency
88 // date_ is display date (non-sql)
89 function write_customer_trans($trans_type, $trans_no, $debtor_no, $BranchNo,
90         $date_, $reference, $Total, $discount=0, $Tax=0, $Freight=0, $FreightTax=0,
91         $sales_type=0, $order_no=0, $trans_link=0, $ship_via=0, $due_date="",
92         $AllocAmt=0, $rate=0, $dimension_id=0, $dimension2_id=0)
93 {
94
95         $curr = get_customer_currency($debtor_no);
96         if ($rate == 0)
97                 $rate = get_exchange_rate_from_home_currency($curr, $date_);
98
99         $SQLDate = date2sql($date_);
100         if ($due_date == "")
101                 $SQLDueDate = "000-00-00";
102         else
103                 $SQLDueDate = date2sql($due_date);
104
105         if ($trans_no==0) {
106         $trans_no = get_next_trans_no($trans_type);
107
108         $sql = "INSERT INTO ".TB_PREF."debtor_trans (
109                 trans_no, type,
110                 debtor_no, branch_code,
111                 tran_date, due_date,
112                 reference, tpe,
113                 order_, ov_amount, ov_discount,
114                 ov_gst, ov_freight, ov_freight_tax,
115                 rate, ship_via, alloc, trans_link,
116                 dimension_id, dimension2_id
117                 ) VALUES ($trans_no, $trans_type,
118                 ".db_escape($debtor_no).", ".db_escape($BranchNo).",
119                 '$SQLDate', '$SQLDueDate', ".db_escape($reference).",
120                 ".db_escape($sales_type).", $order_no, $Total, ".db_escape($discount).", $Tax,
121                 ".db_escape($Freight).",
122                 $FreightTax, $rate, ".db_escape($ship_via).", $AllocAmt, ".db_escape($trans_link).",
123                 $dimension_id, $dimension2_id)";
124         } else {        // may be optional argument should stay unchanged ?
125         $sql = "UPDATE ".TB_PREF."debtor_trans SET
126                 debtor_no=".db_escape($debtor_no)." , branch_code=".db_escape($BranchNo).",
127                 tran_date='$SQLDate', due_date='$SQLDueDate',
128                 reference=".db_escape($reference).", tpe=".db_escape($sales_type).", order_=$order_no,
129                 ov_amount=$Total, ov_discount=".db_escape($discount).", ov_gst=$Tax,
130                 ov_freight=".db_escape($Freight).", ov_freight_tax=$FreightTax, rate=$rate,
131                 ship_via=".db_escape($ship_via).", alloc=$AllocAmt, trans_link=$trans_link,
132                 dimension_id=$dimension_id, dimension2_id=$dimension2_id
133                 WHERE trans_no=$trans_no AND type=$trans_type";
134         }
135         db_query($sql, "The debtor transaction record could not be inserted");
136
137         return $trans_no;
138 }
139
140 //----------------------------------------------------------------------------------------
141
142 function get_customer_trans($trans_id, $trans_type)
143 {
144         $sql = "SELECT ".TB_PREF."debtor_trans.*,
145                 ov_amount+ov_gst+ov_freight+ov_freight_tax+ov_discount AS Total,
146                 ".TB_PREF."debtors_master.name AS DebtorName, ".TB_PREF."debtors_master.address, ".TB_PREF."debtors_master.email AS email2,
147                 ".TB_PREF."debtors_master.curr_code, ".TB_PREF."debtors_master.tax_id, ".TB_PREF."debtors_master.payment_terms ";
148
149         if ($trans_type == systypes::cust_payment()) {
150                 // it's a payment so also get the bank account
151                 $sql .= ", ".TB_PREF."bank_accounts.bank_name, ".TB_PREF."bank_accounts.bank_account_name,
152                         ".TB_PREF."bank_accounts.account_type AS BankTransType ";
153         }
154
155         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
156                 // it's an invoice so also get the shipper and salestype
157                 $sql .= ", ".TB_PREF."shippers.shipper_name, "
158                 .TB_PREF."sales_types.sales_type, "
159                 .TB_PREF."sales_types.tax_included, "
160                 .TB_PREF."cust_branch.*, "
161                 .TB_PREF."debtors_master.discount, "
162                 .TB_PREF."tax_groups.name AS tax_group_name, "
163                 .TB_PREF."tax_groups.id AS tax_group_id ";
164         }
165
166
167         $sql .= " FROM ".TB_PREF."debtor_trans, ".TB_PREF."debtors_master ";
168
169         if ($trans_type == systypes::cust_payment()) {
170                 // it's a payment so also get the bank account
171                 $sql .= ", ".TB_PREF."bank_trans, ".TB_PREF."bank_accounts";
172         }
173
174         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
175                 // it's an invoice so also get the shipper, salestypes
176                 $sql .= ", ".TB_PREF."shippers, ".TB_PREF."sales_types, ".TB_PREF."cust_branch, ".TB_PREF."tax_groups ";
177         }
178
179         $sql .= " WHERE ".TB_PREF."debtor_trans.trans_no=$trans_id
180                 AND ".TB_PREF."debtor_trans.type=$trans_type
181                 AND ".TB_PREF."debtor_trans.debtor_no=".TB_PREF."debtors_master.debtor_no";
182
183         if ($trans_type == systypes::cust_payment()) {
184                 // it's a payment so also get the bank account
185                 $sql .= " AND ".TB_PREF."bank_trans.trans_no =$trans_id
186                         AND ".TB_PREF."bank_trans.type=$trans_type
187                         AND ".TB_PREF."bank_accounts.id=".TB_PREF."bank_trans.bank_act ";
188         }
189         if ($trans_type == 10 OR $trans_type == 11 OR $trans_type == 13) {
190                 // it's an invoice so also get the shipper
191                 $sql .= " AND ".TB_PREF."shippers.shipper_id=".TB_PREF."debtor_trans.ship_via
192                         AND ".TB_PREF."sales_types.id = ".TB_PREF."debtor_trans.tpe
193                         AND ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code
194                         AND ".TB_PREF."cust_branch.tax_group_id = ".TB_PREF."tax_groups.id ";
195         }
196
197         $result = db_query($sql, "Cannot retreive a debtor transaction");
198
199         if (db_num_rows($result) == 0) {
200                 // can't return nothing
201                 display_db_error("no debtor trans found for given params", $sql, true);
202                 exit;
203         }
204
205         if (db_num_rows($result) > 1) {
206                 // can't return multiple
207                 display_db_error("duplicate debtor transactions found for given params", $sql, true);
208                 exit;
209         }
210
211         //return db_fetch($result);
212         $row = db_fetch($result);
213         $row['email'] = $row['email2'];
214         return $row;
215 }
216
217 //----------------------------------------------------------------------------------------
218
219 function exists_customer_trans($type, $type_no)
220 {
221         $sql = "SELECT trans_no FROM ".TB_PREF."debtor_trans WHERE type=$type
222                 AND trans_no=$type_no";
223
224         $result = db_query($sql, "Cannot retreive a debtor transaction");
225
226         return (db_num_rows($result) > 0);
227 }
228
229 //----------------------------------------------------------------------------------------
230
231 // retreives the related sales order for a given trans
232
233 function get_customer_trans_order($type, $type_no)
234 {
235         $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=$type AND trans_no=$type_no";
236
237         $result = db_query($sql, "The debtor transaction could not be queried");
238
239         $row = db_fetch_row($result);
240
241         return $row[0];
242 }
243
244 //----------------------------------------------------------------------------------------
245
246 function get_customer_details_from_trans($type, $type_no)
247 {
248         $sql = "SELECT ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code, ".TB_PREF."cust_branch.br_name
249                 FROM ".TB_PREF."debtors_master,".TB_PREF."cust_branch,".TB_PREF."debtor_trans
250                 WHERE ".TB_PREF."debtor_trans.type=$type AND ".TB_PREF."debtor_trans.trans_no=$type_no
251                 AND ".TB_PREF."debtors_master.debtor_no = ".TB_PREF."debtor_trans.debtor_no
252                 AND     ".TB_PREF."cust_branch.branch_code = ".TB_PREF."debtor_trans.branch_code";
253
254         $result = db_query($sql, "could not get customer details from trans");
255         return db_fetch($result);
256 }
257
258 //----------------------------------------------------------------------------------------
259
260 function void_customer_trans($type, $type_no)
261 {
262         // clear all values and mark as void
263         $sql = "UPDATE ".TB_PREF."debtor_trans SET ov_amount=0, ov_discount=0, ov_gst=0, ov_freight=0,
264                 ov_freight_tax=0, alloc=0, version=version+1 WHERE type=$type AND trans_no=$type_no";
265
266         db_query($sql, "could not void debtor transactions for type=$type and trans_no=$type_no");
267 }
268
269 //----------------------------------------------------------------------------------------
270
271 function post_void_customer_trans($type, $type_no)
272 {
273         switch ($type) {
274                 case 10 :
275                 case 11 :
276                         void_sales_invoice($type, $type_no);
277                         break;
278                 case 13 :
279                         void_sales_delivery($type, $type_no);
280                         break;
281                 case 12 :
282                         void_customer_payment($type, $type_no);
283                         break;
284         }
285 }
286
287 //----------------------------------------------------------------------------------------
288
289 function get_customer_trans_link($type, $type_no)
290 {
291         $row = db_query("SELECT trans_link from ".TB_PREF."debtor_trans
292                 WHERE type=$type AND trans_no=$type_no",
293                 "could not get transaction link for type=$type and trans_no=$type_no");
294         return $row[0];
295 }
296 //----------------------------------------------------------------------------------------
297
298 ?>