sales/includes/ui/sales_order_ui.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU Affero General Public License,
   5         AGPL, as published by the Free Software Foundation, either version
   6         3 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/agpl-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_notification(_("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 delivery 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 = $myrow["br_post_address"];
 110
 111         if (strlen($address) <= 1)      // if branch has no address
 112                 $address = $deliver;    // set sales order address
 113         $order->set_delivery($myrow["default_ship_via"], $myrow["br_name"],
 114                 $address);
 115         if ($order->trans_type == 10) {
 116                 $order->due_date = get_invoice_duedate($customer_id, $order->document_date);
 117                 if ($order->pos != -1)
 118                         $order->cash = date_diff($order->due_date, Today(), 'd')<2;
 119         }
 120         if($order->cash ) {
 121                 if($order->pos != -1) {
 122                 $paym = get_sales_point($order->pos);
 123                 $order->set_location($paym["pos_location"], $paym["location_name"]);
 124                 }
 125         } else
 126                 $order->set_location($myrow["default_location"], $myrow["location_name"]);
 127
 128         return $ret_error;
 129 }
 130
 131 //---------------------------------------------------------------------------------
 132
 133 function display_order_summary($title, &$order, $editable_items=false)
 134 {
 135         global $table_style, $path_to_root;
 136
 137         display_heading($title);
 138
 139     div_start('items_table');
 140         start_table("$table_style colspan=7 width=90%");
 141         $th = array(_("Item Code"), _("Item Description"), _("Quantity"),
 142                 _("Delivered"),
 143                 _("Unit"), _("Price"), _("Discount %"), _("Total"), "");
 144
 145         if ($order->trans_no == 0) {
 146         unset( $th[3] );
 147         }
 148
 149         if (count($order->line_items))
 150              $th[]= '';
 151
 152         table_header($th);
 153
 154         $total = 0;
 155         $k = 0;  //row colour counter
 156
 157         $id = find_submit('Edit');
 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
 165                 if (!$editable_items || $id != $line_no)
 166                 {
 167                         alt_table_row_color($k);
 168
 169                         view_stock_status_cell($stock_item->stock_id);
 170
 171                         label_cell($stock_item->item_description, "nowrap" );
 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                 if (!isset($_POST['branch_id']) || $_POST['branch_id'] == "")
 253                 {
 254                         // ignore errors on customer search box call
 255                         if ($_POST['customer_id'] == '')
 256                             $customer_error = _("No customer found for entered text.");
 257                         else
 258                             $customer_error = _("The selected customer does not have any branches. Please create at least one branch.");
 259                     unset($_POST['branch_id']);
 260                     $order->Branch = 0;
 261                 } else
 262                 {
 263
 264                                 $old_order = (PHP_VERSION<5) ? $order : clone( $order );
 265                                 $customer_error = get_customer_details_to_order($order, $_POST['customer_id'], $_POST['branch_id']);
 266
 267                                 $_POST['Location'] = $order->Location;
 268                                 $_POST['deliver_to'] = $order->deliver_to;
 269                                 $_POST['delivery_address'] = $order->delivery_address;
 270                                 $_POST['phone'] = $order->phone;
 271                                 if (get_post('cash') !== $order->cash) {
 272                                         $_POST['cash'] = $order->cash;
 273                                         $Ajax->activate('delivery');
 274                                         $Ajax->activate('cash');
 275                                 } else {
 276                                         if ($order->trans_type == 10)
 277                                         {
 278                                                 $_POST['delivery_date'] = $order->due_date;
 279                                                 $Ajax->activate('delivery_date');
 280                                         }
 281                                         $Ajax->activate('Location');
 282                                         $Ajax->activate('deliver_to');
 283                                         $Ajax->activate('phone');
 284                                         $Ajax->activate('delivery_address');
 285                                 }
 286                                 // change prices if necessary
 287                                 // what about discount in template case?
 288                                 if ($old_order->customer_currency != $order->customer_currency) {
 289                                     $change_prices = 1;
 290                                 }
 291                                 if ($old_order->sales_type != $order->sales_type) {
 292                                 //  || $old_order->default_discount!=$order->default_discount
 293                                         $_POST['sales_type'] = $order->sales_type;
 294                                     $Ajax->activate('sales_type');
 295                                     $change_prices = 1;
 296                                 }
 297                                 if ($old_order->dimension_id != $order->dimension_id) {
 298                                         $_POST['dimension_id'] = $order->dimension_id;
 299                                     $Ajax->activate('dimension_id');
 300                                 }
 301                                 if ($old_order->dimension2_id != $order->dimension2_id) {
 302                                         $_POST['dimension2_id'] = $order->dimension2_id;
 303                                     $Ajax->activate('dimension2_id');
 304                                 }
 305                                 unset($old_order);
 306                         }
 307                 set_global_customer($_POST['customer_id']);
 308                 } // changed branch
 309         }
 310
 311         if ($_SESSION['Items']->trans_type!=30) {
 312                 ref_cells(_("Reference").':', 'ref', _('Reference number unique for this document type'), null, '');
 313         }
 314
 315         if (!is_company_currency($order->customer_currency))
 316         {
 317             table_section(2);
 318
 319             div_start('currency');
 320                 label_row(_("Customer Currency:"), $order->customer_currency);
 321                 exchange_rate_display($order->customer_currency, get_company_currency(),
 322                         ($editable ? $_POST['OrderDate'] : $order->document_date));
 323             div_end();
 324         }
 325         table_section(3);
 326
 327         if ($order->trans_type == 10 && $order->pos != -1) {
 328                 sale_payment_list_cells(_('Payment:'), 'cash', null, true);
 329                 $cash_payment = get_post('cash', 0);
 330                 // current user can issue both credit and cash invoices
 331                 if ($order->cash != $cash_payment) {
 332                         $order->cash = $cash_payment;
 333                         if ($cash_payment) {
 334                                 $paym = get_sales_point(user_pos());
 335                                 $order->cash_account = $paym['pos_account'];
 336                                 $order->account_name = $paym['bank_account_name'];
 337                                 $_POST['Location'] = $order->Location = $paym['pos_location'];
 338                                 $order->location_name = $paym['location_name'];
 339                         }
 340                         check_qoh($order);
 341                         $Ajax->activate('delivery');
 342                         set_focus($order->pos == -1 ? 'delivery_date' : 'account');
 343                 }
 344         } else
 345                 hidden('cash', $order->cash);
 346
 347         if($editable) {
 348                 $str = sales_types_list_row(_("Price List"), 'sales_type', null, true);
 349         } else {
 350                 label_row(_("Price List:"), $order->sales_type_name);
 351         }
 352         if ($order->sales_type != $_POST['sales_type']) {
 353                 $myrow = get_sales_type($_POST['sales_type']);
 354                 $order->set_sales_type($myrow['id'], $myrow['sales_type'],
 355                         $myrow['tax_included'], $myrow['factor']);
 356                 $Ajax->activate('sales_type');
 357                 $change_prices = 1;
 358         }
 359
 360         label_row(_("Customer Discount:"), ($order->default_discount * 100) . "%");
 361
 362         table_section(4);
 363
 364         if ($editable)
 365         {
 366                 if (!isset($_POST['OrderDate']) || $_POST['OrderDate'] == "")
 367                         $_POST['OrderDate'] = $order->document_date;
 368
 369                 date_row($date_text, 'OrderDate',
 370                   _('Date of order receive'), null, 0, 0, 0, null, true);
 371                 if (isset($_POST['_OrderDate_changed'])) {
 372                         $change_prices = 1;
 373                         $Ajax->activate('currency');
 374                         if ($order->trans_type == 10) {
 375                                 $_POST['delivery_date'] = get_invoice_duedate(get_post('customer_id'), get_post('OrderDate'));
 376                         } else
 377                                 $_POST['delivery_date'] = add_days(get_post('OrderDate'), sys_prefs::default_delivery_required_by());
 378                         $Ajax->activate('delivery_date');
 379                 }
 380                 if ($order->trans_type != 30)
 381                 {       // 2008-11-12 Joe Hunt added dimensions
 382                         $dim = get_company_pref('use_dimension');
 383                         if ($dim > 0)
 384                                 dimensions_list_row(_("Dimension").":", 'dimension_id',
 385                                         null, true, ' ', false, 1, false);
 386                         else
 387                                 hidden('dimension_id', 0);
 388                         if ($dim > 1)
 389                                 dimensions_list_row(_("Dimension")." 2:", 'dimension2_id',
 390                                         null, true, ' ', false, 2, false);
 391                         else
 392                                 hidden('dimension2_id', 0);
 393                 }
 394         }
 395         else
 396         {
 397                 label_row($date_text, $order->document_date);
 398                 hidden('OrderDate', $order->document_date);
 399         }
 400
 401         if ($display_tax_group)
 402         {
 403             label_row(_("Tax Group:"), $order->tax_group_name);
 404             hidden('tax_group_id', $_SESSION['Items']->tax_group_id);
 405         }
 406
 407         end_outer_table(1); // outer table
 408
 409         if ($change_prices != 0) {
 410                 foreach ($order->line_items as $line_no=>$item) {
 411                         $line = &$order->line_items[$line_no];
 412                         $line->price = get_kit_price($line->stock_id, $order->customer_currency,
 413                                 $order->sales_type, $order->price_factor, get_post('OrderDate'));
 414                 //              $line->discount_percent = $order->default_discount;
 415                 }
 416             $Ajax->activate('items_table');
 417         }
 418
 419         return $customer_error;
 420 }
 421
 422 //--------------------------------------------------------------------------------
 423
 424 function sales_order_item_controls(&$order, &$rowcounter, $line_no=-1)
 425 {
 426     global $Ajax;
 427
 428         alt_table_row_color($rowcounter);
 429
 430         $id = find_submit('Edit');
 431         if ($line_no!=-1 && $line_no == $id) // edit old line
 432         {
 433                 $_POST['stock_id'] = $order->line_items[$id]->stock_id;
 434                 $dec = get_qty_dec($_POST['stock_id']);
 435                 $_POST['qty'] = number_format2($order->line_items[$id]->qty_dispatched, $dec);
 436                 $_POST['price'] = price_format($order->line_items[$id]->price);
 437                 $_POST['Disc'] = percent_format($order->line_items[$id]->discount_percent*100);
 438                 $units = $order->line_items[$id]->units;
 439                 hidden('stock_id', $_POST['stock_id']);
 440                 label_cell($_POST['stock_id']);
 441                 label_cell($order->line_items[$line_no]->item_description, "nowrap");
 442             $Ajax->activate('items_table');
 443         }
 444         else    // prepare new line
 445         {
 446                 sales_items_list_cells(null,'stock_id', null, false, true);
 447                 if (list_updated('stock_id')) {
 448                             $Ajax->activate('price');
 449                             $Ajax->activate('units');
 450                             $Ajax->activate('qty');
 451                             $Ajax->activate('line_total');
 452                 }
 453
 454                 $item_info = get_item_edit_info($_POST['stock_id']);
 455                 $units = $item_info["units"];
 456                 $dec = $item_info['decimals'];
 457                 $_POST['qty'] = number_format2(1, $dec);
 458                 $price = get_kit_price($_POST['stock_id'],
 459                         $order->customer_currency, $order->sales_type,
 460                         $order->price_factor, get_post('OrderDate'));
 461                 $_POST['price'] = price_format($price);
 462                 // default to the customer's discount %
 463                 $_POST['Disc'] = percent_format($order->default_discount * 100);
 464         }
 465
 466         qty_cells(null, 'qty', $_POST['qty'], null, null, $dec);
 467
 468         if ($order->trans_no!=0) {
 469                 qty_cell($line_no==-1 ? 0 :$order->line_items[$line_no]->qty_done, false, $dec);
 470         }
 471
 472         label_cell($units, '', 'units');
 473
 474         $str = amount_cells(null, 'price');
 475
 476         small_amount_cells(null, 'Disc', percent_format($_POST['Disc']), null, null, user_percent_dec());
 477
 478         $line_total = input_num('qty') * input_num('price') * (1 - input_num('Disc') / 100);
 479
 480         amount_cell($line_total, false, '','line_total');
 481
 482         if ($id!=-1)
 483         {
 484                 button_cell('UpdateItem', _("Update"),
 485                                 _('Confirm changes'), ICON_UPDATE);
 486                 button_cell('CancelItemChanges', _("Cancel"),
 487                                 _('Cancel changes'), ICON_CANCEL);
 488                 hidden('LineNo', $line_no);
 489                 set_focus('qty');
 490         }
 491         else
 492         {
 493                 submit_cells('AddItem', _("Add Item"), "colspan=2",
 494                     _('Add new item to document'), true);
 495         }
 496
 497         end_row();
 498 }
 499
 500 //--------------------------------------------------------------------------------
 501
 502 function display_delivery_details(&$order)
 503 {
 504         global $table_style2, $Ajax;
 505
 506         div_start('delivery');
 507
 508         if (get_post('cash', 0)) {      // Direct payment sale
 509                 display_heading(_('Cash payment'));
 510                 start_table("$table_style2 width=60%");
 511                 label_row(_("Deliver from Location:"), $order->location_name);
 512
 513                 hidden('Location', $order->Location);
 514                 label_row(_("Cash account:"), $order->account_name);
 515                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 516                 end_table();
 517         } else {
 518
 519                 if ($order->trans_type==10)
 520                 {
 521                         $title = _("Delivery Details");
 522                         $delname = _("Due Date").':';
 523                 }
 524                 elseif ($order->trans_type==13)
 525                 {
 526                         $title = _("Invoice Delivery Details");
 527                         $delname = _("Invoice before").':';
 528                 }
 529                 else
 530                 {
 531                         $title = _("Order Delivery Details");
 532                         $delname = _("Required Delivery Date").':';
 533                 }
 534                 display_heading($title);
 535                 start_outer_table("$table_style2 width=90%");
 536                 table_section(1);
 537
 538                 locations_list_row(_("Deliver from Location:"), 'Location', null,
 539                         false, true);
 540                 if (list_updated('Location'))
 541                         check_qoh($order);
 542
 543                 date_row($delname, 'delivery_date',
 544                         $order->trans_type==30 ?  _('Enter requested day of delivery') : '',
 545                         $order->due_date, 0, 0, 0);
 546                 text_row(_("Deliver To:"), 'deliver_to', $order->deliver_to, 40, 40,
 547                         _('Additional identifier for delivery e.g. name of receiving person'));
 548
 549                 textarea_row(_("Address:"), 'delivery_address', $order->delivery_address, 35, 5,
 550                         _('Delivery address. Default is address of customer branch'));
 551                 text_row(_("Contact Phone Number:"), 'phone', $order->phone, 25, 25,
 552                     _('Phone number of ordering person. Defaults to branch phone number'));
 553
 554                 table_section(2);
 555
 556                 text_row(_("Customer Reference:"), 'cust_ref', $order->cust_ref, 25, 25,
 557                   _('Customer reference number for this order (if any)'));
 558                 textarea_row(_("Comments:"), "Comments", $order->Comments, 31, 5);
 559
 560                 small_amount_row(_("Shipping Charge:"), 'freight_cost',
 561                 price_format(get_post('freight_cost',0)));
 562
 563                 shippers_list_row(_("Shipping Company:"), 'ship_via', $order->ship_via);
 564
 565                 end_outer_table(1);
 566         }
 567         div_end();
 568 }
 569
 570 function check_qoh($order)
 571 {
 572         $msg = '';
 573         foreach($order->line_items as $line_no => $line) {
 574                 $qoh = get_qoh_on_date($line->stock_id, $_POST['Location'], $_POST['OrderDate']);
 575                 if ($line->qty_dispatched > $qoh)       {
 576                         $msg .= $line->stock_id . " - " . $line->item_description . ": " .
 577                                 _("Quantity On Hand") . " = "
 578                                 . number_format2($qoh, get_qty_dec($line->stock_id)) . '<br>';
 579                 }
 580         }
 581         if (strlen($msg)) {
 582                 display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:")
 583                         . '<br>'. $msg);
 584                 return false;
 585         }
 586         return true;
 587 }
 588 ?>