<?php
-
+/**********************************************************************
+ Copyright (C) FrontAccounting, LLC.
+ Released under the terms of the GNU General Public License, GPL,
+ as published by the Free Software Foundation, either version 3
+ of the License, or (at your option) any later version.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
include_once($path_to_root . "/includes/banking.inc");
-
-include_once($path_to_root . "/includes/db/inventory_db.inc");
-
+include_once($path_to_root . "/includes/inventory.inc");
+include_once($path_to_root . "/includes/db/allocations_db.inc");
include_once($path_to_root . "/sales/includes/db/sales_order_db.inc");
include_once($path_to_root . "/sales/includes/db/sales_credit_db.inc");
include_once($path_to_root . "/sales/includes/db/sales_invoice_db.inc");
+include_once($path_to_root . "/sales/includes/db/sales_delivery_db.inc");
+include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
+include_once($path_to_root . "/sales/includes/db/sales_points_db.inc");
+include_once($path_to_root . "/sales/includes/db/sales_groups_db.inc");
+include_once($path_to_root . "/sales/includes/db/recurrent_invoices_db.inc");
include_once($path_to_root . "/sales/includes/db/custalloc_db.inc");
include_once($path_to_root . "/sales/includes/db/cust_trans_db.inc");
include_once($path_to_root . "/sales/includes/db/cust_trans_details_db.inc");
include_once($path_to_root . "/sales/includes/db/branches_db.inc");
include_once($path_to_root . "/sales/includes/db/customers_db.inc");
+//----------------------------------------------------------------------------------------
+// add a debtor-related gl transaction
+// $date_ is display date (non-sql)
+// $amount is in CUSTOMER'S currency
+
+function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
+ $amount, $customer_id, $rate=0)
+{
+ return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
+ get_customer_currency($customer_id),
+ PT_CUSTOMER, $customer_id, $rate);
+}
//----------------------------------------------------------------------------------------
-// $price in customer's currency
-// $quantity is used as is (if it's neg it's neg, if it's pos it's pos)
-// $std_cost is in home currency
-// $show_or_hide 1 show this item in invoice/credit views, 0 to hide it (used for write-off items)
-// $type is 10 (invoice) or 11 (credit)
+function get_calculated_price($stock_id, $add_pct)
+{
+ $avg = get_unit_cost($stock_id);
+ if ($avg == 0)
+ return 0;
+ return round2($avg * (1 + $add_pct / 100), user_price_dec());
+}
-function add_stock_move_customer($type, $stock_id, $trans_id, $location, $date_, $reference,
- $quantity, $std_cost, $show_or_hide=1, $price=0, $discount_percent=0)
+function round_to_nearest($price, $round_to)
{
- return add_stock_move($type, $stock_id, $trans_id, $location, $date_, $reference,
- $quantity, $std_cost, 0, $show_or_hide, $price, $discount_percent,
- "The customer stock movement record cannot be inserted");
-}
+ if ($price == 0)
+ return 0;
+ $pow = pow(10, user_price_dec());
+ if ($pow >= $round_to)
+ $mod = ($pow % $round_to);
+ else
+ $mod = ($round_to % $pow);
+ if ($mod != 0)
+ $price = ceil($price) - ($pow - $round_to) / $pow;
+ else
+ $price = ceil($price * ($pow / $round_to)) / ($pow / $round_to);
+ return $price;
+}
+
+function get_price ($stock_id, $currency, $sales_type_id, $factor=null, $date=null)
+{
+ if ($date == null)
+ $date = new_doc_date();
+
+ if ($factor === null)
+ {
+ $myrow = get_sales_type($sales_type_id);
+ $factor = $myrow['factor'];
+ }
+
+ $add_pct = get_company_pref('add_pct');
+ $base_id = get_base_sales_type();
+ $home_curr = get_company_currency();
+ // AND (sales_type_id = $sales_type_id OR sales_type_id = $base_id)
+ $sql = "SELECT price, curr_abrev, sales_type_id
+ FROM ".TB_PREF."prices
+ WHERE stock_id = ".db_escape($stock_id)."
+ AND (curr_abrev = ".db_escape($currency)." OR curr_abrev = ".db_escape($home_curr).")";
+
+ $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
+ $num_rows = db_num_rows($result);
+ $rate = round2(get_exchange_rate_from_home_currency($currency, $date),
+ user_exrate_dec());
+ $round_to = get_company_pref('round_to');
+ $prices = array();
+ while($myrow = db_fetch($result))
+ {
+ $prices[$myrow['sales_type_id']][$myrow['curr_abrev']] = $myrow['price'];
+ }
+ $price = false;
+ if (isset($prices[$sales_type_id][$currency]))
+ {
+ $price = $prices[$sales_type_id][$currency];
+ }
+ elseif (isset($prices[$base_id][$currency]))
+ {
+ $price = $prices[$base_id][$currency] * $factor;
+ }
+ elseif (isset($prices[$sales_type_id][$home_curr]))
+ {
+ $price = $prices[$sales_type_id][$home_curr] / $rate;
+ }
+ elseif (isset($prices[$base_id][$home_curr]))
+ {
+ $price = $prices[$base_id][$home_curr] * $factor / $rate;
+ }
+ elseif ($num_rows == 0 && $add_pct != -1)
+ {
+ $price = get_calculated_price($stock_id, $add_pct);
+ if ($currency != $home_curr)
+ $price /= $rate;
+ if ($factor != 0)
+ $price *= $factor;
+ }
+ if ($price === false)
+ return 0;
+ elseif ($round_to != 1)
+ return round_to_nearest($price, $round_to);
+ else
+ return round2($price, user_price_dec());
+}
//----------------------------------------------------------------------------------------
+//
+// Get price for given item or kit.
+// When $std==true price is calculated as a sum of all included stock items,
+// otherwise all prices set for kits and items are accepted.
+//
+function get_kit_price($item_code, $currency, $sales_type_id, $factor=null,
+ $date=null, $std = false)
+{
+ $kit_price = 0.00;
+ if (!$std) {
+ $kit_price = get_price( $item_code, $currency, $sales_type_id,
+ $factor, $date);
-// add a debtor-related gl transaction
-// $date_ is display date (non-sql)
-// $amount is in CUSTOMER'S currency
+ if ($kit_price !== 0) {
+ return $kit_price;
+ }
+ }
+ // no price for kit found, get total value of all items
+ $kit = get_item_kit($item_code);
+
+ while($item = db_fetch($kit)) {
+ if ($item['item_code'] != $item['stock_id']) {
+ // foreign/kit code
+ $kit_price += $item['quantity'] * get_kit_price( $item['stock_id'],
+ $currency, $sales_type_id, $factor, $date, $std);
-function add_gl_trans_customer($type, $type_no, $date_, $account, $dimension, $dimension2,
- $amount, $customer_id, $err_msg="")
+ } else {
+ // stock item
+ $kit_price += $item['quantity'] * get_price( $item['stock_id'],
+ $currency, $sales_type_id, $factor, $date);
+ }
+ }
+ return $kit_price;
+}
+
+//--------------------------------------------------------------------------------------------------
+function update_parent_line($doc_type, $line_id, $qty_dispatched, $auto=false)
{
- if ($err_msg == "")
- $err_msg = "The customer GL transaction could not be inserted";
-
- return add_gl_trans($type, $type_no, $date_, $account, $dimension, $dimension2, "", $amount,
- get_customer_currency($customer_id),
- payment_person_types::customer(), $customer_id, $err_msg);
+ $doc_type = get_parent_type($doc_type);
+
+ $qty_dispatched = (float)$qty_dispatched;
+
+ if ($doc_type == 0)
+ return false;
+ else {
+ if ($doc_type==ST_SALESORDER || $doc_type==ST_SALESQUOTE)
+ {
+ $sql = "UPDATE ".TB_PREF."sales_order_details
+ SET qty_sent = qty_sent + $qty_dispatched";
+ if ($auto)
+ $sql .= ", quantity = quantity + $qty_dispatched";
+ $sql .= " WHERE id=".db_escape($line_id);
+ }
+ else
+ $sql = "UPDATE ".TB_PREF."debtor_trans_details
+ SET qty_done = qty_done + $qty_dispatched
+ WHERE id=".db_escape($line_id);
+ }
+ db_query($sql, "The parent document detail record could not be updated");
+ return true;
}
+//--------------------------------------------------------------------------------------------------
+// find inventory location for given transaction
+//
+function get_location(&$cart)
+{
+ $sql = "SELECT location.*
+ FROM ".TB_PREF."stock_moves move,"
+ .TB_PREF."locations location".
+ " WHERE type=".db_escape($cart->trans_type).
+ " AND trans_no=".key($cart->trans_no).
+ " AND qty!=0 ".
+ " AND location.loc_code=move.loc_code";
+
+ $result = db_query($sql, 'Retreiving inventory location');
+
+ if (db_num_rows($result)) {
+ return db_fetch($result);
+ }
+ return null;
+}
+//--------------------------------------------------------------------------------------------------
+// Generic read debtor transaction into cart
+//
+// $trans_no - array of trans nums; special case trans_no==0 - new doc
+//
+function read_sales_trans($doc_type, $trans_no, &$cart)
+{
+ if (!is_array($trans_no) && $trans_no)
+ $trans_no = array($trans_no);
+
+ $cart->trans_type = $doc_type;
+ if (!$trans_no) { // new document
+ $cart->trans_no = $trans_no;
+ } else {
+ // read header data from first document
+ $myrow = get_customer_trans($trans_no[0],$doc_type);
+ if (count_array($trans_no)>1)
+ $cart->trans_no = get_customer_trans_version($doc_type, $trans_no);
+ else
+ $cart->trans_no = array($trans_no[0]=>$myrow["version"]);
+
+ $cart->set_sales_type($myrow["tpe"], $myrow["sales_type"], $myrow["tax_included"],0);
+
+ $cart->set_customer($myrow["debtor_no"], $myrow["DebtorName"],
+ $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
+
+ $cart->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
+ $myrow["tax_group_name"]);
+
+ $cart->reference = $myrow["reference"];
+ $cart->prepaid = $myrow["prepaid"];
+ $cart->order_no = $myrow["order_"];
+ $cart->due_date = sql2date($myrow["due_date"]);
+ $cart->document_date = sql2date($myrow["tran_date"]);
+ $cart->dimension_id = $myrow['dimension_id']; // added 2.1 Joe Hunt 2008-11-12
+ $cart->dimension2_id = $myrow['dimension2_id'];
+ $cart->Comments = '';
+ foreach ( $trans_no as $trans ) {
+ $cart->Comments .= get_comments_string($doc_type,$trans);
+ }
+
+ // FIX this should be calculated sum() for multiply parents
+
+ $cart->set_delivery($myrow["ship_via"], $myrow["br_name"],
+ $myrow["br_address"], $myrow["ov_freight"]);
+
+ $location = 0;
+ $myrow = get_location($cart); // find location from movement
+
+ if($myrow!=null) {
+ $cart->set_location($myrow['loc_code'], $myrow['location_name']);
+ }
+
+ $result = get_customer_trans_details($doc_type,$trans_no);
+ if (db_num_rows($result) > 0) {
+ for($line_no=0; $myrow = db_fetch($result); $line_no++) {
+ $cart->add_to_cart($line_no, $myrow["stock_id"],$myrow["quantity"],
+ $myrow["unit_price"], $myrow["discount_percent"],
+ $myrow["qty_done"], $myrow["unit_cost"],
+ $myrow["StockDescription"],$myrow["id"], $myrow["debtor_trans_no"],
+ @$myrow["src_id"]);
+ }
+ }
+ $cart->prepayments = get_payments_for($trans_no, $doc_type, $myrow["debtor_no"]);
+
+ } // !newdoc
+
+ return true;
+}
//----------------------------------------------------------------------------------------
-function get_price ($stock_id, $debtor_no)
+function get_sales_child_lines($trans_type, $trans_no, $lines=true)
{
- $sql = "SELECT ".TB_PREF."prices.price
- FROM ".TB_PREF."prices, ".TB_PREF."debtors_master
- WHERE ".TB_PREF."debtors_master.sales_type=".TB_PREF."prices.sales_type_id
- AND ".TB_PREF."debtors_master.debtor_no='" . $debtor_no . "'
- AND ".TB_PREF."prices.stock_id = '" . $stock_id . "'
- AND ".TB_PREF."prices.curr_abrev = ".TB_PREF."debtors_master.curr_code";
-
- $result = db_query($sql, "There was a problem retrieving the pricing information for the part $stock_id for customer");
+ if (!($ctype = get_child_type($trans_type)))
+ return false;
+ if (!is_array($trans_no)) {
+ $trans_no = array($trans_no);
+ }
- if (db_num_rows($result) != 0)
- {
- /*There is a price from one of the above so return that */
- $myrow = db_fetch_row($result);
- return $myrow[0];
- }
- else
- {
- return 0;
+ $par_tbl = $trans_type == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
+ $par_no = $trans_type == ST_SALESORDER ? "trans.order_no" : "trans.debtor_trans_no";
+
+ foreach($trans_no as $n => $trans) {
+ $trans_no[$n] = db_escape($trans);
+ }
+ $sql = "SELECT child.*
+ FROM
+ ".TB_PREF."debtor_trans_details child
+ LEFT JOIN ".TB_PREF."$par_tbl trans
+ ON child.src_id=trans.id AND child.debtor_trans_type=$ctype
+ WHERE $par_no IN(". implode(',', array_values($trans_no)).")";
+
+ if (!$lines)
+ $sql .= " GROUP BY child.debtor_trans_no";
+
+ $sql .= " ORDER BY child.debtor_trans_no";
+
+ return db_query($sql, "can't retrieve child trans");
+}
+
+function get_sales_child_numbers($trans_type, $trans_no)
+{
+ $trans = array();
+ $res = get_sales_child_lines($trans_type, $trans_no, false);
+ while ($line = db_fetch($res)) {
+ $trans[] = $line['debtor_trans_no'];
}
-
+ return $trans;
+}
+
+function get_sales_parent_lines($trans_type, $trans_no, $lines=true)
+{
+ $partype = get_parent_type($trans_type);
+
+ if (!$partype)
+ return false;
+
+ $par_tbl = $partype == ST_SALESORDER ? "sales_order_details" : "debtor_trans_details";
+ $par_no = $partype == ST_SALESORDER ? "parent.order_no" : "parent.debtor_trans_no";
+ $sql = "SELECT parent.*
+ FROM
+ ".TB_PREF."$par_tbl parent
+ LEFT JOIN ".TB_PREF."debtor_trans_details trans
+ ON trans.src_id=parent.id
+ WHERE
+ trans.debtor_trans_type=".db_escape($trans_type)
+ ." AND trans.debtor_trans_no=".db_escape($trans_no);
+ if (!$lines)
+ $sql .= " GROUP BY $par_no";
+
+ $sql .= " ORDER BY $par_no";
+
+ return db_query($sql, "can't retrieve child trans");
+
+}
+
+function get_sales_parent_numbers($trans_type, $trans_no)
+{
+ $trans = array();
+ $res = get_sales_parent_lines($trans_type, $trans_no, false);
+ while ($line = db_fetch($res))
+ $trans[] = $line[$trans_type==ST_CUSTDELIVERY ? 'order_no' : 'debtor_trans_no'];
+ return $trans;
}
//----------------------------------------------------------------------------------------
-?>
\ No newline at end of file
+function get_sales_child_documents($trans_type, $trans_no)
+{
+ // FIXME - credit notes retrieved here should be those linked to invoices containing
+ // at least one line from related invoice
+
+ if (!count_array($trans_no))
+ return false;
+ $childs = get_sales_child_numbers($trans_type, $trans_no, false);
+ if (!count_array($childs))
+ return false;
+
+ $sql = "SELECT * FROM ".TB_PREF."debtor_trans
+ WHERE type=".get_child_type($trans_type)." AND trans_no IN(". implode(',', array_values($childs)).")";
+
+ return db_query($sql,"The related credit notes could not be retreived");
+}
+
+//-------------------------------- Backend interfaces -------------------------------------
+
+
+function write_sales_trans($cart, $policy = 0)
+{
+ begin_transaction(__FUNCTION__, func_get_args());
+ $result = $cart->write($policy);
+ commit_transaction();
+ return $result;
+}
+
+function save_cust_payment($cart, $customer_id, $branch_id,
+ $bank_account, $trans_date, $ref, $amount, $memo, $charge, $bank_amount)
+{
+ begin_transaction(__FUNCTION__, func_get_args());
+
+ $discount = 0;
+ foreach($cart->allocs as $alloc)
+ if ($alloc->discount_confirmed)
+ $discount += $alloc->early_discount*$alloc->amount;
+
+ $payment_no = write_customer_payment($cart->trans_no, $customer_id, $branch_id,
+ $bank_account, $trans_date, $ref, $amount, $discount, $memo, 0, $charge, $bank_amount);
+
+ $cart->trans_no = $payment_no;
+ $cart->date_ = $trans_date;
+ $cart->write();
+
+ commit_transaction();
+ return $payment_no;
+}
+
+function create_recurrent_invoices($id, $from, $to, $date, $memo)
+{
+ /*
+ whole invoiced time is <begin, end>
+ invoices are issued _after_ invoiced period is gone, eg:
+ begin 1.1
+ end 31.3
+ period: invoice ready for issue since:
+ 1.1-31.1 - 1.2
+ 1.2-28.2 - 1.3
+ 1.3-31.3 - 1.4
+ In example above, when end is set to 1.4 will generate additional invoice on 1.5 !
+ */
+ log_user();
+
+ $myrow = get_recurrent_invoice($id);
+
+ $invs = array();
+ if (recurrent_invoice_ready($id, $date))
+ {
+
+ begin_transaction(__FUNCTION__, func_get_args());
+ if ($myrow['debtor_no'] == 0)
+ {
+ $cust = get_cust_branches_from_group($myrow['group_no']);
+ while ($row = db_fetch($cust))
+ {
+ $invs[] = create_template_invoice($row['debtor_no'], $row['branch_code'], $myrow['order_no'], $myrow['id'],
+ $date, $from, $to, $memo);
+ }
+ }
+ else
+ {
+ $invs[] = create_template_invoice($myrow['debtor_no'], $myrow['group_no'], $myrow['order_no'], $myrow['id'],
+ $date, $from, $to, $memo);
+ }
+ commit_transaction();
+ }
+ return $invs;
+}
+
+function write_recurrent_invoice($invoice_id, $description, $order_no, $debtor_no, $group_no,
+ $days, $monthly, $begin, $end, $last_sent)
+{
+ begin_transaction(__FUNCTION__, func_get_args());
+
+ if ($invoice_id != -1)
+ {
+ update_recurrent_invoice($invoice_id, $description, $order_no, $debtor_no, $group_no,
+ $days, $monthly, $begin, $end);
+ if (isset($last_sent))
+ update_last_sent_recurrent_invoice($invoice_id, $last_sent);
+ }
+ else
+ {
+ add_recurrent_invoice($description, $order_no, $debtor_no, $group_no,
+ $days, $monthly, $begin, $end);
+ }
+ commit_transaction();
+}
+
+function write_customer($customer_id, $name, $ref, $address, $tax_id, $curr_code, $dim1, $dim2, $credit_status,
+ $payment_terms, $discount, $credit_limit, $sales_type, $notes, $inactive, $salesman, $area,
+ $tax_group, $location, $address, $ship_via, $notes, $bank_account, $phone, $phone2, $fax, $email)
+{
+ global $SysPrefs;
+
+ begin_transaction(__FUNCTION__, func_get_args());
+
+ if ($customer_id) {
+ update_customer($customer_id, $name, $ref, $address, $tax_id, $curr_code, $dim1, $dim2, $credit_status,
+ $payment_terms, $discount/100, $credit_limit, $sales_type, $notes, $inactive);
+
+ update_record_status($customer_id, $inactive, 'debtors_master', 'debtor_no');
+
+ } else {
+ add_customer($name, $ref, $address, $tax_id, $curr_code, $dim1, $dim2, $credit_status, $payment_terms,
+ $discount / 100, $credit_limit, $sales_type, $notes);
+
+ $customer_id = db_insert_id();
+
+ if (isset($SysPrefs->auto_create_branch) && $SysPrefs->auto_create_branch == 1)
+ {
+ add_branch($customer_id, $name, $ref, $address, $salesman, $area, $tax_group, '',
+ get_company_pref('default_sales_discount_act'),
+ get_company_pref('debtors_act'),
+ get_company_pref('default_prompt_payment_act'),
+ $location, $address, 0, $ship_via, $notes, $bank_account);
+
+ $selected_branch = db_insert_id();
+
+ add_crm_person($ref, $name, '', $address, $phone, $phone2, $fax, $email, '', '');
+
+ $pers_id = db_insert_id();
+ add_crm_contact('cust_branch', 'general', $selected_branch, $pers_id);
+
+ add_crm_contact('customer', 'general', $customer_id, $pers_id);
+ }
+ }
+ commit_transaction();
+
+ return $customer_id;
+}
+
+function write_cust_branch($id, $customer_id, $name, $ref, $br_address, $salesman, $area, $tax_group,
+ $sales_act, $discount_act, $ar_act, $payment_discount_act, $location, $post_address, $group_no, $ship_via, $notes, $bank_act,
+ $contact_name, $phone, $phone2,$fax, $email, $lang)
+{
+
+ begin_transaction(__FUNCTION__, func_get_args());
+
+ if ($id !== 0) {
+ update_branch($customer_id, $id, $name, $ref, $br_address, $salesman, $area, $tax_group, $sales_act,
+ $discount_act, $ar_act, $discount_act, $location, $post_address, $group_no,
+ $ship_via, $notes, $bank_act);
+ } else {
+ add_branch($customer_id, $name, $ref, $br_address, $salesman, $area, $tax_group, $sales_act,
+ $discount_act, $ar_act, $payment_discount_act, $location, $post_address, $group_no,
+ $ship_via, $notes, $bank_act);
+
+ $branch_id = db_insert_id();
+
+ add_crm_person($contact_name, $contact_name, '', $post_address, $phone, $phone2, $fax, $email, $lang, '');
+
+ add_crm_contact('cust_branch', 'general', $branch_id, db_insert_id());
+
+ }
+ commit_transaction();
+}
+
+function write_cust_allocation($cart)
+{
+ begin_transaction(__FUNCTION__, func_get_args());
+ $result = $cart->write();
+ commit_transaction();
+ return $result;
+}
+