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 include_once($path_to_root . "/includes/banking.inc");
13 include_once($path_to_root . "/includes/inventory.inc");
14 include_once($path_to_root . "/includes/db/allocations_db.inc");
15 include_once($path_to_root . "/sales/includes/db/sales_order_db.inc");
16 include_once($path_to_root . "/sales/includes/db/sales_credit_db.inc");
17 include_once($path_to_root . "/sales/includes/db/sales_invoice_db.inc");
18 include_once($path_to_root . "/sales/includes/db/sales_delivery_db.inc");
19 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
20 include_once($path_to_root . "/sales/includes/db/sales_points_db.inc");
21 include_once($path_to_root . "/sales/includes/db/sales_groups_db.inc");
22 include_once($path_to_root . "/sales/includes/db/recurrent_invoices_db.inc");
23 include_once($path_to_root . "/sales/includes/db/custalloc_db.inc");
24 include_once($path_to_root . "/sales/includes/db/cust_trans_db.inc");
25 include_once($path_to_root . "/sales/includes/db/cust_trans_details_db.inc");
26 include_once($path_to_root . "/sales/includes/db/payment_db.inc");
27 include_once($path_to_root . "/sales/includes/db/branches_db.inc");
28 include_once($path_to_root . "/sales/includes/db/customers_db.inc");
30 //----------------------------------------------------------------------------------------
31 // add a debtor-related gl transaction
32 // $date_ is display date (non-sql)
33 // $amount is in CUSTOMER'S currency
35 function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
36 $amount, $customer_id, $rate=0)
38 return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
39 get_customer_currency($customer_id),
40 PT_CUSTOMER, $customer_id, $rate);
43 //----------------------------------------------------------------------------------------
45 function get_calculated_price($stock_id, $add_pct)
47 $avg = get_unit_cost($stock_id);
50 return round2($avg * (1 + $add_pct / 100), user_price_dec());
53 function round_to_nearest($price, $round_to)
57 $pow = pow(10, user_price_dec());
58 if ($pow >= $round_to)
59 $mod = ($pow % $round_to);
61 $mod = ($round_to % $pow);
63 $price = ceil($price) - ($pow - $round_to) / $pow;
65 $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
70 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
73 $date = new_doc_date();
77 $myrow = get_sales_type($sales_type_id);
78 $factor = $myrow['factor'];
81 $add_pct = get_company_pref('add_pct');
82 $base_id = get_base_sales_type();
83 $home_curr = get_company_currency();
84 // AND (sales_type_id = $sales_type_id OR sales_type_id = $base_id)
85 $sql = "SELECT price, curr_abrev, sales_type_id
86 FROM ".TB_PREF."prices
87 WHERE stock_id = ".db_escape($stock_id)."
88 AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
90 $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
91 $num_rows = db_num_rows($result);
92 $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
94 $round_to = get_company_pref('round_to');
96 while($myrow = db_fetch($result))
98 $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
101 if (isset($prices[$sales_type_id][$currency]))
103 $price = $prices[$sales_type_id][$currency];
105 elseif (isset($prices[$base_id][$currency]))
107 $price = $prices[$base_id][$currency] * $factor;
109 elseif (isset($prices[$sales_type_id][$home_curr]))
111 $price = $prices[$sales_type_id][$home_curr] / $rate;
113 elseif (isset($prices[$base_id][$home_curr]))
115 $price = $prices[$base_id][$home_curr] * $factor / $rate;
117 elseif ($num_rows == 0 && $add_pct != -1)
119 $price = get_calculated_price($stock_id, $add_pct);
120 if ($currency != $home_curr)
125 if ($price === false)
127 elseif ($round_to != 1)
128 return round_to_nearest($price, $round_to);
130 return round2($price, user_price_dec());
132 //----------------------------------------------------------------------------------------
134 // Get price for given item or kit.
135 // When $std==true price is calculated as a sum of all included stock items,
136 // otherwise all prices set for kits and items are accepted.
138 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
139 $date=null, $std = false)
143 $kit_price = get_price( $item_code, $currency, $sales_type_id,
146 if ($kit_price !== 0) {
150 // no price for kit found, get total value of all items
151 $kit = get_item_kit($item_code);
153 while($item = db_fetch($kit)) {
154 if ($item['item_code'] != $item['stock_id']) {
156 $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
157 $currency, $sales_type_id, $factor, $date, $std);
161 $kit_price += $item['quantity'] * get_price( $item['stock_id'],
162 $currency, $sales_type_id, $factor, $date);
168 //--------------------------------------------------------------------------------------------------
169 function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
171 $doc_type = get_parent_type($doc_type);
173 $qty_dispatched = (float)$qty_dispatched;
178 if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
180 $sql = "UPDATE ".TB_PREF."sales_order_details
181 SET qty_sent = qty_sent + $qty_dispatched";
183 $sql .= ", quantity = quantity + $qty_dispatched";
184 $sql .= " WHERE id=".db_escape($line_id);
187 $sql = "UPDATE ".TB_PREF."debtor_trans_details
188 SET qty_done = qty_done + $qty_dispatched
189 WHERE id=".db_escape($line_id);
191 db_query($sql, "The parent document detail record could not be updated");
195 //--------------------------------------------------------------------------------------------------
196 // find inventory location for given transaction
198 function get_location(&$cart)
200 $sql = "SELECT location.*
201 FROM ".TB_PREF."stock_moves move,"
202 .TB_PREF."locations location".
203 " WHERE type=".db_escape($cart->trans_type).
204 " AND trans_no=".key($cart->trans_no).
206 " AND location.loc_code=move.loc_code";
208 $result = db_query($sql, 'Retreiving inventory location');
210 if (db_num_rows($result)) {
211 return db_fetch($result);
215 //--------------------------------------------------------------------------------------------------
216 // Generic read debtor transaction into cart
218 // $trans_no - array of trans nums; special case trans_no==0 - new doc
220 function read_sales_trans($doc_type, $trans_no, &$cart)
222 if (!is_array($trans_no) && $trans_no)
223 $trans_no = array($trans_no);
225 $cart->trans_type = $doc_type;
226 if (!$trans_no) { // new document
227 $cart->trans_no = $trans_no;
229 // read header data from first document
230 $myrow = get_customer_trans($trans_no[0],$doc_type);
231 if (count_array($trans_no)>1)
232 $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
234 $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
236 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
238 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
239 $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
241 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
242 $myrow["tax_group_name"]);
244 $cart->reference = $myrow["reference"];
245 $cart->prepaid = $myrow["prepaid"];
246 $cart->order_no = $myrow["order_"];
247 $cart->due_date = sql2date($myrow["due_date"]);
248 $cart->document_date = sql2date($myrow["tran_date"]);
249 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
250 $cart->dimension2_id = $myrow['dimension2_id'];
251 $cart->Comments = '';
252 foreach ( $trans_no as $trans ) {
253 $cart->Comments .= get_comments_string($doc_type,$trans);
256 // FIX this should be calculated sum() for multiply parents
258 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
259 $myrow["br_address"], $myrow["ov_freight"]);
262 $myrow = get_location($cart); // find location from movement
265 $cart->set_location($myrow['loc_code'], $myrow['location_name']);
268 $result = get_customer_trans_details($doc_type,$trans_no);
269 if (db_num_rows($result) > 0) {
270 for($line_no=0; $myrow = db_fetch($result); $line_no++) {
271 $cart->add_to_cart($line_no, $myrow["stock_id"],$myrow["quantity"],
272 $myrow["unit_price"], $myrow["discount_percent"],
273 $myrow["qty_done"], $myrow["unit_cost"],
274 $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
278 $cart->prepayments = get_payments_for($trans_no, $doc_type, $myrow["debtor_no"]);
284 //----------------------------------------------------------------------------------------
286 function get_sales_child_lines($trans_type, $trans_no, $lines=true)
288 if (!($ctype = get_child_type($trans_type)))
290 if (!is_array($trans_no)) {
291 $trans_no = array($trans_no);
294 $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
295 $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
297 foreach($trans_no as $n => $trans) {
298 $trans_no[$n] = db_escape($trans);
300 $sql = "SELECT child.*
302 ".TB_PREF."debtor_trans_details child
303 LEFT JOIN ".TB_PREF."$par_tbl trans
304 ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
305 WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
308 $sql .= " GROUP BY child.debtor_trans_no";
310 $sql .= " ORDER BY child.debtor_trans_no";
312 return db_query($sql, "can't retrieve child trans");
315 function get_sales_child_numbers($trans_type, $trans_no)
318 $res = get_sales_child_lines($trans_type, $trans_no, false);
319 while ($line = db_fetch($res)) {
320 $trans[] = $line['debtor_trans_no'];
325 function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
327 $partype = get_parent_type($trans_type);
332 $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
333 $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
334 $sql = "SELECT parent.*
336 ".TB_PREF."$par_tbl parent
337 LEFT JOIN ".TB_PREF."debtor_trans_details trans
338 ON trans.src_id=parent.id
340 trans.debtor_trans_type=".db_escape($trans_type)
341 ." AND trans.debtor_trans_no=".db_escape($trans_no);
343 $sql .= " GROUP BY $par_no";
345 $sql .= " ORDER BY $par_no";
347 return db_query($sql, "can't retrieve child trans");
351 function get_sales_parent_numbers($trans_type, $trans_no)
354 $res = get_sales_parent_lines($trans_type, $trans_no, false);
355 while ($line = db_fetch($res))
356 $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
360 //----------------------------------------------------------------------------------------
362 function get_sales_child_documents($trans_type, $trans_no)
364 // FIXME - credit notes retrieved here should be those linked to invoices containing
365 // at least one line from related invoice
367 if (!count_array($trans_no))
369 $childs = get_sales_child_numbers($trans_type, $trans_no, false);
370 if (!count_array($childs))
373 $sql = "SELECT * FROM ".TB_PREF."debtor_trans
374 WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
376 return db_query($sql,"The related credit notes could not be retreived");