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