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 . "/sales/includes/db/sales_order_db.inc");
15 include_once($path_to_root . "/sales/includes/db/sales_credit_db.inc");
16 include_once($path_to_root . "/sales/includes/db/sales_invoice_db.inc");
17 include_once($path_to_root . "/sales/includes/db/sales_delivery_db.inc");
18 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
19 include_once($path_to_root . "/sales/includes/db/sales_points_db.inc");
20 include_once($path_to_root . "/sales/includes/db/custalloc_db.inc");
21 include_once($path_to_root . "/sales/includes/db/cust_trans_db.inc");
22 include_once($path_to_root . "/sales/includes/db/cust_trans_details_db.inc");
23 include_once($path_to_root . "/sales/includes/db/payment_db.inc");
24 include_once($path_to_root . "/sales/includes/db/branches_db.inc");
25 include_once($path_to_root . "/sales/includes/db/customers_db.inc");
27 //----------------------------------------------------------------------------------------
28 // $price in customer's currency
29 // $quantity is used as is (if it's neg it's neg, if it's pos it's pos)
30 // $std_cost is in home currency
31 // $show_or_hide 1 show this item in invoice/credit views, 0 to hide it (used for write-off items)
32 // $type is 10 (invoice) or 11 (credit)
34 function add_stock_move_customer($type, $stock_id, $trans_id, $location, $date_, $reference,
35 $quantity, $std_cost, $show_or_hide=1, $price=0, $discount_percent=0)
37 return add_stock_move($type, $stock_id, $trans_id, $location, $date_, $reference,
38 $quantity, $std_cost, 0, $show_or_hide, $price, $discount_percent,
39 "The customer stock movement record cannot be inserted");
42 //----------------------------------------------------------------------------------------
43 // add a debtor-related gl transaction
44 // $date_ is display date (non-sql)
45 // $amount is in CUSTOMER'S currency
47 function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
48 $amount, $customer_id, $err_msg="", $rate=0)
51 $err_msg = "The customer GL transaction could not be inserted";
53 return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
54 get_customer_currency($customer_id),
55 payment_person_types::customer(), $customer_id, $err_msg, $rate);
58 //----------------------------------------------------------------------------------------
60 function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
63 $date = new_doc_date();
67 $myrow = get_sales_type($sales_type_id);
68 $factor = $myrow['factor'];
72 FROM ".TB_PREF."prices
73 WHERE stock_id = '" . $stock_id . "' "
74 ." AND sales_type_id = " . $sales_type_id
75 ." AND curr_abrev = '$currency'";
77 $msg = "There was a problem retrieving the pricing information for the part $stock_id for customer";
78 $result = db_query($sql, $msg);
80 if (db_num_rows($result) != 0)
82 $myrow = db_fetch_row($result);
85 if ($factor == 0) return false; // auto price calculations off
87 $base_id = get_base_sales_type();
88 if ($base_id <= 0) return 0; // auto price calculations off
90 $home_curr = get_company_currency();
92 // get all prices which we can use to guess the price.
93 // alternative is make up to 2 additional sql queries
94 $sql = "SELECT price, curr_abrev, sales_type_id
95 FROM ".TB_PREF."prices
96 WHERE stock_id = '" . $stock_id . "' "
97 ." AND (sales_type_id = " . $sales_type_id
98 ." OR sales_type_id = " . $base_id.")"
99 ." AND (curr_abrev = '$currency'"
100 ." OR curr_abrev = '$home_curr')";
102 $result = db_query($sql, $msg);
105 while($myrow = db_fetch($result))
107 $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
110 $rate = round(get_exchange_rate_from_home_currency($currency, $date),
114 if (isset($prices[$sales_type_id][$home_curr]))
116 $price = $prices[$sales_type_id][$home_curr] / $rate;
118 elseif (isset($prices[$base_id][$currency]))
120 $price = $prices[$base_id][$currency] * $factor;
122 elseif (isset($prices[$base_id][$home_curr]))
124 $price = $prices[$base_id][$home_curr] * $factor / $rate;
127 return $price === false ? false : round($price, user_price_dec());
129 //----------------------------------------------------------------------------------------
131 // Get price for given item or kit.
132 // When $std==true price is calculated as a sum of all included stock items,
133 // otherwise all prices set for kits and items are accepted.
135 function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
136 $date=null, $std = false)
140 $kit_price = get_price( $item_code, $currency, $sales_type_id,
143 if ($kit_price !== false) {
147 // no price for kit found, get total value of all items
148 $kit = get_item_kit($item_code);
150 while($item = db_fetch($kit)) {
151 if ($item['item_code'] != $item['stock_id']) {
153 $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
154 $currency, $sales_type_id, $factor, $date, $std);
158 $kit_price += $item['quantity'] * get_price( $item['stock_id'],
159 $currency, $sales_type_id, $factor, $date);
165 //-----------------------------------------------------------------------------
167 function set_document_parent($cart)
169 $inv_no = key($cart->trans_no);
171 if (count($cart->src_docs) == 1) {
173 // if this child document has only one parent - update child link
174 $del_no = reset(array_keys($cart->src_docs));
176 $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $del_no .
177 ' WHERE type='.$cart->trans_type.' AND trans_no='. $inv_no ;
178 db_query($sql, 'Child document link cannot be updated');
181 if ($cart->trans_type != 10)
184 // the rest is batch invoice specific
186 foreach ($cart->line_items as $line) {
187 if ($line->quantity != $line->qty_dispatched) {
188 return 1; // this is partial invoice
192 $sql = 'UPDATE '.TB_PREF.'debtor_trans SET trans_link = ' . $inv_no .
193 ' WHERE type='.get_parent_type($cart->trans_type).' AND (';
195 $deliveries = array_keys($cart->src_docs);
197 foreach ($deliveries as $key=>$del)
198 $deliveries[$key] = 'trans_no='.$del;
200 $sql .= implode(' OR ', $deliveries) . ')';
201 db_query($sql, 'Delivery links cannot be updated');
203 return 0; // batch or complete invoice
206 //--------------------------------------------------------------------------------------------------
207 function get_parent_type($type)
209 $parent_types = array( 11=>10, 10=>13, 13=>30 );
210 return isset($parent_types[$type]) ? $parent_types[$type] : 0;
213 //--------------------------------------------------------------------------------------------------
214 function update_parent_line($doc_type, $line_id, $qty_dispatched)
216 $doc_type = get_parent_type($doc_type);
218 // echo "update line: $line_id, $doc_type, $qty_dispatched";
223 $sql = "UPDATE ".TB_PREF."sales_order_details
224 SET qty_sent = qty_sent + $qty_dispatched
227 $sql = "UPDATE ".TB_PREF."debtor_trans_details
228 SET qty_done = qty_done + $qty_dispatched
231 db_query($sql, "The parent document detail record could not be updated");
235 //--------------------------------------------------------------------------------------------------
236 // find inventory location for given transaction
238 function get_location(&$cart)
240 $sql = "SELECT ".TB_PREF."locations.* FROM ".TB_PREF."stock_moves,"
241 .TB_PREF."locations".
242 " WHERE type=".$cart->trans_type.
243 " AND trans_no=".key($cart->trans_no).
245 " AND ".TB_PREF."locations.loc_code=".TB_PREF."stock_moves.loc_code";
246 $result = db_query($sql, 'Retreiving inventory location');
249 if (db_num_rows($result)) {
250 return db_fetch($result);
254 //--------------------------------------------------------------------------------------------------
255 // Generic read debtor transaction into cart
257 // $trans_no - array of trans nums; special case trans_no==0 - new doc
259 function read_sales_trans($doc_type, $trans_no, &$cart)
261 if (!is_array($trans_no) && $trans_no)
262 $trans_no = array($trans_no);
264 $cart->trans_type = $doc_type;
265 if (!$trans_no) { // new document
266 $cart->trans_no = $trans_no;
268 // read header data from first document
269 $myrow = get_customer_trans($trans_no[0],$doc_type);
270 if (count($trans_no)>1)
271 $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
273 $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
275 $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
277 $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
278 $myrow["curr_code"], $myrow["discount"]);
280 $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
281 $myrow["tax_group_name"], $myrow["phone"], $myrow["email"]);
283 $cart->reference = $myrow["reference"];
284 $cart->order_no = $myrow["order_"];
285 $cart->trans_link = $myrow["trans_link"];
286 $cart->due_date = sql2date($myrow["due_date"]);
287 $cart->document_date = sql2date($myrow["tran_date"]);
288 $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
289 $cart->dimension2_id = $myrow['dimension2_id'];
290 $cart->Comments = '';
291 foreach ( $trans_no as $trans ) {
292 $cart->Comments .= get_comments_string($doc_type,$trans);
295 // FIX this should be calculated sum() for multiply parents
297 $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
298 $myrow["br_address"], $myrow["ov_freight"]);
301 $myrow = get_location($cart); // find location from movement
304 $cart->set_location($myrow['loc_code'], $myrow['location_name']);
307 $result = get_customer_trans_details($doc_type,$trans_no);
308 if (db_num_rows($result) > 0) {
309 for($line_no=0; $myrow = db_fetch($result); $line_no++) {
310 $cart->line_items[$line_no] = new line_details(
311 $myrow["stock_id"],$myrow["quantity"],
312 $myrow["unit_price"], $myrow["discount_percent"],
313 $myrow["qty_done"], $myrow["standard_cost"],
314 $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"]);
321 //----------------------------------------------------------------------------------------