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/db/inventory_db.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 // $price in customer's currency
32 // $quantity is used as is (if it's neg it's neg, if it's pos it's pos)
33 // $std_cost is in home currency
34 // $show_or_hide 1 show this item in invoice/credit views, 0 to hide it (used for write-off items)
35 // $type is 10 (invoice) or 11 (credit)
37 function add_stock_move_customer($type, $stock_id, $trans_id, $location, $date_, $reference,
38 $quantity, $std_cost, $show_or_hide=1, $price=0, $discount_percent=0)
40 return add_stock_move($type, $stock_id, $trans_id, $location, $date_, $reference,
41 $quantity, $std_cost, 0, $show_or_hide, $price, $discount_percent,
42 "The customer stock movement record cannot be inserted");
45 //----------------------------------------------------------------------------------------
46 // add a debtor-related gl transaction
47 // $date_ is display date (non-sql)
48 // $amount is in CUSTOMER'S currency
50 function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
51 $amount, $customer_id, $err_msg="", $rate=0)
54 $err_msg = "The customer GL transaction could not be inserted";
56 return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
57 get_customer_currency($customer_id),
58 PT_CUSTOMER, $customer_id, $err_msg, $rate);
61 //----------------------------------------------------------------------------------------
63 function get_calculated_price($stock_id, $add_pct)
65 $avg = get_standard_cost($stock_id);
68 return round2($avg * (1 + $add_pct / 100), user_price_dec());
71 function round_to_nearest($price, $round_to)
75 $pow = pow(10, user_price_dec());
76 if ($pow >= $round_to)
77 $mod = ($pow % $round_to);
79 $mod = ($round_to % $pow);
81 $price = ceil($price) - ($pow - $round_to) / $pow;
83 $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
88 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
91 $date = new_doc_date();
95 $myrow = get_sales_type($sales_type_id);
96 $factor = $myrow['factor'];
99 $add_pct = get_company_pref('add_pct');
100 $base_id = get_base_sales_type();
101 $home_curr = get_company_currency();
102 // AND (sales_type_id = $sales_type_id OR sales_type_id = $base_id)
103 $sql = "SELECT price, curr_abrev, sales_type_id
104 FROM ".TB_PREF."prices
105 WHERE stock_id = ".db_escape($stock_id)."
106 AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
108 $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
109 $num_rows = db_num_rows($result);
110 $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
112 $round_to = get_company_pref('round_to');
114 while($myrow = db_fetch($result))
116 $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
119 if (isset($prices[$sales_type_id][$currency]))
121 $price = $prices[$sales_type_id][$currency];
123 elseif (isset($prices[$base_id][$currency]))
125 $price = $prices[$base_id][$currency] * $factor;
127 elseif (isset($prices[$sales_type_id][$home_curr]))
129 $price = $prices[$sales_type_id][$home_curr] / $rate;
131 elseif (isset($prices[$base_id][$home_curr]))
133 $price = $prices[$base_id][$home_curr] * $factor / $rate;
136 if (isset($prices[$sales_type_id][$home_curr]))
138 $price = $prices[$sales_type_id][$home_curr] / $rate;
140 elseif (isset($prices[$base_id][$currency]))
142 $price = $prices[$base_id][$currency] * $factor;
144 elseif (isset($prices[$base_id][$home_curr]))
146 $price = $prices[$base_id][$home_curr] * $factor / $rate;
149 elseif ($num_rows == 0 && $add_pct != -1)
151 $price = get_calculated_price($stock_id, $add_pct);
152 if ($currency != $home_curr)
157 if ($price === false)
159 elseif ($round_to != 1)
160 return round_to_nearest($price, $round_to);
162 return round2($price, user_price_dec());
164 //----------------------------------------------------------------------------------------
166 // Get price for given item or kit.
167 // When $std==true price is calculated as a sum of all included stock items,
168 // otherwise all prices set for kits and items are accepted.
170 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
171 $date=null, $std = false)
175 $kit_price = get_price( $item_code, $currency, $sales_type_id,
178 if ($kit_price !== 0) {
182 // no price for kit found, get total value of all items
183 $kit = get_item_kit($item_code);
185 while($item = db_fetch($kit)) {
186 if ($item['item_code'] != $item['stock_id']) {
188 $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
189 $currency, $sales_type_id, $factor, $date, $std);
193 $kit_price += $item['quantity'] * get_price( $item['stock_id'],
194 $currency, $sales_type_id, $factor, $date);
200 //--------------------------------------------------------------------------------------------------
201 function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
203 $doc_type = get_parent_type($doc_type);
205 $qty_dispatched = (float)$qty_dispatched;
207 // echo "update line: $line_id, $doc_type, $qty_dispatched";
211 if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
213 $sql = "UPDATE ".TB_PREF."sales_order_details
214 SET qty_sent = qty_sent + $qty_dispatched";
216 $sql .= ", quantity = quantity + $qty_dispatched";
217 $sql .= " WHERE id=".db_escape($line_id);
220 $sql = "UPDATE ".TB_PREF."debtor_trans_details
221 SET qty_done = qty_done + $qty_dispatched
222 WHERE id=".db_escape($line_id);
224 db_query($sql, "The parent document detail record could not be updated");
228 //--------------------------------------------------------------------------------------------------
229 // find inventory location for given transaction
231 function get_location(&$cart)
233 $sql = "SELECT ".TB_PREF."locations.* FROM ".TB_PREF."stock_moves,"
234 .TB_PREF."locations".
235 " WHERE type=".db_escape($cart->trans_type).
236 " AND trans_no=".key($cart->trans_no).
238 " AND ".TB_PREF."locations.loc_code=".TB_PREF."stock_moves.loc_code";
239 $result = db_query($sql, 'Retreiving inventory location');
242 if (db_num_rows($result)) {
243 return db_fetch($result);
247 //--------------------------------------------------------------------------------------------------
248 // Generic read debtor transaction into cart
250 // $trans_no - array of trans nums; special case trans_no==0 - new doc
252 function read_sales_trans($doc_type, $trans_no, &$cart)
254 if (!is_array($trans_no) && $trans_no)
255 $trans_no = array($trans_no);
257 $cart->trans_type = $doc_type;
258 if (!$trans_no) { // new document
259 $cart->trans_no = $trans_no;
261 // read header data from first document
262 $myrow = get_customer_trans($trans_no[0],$doc_type);
263 if (count($trans_no)>1)
264 $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
266 $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
268 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
270 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
271 $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
273 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
274 $myrow["tax_group_name"]);
276 $cart->reference = $myrow["reference"];
277 $cart->prepaid = $myrow["prepaid"];
278 $cart->order_no = $myrow["order_"];
279 $cart->due_date = sql2date($myrow["due_date"]);
280 $cart->document_date = sql2date($myrow["tran_date"]);
281 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
282 $cart->dimension2_id = $myrow['dimension2_id'];
283 $cart->Comments = '';
284 foreach ( $trans_no as $trans ) {
285 $cart->Comments .= get_comments_string($doc_type,$trans);
288 // FIX this should be calculated sum() for multiply parents
290 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
291 $myrow["br_address"], $myrow["ov_freight"]);
294 $myrow = get_location($cart); // find location from movement
297 $cart->set_location($myrow['loc_code'], $myrow['location_name']);
300 $result = get_customer_trans_details($doc_type,$trans_no);
301 if (db_num_rows($result) > 0) {
302 for($line_no=0; $myrow = db_fetch($result); $line_no++) {
303 $cart->line_items[$line_no] = new line_details(
304 $myrow["stock_id"],$myrow["quantity"],
305 $myrow["unit_price"], $myrow["discount_percent"],
306 $myrow["qty_done"], $myrow["standard_cost"],
307 $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
311 $cart->prepayments = get_payments_for($trans_no, $doc_type);
317 //----------------------------------------------------------------------------------------
319 function get_sales_child_lines($trans_type, $trans_no, $lines=true)
321 if (!($ctype = get_child_type($trans_type)))
323 if (!is_array($trans_no)) {
324 $trans_no = array($trans_no);
327 $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
328 $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
330 foreach($trans_no as $n => $trans) {
331 $trans_no[$n] = db_escape($trans);
333 $sql = "SELECT child.*
335 ".TB_PREF."debtor_trans_details child
336 LEFT JOIN ".TB_PREF."$par_tbl trans
337 ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
338 WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
341 $sql .= " GROUP BY child.debtor_trans_no";
343 $sql .= " ORDER BY child.debtor_trans_no";
345 return db_query($sql, "can't retrieve child trans");
348 function get_sales_child_numbers($trans_type, $trans_no)
351 $res = get_sales_child_lines($trans_type, $trans_no, false);
352 while ($line = db_fetch($res)) {
353 $trans[] = $line['debtor_trans_no'];
358 function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
360 $partype = get_parent_type($trans_type);
365 $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
366 $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
367 $sql = "SELECT parent.*
369 ".TB_PREF."$par_tbl parent
370 LEFT JOIN ".TB_PREF."debtor_trans_details trans
371 ON trans.src_id=parent.id
373 trans.debtor_trans_type=".db_escape($trans_type)
374 ." AND trans.debtor_trans_no=".db_escape($trans_no);
376 $sql .= " GROUP BY $par_no";
378 $sql .= " ORDER BY $par_no";
380 return db_query($sql, "can't retrieve child trans");
384 function get_sales_parent_numbers($trans_type, $trans_no)
387 $res = get_sales_parent_lines($trans_type, $trans_no, false);
388 while ($line = db_fetch($res))
389 $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
393 //----------------------------------------------------------------------------------------
395 function get_sales_child_documents($trans_type, $trans_no)
397 // FIXME - credit notes retrieved here should be those linked to invoices containing
398 // at least one line from related invoice
400 if (!count($trans_no))
402 $childs = get_sales_child_numbers($trans_type, $trans_no, false);
406 $sql = "SELECT * FROM ".TB_PREF."debtor_trans
407 WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
409 return db_query($sql,"The related credit notes could not be retreived");