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         $has_marked = false;
 158         foreach ($order->line_items as $line_no=>$stock_item)
 159         {
 160
 161                 $line_total = round($stock_item->qty_dispatched * $stock_item->price * (1 - $stock_item->discount_percent),
 162                    user_price_dec());
 163
 164                 $qoh_msg = '';
 165                 if (!$editable_items || $id != $line_no)
 166                 {
 167                         if (is_inventory_item($stock_item->stock_id)) {
 168                                 $qoh = get_qoh_on_date($stock_item->stock_id,
 169                                         $_POST['Location'], $_POST['OrderDate']);
 170                          if ($stock_item->qty_dispatched > $qoh)
 171                          {
 172                                 // oops, we don't have enough of one of the component items
 173                                 start_row("class='stockmankobg'");
 174                                 $qoh_msg .= $stock_item->stock_id . " - " . $stock_item->item_description . ": " .
 175                                 _("Quantity On Hand") . " = "
 176                                 . number_format2($qoh, get_qty_dec($stock_item->stock_id)) . '<br>';
 177                                 $has_marked = true;
 178                          } else
 179                                 alt_table_row_color($k);
 180                         } else {
 181                                 alt_table_row_color($k);
 182                         }
 183
 184                         view_stock_status_cell($stock_item->stock_id);
 185
 186                         //label_cell($stock_item->item_description, "nowrap" );
 187                         label_cell($stock_item->item_description );
 188                         qty_cell($stock_item->qty_dispatched, false, get_qty_dec($stock_item->stock_id));
 189
 190                         if ($order->trans_no!=0)
 191                                 amount_cell($stock_item->qty_done);
 192
 193                         label_cell($stock_item->units);
 194                         amount_cell($stock_item->price);
 195
 196                         percent_cell($stock_item->discount_percent * 100);
 197                         amount_cell($line_total);
 198
 199                         if ($editable_items)
 200                         {
 201                                 edit_button_cell("Edit$line_no", _("Edit"),
 202                                 _('Edit document line'));
 203                                 delete_button_cell("Delete$line_no", _("Delete"),
 204                                 _('Remove line from document'));
 205                         }
 206                         end_row();
 207                 }
 208                 else
 209                 {
 210                         sales_order_item_controls($order, $k,  $line_no);
 211                 }
 212
 213                 $total += $line_total;
 214         }
 215
 216         if ($id==-1 && $editable_items)
 217                 sales_order_item_controls($order, $k);
 218
 219         $display_total = price_format($total);
 220         label_row(_("Total Excluding Shipping"), $display_total, "colspan=6 align=right",
 221                 "nowrap align=right", 2);
 222
 223         end_table();
 224         if ($has_marked) {
 225                 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
 226                 if ($order->trans_type!=30 && !sys_prefs::allow_negative_stock())
 227                         display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:")
 228                                 . '<br>'. $qoh_msg);
 229         }
 230     div_end();
 231 }
 232
 233 // ------------------------------------------------------------------------------
 234
 235 function display_order_header(&$order, $editable, $date_text, $display_tax_group=false)
 236 {
 237         global $table_style, $Ajax;
 238
 239         start_outer_table("width=80% $table_style");
 240
 241         table_section(1);
 242
 243         $customer_error = "";
 244         $change_prices = 0;
 245
 246         if (isset($order) && !$editable)
 247         {
 248                 // can't change the customer/branch if items already received on this order
 249                 echo $order->customer_name . " - " . $order->deliver_to;
 250                 hidden('customer_id', $order->customer_id);
 251                 hidden('branch_id', $order->Branch);
 252                 hidden('sales_type', $order->sales_type);
 253                 if ($order->trans_type != 30) {
 254                         hidden('dimension_id', $order->dimension_id); // 2008-11-12 Joe Hunt
 255                         hidden('dimension2_id', $order->dimension2_id);
 256                 }
 257         }
 258         else
 259         {
 260                 customer_list_row(_("Customer:"), 'customer_id', null, false, true);
 261
 262                 if ($order->customer_id != get_post('customer_id', -1))
 263                 {
 264                         // customer has changed
 265                         $Ajax->activate('branch_id');
 266                 }
 267                 customer_branches_list_row(_("Branch:"),
 268                   $_POST['customer_id'], 'branch_id', null, false, true, true);
 269
 270                 if( ($order->customer_id != get_post('customer_id', -1)) ||
 271                         ($order->Branch != get_post('branch_id', -1)) ||
 272                         list_updated('customer_id'))
 273                 {
 274
 275                         if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
 276                         {
 277                                 // ignore errors on customer search box call
 278                                 if ($_POST['customer_id'] == '')
 279                                         $customer_error = _("No customer found for entered text.");
 280                                 else
 281                                         $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
 282                                 unset($_POST['branch_id']);
 283                                 $order->Branch = 0;
 284                         }
 285                         else
 286                         {
 287
 288                                 $old_order = (PHP_VERSION<5) ? $order : clone( $order );
 289
 290                                 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
 291                                 $_POST['Location'] = $order->Location;
 292                                 $_POST['deliver_to'] = $order->deliver_to;
 293                                 $_POST['delivery_address'] = $order->delivery_address;
 294                                 $_POST['phone'] = $order->phone;
 295                                 if (get_post('cash') !== $order->cash) {
 296                                         $_POST['cash'] = $order->cash;
 297                                         $Ajax->activate('delivery');
 298                                         $Ajax->activate('cash');
 299                                 } else {
 300                                         if ($order->trans_type == 10)
 301                                         {
 302                                                 $_POST['delivery_date'] = $order->due_date;
 303                                                 $Ajax->activate('delivery_date');
 304                                         }
 305                                         $Ajax->activate('Location');
 306                                         $Ajax->activate('deliver_to');
 307                                         $Ajax->activate('phone');
 308                                         $Ajax->activate('delivery_address');
 309                                 }
 310                                 // change prices if necessary
 311                                 // what about discount in template case?
 312                                 if ($old_order->customer_currency != $order->customer_currency) {
 313                                         $change_prices = 1;
 314                                 }
 315                                 if ($old_order->sales_type != $order->sales_type) {
 316                                 //  || $old_order->default_discount!=$order->default_discount
 317                                         $_POST['sales_type'] = $order->sales_type;
 318                                         $Ajax->activate('sales_type');
 319                                         $change_prices = 1;
 320                                 }
 321                                 if ($old_order->dimension_id != $order->dimension_id) {
 322                                         $_POST['dimension_id'] = $order->dimension_id;
 323                                     $Ajax->activate('dimension_id');
 324                                 }
 325                                 if ($old_order->dimension2_id != $order->dimension2_id) {
 326                                         $_POST['dimension2_id'] = $order->dimension2_id;
 327                                     $Ajax->activate('dimension2_id');
 328                                 }
 329                                 unset($old_order);
 330                         }
 331                         set_global_customer($_POST['customer_id']);
 332                 } // changed branch
 333                 else
 334                 {
 335                         $row = get_customer_to_order($_POST['customer_id']);
 336                         if ($row['dissallow_invoices'] == 1)
 337                                 $customer_error = _("The selected customer account is currently on hold. Please contact the credit control personnel to discuss.");
 338
 339                 }
 340         }
 341
 342         if ($order->trans_type != 30) {
 343                 ref_cells(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '');
 344         }
 345
 346         if (!is_company_currency($order->customer_currency))
 347         {
 348             table_section(2);
 349
 350                 label_row(_("Customer Currency:"), $order->customer_currency);
 351                 exchange_rate_display($order->customer_currency, get_company_currency(),
 352                         ($editable ? $_POST['OrderDate'] : $order->document_date));
 353         }
 354         table_section(3);
 355
 356         if ($order->trans_type == 10 && $order->pos != -1) {
 357                 sale_payment_list_cells(_('Payment:'), 'cash', null, true);
 358                 $cash_payment = get_post('cash', 0);
 359                 // current user can issue both credit and cash invoices
 360                 if ($order->cash != $cash_payment) {
 361                         $order->cash = $cash_payment;
 362                         if ($cash_payment) {
 363                                 $paym = get_sales_point(user_pos());
 364                                 $order->cash_account = $paym['pos_account'];
 365                                 $order->account_name = $paym['bank_account_name'];
 366                                 $_POST['Location'] = $order->Location = $paym['pos_location'];
 367                                 $order->location_name = $paym['location_name'];
 368                         }
 369                         $Ajax->activate('items_table');
 370                         $Ajax->activate('delivery');
 371                         set_focus($order->pos == -1 ? 'delivery_date' : 'account');
 372                 }
 373         } else
 374                 hidden('cash', $order->cash);
 375
 376         if($editable) {
 377                 $str = sales_types_list_row(_("Price List"), 'sales_type', null, true);
 378         } else {
 379                 label_row(_("Price List:"), $order->sales_type_name);
 380         }
 381         if ($order->sales_type != $_POST['sales_type']) {
 382                 $myrow = get_sales_type($_POST['sales_type']);
 383                 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
 384                         $myrow['tax_included'], $myrow['factor']);
 385                 $Ajax->activate('sales_type');
 386                 $change_prices = 1;
 387         }
 388
 389         label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
 390
 391         table_section(4);
 392
 393         if ($editable)
 394         {
 395                 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
 396                         $_POST['OrderDate'] = $order->document_date;
 397
 398                 date_row($date_text, 'OrderDate',
 399                   _('Date of order receive'), null, 0, 0, 0, null, true);
 400                 if (isset($_POST['_OrderDate_changed'])) {
 401                         if (!is_company_currency($order->customer_currency)
 402                                 && (get_base_sales_type()>0)) {
 403                                         $change_prices = 1;
 404                         }
 405                         $Ajax->activate('_ex_rate');
 406                         if ($order->trans_type == 10) {
 407                                 $_POST['delivery_date'] = get_invoice_duedate(get_post('customer_id'), get_post('OrderDate'));
 408                         } else
 409                                 $_POST['delivery_date'] = add_days(get_post('OrderDate'), sys_prefs::default_delivery_required_by());
 410                         $Ajax->activate('items_table');
 411                         $Ajax->activate('delivery_date');
 412                 }
 413                 if ($order->trans_type != 30)
 414                 {       // 2008-11-12 Joe Hunt added dimensions
 415                         $dim = get_company_pref('use_dimension');
 416                         if ($dim > 0)
 417                                 dimensions_list_row(_("Dimension").":", 'dimension_id',
 418                                         null, true, ' ', false, 1, false);
 419                         else
 420                                 hidden('dimension_id', 0);
 421                         if ($dim > 1)
 422                                 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
 423                                         null, true, ' ', false, 2, false);
 424                         else
 425                                 hidden('dimension2_id', 0);
 426                 }
 427         }
 428         else
 429         {
 430                 label_row($date_text, $order->document_date);
 431                 hidden('OrderDate', $order->document_date);
 432         }
 433
 434         if ($display_tax_group)
 435         {
 436             label_row(_("Tax Group:"), $order->tax_group_name);
 437             hidden('tax_group_id', $order->tax_group_id);
 438         }
 439
 440         end_outer_table(1); // outer table
 441
 442         if ($change_prices != 0) {
 443                 foreach ($order->line_items as $line_no=>$item) {
 444                         $line = &$order->line_items[$line_no];
 445                         $line->price = get_kit_price($line->stock_id, $order->customer_currency,
 446                                 $order->sales_type, $order->price_factor, get_post('OrderDate'));
 447                 //              $line->discount_percent = $order->default_discount;
 448                 }
 449             $Ajax->activate('items_table');
 450         }
 451
 452         return $customer_error;
 453 }
 454
 455 //--------------------------------------------------------------------------------
 456
 457 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
 458 {
 459     global $Ajax;
 460
 461         alt_table_row_color($rowcounter);
 462
 463         $id = find_submit('Edit');
 464         if ($line_no!=-1 && $line_no == $id) // edit old line
 465         {
 466                 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
 467                 $dec = get_qty_dec($_POST['stock_id']);
 468                 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
 469                 $_POST['price'] = price_format($order->line_items[$id]->price);
 470                 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
 471                 $_POST['item_description'] = $order->line_items[$id]->item_description;
 472                 $units = $order->line_items[$id]->units;
 473                 hidden('stock_id', $_POST['stock_id']);
 474                 label_cell($_POST['stock_id']);
 475                 text_cells(null,'item_description', null, 45, 150);
 476                 //label_cell($order->line_items[$line_no]->item_description, "nowrap");
 477             $Ajax->activate('items_table');
 478         }
 479         else    // prepare new line
 480         {
 481                 sales_items_list_cells(null,'stock_id', null, false, true);
 482                 if (list_updated('stock_id')) {
 483                             $Ajax->activate('price');
 484                             $Ajax->activate('units');
 485                             $Ajax->activate('qty');
 486                             $Ajax->activate('line_total');
 487                 }
 488
 489                 $item_info = get_item_edit_info($_POST['stock_id']);
 490                 $units = $item_info["units"];
 491                 $dec = $item_info['decimals'];
 492                 $_POST['qty'] = number_format2(1, $dec);
 493                 $price = get_kit_price($_POST['stock_id'],
 494                         $order->customer_currency, $order->sales_type,
 495                         $order->price_factor, get_post('OrderDate'));
 496                 $_POST['price'] = price_format($price);
 497                 // default to the customer's discount %
 498                 $_POST['Disc'] = percent_format($order->default_discount * 100);
 499         }
 500
 501         qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
 502
 503         if ($order->trans_no!=0) {
 504                 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
 505         }
 506
 507         label_cell($units, '', 'units');
 508
 509         $str = amount_cells(null, 'price');
 510
 511         small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
 512
 513         $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
 514
 515         amount_cell($line_total, false, '','line_total');
 516
 517         if ($id!=-1)
 518         {
 519                 button_cell('UpdateItem', _("Update"),
 520                                 _('Confirm changes'), ICON_UPDATE);
 521                 button_cell('CancelItemChanges', _("Cancel"),
 522                                 _('Cancel changes'), ICON_CANCEL);
 523                 hidden('LineNo', $line_no);
 524                 set_focus('qty');
 525         }
 526         else
 527         {
 528                 submit_cells('AddItem', _("Add Item"), "colspan=2",
 529                     _('Add new item to document'), true);
 530         }
 531
 532         end_row();
 533 }
 534
 535 //--------------------------------------------------------------------------------
 536
 537 function display_delivery_details(&$order)
 538 {
 539         global $table_style2, $Ajax;
 540
 541         div_start('delivery');
 542
 543         if (get_post('cash', 0)) {      // Direct payment sale
 544                 $Ajax->activate('items_table');
 545                 display_heading(_('Cash payment'));
 546                 start_table("$table_style2 width=60%");
 547                 label_row(_("Deliver from Location:"), $order->location_name);
 548
 549                 hidden('Location', $order->Location);
 550                 label_row(_("Cash account:"), $order->account_name);
 551                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 552                 end_table();
 553         } else {
 554
 555                 if ($order->trans_type==10)
 556                 {
 557                         $title = _("Delivery Details");
 558                         $delname = _("Due Date").':';
 559                 }
 560                 elseif ($order->trans_type==13)
 561                 {
 562                         $title = _("Invoice Delivery Details");
 563                         $delname = _("Invoice before").':';
 564                 }
 565                 else
 566                 {
 567                         $title = _("Order Delivery Details");
 568                         $delname = _("Required Delivery Date").':';
 569                 }
 570                 display_heading($title);
 571                 start_outer_table("$table_style2 width=90%");
 572                 table_section(1);
 573
 574                 locations_list_row(_("Deliver from Location:"), 'Location', null,
 575                         false, true);
 576                 if (list_updated('Location'))
 577                         $Ajax->activate('items_table');
 578
 579                 date_row($delname, 'delivery_date',
 580                         $order->trans_type==30 ?  _('Enter requested day of delivery') : '',
 581                         $order->due_date, 0, 0, 0);
 582                 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 40, 40,
 583                         _('Additional identifier for delivery e.g. name of receiving person'));
 584
 585                 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
 586                         _('Delivery address. Default is address of customer branch'));
 587                 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
 588                     _('Phone number of ordering person. Defaults to branch phone number'));
 589
 590                 table_section(2);
 591
 592                 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
 593                   _('Customer reference number for this order (if any)'));
 594                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 595
 596                 small_amount_row(_("Shipping Charge:"), 'freight_cost',
 597                 price_format(get_post('freight_cost',0)));
 598
 599                 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);
 600
 601                 end_outer_table(1);
 602         }
 603         div_end();
 604 }
 605
 606 ?>