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, $err_msg="", $rate=0)
39 $err_msg = "The customer GL transaction could not be inserted";
41 return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
42 get_customer_currency($customer_id),
43 PT_CUSTOMER, $customer_id, $err_msg, $rate);
46 //----------------------------------------------------------------------------------------
48 function get_calculated_price($stock_id, $add_pct)
50 $avg = get_standard_cost($stock_id);
53 return round2($avg * (1 + $add_pct / 100), user_price_dec());
56 function round_to_nearest($price, $round_to)
60 $pow = pow(10, user_price_dec());
61 if ($pow >= $round_to)
62 $mod = ($pow % $round_to);
64 $mod = ($round_to % $pow);
66 $price = ceil($price) - ($pow - $round_to) / $pow;
68 $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
73 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
76 $date = new_doc_date();
80 $myrow = get_sales_type($sales_type_id);
81 $factor = $myrow['factor'];
84 $add_pct = get_company_pref('add_pct');
85 $base_id = get_base_sales_type();
86 $home_curr = get_company_currency();
87 // AND (sales_type_id = $sales_type_id OR sales_type_id = $base_id)
88 $sql = "SELECT price, curr_abrev, sales_type_id
89 FROM ".TB_PREF."prices
90 WHERE stock_id = ".db_escape($stock_id)."
91 AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
93 $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
94 $num_rows = db_num_rows($result);
95 $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
97 $round_to = get_company_pref('round_to');
99 while($myrow = db_fetch($result))
101 $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
104 if (isset($prices[$sales_type_id][$currency]))
106 $price = $prices[$sales_type_id][$currency];
108 elseif (isset($prices[$base_id][$currency]))
110 $price = $prices[$base_id][$currency] * $factor;
112 elseif (isset($prices[$sales_type_id][$home_curr]))
114 $price = $prices[$sales_type_id][$home_curr] / $rate;
116 elseif (isset($prices[$base_id][$home_curr]))
118 $price = $prices[$base_id][$home_curr] * $factor / $rate;
120 elseif ($num_rows == 0 && $add_pct != -1)
122 $price = get_calculated_price($stock_id, $add_pct);
123 if ($currency != $home_curr)
128 if ($price === false)
130 elseif ($round_to != 1)
131 return round_to_nearest($price, $round_to);
133 return round2($price, user_price_dec());
135 //----------------------------------------------------------------------------------------
137 // Get price for given item or kit.
138 // When $std==true price is calculated as a sum of all included stock items,
139 // otherwise all prices set for kits and items are accepted.
141 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
142 $date=null, $std = false)
146 $kit_price = get_price( $item_code, $currency, $sales_type_id,
149 if ($kit_price !== 0) {
153 // no price for kit found, get total value of all items
154 $kit = get_item_kit($item_code);
156 while($item = db_fetch($kit)) {
157 if ($item['item_code'] != $item['stock_id']) {
159 $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
160 $currency, $sales_type_id, $factor, $date, $std);
164 $kit_price += $item['quantity'] * get_price( $item['stock_id'],
165 $currency, $sales_type_id, $factor, $date);
171 //--------------------------------------------------------------------------------------------------
172 function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
174 $doc_type = get_parent_type($doc_type);
176 $qty_dispatched = (float)$qty_dispatched;
181 if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
183 $sql = "UPDATE ".TB_PREF."sales_order_details
184 SET qty_sent = qty_sent + $qty_dispatched";
186 $sql .= ", quantity = quantity + $qty_dispatched";
187 $sql .= " WHERE id=".db_escape($line_id);
190 $sql = "UPDATE ".TB_PREF."debtor_trans_details
191 SET qty_done = qty_done + $qty_dispatched
192 WHERE id=".db_escape($line_id);
194 db_query($sql, "The parent document detail record could not be updated");
198 //--------------------------------------------------------------------------------------------------
199 // find inventory location for given transaction
201 function get_location(&$cart)
203 $sql = "SELECT ".TB_PREF."locations.* FROM ".TB_PREF."stock_moves,"
204 .TB_PREF."locations".
205 " WHERE type=".db_escape($cart->trans_type).
206 " AND trans_no=".key($cart->trans_no).
208 " AND ".TB_PREF."locations.loc_code=".TB_PREF."stock_moves.loc_code";
209 $result = db_query($sql, 'Retreiving inventory location');
212 if (db_num_rows($result)) {
213 return db_fetch($result);
217 //--------------------------------------------------------------------------------------------------
218 // Generic read debtor transaction into cart
220 // $trans_no - array of trans nums; special case trans_no==0 - new doc
222 function read_sales_trans($doc_type, $trans_no, &$cart)
224 if (!is_array($trans_no) && $trans_no)
225 $trans_no = array($trans_no);
227 $cart->trans_type = $doc_type;
228 if (!$trans_no) { // new document
229 $cart->trans_no = $trans_no;
231 // read header data from first document
232 $myrow = get_customer_trans($trans_no[0],$doc_type);
233 if (count($trans_no)>1)
234 $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
236 $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
238 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
240 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
241 $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
243 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
244 $myrow["tax_group_name"]);
246 $cart->reference = $myrow["reference"];
247 $cart->prepaid = $myrow["prepaid"];
248 $cart->order_no = $myrow["order_"];
249 $cart->due_date = sql2date($myrow["due_date"]);
250 $cart->document_date = sql2date($myrow["tran_date"]);
251 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
252 $cart->dimension2_id = $myrow['dimension2_id'];
253 $cart->Comments = '';
254 foreach ( $trans_no as $trans ) {
255 $cart->Comments .= get_comments_string($doc_type,$trans);
258 // FIX this should be calculated sum() for multiply parents
260 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
261 $myrow["br_address"], $myrow["ov_freight"]);
264 $myrow = get_location($cart); // find location from movement
267 $cart->set_location($myrow['loc_code'], $myrow['location_name']);
270 $result = get_customer_trans_details($doc_type,$trans_no);
271 if (db_num_rows($result) > 0) {
272 for($line_no=0; $myrow = db_fetch($result); $line_no++) {
273 $cart->line_items[$line_no] = new line_details(
274 $myrow["stock_id"],$myrow["quantity"],
275 $myrow["unit_price"], $myrow["discount_percent"],
276 $myrow["qty_done"], $myrow["standard_cost"],
277 $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
281 $cart->prepayments = get_payments_for($trans_no, $doc_type);
287 //----------------------------------------------------------------------------------------
289 function get_sales_child_lines($trans_type, $trans_no, $lines=true)
291 if (!($ctype = get_child_type($trans_type)))
293 if (!is_array($trans_no)) {
294 $trans_no = array($trans_no);
297 $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
298 $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
300 foreach($trans_no as $n => $trans) {
301 $trans_no[$n] = db_escape($trans);
303 $sql = "SELECT child.*
305 ".TB_PREF."debtor_trans_details child
306 LEFT JOIN ".TB_PREF."$par_tbl trans
307 ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
308 WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
311 $sql .= " GROUP BY child.debtor_trans_no";
313 $sql .= " ORDER BY child.debtor_trans_no";
315 return db_query($sql, "can't retrieve child trans");
318 function get_sales_child_numbers($trans_type, $trans_no)
321 $res = get_sales_child_lines($trans_type, $trans_no, false);
322 while ($line = db_fetch($res)) {
323 $trans[] = $line['debtor_trans_no'];
328 function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
330 $partype = get_parent_type($trans_type);
335 $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
336 $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
337 $sql = "SELECT parent.*
339 ".TB_PREF."$par_tbl parent
340 LEFT JOIN ".TB_PREF."debtor_trans_details trans
341 ON trans.src_id=parent.id
343 trans.debtor_trans_type=".db_escape($trans_type)
344 ." AND trans.debtor_trans_no=".db_escape($trans_no);
346 $sql .= " GROUP BY $par_no";
348 $sql .= " ORDER BY $par_no";
350 return db_query($sql, "can't retrieve child trans");
354 function get_sales_parent_numbers($trans_type, $trans_no)
357 $res = get_sales_parent_lines($trans_type, $trans_no, false);
358 while ($line = db_fetch($res))
359 $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
363 //----------------------------------------------------------------------------------------
365 function get_sales_child_documents($trans_type, $trans_no)
367 // FIXME - credit notes retrieved here should be those linked to invoices containing
368 // at least one line from related invoice
370 if (!count($trans_no))
372 $childs = get_sales_child_numbers($trans_type, $trans_no, false);
376 $sql = "SELECT * FROM ".TB_PREF."debtor_trans
377 WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
379 return db_query($sql,"The related credit notes could not be retreived");