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 //----------------------------------------------------------------------------------------
13 function add_sales_order(&$order)
15 global $SysPrefs, $path_to_root, $Refs;
18 hook_db_prewrite($order, $order->trans_type);
19 $order_no = get_next_trans_no($order->trans_type);
20 $del_date = date2sql($order->due_date);
21 $order_type = 0; // this is default on new order
22 $total = $order->get_trans_total();
23 $sql = "INSERT INTO ".TB_PREF."sales_orders (order_no, type, debtor_no, trans_type, branch_code, customer_ref, reference, comments, ord_date,
24 order_type, ship_via, deliver_to, delivery_address, contact_phone,
25 freight_cost, from_stk_loc, delivery_date, payment_terms, total, prep_amount)
26 VALUES (" .db_escape($order_no) . "," .db_escape($order_type) . "," . db_escape($order->customer_id) .
27 ", " .db_escape($order->trans_type) . "," .db_escape($order->Branch) . ", ".
28 db_escape($order->cust_ref) .",".
29 db_escape($order->reference) .",".
30 db_escape($order->Comments) .",'" .
31 date2sql($order->document_date) . "', " .
32 db_escape($order->sales_type) . ", " .
33 db_escape($order->ship_via)."," .
34 db_escape($order->deliver_to) . "," .
35 db_escape($order->delivery_address) . ", " .
36 db_escape($order->phone) . ", " .
37 db_escape($order->freight_cost) .", " .
38 db_escape($order->Location) .", " .
39 db_escape($del_date) . "," .
40 db_escape($order->payment) . "," .
41 db_escape($total) . "," .
42 db_escape($order->prep_amount).")";
44 db_query($sql, "order Cannot be Added");
46 $order->trans_no = array($order_no=>0);
48 if ($SysPrefs->loc_notification() == 1)
50 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
54 $st_reorder = array();
56 foreach ($order->line_items as $line)
58 if ($SysPrefs->loc_notification() == 1 && is_inventory_item($line->stock_id))
59 $loc = calculate_reorder_level($order->Location, $line, $st_ids, $st_names, $st_num, $st_reorder);
61 $sql = "INSERT INTO ".TB_PREF."sales_order_details (order_no, trans_type, stk_code, description, unit_price, quantity, discount_percent) VALUES (";
62 $sql .= $order_no . ",".$order->trans_type .
63 ",".db_escape($line->stock_id).", "
64 .db_escape($line->item_description).", $line->price,
66 $line->discount_percent)";
67 db_query($sql, "order Details Cannot be Added");
69 // Now mark quotation line as processed
70 if ($order->trans_type == ST_SALESORDER && $line->src_id)
71 update_parent_line(ST_SALESORDER, $line->src_id, $line->qty_dispatched); // clear all the quote despite all or the part was ordered
72 } /* inserted line items into sales order details */
74 add_audit_trail($order->trans_type, $order_no, $order->document_date);
75 $Refs->save($order->trans_type, $order_no, $order->reference, null, $order->fixed_asset);
77 hook_db_postwrite($order, $order->trans_type);
80 if ($SysPrefs->loc_notification() == 1 && count($st_ids) > 0)
81 send_reorder_email($loc, $st_ids, $st_names, $st_num, $st_reorder);
85 //----------------------------------------------------------------------------------------
87 function delete_sales_order($order_no, $trans_type)
90 hook_db_prevoid($trans_type, $order_no);
92 $sql = "DELETE FROM ".TB_PREF."sales_orders WHERE order_no=" . db_escape($order_no)
93 . " AND trans_type=".db_escape($trans_type);
95 db_query($sql, "order Header Delete");
97 $sql = "DELETE FROM ".TB_PREF."sales_order_details WHERE order_no ="
98 .db_escape($order_no) . " AND trans_type=".db_escape($trans_type);
99 db_query($sql, "order Detail Delete");
101 add_audit_trail($trans_type, $order_no, Today(), _("Deleted."));
102 commit_transaction();
105 //----------------------------------------------------------------------------------------
106 // Mark changes in sales_order_details
108 function update_sales_order_version($order)
110 foreach ($order as $so_num => $so_ver) {
111 $sql= 'UPDATE '.TB_PREF.'sales_orders SET version=version+1 WHERE order_no='. db_escape($so_num).
112 ' AND version='.$so_ver . " AND trans_type=".ST_SALESORDER;
113 db_query($sql, 'Concurrent editing conflict while sales order update');
117 //----------------------------------------------------------------------------------------
119 function update_sales_order($order)
121 global $SysPrefs, $path_to_root, $Refs;
123 $del_date = date2sql($order->due_date);
124 $ord_date = date2sql($order->document_date);
125 $order_no = key($order->trans_no);
126 $version= current($order->trans_no);
127 $total = $order->get_trans_total();
130 hook_db_prewrite($order, $order->trans_type);
132 if ($order->trans_type == ST_SALESORDER)
133 $allocs = get_payments_for($order_no, $order->trans_type, $order->customer_id);
135 $sql = "UPDATE ".TB_PREF."sales_orders SET type =".db_escape($order->so_type)." ,
136 debtor_no = " . db_escape($order->customer_id) . ",
137 branch_code = " . db_escape($order->Branch) . ",
138 customer_ref = ". db_escape($order->cust_ref) .",
139 reference = ". db_escape($order->reference) .",
140 comments = ". db_escape($order->Comments) .",
141 ord_date = " . db_escape($ord_date) . ",
142 order_type = " .db_escape($order->sales_type) . ",
143 ship_via = " . db_escape($order->ship_via) .",
144 deliver_to = " . db_escape($order->deliver_to) . ",
145 delivery_address = " . db_escape($order->delivery_address) . ",
146 contact_phone = " .db_escape($order->phone) . ",
147 freight_cost = " .db_escape($order->freight_cost) .",
148 from_stk_loc = " .db_escape($order->Location) .",
149 delivery_date = " .db_escape($del_date). ",
150 version = ".($version+1).",
151 payment_terms = " .db_escape($order->payment). ",
152 total = ". db_escape($total). ",
153 prep_amount = ". db_escape($order->prep_amount) ."
154 WHERE order_no=" . db_escape($order_no) ."
155 AND trans_type=".$order->trans_type." AND version=".$version;
156 db_query($sql, "order Cannot be Updated, this can be concurrent edition conflict");
158 $id_tokeep = array();
159 foreach ($order->line_items as $line) {
160 array_push($id_tokeep , $line->id);
162 $id_list = implode(', ', $id_tokeep);
164 $sql = "DELETE FROM ".TB_PREF."sales_order_details WHERE order_no =" . db_escape($order_no) . " AND trans_type=".$order->trans_type;
165 $sql .= " AND id NOT IN ($id_list)";
167 db_query($sql, "Old order Cannot be Deleted");
169 if ($SysPrefs->loc_notification() == 1)
171 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
175 $st_reorder = array();
177 foreach ($order->line_items as $line)
179 if ($SysPrefs->loc_notification() == 1 && is_inventory_item($line->stock_id))
180 $loc = calculate_reorder_level($order->Location, $line, $st_ids, $st_names, $st_num, $st_reorder);
182 if (!$line->id) //new line
183 $sql = "INSERT INTO ".TB_PREF."sales_order_details
184 (order_no, trans_type, stk_code, description, unit_price, quantity,
185 discount_percent, qty_sent)
186 VALUES (".$order_no . ",".$order->trans_type.","
187 .db_escape($line->stock_id) . ","
188 .db_escape($line->item_description) . ", "
189 .db_escape($line->price) . ", "
190 .db_escape($line->quantity) . ", "
191 .db_escape($line->discount_percent) . ", "
192 .db_escape($line->qty_done) ." )";
194 $sql = "UPDATE ".TB_PREF."sales_order_details
195 SET id=".db_escape($line->id).",
197 trans_type=".$order->trans_type.",
198 stk_code=".db_escape($line->stock_id).",
199 description=".db_escape($line->item_description).",
200 unit_price=".db_escape($line->price).",
201 quantity=".db_escape($line->quantity).",
202 discount_percent=".db_escape($line->discount_percent).",
203 qty_sent=".db_escape($line->qty_done)."
204 WHERE id = ".db_escape($line->id);
206 db_query($sql, "Old order Cannot be updated");
207 } /* inserted line items into sales order details */
209 if ($order->trans_type == ST_SALESORDER)
210 reallocate_payments($order_no, ST_SALESORDER, $ord_date, $total, $allocs, $order->customer_id);
211 add_audit_trail($order->trans_type, $order_no, $order->document_date, _("Updated."));
212 $Refs->save($order->trans_type, $order_no, $order->reference, null, $order->fixed_asset);
214 hook_db_postwrite($order, $order->trans_type);
215 commit_transaction();
216 if ($SysPrefs->loc_notification() == 1 && count($st_ids) > 0)
217 send_reorder_email($loc, $st_ids, $st_names, $st_num, $st_reorder);
220 //----------------------------------------------------------------------------------------
222 function get_sales_order_header($order_no, $trans_type)
224 $sql = "SELECT sorder.*,
231 stype.id AS sales_type_id,
235 tax_group.name AS tax_group_name,
236 tax_group.id AS tax_group_id,
239 IFNULL(allocs.ord_allocs, 0)+IFNULL(inv.inv_allocs ,0) AS sum_paid,
240 sorder.prep_amount>0 as prepaid
241 FROM ".TB_PREF."sales_orders sorder
242 LEFT JOIN (SELECT trans_no_to, sum(amt) ord_allocs FROM ".TB_PREF."cust_allocations
243 WHERE trans_type_to=".ST_SALESORDER." AND trans_no_to=".db_escape($order_no)." GROUP BY trans_no_to)
244 allocs ON sorder.trans_type=".ST_SALESORDER." AND allocs.trans_no_to=sorder.order_no
245 LEFT JOIN (SELECT order_, sum(alloc) inv_allocs FROM ".TB_PREF."debtor_trans
246 WHERE type=".ST_SALESINVOICE." AND order_=".db_escape($order_no)." GROUP BY order_)
247 inv ON sorder.trans_type=".ST_SALESORDER." AND inv.order_=sorder.order_no
248 LEFT JOIN ".TB_PREF."shippers ship ON ship.shipper_id = sorder.ship_via,"
249 .TB_PREF."debtors_master cust,"
250 .TB_PREF."sales_types stype, "
251 .TB_PREF."tax_groups tax_group, "
252 .TB_PREF."cust_branch branch,"
253 .TB_PREF."locations loc
254 WHERE sorder.order_type=stype.id
255 AND branch.branch_code = sorder.branch_code
256 AND branch.tax_group_id = tax_group.id
257 AND sorder.debtor_no = cust.debtor_no
258 AND loc.loc_code = sorder.from_stk_loc
259 AND sorder.trans_type = " . db_escape($trans_type) ."
260 AND sorder.order_no = " . db_escape($order_no );
262 $result = db_query($sql, "order Retreival");
264 $num = db_num_rows($result);
267 display_warning("You have duplicate document in database: (type:$trans_type, number:$order_no).");
271 return db_fetch($result);
274 display_warning("You have missing or invalid sales document in database (type:$trans_type, number:$order_no).");
278 //----------------------------------------------------------------------------------------
280 function get_sales_order_details($order_no, $trans_type) {
281 $sql = "SELECT id, stk_code, unit_price,
285 qty_sent as qty_done,
289 FROM ".TB_PREF."sales_order_details line,"
290 .TB_PREF."stock_master item
291 WHERE line.stk_code = item.stock_id
292 AND order_no =".db_escape($order_no)
293 ." AND trans_type = ".db_escape($trans_type) . " ORDER BY id";
295 return db_query($sql, "Retreive order Line Items");
297 //----------------------------------------------------------------------------------------
299 function read_sales_order($order_no, &$order, $trans_type)
302 $myrow = get_sales_order_header($order_no, $trans_type);
304 $order->trans_type = $myrow['trans_type'];
305 $order->so_type = $myrow["type"];
306 $order->trans_no = array($order_no=> $myrow["version"]);
308 $order->set_customer($myrow["debtor_no"], $myrow["name"],
309 $myrow["curr_code"], $myrow["discount"], $myrow["payment_terms"]);
311 $order->set_branch($myrow["branch_code"], $myrow["tax_group_id"],
312 $myrow["tax_group_name"], $myrow["contact_phone"]);
314 $order->set_sales_type($myrow["sales_type_id"], $myrow["sales_type"],
315 $myrow["tax_included"], $myrow["factor"]); // no default price calculations on edit
317 $order->set_location($myrow["from_stk_loc"], $myrow["location_name"]);
319 $order->set_delivery($myrow["ship_via"], $myrow["deliver_to"],
320 $myrow["delivery_address"], $myrow["freight_cost"]);
322 $order->cust_ref = $myrow["customer_ref"];
323 $order->sales_type =$myrow["order_type"];
324 $order->reference = $myrow["reference"];
325 $order->Comments = $myrow["comments"];
326 $order->due_date = sql2date($myrow["delivery_date"]);
327 $order->document_date = sql2date($myrow["ord_date"]);
329 $order->prepaid = $myrow["prepaid"];
330 $order->alloc = $myrow['alloc'];
331 $order->sum_paid = $myrow["sum_paid"]; // sum of all prepayments to so (also invoiced)
332 $order->prep_amount = $myrow["prep_amount"];
333 $order->prepayments = get_payments_for($order_no, $myrow['trans_type'], $myrow['debtor_no']);
335 $result = get_sales_order_details($order_no, $order->trans_type);
336 if (db_num_rows($result) > 0)
339 while ($myrow = db_fetch($result))
341 $order->add_to_cart($line_no,$myrow["stk_code"],$myrow["quantity"],
342 $myrow["unit_price"], $myrow["discount_percent"],
343 $myrow["qty_done"], $myrow["material_cost"], $myrow["description"], $myrow["id"] );
351 //----------------------------------------------------------------------------------------
353 function sales_order_has_deliveries($order_no)
355 $sql = "SELECT SUM(qty_sent) FROM ".TB_PREF.
356 "sales_order_details WHERE order_no=".db_escape($order_no)
357 ." AND trans_type=".ST_SALESORDER;
359 $result = db_query($sql, "could not query for sales order usage");
361 $row = db_fetch_row($result);
364 return true; // 2010-04-21 added check for eventually voided deliveries, Joe Hunt
365 $sql = "SELECT order_ FROM ".TB_PREF."debtor_trans WHERE type=".ST_CUSTDELIVERY." AND order_=".db_escape($order_no);
366 $result = db_query($sql,"The related delivery notes could not be retreived");
367 return (db_num_rows($result) > 0);
370 //----------------------------------------------------------------------------------------
372 function close_sales_order($order_no)
374 // set the quantity of each item to the already sent quantity. this will mark item as closed.
375 $sql = "UPDATE ".TB_PREF."sales_order_details
376 SET quantity = qty_sent WHERE order_no = ".db_escape($order_no)
377 ." AND trans_type=".ST_SALESORDER;
379 db_query($sql, "The sales order detail record could not be updated");
382 //---------------------------------------------------------------------------------------------------------------
384 function get_invoice_duedate($terms, $invdate)
386 if (!is_date($invdate))
388 return new_doc_date();
391 $myrow = get_payment_terms($terms);
396 if ($myrow['day_in_following_month'] > 0)
397 $duedate = add_days(end_month($invdate), $myrow['day_in_following_month']);
398 elseif ($myrow['days_before_due'] > 0)
399 $duedate = add_days($invdate, $myrow['days_before_due']);
405 function get_customer_to_order($customer_id) {
407 // Now check to ensure this account is not on hold */
408 $sql = "SELECT cust.name,
410 credit_status.dissallow_invoices,
411 cust.sales_type AS salestype,
421 cust.credit_limit - Sum(IFNULL(IF(trans.type IN(".implode(',', array(ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_BANKDEPOSIT))."),
422 -1, 1) * (ov_amount + ov_gst + ov_freight + ov_freight_tax + ov_discount),0)) as cur_credit
423 FROM ".TB_PREF."debtors_master cust
424 LEFT JOIN ".TB_PREF."debtor_trans trans ON trans.type!=".ST_CUSTDELIVERY." AND trans.debtor_no = cust.debtor_no,"
425 .TB_PREF."credit_status credit_status,"
426 .TB_PREF."sales_types stype
427 WHERE cust.sales_type=stype.id
428 AND cust.credit_status=credit_status.id
429 AND cust.debtor_no=".db_escape($customer_id)
430 ." GROUP by cust.debtor_no";
432 $result =db_query($sql,"Customer Record Retreive");
433 return db_fetch($result);
436 function get_branch_to_order($customer_id, $branch_id) {
438 // the branch was also selected from the customer selection so default the delivery details from the customer branches table cust_branch. The order process will ask for branch details later anyway
439 $sql = "SELECT branch.br_name,
441 branch.br_post_address,
442 default_location, location_name, default_ship_via,
443 tax_group.name AS tax_group_name,
444 tax_group.id AS tax_group_id
445 FROM ".TB_PREF."cust_branch branch,"
446 .TB_PREF."tax_groups tax_group,"
447 .TB_PREF."locations location
448 WHERE branch.tax_group_id = tax_group.id
449 AND location.loc_code=default_location
450 AND branch.branch_code=".db_escape($branch_id)."
451 AND branch.debtor_no=".db_escape($customer_id);
453 return db_query($sql,"Customer Branch Record Retreive");
464 function get_sql_for_sales_orders_view($trans_type, $trans_no, $filter,
465 $stock_item='', $from='', $to='', $ref='', $location=ALL_TEXT, $customer_id=ALL_TEXT)
473 .($filter=='InvoiceTemplates'
474 || $filter=='DeliveryTemplates' ?
475 "sorder.comments, " : "sorder.customer_ref, ")
477 sorder.delivery_date,
479 Sum(line.unit_price*line.quantity*(1-line.discount_percent))+freight_cost AS OrderValue,
482 Sum(line.qty_sent) AS TotDelivered,
483 Sum(line.quantity) AS TotQuantity,
484 Sum(line.invoiced) AS TotInvoiced,
491 FROM ".TB_PREF."sales_orders as sorder
492 LEFT JOIN (SELECT trans_no_to, sum(amt) ord_payments FROM ".TB_PREF."cust_allocations WHERE trans_type_to=".ST_SALESORDER." GROUP BY trans_no_to)
493 allocs ON sorder.trans_type=".ST_SALESORDER." AND allocs.trans_no_to=sorder.order_no
494 LEFT JOIN (SELECT order_, sum(prep_amount) inv_payments FROM ".TB_PREF."debtor_trans WHERE type=".ST_SALESINVOICE." GROUP BY order_)
495 inv ON sorder.trans_type=".ST_SALESORDER." AND inv.order_=sorder.order_no,"
496 .TB_PREF."sales_order_details as line, "
497 .TB_PREF."debtors_master as debtor, "
498 .TB_PREF."cust_branch as branch
499 WHERE sorder.order_no = line.order_no
500 AND sorder.trans_type = line.trans_type
501 AND sorder.trans_type = ".db_escape($trans_type)."
502 AND sorder.debtor_no = debtor.debtor_no
503 AND sorder.branch_code = branch.branch_code
504 AND debtor.debtor_no = branch.debtor_no";
506 if (isset($trans_no) && $trans_no != "")
508 // search orders with number like
509 $number_like = "%".$trans_no;
510 $sql .= " AND sorder.order_no LIKE ".db_escape($number_like);
511 // ." GROUP BY sorder.order_no";
515 // search orders with reference like
516 $sql .= " AND sorder.reference LIKE ".db_escape('%' . $ref . '%');
517 // ." GROUP BY sorder.order_no";
519 else // ... or select inquiry constraints
521 if ($filter!='DeliveryTemplates' && $filter!='InvoiceTemplates' && $filter!='OutstandingOnly')
523 $date_after = date2sql($from);
524 $date_before = date2sql($to);
526 $sql .= " AND sorder.ord_date >= '$date_after'"
527 ." AND sorder.ord_date <= '$date_before'";
530 if ($trans_type == ST_SALESQUOTE && !check_value('show_all'))
531 $sql .= " AND sorder.delivery_date >= '".date2sql(Today())."' AND line.qty_sent=0"; // show only outstanding, not realized quotes
533 //if ($selected_customer != -1)
534 // $sql .= " AND sorder.debtor_no=".db_escape($selected_customer);
536 if ($stock_item != ALL_TEXT)
537 $sql .= " AND line.stk_code=".db_escape($stock_item);
539 if ($location != ALL_TEXT)
540 $sql .= " AND sorder.from_stk_loc = ".db_escape($location);
542 if ($filter=='OutstandingOnly')
543 $sql .= " AND line.qty_sent < line.quantity";
545 if ($filter=='PrepaidOrders')
546 $sql .= " AND prep_amount>0";
548 elseif ($filter=='InvoiceTemplates' || $filter=='DeliveryTemplates')
549 $sql .= " AND sorder.type=1";
551 //Chaiatanya : New Filter
552 if ($customer_id != ALL_TEXT)
553 $sql .= " AND sorder.debtor_no = ".db_escape($customer_id);
555 $sql .= " GROUP BY sorder.order_no,
564 //--------------------------------------------------------------------------------------------------
565 function update_prepaid_so_line($line_id, $qty_invoiced)
567 $sql = "UPDATE ".TB_PREF."sales_order_details
568 SET invoiced = invoiced + ".(float)$qty_invoiced."
569 WHERE id=".db_escape($line_id);
571 db_query($sql, "The document detail record could not be updated with invoiced qty");
575 Returns array of all issued invoices to sales order $order_no, optinally up to trans_no==$up_to
577 function get_sales_order_invoices($order_no)
579 $sql = "SELECT trans_no, dt.type as type, tran_date, reference, prep_amount
580 FROM ".TB_PREF."debtor_trans dt
581 LEFT JOIN ".TB_PREF."voided v ON v.type=dt.type AND v.id=dt.trans_no
582 WHERE ISNULL(v.id) AND dt.type=".ST_SALESINVOICE." AND dt.order_=".db_escape($order_no)
583 ." ORDER BY dt.tran_date, dt.reference, dt.trans_no";
585 return db_query($sql, "cannot retrieve sales invoices for sales order");
588 function is_sales_order_started($order_no)
590 $sql = "SELECT count(*) FROM ".TB_PREF."sales_order_details WHERE order_no=".db_escape($order_no)." AND trans_type=".ST_SALESORDER
591 ." AND (invoiced!=0 OR qty_sent!=0)";
593 $result = db_fetch(db_query($sql, "cannot retrieve sales invoices for sales order"));
597 //---------------------------------------------------------------------------------------------
599 // Mark/unmark sales order as template.
601 function sales_order_set_template($id, $status)
603 $sql = "UPDATE ".TB_PREF."sales_orders SET type = ".db_escape($status)." WHERE order_no=".db_escape($id);
604 db_query($sql, "Can't change sales order type");
608 Check whether sales order is issued in prepaid mode and already opened
611 function is_prepaid_order_open($order_no)
613 $sql = "SELECT count(*)
614 FROM ".TB_PREF."sales_orders o,
615 ((SELECT trans_no_to FROM ".TB_PREF."cust_allocations
616 WHERE trans_type_to=".ST_SALESORDER." AND trans_no_to=".db_escape($order_no).")
618 (SELECT order_ FROM ".TB_PREF."debtor_trans
619 WHERE type=".ST_SALESINVOICE." AND order_=".db_escape($order_no).")) related
622 AND o.trans_type = ".ST_SALESORDER."
623 AND o.order_no = " . db_escape($order_no);
625 $result = db_fetch(db_query($sql, "cannot check prepaid order open"));
630 function last_sales_order_detail($order, $field)
632 $sql = "SELECT $field
633 FROM ".TB_PREF."sales_order_details d
635 (SELECT order_no FROM ".TB_PREF."sales_orders o
636 WHERE debtor_no=" . db_escape($order->customer_id) . "
637 ORDER BY order_no DESC LIMIT 1)
638 ORDER BY d.id DESC LIMIT 1";
640 $last_query=db_query($sql, "Retreive last order detail");
641 $row = db_fetch_row($last_query);