sales/includes/ui/sales_order_ui.inc

   1 <?php
   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");
  14
  15 //--------------------------------------------------------------------------------
  16 function add_to_order(&$order, $new_item, $new_item_qty, $price, $discount)
  17 {
  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);
  22
  23         if ($std_price == 0)
  24                 $price_factor = 0;
  25         else
  26                 $price_factor = $price/$std_price;
  27
  28         $kit = get_item_kit($new_item);
  29         $item_num = db_num_rows($kit);
  30
  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);
  34
  35                 // rounding differences are included in last price item in kit
  36                 $item_num--;
  37                 if ($item_num) {
  38                         $price -= $item['quantity']*$std_price*$price_factor;
  39                         $item_price = $std_price*$price_factor;
  40                 } else {
  41                         if ($item['quantity'])
  42                                 $price = $price/$item['quantity'];
  43                         $item_price = $price;
  44                 }
  45                 $item_price = round($item_price, user_price_dec());
  46
  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, $std_price);
  51          }
  52          else
  53          {      // stock item record eventually with foreign code
  54
  55                 // check duplicate stock item
  56                 foreach ($order->line_items as $order_item)
  57                 {
  58                         if (strcasecmp($order_item->stock_id, $item['stock_id']) == 0)
  59                         {
  60                                 display_warning(_("For Part :").$item['stock_id']. " "
  61                                         . _("This item is already on this order. You have been warned."));
  62                                 break;
  63                         }
  64                 }
  65                 $order->add_to_cart (count($order->line_items), $item['stock_id'],
  66                         $new_item_qty*$item['quantity'], $item_price, $discount);
  67          }
  68         }
  69 }
  70 //---------------------------------------------------------------------------------
  71
  72 function get_customer_details_to_order(&$order, $customer_id, $branch_id)
  73 {
  74         $ret_error = "";
  75
  76         $myrow = get_customer_to_order($customer_id);
  77
  78         $name = $myrow['name'];
  79
  80         if ($myrow['dissallow_invoices'] == 1)
  81                 $ret_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
  82
  83         $deliver = $myrow['address']; // in case no branch address use company address
  84
  85         $order->set_customer($customer_id, $name, $myrow['curr_code'],
  86                 $myrow['discount'], $myrow['pymt_discount']);
  87
  88         // the sales type determines the price list to be used by default
  89         $order->set_sales_type($myrow['salestype'], $myrow['sales_type'], $myrow['tax_included'],
  90             $myrow['factor']);
  91
  92         if ($order->trans_type != 30)
  93         {
  94                 $order->dimension_id = $myrow['dimension_id'];
  95                 $order->dimension2_id = $myrow['dimension2_id'];
  96         }
  97         $result = get_branch_to_order($customer_id, $branch_id);
  98
  99         if (db_num_rows($result) == 0)
 100         {
 101                 return _("The selected customer and branch are not valid, or the customer does not have any branches.");
 102         }
 103
 104         $myrow = db_fetch($result);
 105
 106         $order->set_branch($branch_id, $myrow["tax_group_id"],
 107         $myrow["tax_group_name"], $myrow["phone"], $myrow["email"]);
 108
 109         $address = trim($myrow["br_post_address"]) != '' ? $myrow["br_post_address"]
 110                 : (trim($myrow["br_address"]) != '' ? $myrow["br_address"]:$deliver);
 111
 112         $order->set_delivery($myrow["default_ship_via"], $myrow["br_name"],
 113                 $address);
 114         if ($order->trans_type == 10) {
 115                 $order->due_date = get_invoice_duedate($customer_id, $order->document_date);
 116                 if ($order->pos != -1)
 117                         $order->cash = date_diff($order->due_date, Today(), 'd')<2;
 118         }
 119         if($order->cash ) {
 120                 if($order->pos != -1) {
 121                 $paym = get_sales_point($order->pos);
 122                 $order->set_location($paym["pos_location"], $paym["location_name"]);
 123                 }
 124         } else
 125                 $order->set_location($myrow["default_location"], $myrow["location_name"]);
 126
 127         return $ret_error;
 128 }
 129
 130 //---------------------------------------------------------------------------------
 131
 132 function display_order_summary($title, &$order, $editable_items=false)
 133 {
 134         global $table_style, $path_to_root;
 135
 136         display_heading($title);
 137
 138     div_start('items_table');
 139         start_table("$table_style colspan=7 width=90%");
 140         $th = array(_("Item Code"), _("Item Description"), _("Quantity"),
 141                 _("Delivered"),
 142                 _("Unit"), _("Price"), _("Discount %"), _("Total"), "");
 143
 144         if ($order->trans_no == 0) {
 145         unset( $th[3] );
 146         }
 147
 148         if (count($order->line_items))
 149              $th[]= '';
 150
 151         table_header($th);
 152
 153         $total = 0;
 154         $k = 0;  //row colour counter
 155
 156         $id = find_submit('Edit');
 157         foreach ($order->line_items as $line_no=>$stock_item)
 158         {
 159
 160                 $line_total = round($stock_item->qty_dispatched * $stock_item->price * (1 - $stock_item->discount_percent),
 161                    user_price_dec());
 162
 163
 164                 if (!$editable_items || $id != $line_no)
 165                 {
 166                         alt_table_row_color($k);
 167
 168                         view_stock_status_cell($stock_item->stock_id);
 169
 170                         //label_cell($stock_item->item_description, "nowrap" );
 171                         label_cell($stock_item->item_description );
 172                         qty_cell($stock_item->qty_dispatched, false, get_qty_dec($stock_item->stock_id));
 173
 174                         if ($order->trans_no!=0)
 175                                 amount_cell($stock_item->qty_done);
 176
 177                         label_cell($stock_item->units);
 178                         amount_cell($stock_item->price);
 179
 180                         percent_cell($stock_item->discount_percent * 100);
 181                         amount_cell($line_total);
 182
 183                         if ($editable_items)
 184                         {
 185                                 edit_button_cell("Edit$line_no", _("Edit"),
 186                                 _('Edit document line'));
 187                                 delete_button_cell("Delete$line_no", _("Delete"),
 188                                 _('Remove line from document'));
 189                         }
 190                         end_row();
 191                 }
 192                 else
 193                 {
 194                         sales_order_item_controls($order, $k,  $line_no);
 195                 }
 196
 197                 $total += $line_total;
 198         }
 199
 200         if ($id==-1 && $editable_items)
 201                 sales_order_item_controls($order, $k);
 202
 203         $display_total = price_format($total);
 204         label_row(_("Total Excluding Shipping"), $display_total, "colspan=6 align=right",
 205                 "nowrap align=right", 2);
 206
 207         end_table();
 208     div_end();
 209 }
 210
 211 // ------------------------------------------------------------------------------
 212
 213 function display_order_header(&$order, $editable, $date_text, $display_tax_group=false)
 214 {
 215         global $table_style, $Ajax;
 216
 217         start_outer_table("width=80% $table_style");
 218
 219         table_section(1);
 220
 221         $customer_error = "";
 222         $change_prices = 0;
 223
 224         if (isset($order) && !$editable)
 225         {
 226                 // can't change the customer/branch if items already received on this order
 227                 echo $order->customer_name . " - " . $order->deliver_to;
 228                 hidden('customer_id', $order->customer_id);
 229                 hidden('branch_id', $order->Branch);
 230                 hidden('sales_type', $order->sales_type);
 231                 if ($order->trans_type != 30) {
 232                         hidden('dimension_id', $order->dimension_id); // 2008-11-12 Joe Hunt
 233                         hidden('dimension2_id', $order->dimension2_id);
 234                 }
 235         }
 236         else
 237         {
 238                 customer_list_row(_("Customer:"), 'customer_id', null, false, true);
 239
 240                 if ($order->customer_id != get_post('customer_id', -1))
 241                 {
 242                         // customer has changed
 243                         $Ajax->activate('branch_id');
 244                 }
 245                 customer_branches_list_row(_("Branch:"),
 246                   $_POST['customer_id'], 'branch_id', null, false, true, true);
 247
 248                 if( ($order->customer_id != get_post('customer_id', -1)) ||
 249                         ($order->Branch != get_post('branch_id', -1)) ||
 250                         list_updated('customer_id'))
 251                 {
 252
 253                         if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
 254                         {
 255                                 // ignore errors on customer search box call
 256                                 if ($_POST['customer_id'] == '')
 257                                         $customer_error = _("No customer found for entered text.");
 258                                 else
 259                                         $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
 260                                 unset($_POST['branch_id']);
 261                                 $order->Branch = 0;
 262                         }
 263                         else
 264                         {
 265
 266                                 $old_order = (PHP_VERSION<5) ? $order : clone( $order );
 267
 268                                 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
 269                                 $_POST['Location'] = $order->Location;
 270                                 $_POST['deliver_to'] = $order->deliver_to;
 271                                 $_POST['delivery_address'] = $order->delivery_address;
 272                                 $_POST['phone'] = $order->phone;
 273                                 if (get_post('cash') !== $order->cash) {
 274                                         $_POST['cash'] = $order->cash;
 275                                         $Ajax->activate('delivery');
 276                                         $Ajax->activate('cash');
 277                                 } else {
 278                                         if ($order->trans_type == 10)
 279                                         {
 280                                                 $_POST['delivery_date'] = $order->due_date;
 281                                                 $Ajax->activate('delivery_date');
 282                                         }
 283                                         $Ajax->activate('Location');
 284                                         $Ajax->activate('deliver_to');
 285                                         $Ajax->activate('phone');
 286                                         $Ajax->activate('delivery_address');
 287                                 }
 288                                 // change prices if necessary
 289                                 // what about discount in template case?
 290                                 if ($old_order->customer_currency != $order->customer_currency) {
 291                                         $change_prices = 1;
 292                                 }
 293                                 if ($old_order->sales_type != $order->sales_type) {
 294                                 //  || $old_order->default_discount!=$order->default_discount
 295                                         $_POST['sales_type'] = $order->sales_type;
 296                                         $Ajax->activate('sales_type');
 297                                         $change_prices = 1;
 298                                 }
 299                                 if ($old_order->dimension_id != $order->dimension_id) {
 300                                         $_POST['dimension_id'] = $order->dimension_id;
 301                                     $Ajax->activate('dimension_id');
 302                                 }
 303                                 if ($old_order->dimension2_id != $order->dimension2_id) {
 304                                         $_POST['dimension2_id'] = $order->dimension2_id;
 305                                     $Ajax->activate('dimension2_id');
 306                                 }
 307                                 unset($old_order);
 308                         }
 309                         set_global_customer($_POST['customer_id']);
 310                 } // changed branch
 311                 else
 312                 {
 313                         $row = get_customer_to_order($_POST['customer_id']);
 314                         if ($row['dissallow_invoices'] == 1)
 315                                 $customer_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
 316
 317                 }
 318         }
 319
 320         if ($order->trans_type != 30) {
 321                 ref_cells(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '');
 322         }
 323
 324         if (!is_company_currency($order->customer_currency))
 325         {
 326             table_section(2);
 327
 328             div_start('currency');
 329                 label_row(_("Customer Currency:"), $order->customer_currency);
 330                 exchange_rate_display($order->customer_currency, get_company_currency(),
 331                         ($editable ? $_POST['OrderDate'] : $order->document_date));
 332             div_end();
 333         }
 334         table_section(3);
 335
 336         if ($order->trans_type == 10 && $order->pos != -1) {
 337                 sale_payment_list_cells(_('Payment:'), 'cash', null, true);
 338                 $cash_payment = get_post('cash', 0);
 339                 // current user can issue both credit and cash invoices
 340                 if ($order->cash != $cash_payment) {
 341                         $order->cash = $cash_payment;
 342                         if ($cash_payment) {
 343                                 $paym = get_sales_point(user_pos());
 344                                 $order->cash_account = $paym['pos_account'];
 345                                 $order->account_name = $paym['bank_account_name'];
 346                                 $_POST['Location'] = $order->Location = $paym['pos_location'];
 347                                 $order->location_name = $paym['location_name'];
 348                         }
 349                         check_qoh($order);
 350                         $Ajax->activate('delivery');
 351                         set_focus($order->pos == -1 ? 'delivery_date' : 'account');
 352                 }
 353         } else
 354                 hidden('cash', $order->cash);
 355
 356         if($editable) {
 357                 $str = sales_types_list_row(_("Price List"), 'sales_type', null, true);
 358         } else {
 359                 label_row(_("Price List:"), $order->sales_type_name);
 360         }
 361         if ($order->sales_type != $_POST['sales_type']) {
 362                 $myrow = get_sales_type($_POST['sales_type']);
 363                 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
 364                         $myrow['tax_included'], $myrow['factor']);
 365                 $Ajax->activate('sales_type');
 366                 $change_prices = 1;
 367         }
 368
 369         label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
 370
 371         table_section(4);
 372
 373         if ($editable)
 374         {
 375                 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
 376                         $_POST['OrderDate'] = $order->document_date;
 377
 378                 date_row($date_text, 'OrderDate',
 379                   _('Date of order receive'), null, 0, 0, 0, null, true);
 380                 if (isset($_POST['_OrderDate_changed'])) {
 381                         if (!is_company_currency($order->customer_currency)
 382                                 && (get_base_sales_type()>0)) {
 383                                         $change_prices = 1;
 384                         }
 385                         $Ajax->activate('currency');
 386                         if ($order->trans_type == 10) {
 387                                 $_POST['delivery_date'] = get_invoice_duedate(get_post('customer_id'), get_post('OrderDate'));
 388                         } else
 389                                 $_POST['delivery_date'] = add_days(get_post('OrderDate'), sys_prefs::default_delivery_required_by());
 390                         $Ajax->activate('delivery_date');
 391                 }
 392                 if ($order->trans_type != 30)
 393                 {       // 2008-11-12 Joe Hunt added dimensions
 394                         $dim = get_company_pref('use_dimension');
 395                         if ($dim > 0)
 396                                 dimensions_list_row(_("Dimension").":", 'dimension_id',
 397                                         null, true, ' ', false, 1, false);
 398                         else
 399                                 hidden('dimension_id', 0);
 400                         if ($dim > 1)
 401                                 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
 402                                         null, true, ' ', false, 2, false);
 403                         else
 404                                 hidden('dimension2_id', 0);
 405                 }
 406         }
 407         else
 408         {
 409                 label_row($date_text, $order->document_date);
 410                 hidden('OrderDate', $order->document_date);
 411         }
 412
 413         if ($display_tax_group)
 414         {
 415             label_row(_("Tax Group:"), $order->tax_group_name);
 416             hidden('tax_group_id', $order->tax_group_id);
 417         }
 418
 419         end_outer_table(1); // outer table
 420
 421         if ($change_prices != 0) {
 422                 foreach ($order->line_items as $line_no=>$item) {
 423                         $line = &$order->line_items[$line_no];
 424                         $line->price = get_kit_price($line->stock_id, $order->customer_currency,
 425                                 $order->sales_type, $order->price_factor, get_post('OrderDate'));
 426                 //              $line->discount_percent = $order->default_discount;
 427                 }
 428             $Ajax->activate('items_table');
 429         }
 430
 431         return $customer_error;
 432 }
 433
 434 //--------------------------------------------------------------------------------
 435
 436 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
 437 {
 438     global $Ajax;
 439
 440         alt_table_row_color($rowcounter);
 441
 442         $id = find_submit('Edit');
 443         if ($line_no!=-1 && $line_no == $id) // edit old line
 444         {
 445                 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
 446                 $dec = get_qty_dec($_POST['stock_id']);
 447                 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
 448                 $_POST['price'] = price_format($order->line_items[$id]->price);
 449                 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
 450                 $_POST['item_description'] = $order->line_items[$id]->item_description;
 451                 $units = $order->line_items[$id]->units;
 452                 hidden('stock_id', $_POST['stock_id']);
 453                 label_cell($_POST['stock_id']);
 454                 text_cells(null,'item_description', null, 45, 150);
 455                 //label_cell($order->line_items[$line_no]->item_description, "nowrap");
 456             $Ajax->activate('items_table');
 457         }
 458         else    // prepare new line
 459         {
 460                 sales_items_list_cells(null,'stock_id', null, false, true);
 461                 if (list_updated('stock_id')) {
 462                             $Ajax->activate('price');
 463                             $Ajax->activate('units');
 464                             $Ajax->activate('qty');
 465                             $Ajax->activate('line_total');
 466                 }
 467
 468                 $item_info = get_item_edit_info($_POST['stock_id']);
 469                 $units = $item_info["units"];
 470                 $dec = $item_info['decimals'];
 471                 $_POST['qty'] = number_format2(1, $dec);
 472                 $price = get_kit_price($_POST['stock_id'],
 473                         $order->customer_currency, $order->sales_type,
 474                         $order->price_factor, get_post('OrderDate'));
 475                 $_POST['price'] = price_format($price);
 476                 // default to the customer's discount %
 477                 $_POST['Disc'] = percent_format($order->default_discount * 100);
 478         }
 479
 480         qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
 481
 482         if ($order->trans_no!=0) {
 483                 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
 484         }
 485
 486         label_cell($units, '', 'units');
 487
 488         $str = amount_cells(null, 'price');
 489
 490         small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
 491
 492         $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
 493
 494         amount_cell($line_total, false, '','line_total');
 495
 496         if ($id!=-1)
 497         {
 498                 button_cell('UpdateItem', _("Update"),
 499                                 _('Confirm changes'), ICON_UPDATE);
 500                 button_cell('CancelItemChanges', _("Cancel"),
 501                                 _('Cancel changes'), ICON_CANCEL);
 502                 hidden('LineNo', $line_no);
 503                 set_focus('qty');
 504         }
 505         else
 506         {
 507                 submit_cells('AddItem', _("Add Item"), "colspan=2",
 508                     _('Add new item to document'), true);
 509         }
 510
 511         end_row();
 512 }
 513
 514 //--------------------------------------------------------------------------------
 515
 516 function display_delivery_details(&$order)
 517 {
 518         global $table_style2, $Ajax;
 519
 520         div_start('delivery');
 521
 522         if (get_post('cash', 0)) {      // Direct payment sale
 523                 display_heading(_('Cash payment'));
 524                 start_table("$table_style2 width=60%");
 525                 label_row(_("Deliver from Location:"), $order->location_name);
 526
 527                 hidden('Location', $order->Location);
 528                 label_row(_("Cash account:"), $order->account_name);
 529                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 530                 end_table();
 531         } else {
 532
 533                 if ($order->trans_type==10)
 534                 {
 535                         $title = _("Delivery Details");
 536                         $delname = _("Due Date").':';
 537                 }
 538                 elseif ($order->trans_type==13)
 539                 {
 540                         $title = _("Invoice Delivery Details");
 541                         $delname = _("Invoice before").':';
 542                 }
 543                 else
 544                 {
 545                         $title = _("Order Delivery Details");
 546                         $delname = _("Required Delivery Date").':';
 547                 }
 548                 display_heading($title);
 549                 start_outer_table("$table_style2 width=90%");
 550                 table_section(1);
 551
 552                 locations_list_row(_("Deliver from Location:"), 'Location', null,
 553                         false, true);
 554                 if (list_updated('Location'))
 555                         check_qoh($order);
 556
 557                 date_row($delname, 'delivery_date',
 558                         $order->trans_type==30 ?  _('Enter requested day of delivery') : '',
 559                         $order->due_date, 0, 0, 0);
 560                 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 40, 40,
 561                         _('Additional identifier for delivery e.g. name of receiving person'));
 562
 563                 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
 564                         _('Delivery address. Default is address of customer branch'));
 565                 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
 566                     _('Phone number of ordering person. Defaults to branch phone number'));
 567
 568                 table_section(2);
 569
 570                 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
 571                   _('Customer reference number for this order (if any)'));
 572                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 573
 574                 small_amount_row(_("Shipping Charge:"), 'freight_cost',
 575                 price_format(get_post('freight_cost',0)));
 576
 577                 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);
 578
 579                 end_outer_table(1);
 580         }
 581         div_end();
 582 }
 583
 584 function check_qoh($order)
 585 {
 586         $msg = '';
 587         foreach($order->line_items as $line_no => $line) {
 588                 if (!is_inventory_item($line['stock_id'])) continue;
 589                 $qoh = get_qoh_on_date($line->stock_id, $_POST['Location'], $_POST['OrderDate']);
 590                 if ($line->qty_dispatched > $qoh)       {
 591                         $msg .= $line->stock_id . " - " . $line->item_description . ": " .
 592                                 _("Quantity On Hand") . " = "
 593                                 . number_format2($qoh, get_qty_dec($line->stock_id)) . '<br>';
 594                 }
 595         }
 596         if (strlen($msg)) {
 597                 display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:")
 598                         . '<br>'. $msg);
 599                 return false;
 600         }
 601         return true;
 602 }
 603 ?>