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