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");
13 include_once($path_to_root . "/includes/manufacturing.inc");
15 //--------------------------------------------------------------------------------
16 function add_to_order(&$order, $new_item, $new_item_qty, $price, $discount, $description='')
18 // calculate item price to sum of kit element prices factor for
19 // value distribution over all exploded kit items
20 $std_price = get_kit_price($new_item, $order->customer_currency,
21 $order->sales_type, $order->price_factor, get_post('OrderDate'), true);
26 $price_factor = $price/$std_price;
28 $kit = get_item_kit($new_item);
29 $item_num = db_num_rows($kit);
31 while($item = db_fetch($kit)) {
32 $std_price = get_kit_price($item['stock_id'], $order->customer_currency,
33 $order->sales_type, $order->price_factor, get_post('OrderDate'), true);
35 // rounding differences are included in last price item in kit
38 $price -= $item['quantity']*$std_price*$price_factor;
39 $item_price = $std_price*$price_factor;
41 if ($item['quantity'])
42 $price = $price/$item['quantity'];
45 $item_price = round($item_price, user_price_dec());
47 if (!$item['is_foreign'] && $item['item_code'] != $item['stock_id'])
48 { // this is sales kit - recurse
49 add_to_order($order, $item['stock_id'], $new_item_qty*$item['quantity'],
50 $item_price, $discount);
53 { // stock item record eventually with foreign code
55 // check duplicate stock item
56 foreach ($order->line_items as $order_item)
58 if (strcasecmp($order_item->stock_id, $item['stock_id']) == 0)
60 display_warning(_("For Part :").$item['stock_id']. " "
61 . _("This item is already on this document. You have been warned."));
65 $order->add_to_cart (count($order->line_items), $item['stock_id'],
66 $new_item_qty*$item['quantity'], $item_price, $discount, 0,0, $description);
71 //---------------------------------------------------------------------------------
73 function get_customer_details_to_order(&$order, $customer_id, $branch_id)
79 $myrow = get_customer_to_order($customer_id);
81 $name = $myrow['name'];
83 if ($myrow['dissallow_invoices'] == 1)
84 $ret_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
86 $deliver = $myrow['address']; // in case no branch address use company address
88 $order->set_customer($customer_id, $name, $myrow['curr_code'],
89 $myrow['discount'], $myrow['payment_terms'], $myrow['pymt_discount']);
91 // the sales type determines the price list to be used by default
92 $order->set_sales_type($myrow['salestype'], $myrow['sales_type'], $myrow['tax_included'],
95 $order->credit = $myrow['cur_credit'];
97 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
99 $order->dimension_id = $myrow['dimension_id'];
100 $order->dimension2_id = $myrow['dimension2_id'];
102 $result = get_branch_to_order($customer_id, $branch_id);
104 if (db_num_rows($result) == 0)
106 return _("The selected customer and branch are not valid, or the customer does not have any branches.");
109 $myrow = db_fetch($result);
111 // FIX - implement editable contact selector in sales order
112 $contact = get_branch_contacts($branch_id, 'order', $customer_id);
113 $order->set_branch($branch_id, $myrow["tax_group_id"],
114 $myrow["tax_group_name"], @$contact["phone"], @$contact["email"]);
116 $address = trim($myrow["br_post_address"]) != '' ? $myrow["br_post_address"]
117 : (trim($myrow["br_address"]) != '' ? $myrow["br_address"]:$deliver);
119 $order->set_delivery($myrow["default_ship_via"], $myrow["br_name"],
121 if ($order->trans_type == ST_SALESINVOICE) {
122 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
124 elseif ($order->trans_type == ST_SALESORDER)
125 $order->due_date = add_days($order->document_date, $SysPrefs->default_delivery_required_by());
127 if($order->payment_terms['cash_sale']) {
128 $order->set_location($order->pos["pos_location"], $order->pos["location_name"]);
130 $order->set_location($myrow["default_location"], $myrow["location_name"]);
135 //---------------------------------------------------------------------------------
137 function display_order_summary($title, &$order, $editable_items=false)
141 display_heading($title);
143 div_start('items_table');
144 start_table(TABLESTYLE, "colspan=7 width=90%");
145 $th = array(_("Item Code"), _("Item Description"), _("Quantity"),
147 _("Unit"), $order->tax_included ? _("Price after Tax") : _("Price before Tax"), _("Discount %"), _("Total"), "");
149 if ($order->trans_no == 0) {
153 if (count($order->line_items))
159 $k = 0; //row colour counter
161 $id = find_submit('Edit');
164 foreach ($order->get_items() as $line_no=>$stock_item)
167 $line_total = round($stock_item->qty_dispatched * $stock_item->price * (1 - $stock_item->discount_percent),
171 if (!$editable_items || $id != $line_no)
173 if (!$SysPrefs->allow_negative_stock() && is_inventory_item($stock_item->stock_id) &&
174 $order->trans_type != ST_SALESORDER && $order->trans_type!=ST_SALESQUOTE) {
175 $qoh = get_qoh_on_date($stock_item->stock_id,
176 $_POST['Location'], $_POST['delivery_date']);
177 if (($stock_item->qty_dispatched -$stock_item->qty_done) > $qoh)
179 // oops, we don't have enough of one of the component items
180 start_row("class='stockmankobg'");
181 $qoh_msg .= $stock_item->stock_id . " - " . $stock_item->item_description . ": " .
182 _("Quantity On Hand") . " = "
183 . number_format2($qoh, get_qty_dec($stock_item->stock_id)) . '<br>';
186 alt_table_row_color($k);
188 alt_table_row_color($k);
191 view_stock_status_cell($stock_item->stock_id);
193 //label_cell($stock_item->item_description, "nowrap" );
194 label_cell($stock_item->item_description );
195 $dec = get_qty_dec($stock_item->stock_id);
196 qty_cell($stock_item->qty_dispatched, false, $dec);
198 if ($order->trans_no!=0)
199 qty_cell($stock_item->qty_done, false, $dec);
201 label_cell($stock_item->units);
202 amount_cell($stock_item->price);
204 percent_cell($stock_item->discount_percent * 100);
205 amount_cell($line_total);
209 edit_button_cell("Edit$line_no", _("Edit"),
210 _('Edit document line'));
211 delete_button_cell("Delete$line_no", _("Delete"),
212 _('Remove line from document'));
218 sales_order_item_controls($order, $k, $line_no);
221 $total += $line_total;
224 if ($id==-1 && $editable_items)
225 sales_order_item_controls($order, $k);
228 if ($order->trans_no!=0)
231 label_cell(_("Shipping Charge"), "colspan=$colspan align=right");
232 small_amount_cells(null, 'freight_cost', price_format(get_post('freight_cost',0)));
233 label_cell('', 'colspan=2');
235 $display_sub_total = price_format($total + input_num('freight_cost'));
236 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right", 2);
237 $taxes = $order->get_taxes(input_num('freight_cost'));
238 $tax_total = display_edit_tax_items($taxes, $colspan, $order->tax_included, 2);
240 $display_total = price_format(($total + input_num('freight_cost') + $tax_total));
243 label_cells(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
244 submit_cells('update', _("Update"), "colspan=2 align='center'", _("Refresh"), true);
249 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
250 if ($order->trans_type!=30 && !$SysPrefs->allow_negative_stock())
251 display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:")
257 // ------------------------------------------------------------------------------
259 function display_order_header(&$order, $editable, $date_text)
261 global $Ajax, $SysPrefs;
263 start_outer_table(TABLESTYLE2, "width=80%");
267 $customer_error = "";
270 if (isset($order) && !$editable)
272 // can't change the customer/branch if items already received on this order
273 //echo $order->customer_name . " - " . $order->deliver_to;
274 label_row(null, $order->customer_name . " - " . $order->deliver_to);
275 hidden('customer_id', $order->customer_id);
276 hidden('branch_id', $order->Branch);
277 hidden('sales_type', $order->sales_type);
278 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE) {
279 hidden('dimension_id', $order->dimension_id); // 2008-11-12 Joe Hunt
280 hidden('dimension2_id', $order->dimension2_id);
285 customer_list_row(_("Customer:"), 'customer_id', null, false, true, false, true);
287 if ($order->customer_id != get_post('customer_id', -1))
289 // customer has changed
290 $Ajax->activate('branch_id');
292 customer_branches_list_row(_("Branch:"),
293 $_POST['customer_id'], 'branch_id', null, false, true, true, true);
295 if( ($order->customer_id != get_post('customer_id', -1)) ||
296 ($order->Branch != get_post('branch_id', -1)) ||
297 list_updated('customer_id'))
300 if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
302 // ignore errors on customer search box call
303 if ($_POST['customer_id'] == '')
304 $customer_error = _("No customer found for entered text.");
306 $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
307 unset($_POST['branch_id']);
313 $old_order = (PHP_VERSION<5) ? $order : clone( $order );
315 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
316 $_POST['Location'] = $order->Location;
317 $_POST['deliver_to'] = $order->deliver_to;
318 $_POST['delivery_address'] = $order->delivery_address;
319 $_POST['phone'] = $order->phone;
320 $_POST['delivery_date'] = $order->due_date;
322 if (!in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER))
323 && ($order->pos['cash_sale'] != $order->pos['credit_sale'])
324 && (($order->payment_terms['cash_sale'] && !$order->pos['cash_sale']) ||
325 (!$order->payment_terms['cash_sale'] && !$order->pos['credit_sale']))) {
326 // force payment terms refresh if terms are editable
327 // and pos have no permitions for terms selected in customer record.
328 // Terms are set to first terms in allowed category below.
330 sprintf(_("Customer's payment terms '%s' cannot be selected on this POS"),
331 $order->payment_terms['terms']));
332 $order->payment = '';
333 } elseif (get_post('payment') !== $order->payment) {
334 $_POST['payment'] = $order->payment;
335 $Ajax->activate('delivery');
336 $Ajax->activate('payment');
338 if ($order->trans_type == ST_SALESINVOICE)
340 $_POST['delivery_date'] = $order->due_date;
341 $Ajax->activate('delivery_date');
343 $Ajax->activate('Location');
344 $Ajax->activate('deliver_to');
345 $Ajax->activate('phone');
346 $Ajax->activate('delivery_address');
348 // change prices if necessary
349 // what about discount in template case?
350 if ($old_order->customer_currency != $order->customer_currency) {
353 if ($old_order->sales_type != $order->sales_type) {
354 // || $old_order->default_discount!=$order->default_discount
355 $_POST['sales_type'] = $order->sales_type;
356 $Ajax->activate('sales_type');
359 if ($old_order->dimension_id != $order->dimension_id) {
360 $_POST['dimension_id'] = $order->dimension_id;
361 $Ajax->activate('dimension_id');
363 if ($old_order->dimension2_id != $order->dimension2_id) {
364 $_POST['dimension2_id'] = $order->dimension2_id;
365 $Ajax->activate('dimension2_id');
369 set_global_customer($_POST['customer_id']);
373 $row = get_customer_to_order($_POST['customer_id']);
374 if ($row['dissallow_invoices'] == 1)
375 $customer_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
380 ref_row(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '');
384 if (!is_company_currency($order->customer_currency))
386 label_row(_("Customer Currency:"), $order->customer_currency);
387 exchange_rate_display($order->customer_currency, get_company_currency(),
388 ($editable ? $_POST['OrderDate'] : $order->document_date));
391 customer_credit_row($_POST['customer_id'], $order->credit);
393 label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
396 if (($order->pos['cash_sale'] || $order->pos['credit_sale'])
397 && !$order->is_started()) {
398 // editable payment type
399 if (get_post('payment') !== $order->payment) {
400 $order->payment = get_post('payment');
401 $order->payment_terms = get_payment_terms($order->payment);
402 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
403 if ($order->payment_terms['cash_sale']) {
404 $_POST['Location'] = $order->Location = $order->pos['pos_location'];
405 $order->location_name = $order->pos['location_name'];
407 $Ajax->activate('items_table');
408 $Ajax->activate('delivery');
410 $paymcat = !$order->pos['cash_sale'] ? PM_CREDIT :
411 (!$order->pos['credit_sale'] ? PM_CASH : PM_ANY);
412 // all terms are available for SO
413 $is_order = in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER));
414 sale_payment_list_cells(_('Payment:'), 'payment', $is_order ? PM_ANY : $paymcat, null, true, $is_order);
416 label_cells(_('Payment:'), $order->payment_terms['terms'], "class='label'");
420 $str = sales_types_list_row(_("Price List:"), 'sales_type', null, true);
422 label_row(_("Price List:"), $order->sales_type_name);
424 if ($order->sales_type != $_POST['sales_type']) {
425 $myrow = get_sales_type($_POST['sales_type']);
426 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
427 $myrow['tax_included'], $myrow['factor']);
428 $Ajax->activate('sales_type');
436 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
437 $_POST['OrderDate'] = $order->document_date;
439 date_row($date_text, 'OrderDate', _('Date of order receive'),
440 $order->trans_no==0, 0, 0, 0, null, true);
441 if (isset($_POST['_OrderDate_changed']) || list_updated('payment')) {
442 if (!is_company_currency($order->customer_currency)
443 && (get_base_sales_type()>0)) {
446 $Ajax->activate('_ex_rate');
447 if ($order->trans_type == ST_SALESINVOICE) {
448 $_POST['delivery_date'] = get_invoice_duedate(get_post('payment'), get_post('OrderDate'));
450 $_POST['delivery_date'] = add_days(get_post('OrderDate'), $SysPrefs->default_delivery_required_by());
451 $Ajax->activate('items_table');
452 $Ajax->activate('delivery_date');
454 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
455 { // 2008-11-12 Joe Hunt added dimensions
456 $dim = get_company_pref('use_dimension');
458 dimensions_list_row(_("Dimension").":", 'dimension_id',
459 null, true, ' ', false, 1, false);
461 hidden('dimension_id', 0);
463 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
464 null, true, ' ', false, 2, false);
466 hidden('dimension2_id', 0);
471 label_row($date_text, $order->document_date);
472 hidden('OrderDate', $order->document_date);
475 end_outer_table(1); // outer table
477 if ($change_prices != 0) {
478 foreach ($order->line_items as $line_no=>$item) {
479 $line = &$order->line_items[$line_no];
480 $line->price = get_kit_price($line->stock_id, $order->customer_currency,
481 $order->sales_type, $order->price_factor, get_post('OrderDate'));
482 // $line->discount_percent = $order->default_discount;
484 $Ajax->activate('items_table');
487 return $customer_error;
490 //--------------------------------------------------------------------------------
492 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
496 alt_table_row_color($rowcounter);
498 $id = find_submit('Edit');
499 if ($line_no!=-1 && $line_no == $id) // edit old line
501 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
502 $dec = get_qty_dec($_POST['stock_id']);
503 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
504 $_POST['price'] = price_format($order->line_items[$id]->price);
505 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
506 $units = $order->line_items[$id]->units;
507 $_POST['item_description'] = $order->line_items[$id]->item_description;
508 hidden('stock_id', $_POST['stock_id']);
509 label_cell($_POST['stock_id']);
510 if ($order->line_items[$id]->descr_editable)
511 text_cells(null,'item_description', null, 45, 150);
513 hidden('item_description', $_POST['item_description']);
514 label_cell($_POST['item_description']);
517 // sales_items_list_cells(null,'item_description', null, false, true);
519 //label_cell($order->line_items[$line_no]->item_description, "nowrap");
520 $Ajax->activate('items_table');
522 else // prepare new line
524 sales_items_list_cells(null,'stock_id', null, false, true);
525 if (list_updated('stock_id')) {
526 $Ajax->activate('price');
527 $Ajax->activate('units');
528 $Ajax->activate('qty');
529 $Ajax->activate('line_total');
532 $item_info = get_item_edit_info($_POST['stock_id']);
533 $units = $item_info["units"];
534 $dec = $item_info['decimals'];
535 $_POST['qty'] = number_format2(1, $dec);
536 $price = get_kit_price($_POST['stock_id'],
537 $order->customer_currency, $order->sales_type,
538 $order->price_factor, get_post('OrderDate'));
539 $_POST['price'] = price_format($price);
540 // default to the customer's discount %
541 $_POST['Disc'] = percent_format($order->default_discount * 100);
544 qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
546 if ($order->trans_no!=0) {
547 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
550 label_cell($units, '', 'units');
552 amount_cells(null, 'price');
554 small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
556 $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
558 amount_cell($line_total, false, '','line_total');
562 button_cell('UpdateItem', _("Update"),
563 _('Confirm changes'), ICON_UPDATE);
564 button_cell('CancelItemChanges', _("Cancel"),
565 _('Cancel changes'), ICON_CANCEL);
566 hidden('LineNo', $line_no);
571 submit_cells('AddItem', _("Add Item"), "colspan=2 align='center'",
572 _('Add new item to document'), true);
578 //--------------------------------------------------------------------------------
580 function display_delivery_details(&$order)
584 div_start('delivery');
587 if ($order->payment_terms['cash_sale']) { // Direct payment sale
588 $Ajax->activate('items_table');
589 display_heading(_('Cash payment'));
590 start_table(TABLESTYLE2, "width=60%");
592 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true);
593 if (list_updated('Location'))
594 $Ajax->activate('items_table');
595 label_row(_("Cash account:"), $order->pos['bank_account_name']);
596 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
598 hidden('delivery_date', $order->due_date);
600 if ($order->trans_type==ST_SALESINVOICE)
602 $title = _("Delivery Details");
603 $delname = _("Due Date").':';
605 elseif ($order->trans_type==ST_CUSTDELIVERY)
607 $title = _("Invoice Delivery Details");
608 $delname = _("Invoice before").':';
610 elseif ($order->trans_type==ST_SALESQUOTE)
612 $title = _("Quotation Delivery Details");
613 $delname = _("Valid until").':';
617 $title = _("Order Delivery Details");
618 $delname = _("Required Delivery Date").':';
620 display_heading($title);
621 start_outer_table(TABLESTYLE2, "width=90%");
624 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true);
625 if ($order->payment_terms['days_before_due'] < 0)
627 $Ajax->addUpdate('items_table', 'prep_amount', price_format($order->get_trans_total())); // bind to items_table update
628 if (!$order->is_started())
629 amount_row(_("Pre-Payment Required:"), 'prep_amount');
631 label_row(_("Pre-Payment Required:"), price_format($order->prep_amount), "class='label'");
633 if (list_updated('Location'))
634 $Ajax->activate('items_table');
637 date_row($delname, 'delivery_date',
638 $order->trans_type==ST_SALESORDER ? _('Enter requested day of delivery')
639 : $order->trans_type==ST_SALESQUOTE ? _('Enter Valid until Date') : '');
640 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 40, 40,
641 _('Additional identifier for delivery e.g. name of receiving person'));
643 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
644 _('Delivery address. Default is address of customer branch'));
648 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
649 _('Phone number of ordering person. Defaults to branch phone number'));
650 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
651 _('Customer reference number for this order (if any)'));
652 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
654 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);