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)
77 $myrow = get_customer_to_order($customer_id);
79 $name = $myrow['name'];
81 if ($myrow['dissallow_invoices'] == 1)
82 $ret_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
84 $deliver = $myrow['address']; // in case no branch address use company address
86 $order->set_customer($customer_id, $name, $myrow['curr_code'],
87 $myrow['discount'], $myrow['payment_terms'], $myrow['pymt_discount']);
89 // the sales type determines the price list to be used by default
90 $order->set_sales_type($myrow['salestype'], $myrow['sales_type'], $myrow['tax_included'],
93 $order->credit = $myrow['cur_credit'];
95 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
97 $order->dimension_id = $myrow['dimension_id'];
98 $order->dimension2_id = $myrow['dimension2_id'];
100 $result = get_branch_to_order($customer_id, $branch_id);
102 if (db_num_rows($result) == 0)
104 return _("The selected customer and branch are not valid, or the customer does not have any branches.");
107 $myrow = db_fetch($result);
109 // FIX - implement editable contact selector in sales order
110 $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[0]["phone"], @$contact[0]["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 || $order->trans_type == ST_SALESORDER) {
121 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
123 if($order->payment_terms['cash_sale']) {
124 $order->set_location($order->pos["pos_location"], $order->pos["location_name"]);
126 $order->set_location($myrow["default_location"], $myrow["location_name"]);
131 //---------------------------------------------------------------------------------
133 function display_order_summary($title, &$order, $editable_items=false)
137 display_heading($title);
139 div_start('items_table');
140 start_table(TABLESTYLE, "colspan=7 width=90%");
141 $th = array(_("Item Code"), _("Item Description"), _("Quantity"),
143 _("Unit"), $order->tax_included ? _("Price after Tax") : _("Price before Tax"), _("Discount %"), _("Total"), "");
145 if ($order->trans_no == 0) {
149 if (count($order->line_items))
155 $k = 0; //row colour counter
157 $id = find_submit('Edit');
159 foreach ($order->line_items as $line_no=>$stock_item)
162 $line_total = round($stock_item->qty_dispatched * $stock_item->price * (1 - $stock_item->discount_percent),
166 if (!$editable_items || $id != $line_no)
168 if (!$SysPrefs->allow_negative_stock() && is_inventory_item($stock_item->stock_id)) {
169 $qoh = get_qoh_on_date($stock_item->stock_id,
170 $_POST['Location'], $_POST['OrderDate']);
171 if ($stock_item->qty_dispatched > $qoh)
173 // oops, we don't have enough of one of the component items
174 start_row("class='stockmankobg'");
175 $qoh_msg .= $stock_item->stock_id . " - " . $stock_item->item_description . ": " .
176 _("Quantity On Hand") . " = "
177 . number_format2($qoh, get_qty_dec($stock_item->stock_id)) . '<br>';
180 alt_table_row_color($k);
182 alt_table_row_color($k);
185 view_stock_status_cell($stock_item->stock_id);
187 //label_cell($stock_item->item_description, "nowrap" );
188 label_cell($stock_item->item_description );
189 $dec = get_qty_dec($stock_item->stock_id);
190 qty_cell($stock_item->qty_dispatched, false, $dec);
192 if ($order->trans_no!=0)
193 qty_cell($stock_item->qty_done, false, $dec);
195 label_cell($stock_item->units);
196 amount_cell($stock_item->price);
198 percent_cell($stock_item->discount_percent * 100);
199 amount_cell($line_total);
203 edit_button_cell("Edit$line_no", _("Edit"),
204 _('Edit document line'));
205 delete_button_cell("Delete$line_no", _("Delete"),
206 _('Remove line from document'));
212 sales_order_item_controls($order, $k, $line_no);
215 $total += $line_total;
218 if ($id==-1 && $editable_items)
219 sales_order_item_controls($order, $k);
222 if ($order->trans_no!=0)
225 label_cell(_("Shipping Charge"), "colspan=$colspan align=right");
226 small_amount_cells(null, 'freight_cost', price_format(get_post('freight_cost',0)));
227 label_cell('', 'colspan=2');
229 $display_sub_total = price_format($total + input_num('freight_cost'));
230 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right", 2);
231 $taxes = $order->get_taxes(input_num('freight_cost'));
232 $tax_total = display_edit_tax_items($taxes, $colspan, $order->tax_included, 2);
234 $display_total = price_format(($total + input_num('freight_cost') + $tax_total));
237 label_cells(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
238 submit_cells('update', _("Update"), "colspan=2 align='center'", _("Refresh"), true);
243 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
244 if ($order->trans_type!=30 && !$SysPrefs->allow_negative_stock())
245 display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:")
251 // ------------------------------------------------------------------------------
253 function display_order_header(&$order, $editable, $date_text)
255 global $Ajax, $SysPrefs;
257 start_outer_table(TABLESTYLE2, "width=80%");
261 $customer_error = "";
264 if (isset($order) && !$editable)
266 // can't change the customer/branch if items already received on this order
267 //echo $order->customer_name . " - " . $order->deliver_to;
268 label_row(null, $order->customer_name . " - " . $order->deliver_to);
269 hidden('customer_id', $order->customer_id);
270 hidden('branch_id', $order->Branch);
271 hidden('sales_type', $order->sales_type);
272 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE) {
273 hidden('dimension_id', $order->dimension_id); // 2008-11-12 Joe Hunt
274 hidden('dimension2_id', $order->dimension2_id);
279 customer_list_row(_("Customer:"), 'customer_id', null, false, true, false, true);
281 if ($order->customer_id != get_post('customer_id', -1))
283 // customer has changed
284 $Ajax->activate('branch_id');
286 customer_branches_list_row(_("Branch:"),
287 $_POST['customer_id'], 'branch_id', null, false, true, true, true);
289 if( ($order->customer_id != get_post('customer_id', -1)) ||
290 ($order->Branch != get_post('branch_id', -1)) ||
291 list_updated('customer_id'))
294 if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
296 // ignore errors on customer search box call
297 if ($_POST['customer_id'] == '')
298 $customer_error = _("No customer found for entered text.");
300 $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
301 unset($_POST['branch_id']);
307 $old_order = (PHP_VERSION<5) ? $order : clone( $order );
309 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
310 $_POST['Location'] = $order->Location;
311 $_POST['deliver_to'] = $order->deliver_to;
312 $_POST['delivery_address'] = $order->delivery_address;
313 $_POST['phone'] = $order->phone;
314 $_POST['delivery_date'] = $order->due_date;
316 if (!in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER))
317 && ($order->pos['cash_sale'] != $order->pos['credit_sale'])
318 && (($order->payment_terms['cash_sale'] && !$order->pos['cash_sale']) ||
319 (!$order->payment_terms['cash_sale'] && !$order->pos['credit_sale']))) {
320 // force payment terms refresh if terms are editable
321 // and pos have no permitions for terms selected in customer record.
322 // Terms are set to first terms in allowed category below.
324 sprintf(_("Customer's payment terms '%s' cannot be selected on this POS"),
325 $order->payment_terms['terms']));
326 $order->payment = '';
327 } elseif (get_post('payment') !== $order->payment) {
328 $_POST['payment'] = $order->payment;
329 $Ajax->activate('delivery');
330 $Ajax->activate('payment');
332 if ($order->trans_type == ST_SALESINVOICE)
334 $_POST['delivery_date'] = $order->due_date;
335 $Ajax->activate('delivery_date');
337 $Ajax->activate('Location');
338 $Ajax->activate('deliver_to');
339 $Ajax->activate('phone');
340 $Ajax->activate('delivery_address');
342 // change prices if necessary
343 // what about discount in template case?
344 if ($old_order->customer_currency != $order->customer_currency) {
347 if ($old_order->sales_type != $order->sales_type) {
348 // || $old_order->default_discount!=$order->default_discount
349 $_POST['sales_type'] = $order->sales_type;
350 $Ajax->activate('sales_type');
353 if ($old_order->dimension_id != $order->dimension_id) {
354 $_POST['dimension_id'] = $order->dimension_id;
355 $Ajax->activate('dimension_id');
357 if ($old_order->dimension2_id != $order->dimension2_id) {
358 $_POST['dimension2_id'] = $order->dimension2_id;
359 $Ajax->activate('dimension2_id');
363 set_global_customer($_POST['customer_id']);
367 $row = get_customer_to_order($_POST['customer_id']);
368 if ($row['dissallow_invoices'] == 1)
369 $customer_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
374 ref_row(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '');
378 if (!is_company_currency($order->customer_currency))
380 label_row(_("Customer Currency:"), $order->customer_currency);
381 exchange_rate_display($order->customer_currency, get_company_currency(),
382 ($editable ? $_POST['OrderDate'] : $order->document_date));
385 customer_credit_row($_POST['customer_id'], $order->credit);
387 label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
390 if ($order->pos['cash_sale'] || $order->pos['credit_sale']) {
391 // editable payment type
392 if (get_post('payment') !== $order->payment) {
393 $order->payment = get_post('payment');
394 $order->payment_terms = get_payment_terms($order->payment);
395 $order->due_date = get_invoice_duedate($order->payment, $order->document_date);
396 if ($order->payment_terms['cash_sale']) {
397 $order->cash_account = $order->pos['pos_account'];
398 $order->account_name = $order->pos['bank_account_name'];
399 $_POST['Location'] = $order->Location = $order->pos['pos_location'];
400 $order->location_name = $order->pos['location_name'];
402 $Ajax->activate('items_table');
403 $Ajax->activate('delivery');
405 $paymcat = !$order->pos['cash_sale'] ? PM_CREDIT :
406 (!$order->pos['credit_sale'] ? PM_CASH : PM_ANY);
407 // all terms are available for SO
408 sale_payment_list_cells(_('Payment:'), 'payment',
409 (in_array($order->trans_type, array(ST_SALESQUOTE, ST_SALESORDER))
410 ? PM_ANY : $paymcat), null);
412 label_cells(_('Payment:'), $order->payment_terms['terms']);
416 $str = sales_types_list_row(_("Price List"), 'sales_type', null, true);
418 label_row(_("Price List:"), $order->sales_type_name);
420 if ($order->sales_type != $_POST['sales_type']) {
421 $myrow = get_sales_type($_POST['sales_type']);
422 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
423 $myrow['tax_included'], $myrow['factor']);
424 $Ajax->activate('sales_type');
432 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
433 $_POST['OrderDate'] = $order->document_date;
435 date_row($date_text, 'OrderDate', _('Date of order receive'),
436 $order->trans_no==0, 0, 0, 0, null, true);
437 if (isset($_POST['_OrderDate_changed']) || list_updated('payment')) {
438 if (!is_company_currency($order->customer_currency)
439 && (get_base_sales_type()>0)) {
442 $Ajax->activate('_ex_rate');
443 if ($order->trans_type == ST_SALESINVOICE) {
444 $_POST['delivery_date'] = get_invoice_duedate(get_post('payment'), get_post('OrderDate'));
446 $_POST['delivery_date'] = add_days(get_post('OrderDate'), $SysPrefs->default_delivery_required_by());
447 $Ajax->activate('items_table');
448 $Ajax->activate('delivery_date');
450 if ($order->trans_type != ST_SALESORDER && $order->trans_type != ST_SALESQUOTE)
451 { // 2008-11-12 Joe Hunt added dimensions
452 $dim = get_company_pref('use_dimension');
454 dimensions_list_row(_("Dimension").":", 'dimension_id',
455 null, true, ' ', false, 1, false);
457 hidden('dimension_id', 0);
459 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
460 null, true, ' ', false, 2, false);
462 hidden('dimension2_id', 0);
467 label_row($date_text, $order->document_date);
468 hidden('OrderDate', $order->document_date);
471 end_outer_table(1); // outer table
473 if ($change_prices != 0) {
474 foreach ($order->line_items as $line_no=>$item) {
475 $line = &$order->line_items[$line_no];
476 $line->price = get_kit_price($line->stock_id, $order->customer_currency,
477 $order->sales_type, $order->price_factor, get_post('OrderDate'));
478 // $line->discount_percent = $order->default_discount;
480 $Ajax->activate('items_table');
483 return $customer_error;
486 //--------------------------------------------------------------------------------
488 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
492 alt_table_row_color($rowcounter);
494 $id = find_submit('Edit');
495 if ($line_no!=-1 && $line_no == $id) // edit old line
497 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
498 $dec = get_qty_dec($_POST['stock_id']);
499 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
500 $_POST['price'] = price_format($order->line_items[$id]->price);
501 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
502 $units = $order->line_items[$id]->units;
503 $_POST['item_description'] = $order->line_items[$id]->item_description;
504 hidden('stock_id', $_POST['stock_id']);
505 label_cell($_POST['stock_id']);
506 if ($order->line_items[$id]->descr_editable)
507 text_cells(null,'item_description', null, 45, 150);
509 hidden('item_description', $_POST['item_description']);
510 label_cell($_POST['item_description']);
513 // sales_items_list_cells(null,'item_description', null, false, true);
515 //label_cell($order->line_items[$line_no]->item_description, "nowrap");
516 $Ajax->activate('items_table');
518 else // prepare new line
520 sales_items_list_cells(null,'stock_id', null, false, true);
521 if (list_updated('stock_id')) {
522 $Ajax->activate('price');
523 $Ajax->activate('units');
524 $Ajax->activate('qty');
525 $Ajax->activate('line_total');
528 $item_info = get_item_edit_info($_POST['stock_id']);
529 $units = $item_info["units"];
530 $dec = $item_info['decimals'];
531 $_POST['qty'] = number_format2(1, $dec);
532 $price = get_kit_price($_POST['stock_id'],
533 $order->customer_currency, $order->sales_type,
534 $order->price_factor, get_post('OrderDate'));
535 $_POST['price'] = price_format($price);
536 // default to the customer's discount %
537 $_POST['Disc'] = percent_format($order->default_discount * 100);
540 qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
542 if ($order->trans_no!=0) {
543 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
546 label_cell($units, '', 'units');
548 amount_cells(null, 'price');
550 small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
552 $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
554 amount_cell($line_total, false, '','line_total');
558 button_cell('UpdateItem', _("Update"),
559 _('Confirm changes'), ICON_UPDATE);
560 button_cell('CancelItemChanges', _("Cancel"),
561 _('Cancel changes'), ICON_CANCEL);
562 hidden('LineNo', $line_no);
567 submit_cells('AddItem', _("Add Item"), "colspan=2 align='center'",
568 _('Add new item to document'), true);
574 //--------------------------------------------------------------------------------
576 function display_delivery_details(&$order)
580 div_start('delivery');
583 if ($order->payment_terms['cash_sale']) { // Direct payment sale
584 $Ajax->activate('items_table');
585 display_heading(_('Cash payment'));
586 start_table(TABLESTYLE2, "width=60%");
588 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true);
589 label_row(_("Cash account:"), $order->account_name);
590 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
593 if ($order->trans_type==ST_SALESINVOICE)
595 $title = _("Delivery Details");
596 $delname = _("Due Date").':';
598 elseif ($order->trans_type==ST_CUSTDELIVERY)
600 $title = _("Invoice Delivery Details");
601 $delname = _("Invoice before").':';
603 elseif ($order->trans_type==ST_SALESQUOTE)
605 $title = _("Quotation Delivery Details");
606 $delname = _("Valid until").':';
610 $title = _("Order Delivery Details");
611 $delname = _("Required Delivery Date").':';
613 display_heading($title);
614 start_outer_table(TABLESTYLE2, "width=90%");
617 locations_list_row(_("Deliver from Location:"), 'Location', null, false, true);
618 if (list_updated('Location'))
619 $Ajax->activate('items_table');
622 date_row($delname, 'delivery_date',
623 $order->trans_type==ST_SALESORDER ? _('Enter requested day of delivery')
624 : $order->trans_type==ST_SALESQUOTE ? _('Enter Valid until Date') : '');
625 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 40, 40,
626 _('Additional identifier for delivery e.g. name of receiving person'));
628 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
629 _('Delivery address. Default is address of customer branch'));
633 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
634 _('Phone number of ordering person. Defaults to branch phone number'));
635 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
636 _('Customer reference number for this order (if any)'));
637 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
639 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);