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 . "/sales/includes/cart_class.inc");
14 //--------------------------------------------------------------------------------
15 function add_to_order(&$order, $new_item, $new_item_qty, $price, $discount, $description='')
17 // calculate item price to sum of kit element prices factor for
18 // value distribution over all exploded kit items
19 $std_price = get_kit_price($new_item, $order->customer_currency,
20 $order->sales_type, $order->price_factor, get_post('OrderDate'), true);
25 $price_factor = $price/$std_price;
27 $kit = get_item_kit($new_item);
28 $item_num = db_num_rows($kit);
30 while($item = db_fetch($kit)) {
31 $std_price = get_kit_price($item['stock_id'], $order->customer_currency,
32 $order->sales_type, $order->price_factor, get_post('OrderDate'), true);
34 // rounding differences are included in last price item in kit
37 $price -= $item['quantity']*$std_price*$price_factor;
38 $item_price = $std_price*$price_factor;
40 if ($item['quantity'])
41 $price = $price/$item['quantity'];
44 $item_price = round($item_price, user_price_dec());
46 if (!$item['is_foreign'] && $item['item_code'] != $item['stock_id'])
47 { // this is sales kit - recurse
48 add_to_order($order, $item['stock_id'], $new_item_qty*$item['quantity'],
49 $item_price, $discount);
52 { // stock item record eventually with foreign code
54 // check duplicate stock item
55 foreach ($order->line_items as $order_item)
57 if (strcasecmp($order_item->stock_id, $item['stock_id']) == 0)
59 display_warning(_("For Part :").$item['stock_id']. " "
60 . _("This item is already on this document. You have been warned."));
64 $order->add_to_cart (count($order->line_items), $item['stock_id'],
65 $new_item_qty*$item['quantity'], $item_price, $discount, 0,0, $description);
70 //---------------------------------------------------------------------------------
72 function get_customer_details_to_order(&$order, $customer_id, $branch_id)
78 $myrow = get_customer_to_order($customer_id);
80 $name = $myrow['name'];
82 if ($myrow['dissallow_invoices'] == 1)
83 $ret_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
85 $deliver = $myrow['address']; // in case no branch address use company address
87 $order->set_customer($customer_id, $name, $myrow['curr_code'],
88 $myrow['discount'], $myrow['payment_terms'], $myrow['pymt_discount']);
90 // the sales type determines the price list to be used by default
91 $order->set_sales_type($myrow['salestype'], $myrow['sales_type'], $myrow['tax_included'],
94 $order->credit = $myrow['cur_credit'];
96 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
98 $order->dimension_id = $myrow['dimension_id'];
99 $order->dimension2_id = $myrow['dimension2_id'];
101 $result = get_branch_to_order($customer_id, $branch_id);
103 if (db_num_rows($result) == 0)
105 return _("The selected customer and branch are not valid, or the customer does not have any branches.");
108 $myrow = db_fetch($result);
110 // FIX - implement editable contact selector in sales order
111 $contact = get_branch_contacts($branch_id, 'order', $customer_id);
112 $order->set_branch($branch_id, $myrow["tax_group_id"],
113 $myrow["tax_group_name"], @$contact["phone"], @$contact["email"]);
115 $address = trim($myrow["br_post_address"]) != '' ? $myrow["br_post_address"]
116 : (trim($myrow["br_address"]) != '' ? $myrow["br_address"]:$deliver);
118 $order->set_delivery($myrow["default_ship_via"], $myrow["br_name"],
120 if ($order->trans_type == ST_SALESINVOICE) {
121 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
123 elseif ($order->trans_type == ST_SALESORDER)
124 $order->due_date = add_days($order->document_date, $SysPrefs->default_delivery_required_by());
125 elseif ($order->trans_type == ST_SALESQUOTE)
126 $order->due_date = add_days($order->document_date, $SysPrefs->default_quote_valid_days());
128 if($order->payment_terms['cash_sale']) {
129 $order->set_location($order->pos["pos_location"], $order->pos["location_name"]);
131 $order->set_location($myrow["default_location"], $myrow["location_name"]);
136 //---------------------------------------------------------------------------------
138 function display_order_summary($title, &$order, $editable_items=false)
141 display_heading($title);
143 div_start('items_table');
144 start_table(TABLESTYLE, "width='90%'");
146 $th = array(_("Item Code"), _("Item Description"), _("Quantity"),
148 _("Unit"), $order->tax_included ? _("Price after Tax") : _("Price before Tax"), _("Discount %"), _("Total"), "");
150 if ($order->trans_no == 0) {
154 if (count($order->line_items))
160 $k = 0; //row colour counter
162 $id = find_submit('Edit');
164 $low_stock = $order->check_qoh($_POST['OrderDate'], $_POST['Location']);
165 foreach ($order->get_items() as $line_no=>$stock_item)
168 $line_total = round($stock_item->qty_dispatched * $stock_item->price * (1 - $stock_item->discount_percent),
172 if (!$editable_items || $id != $line_no)
174 if (in_array($stock_item->stock_id, $low_stock))
175 start_row("class='stockmankobg'"); // notice low stock status
177 alt_table_row_color($k);
179 view_stock_status_cell($stock_item->stock_id);
181 label_cell($stock_item->item_description );
182 $dec = get_qty_dec($stock_item->stock_id);
183 qty_cell($stock_item->qty_dispatched, false, $dec);
185 if ($order->trans_no!=0)
186 qty_cell($stock_item->qty_done, false, $dec);
188 label_cell($stock_item->units);
189 amount_cell($stock_item->price);
191 percent_cell($stock_item->discount_percent * 100);
192 amount_cell($line_total);
196 edit_button_cell("Edit$line_no", _("Edit"),
197 _('Edit document line'));
198 delete_button_cell("Delete$line_no", _("Delete"),
199 _('Remove line from document'));
205 sales_order_item_controls($order, $k, $line_no);
208 $total += $line_total;
211 if ($id==-1 && $editable_items)
212 sales_order_item_controls($order, $k);
215 if ($order->trans_no!=0)
218 label_cell(_("Shipping Charge"), "colspan=$colspan align=right");
219 small_amount_cells(null, 'freight_cost', price_format(get_post('freight_cost',0)));
220 label_cell('', 'colspan=2');
222 $display_sub_total = price_format($total + input_num('freight_cost'));
223 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right", 2);
224 $taxes = $order->get_taxes(input_num('freight_cost'));
225 $tax_total = display_edit_tax_items($taxes, $colspan, $order->tax_included, 2);
227 $display_total = price_format(($total + input_num('freight_cost') + $tax_total));
230 label_cells(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
231 submit_cells('update', _("Update"), "colspan=2 align='center'", _("Refresh"), true);
236 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
241 // ------------------------------------------------------------------------------
243 function display_order_header(&$order, $editable, $date_text)
245 global $Ajax, $SysPrefs;
247 start_outer_table(TABLESTYLE2, "width='80%'");
251 $customer_error = "";
254 if (isset($order) && !$editable)
256 label_row(null, $order->customer_name . " - " . $order->deliver_to);
257 hidden('customer_id', $order->customer_id);
258 hidden('branch_id', $order->Branch);
259 hidden('sales_type', $order->sales_type);
260 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE) {
261 hidden('dimension_id', $order->dimension_id); // 2008-11-12 Joe Hunt
262 hidden('dimension2_id', $order->dimension2_id);
267 customer_list_row(_("Customer:"), 'customer_id', null, false, true, false, true);
269 if ($order->customer_id != get_post('customer_id', -1))
271 // customer has changed
272 $Ajax->activate('branch_id');
274 customer_branches_list_row(_("Branch:"),
275 $_POST['customer_id'], 'branch_id', null, false, true, true, true);
277 if( ($order->customer_id != get_post('customer_id', -1)) ||
278 ($order->Branch != get_post('branch_id', -1)) ||
279 list_updated('customer_id'))
282 if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
284 // ignore errors on customer search box call
285 if ($_POST['customer_id'] == '')
286 $customer_error = _("No customer found for entered text.");
288 $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
289 unset($_POST['branch_id']);
295 $old_order = (PHP_VERSION<5) ? $order : clone $order;
297 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
298 $_POST['Location'] = $order->Location;
299 $_POST['deliver_to'] = $order->deliver_to;
300 $_POST['delivery_address'] = $order->delivery_address;
301 $_POST['phone'] = $order->phone;
302 $_POST['delivery_date'] = $order->due_date;
304 if (!in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER))
305 && ($order->pos['cash_sale'] != $order->pos['credit_sale'])
306 && (($order->payment_terms['cash_sale'] && !$order->pos['cash_sale']) ||
307 (!$order->payment_terms['cash_sale'] && !$order->pos['credit_sale']))) {
308 // force payment terms refresh if terms are editable
309 // and pos have no permitions for terms selected in customer record.
310 // Terms are set to first terms in allowed category below.
312 sprintf(_("Customer's payment terms '%s' cannot be selected on this POS"),
313 $order->payment_terms['terms']));
314 $order->payment = '';
315 } elseif (get_post('payment') !== $order->payment) {
316 $_POST['payment'] = $order->payment;
317 $Ajax->activate('delivery');
318 $Ajax->activate('payment');
320 if ($order->trans_type == ST_SALESINVOICE)
322 $_POST['delivery_date'] = $order->due_date;
323 $Ajax->activate('delivery_date');
325 $Ajax->activate('Location');
326 $Ajax->activate('deliver_to');
327 $Ajax->activate('phone');
328 $Ajax->activate('delivery_address');
330 // change prices if necessary
331 // what about discount in template case?
332 if ($old_order->customer_currency != $order->customer_currency) {
335 if ($old_order->sales_type != $order->sales_type) {
336 // || $old_order->default_discount!=$order->default_discount
337 $_POST['sales_type'] = $order->sales_type;
338 $Ajax->activate('sales_type');
341 if ($old_order->dimension_id != $order->dimension_id) {
342 $_POST['dimension_id'] = $order->dimension_id;
343 $Ajax->activate('dimension_id');
345 if ($old_order->dimension2_id != $order->dimension2_id) {
346 $_POST['dimension2_id'] = $order->dimension2_id;
347 $Ajax->activate('dimension2_id');
351 set_global_customer($_POST['customer_id']);
355 $row = get_customer_to_order($_POST['customer_id']);
356 if ($row['dissallow_invoices'] == 1)
357 $customer_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
361 ref_row(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '', $order->trans_type, array('date'=> @$_POST['OrderDate']));
365 if (!is_company_currency($order->customer_currency) && in_array($order->trans_type, array(ST_SALESINVOICE, ST_CUSTDELIVERY)))
367 label_row(_("Customer Currency:"), $order->customer_currency);
368 exchange_rate_display(get_company_currency(), $order->customer_currency,
369 ($editable ? $_POST['OrderDate'] : $order->document_date));
372 customer_credit_row($_POST['customer_id'], $order->credit);
374 label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
378 if (($order->pos['cash_sale'] || $order->pos['credit_sale'])
379 && !$order->is_started()) {
380 // editable payment type
381 if (get_post('payment') !== $order->payment) {
382 $order->payment = get_post('payment');
383 $order->payment_terms = get_payment_terms($order->payment);
384 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
385 if ($order->payment_terms['cash_sale']) {
386 $_POST['Location'] = $order->Location = $order->pos['pos_location'];
387 $order->location_name = $order->pos['location_name'];
389 $Ajax->activate('items_table');
390 $Ajax->activate('delivery');
392 $paymcat = !$order->pos['cash_sale'] ? PM_CREDIT :
393 (!$order->pos['credit_sale'] ? PM_CASH : PM_ANY);
394 // all terms are available for SO
395 $is_order = in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER));
396 sale_payment_list_cells(_('Payment:'), 'payment', $is_order ? PM_ANY : $paymcat, null, true, $is_order);
398 label_cells(_('Payment:'), $order->payment_terms['terms'], "class='label'");
403 $str = sales_types_list_row(_("Price List:"), 'sales_type', null, true);
405 label_row(_("Price List:"), $order->sales_type_name);
407 if ($order->sales_type != $_POST['sales_type']) {
408 $myrow = get_sales_type($_POST['sales_type']);
409 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
410 $myrow['tax_included'], $myrow['factor']);
411 $Ajax->activate('sales_type');
419 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
420 $_POST['OrderDate'] = $order->document_date;
422 date_row($date_text, 'OrderDate', _('Date of order receive'),
423 $order->trans_no==0, 0, 0, 0, null, true);
424 if (isset($_POST['_OrderDate_changed']) || list_updated('payment')) {
425 if (!is_company_currency($order->customer_currency)
426 && (get_base_sales_type()>0)) {
429 $Ajax->activate('_ex_rate');
430 if ($order->trans_type == ST_SALESINVOICE) {
431 $_POST['delivery_date'] = get_invoice_duedate(get_post('payment'), get_post('OrderDate'));
433 $_POST['delivery_date'] = add_days(get_post('OrderDate'), $SysPrefs->default_delivery_required_by());
434 $Ajax->activate('items_table');
435 $Ajax->activate('delivery_date');
437 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
438 { // 2008-11-12 Joe Hunt added dimensions
439 $dim = get_company_pref('use_dimension');
441 dimensions_list_row(_("Dimension").":", 'dimension_id',
442 null, true, ' ', false, 1, false);
444 hidden('dimension_id', 0);
446 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
447 null, true, ' ', false, 2, false);
449 hidden('dimension2_id', 0);
454 label_row($date_text, $order->document_date);
455 hidden('OrderDate', $order->document_date);
458 end_outer_table(1); // outer table
460 if ($change_prices != 0) {
461 foreach ($order->line_items as $line_no=>$item) {
462 $line = &$order->line_items[$line_no];
463 $line->price = get_kit_price($line->stock_id, $order->customer_currency,
464 $order->sales_type, $order->price_factor, get_post('OrderDate'));
466 $Ajax->activate('items_table');
469 return $customer_error;
472 //--------------------------------------------------------------------------------
474 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
478 alt_table_row_color($rowcounter);
480 $id = find_submit('Edit');
481 if ($line_no!=-1 && $line_no == $id) // edit old line
483 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
484 $dec = get_qty_dec($_POST['stock_id']);
485 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
486 $_POST['price'] = price_format($order->line_items[$id]->price);
487 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
488 $units = $order->line_items[$id]->units;
489 $_POST['item_description'] = $order->line_items[$id]->item_description;
490 hidden('stock_id', $_POST['stock_id']);
491 label_cell($_POST['stock_id']);
492 if ($order->line_items[$id]->descr_editable)
493 text_cells(null,'item_description', null, 45, 150);
495 hidden('item_description', $_POST['item_description']);
496 label_cell($_POST['item_description']);
498 $Ajax->activate('items_table');
500 else // prepare new line
502 if ($order->fixed_asset)
503 stock_disposable_fa_list_cells(null,'stock_id', null, _('[Select item]'), true, $order->line_items);
505 if (!isset($_POST['stock_id'])) { // Check if stock_id dosesn't exist
506 $_POST['stock_id'] = last_sales_order_detail($order, 'stk_code'); //get the llast sales stock id.
508 sales_items_list_cells(null,'stock_id', $_POST['stock_id'], false, true, true);
510 if (list_updated('stock_id')) {
511 $Ajax->activate('price');
512 $Ajax->activate('units');
513 $Ajax->activate('qty');
514 $Ajax->activate('line_total');
517 $item_info = get_item_edit_info($_POST['stock_id']);
518 $units = $item_info["units"];
519 $dec = $item_info['decimals'];
520 $_POST['qty'] = number_format2(1, $dec);
521 $price = get_kit_price($_POST['stock_id'],
522 $order->customer_currency, $order->sales_type,
523 $order->price_factor, get_post('OrderDate'));
524 $_POST['price'] = price_format($price);
525 // default to the customer's discount %
526 $_POST['Disc'] = percent_format($order->default_discount * 100);
529 if ($order->fixed_asset) {
530 label_cell(1, '', 'qty');
533 qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
535 if ($order->trans_no!=0) {
536 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
539 label_cell($units, '', 'units');
541 amount_cells(null, 'price');
543 small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
545 $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
547 amount_cell($line_total, false, '','line_total');
551 button_cell('UpdateItem', _("Update"),
552 _('Confirm changes'), ICON_UPDATE);
553 button_cell('CancelItemChanges', _("Cancel"),
554 _('Cancel changes'), ICON_CANCEL);
555 hidden('LineNo', $line_no);
560 submit_cells('AddItem', _("Add Item"), "colspan=2 align='center'",
561 _('Add new item to document'), true);
567 //--------------------------------------------------------------------------------
569 function display_delivery_details(&$order)
573 div_start('delivery');
576 if ($order->payment_terms['cash_sale']) { // Direct payment sale
577 $Ajax->activate('items_table');
578 display_heading(_('Cash payment'));
579 start_table(TABLESTYLE2, "width='60%'");
581 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true);
582 if (list_updated('Location'))
583 $Ajax->activate('items_table');
584 label_row(_("Cash account:"), $order->pos['bank_account_name']);
585 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
587 hidden('delivery_date', $order->due_date);
589 if ($order->trans_type==ST_SALESINVOICE)
591 $title = _("Delivery Details");
592 $delname = _("Due Date").':';
594 elseif ($order->trans_type==ST_CUSTDELIVERY)
596 $title = _("Invoice Delivery Details");
597 $delname = _("Invoice before").':';
599 elseif ($order->trans_type==ST_SALESQUOTE)
601 $title = _("Quotation Delivery Details");
602 $delname = _("Valid until").':';
606 $title = _("Order Delivery Details");
607 $delname = _("Required Delivery Date").':';
609 display_heading($title);
610 start_outer_table(TABLESTYLE2, "width='90%'");
613 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true, $order->fixed_asset);
614 if ($order->payment_terms['days_before_due'] == -1)
616 $Ajax->addUpdate('items_table', 'prep_amount', price_format($order->get_trans_total())); // bind to items_table update
617 if (!$order->is_started())
618 amount_row(_("Pre-Payment Required:"), 'prep_amount');
620 label_row(_("Pre-Payment Required:"), price_format($order->prep_amount), "class='label'");
622 if (list_updated('Location'))
623 $Ajax->activate('items_table');
626 date_row($delname, 'delivery_date',
627 $order->trans_type==ST_SALESORDER ? _('Enter requested day of delivery')
628 : $order->trans_type==ST_SALESQUOTE ? _('Enter Valid until Date') : '');
629 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 50, 60,
630 _('Additional identifier for delivery e.g. name of receiving person'));
632 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
633 _('Delivery address. Default is address of customer branch'));
637 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
638 _('Phone number of ordering person. Defaults to branch phone number'));
639 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
640 _('Customer reference number for this order (if any)'));
641 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
643 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);