Additional fixes for editable item descriptions.
[fa-stable.git] / sales / customer_delivery.php
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 //-----------------------------------------------------------------------------
13 //
14 //      Entry/Modify Delivery Note against Sales Order
15 //
16 $page_security = 'SA_SALESDELIVERY';
17 $path_to_root = "..";
18
19 include_once($path_to_root . "/sales/includes/cart_class.inc");
20 include_once($path_to_root . "/includes/session.inc");
21 include_once($path_to_root . "/includes/data_checks.inc");
22 include_once($path_to_root . "/includes/manufacturing.inc");
23 include_once($path_to_root . "/sales/includes/sales_db.inc");
24 include_once($path_to_root . "/sales/includes/sales_ui.inc");
25 include_once($path_to_root . "/reporting/includes/reporting.inc");
26 include_once($path_to_root . "/taxes/tax_calc.inc");
27
28 $js = "";
29 if ($use_popup_windows) {
30         $js .= get_js_open_window(900, 500);
31 }
32 if ($use_date_picker) {
33         $js .= get_js_date_picker();
34 }
35
36 if (isset($_GET['ModifyDelivery'])) {
37         $_SESSION['page_title'] = sprintf(_("Modifying Delivery Note # %d."), $_GET['ModifyDelivery']);
38         $help_context = "Modifying Delivery Note";
39         processing_start();
40 } elseif (isset($_GET['OrderNumber'])) {
41         $_SESSION['page_title'] = _($help_context = "Deliver Items for a Sales Order");
42         processing_start();
43 }
44
45 page($_SESSION['page_title'], false, false, "", $js);
46
47 if (isset($_GET['AddedID'])) {
48         $dispatch_no = $_GET['AddedID'];
49
50         display_notification_centered(sprintf(_("Delivery # %d has been entered."),$dispatch_no));
51
52         display_note(get_customer_trans_view_str(ST_CUSTDELIVERY, $dispatch_no, _("&View This Delivery")), 0, 1);
53
54         display_note(print_document_link($dispatch_no, _("&Print Delivery Note"), true, ST_CUSTDELIVERY));
55         display_note(print_document_link($dispatch_no, _("&Email Delivery Note"), true, ST_CUSTDELIVERY, false, "", "", 1), 1, 1);
56         display_note(print_document_link($dispatch_no, _("P&rint as Packing Slip"), true, ST_CUSTDELIVERY, false, "", "", 0, 1));
57         display_note(print_document_link($dispatch_no, _("E&mail as Packing Slip"), true, ST_CUSTDELIVERY, false, "", "", 1, 1), 1);
58
59         display_note(get_gl_view_str(13, $dispatch_no, _("View the GL Journal Entries for this Dispatch")),1);
60
61         hyperlink_params("$path_to_root/sales/customer_invoice.php", _("Invoice This Delivery"), "DeliveryNumber=$dispatch_no");
62
63         hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select Another Order For Dispatch"), "OutstandingOnly=1");
64
65         display_footer_exit();
66
67 } elseif (isset($_GET['UpdatedID'])) {
68
69         $delivery_no = $_GET['UpdatedID'];
70
71         display_notification_centered(sprintf(_('Delivery Note # %d has been updated.'),$delivery_no));
72
73         display_note(get_trans_view_str(ST_CUSTDELIVERY, $delivery_no, _("View this delivery")), 0, 1);
74
75         display_note(print_document_link($delivery_no, _("&Print Delivery Note"), true, ST_CUSTDELIVERY));
76         display_note(print_document_link($delivery_no, _("&Email Delivery Note"), true, ST_CUSTDELIVERY, false, "", "", 1), 1, 1);
77         display_note(print_document_link($delivery_no, _("P&rint as Packing Slip"), true, ST_CUSTDELIVERY, false, "", "", 0, 1));
78         display_note(print_document_link($delivery_no, _("E&mail as Packing Slip"), true, ST_CUSTDELIVERY, false, "", "", 1, 1), 1);
79
80         hyperlink_params($path_to_root . "/sales/customer_invoice.php", _("Confirm Delivery and Invoice"), "DeliveryNumber=$delivery_no");
81
82         hyperlink_params($path_to_root . "/sales/inquiry/sales_deliveries_view.php", _("Select A Different Delivery"), "OutstandingOnly=1");
83
84         display_footer_exit();
85 }
86 //-----------------------------------------------------------------------------
87
88 if (isset($_GET['OrderNumber']) && $_GET['OrderNumber'] > 0) {
89
90         $ord = new Cart(ST_SALESORDER, $_GET['OrderNumber'], true);
91
92         /*read in all the selected order into the Items cart  */
93
94         if ($ord->count_items() == 0) {
95                 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
96                         _("Select a different sales order to delivery"), "OutstandingOnly=1");
97                 die ("<br><b>" . _("This order has no items. There is nothing to delivery.") . "</b>");
98         }
99
100         $ord->trans_type = ST_CUSTDELIVERY;
101         $ord->src_docs = $ord->trans_no;
102         $ord->order_no = key($ord->trans_no);
103         $ord->trans_no = 0;
104         $ord->reference = $Refs->get_next(ST_CUSTDELIVERY);
105         $ord->document_date = new_doc_date();
106         $_SESSION['Items'] = $ord;
107         copy_from_cart();
108
109 } elseif (isset($_GET['ModifyDelivery']) && $_GET['ModifyDelivery'] > 0) {
110
111         $_SESSION['Items'] = new Cart(ST_CUSTDELIVERY,$_GET['ModifyDelivery']);
112
113         if ($_SESSION['Items']->count_items() == 0) {
114                 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
115                         _("Select a different delivery"), "OutstandingOnly=1");
116                 echo "<br><center><b>" . _("This delivery has all items invoiced. There is nothing to modify.") .
117                         "</center></b>";
118                 display_footer_exit();
119         }
120
121         copy_from_cart();
122         
123 } elseif ( !processing_active() ) {
124         /* This page can only be called with an order number for invoicing*/
125
126         display_error(_("This page can only be opened if an order or delivery note has been selected. Please select it first."));
127
128         hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select a Sales Order to Delivery"), "OutstandingOnly=1");
129
130         end_page();
131         exit;
132
133 } else {
134         check_edit_conflicts();
135
136         if (!check_quantities()) {
137                 display_error(_("Selected quantity cannot be less than quantity invoiced nor more than quantity not dispatched on sales order."));
138
139         } elseif(!check_num('ChargeFreightCost', 0)) {
140                 display_error(_("Freight cost cannot be less than zero"));
141                 set_focus('ChargeFreightCost');
142         }
143 }
144
145 //-----------------------------------------------------------------------------
146
147 function check_data()
148 {
149         global $Refs;
150
151         if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
152                 display_error(_("The entered date of delivery is invalid."));
153                 set_focus('DispatchDate');
154                 return false;
155         }
156
157         if (!is_date_in_fiscalyear($_POST['DispatchDate'])) {
158                 display_error(_("The entered date of delivery is not in fiscal year."));
159                 set_focus('DispatchDate');
160                 return false;
161         }
162
163         if (!isset($_POST['due_date']) || !is_date($_POST['due_date'])) {
164                 display_error(_("The entered dead-line for invoice is invalid."));
165                 set_focus('due_date');
166                 return false;
167         }
168
169         if ($_SESSION['Items']->trans_no==0) {
170                 if (!$Refs->is_valid($_POST['ref'])) {
171                         display_error(_("You must enter a reference."));
172                         set_focus('ref');
173                         return false;
174                 }
175
176                 if ($_SESSION['Items']->trans_no==0 && !is_new_reference($_POST['ref'], ST_CUSTDELIVERY)) {
177                         display_error(_("The entered reference is already in use."));
178                         set_focus('ref');
179                         return false;
180                 }
181         }
182         if ($_POST['ChargeFreightCost'] == "") {
183                 $_POST['ChargeFreightCost'] = price_format(0);
184         }
185
186         if (!check_num('ChargeFreightCost',0)) {
187                 display_error(_("The entered shipping value is not numeric."));
188                 set_focus('ChargeFreightCost');
189                 return false;
190         }
191
192         if ($_SESSION['Items']->has_items_dispatch() == 0 && input_num('ChargeFreightCost') == 0) {
193                 display_error(_("There are no item quantities on this delivery note."));
194                 return false;
195         }
196
197         if (!check_quantities()) {
198                 return false;
199         }
200
201         return true;
202 }
203 //------------------------------------------------------------------------------
204 function copy_to_cart()
205 {
206         $cart = &$_SESSION['Items'];
207         $cart->ship_via = $_POST['ship_via'];
208         $cart->freight_cost = input_num('ChargeFreightCost');
209         $cart->document_date = $_POST['DispatchDate'];
210         $cart->due_date =  $_POST['due_date'];
211         $cart->Location = $_POST['Location'];
212         $cart->Comments = $_POST['Comments'];
213         if ($cart->trans_no == 0)
214                 $cart->reference = $_POST['ref'];
215
216 }
217 //------------------------------------------------------------------------------
218
219 function copy_from_cart()
220 {
221         $cart = &$_SESSION['Items'];
222         $_POST['ship_via'] = $cart->ship_via;
223         $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
224         $_POST['DispatchDate'] = $cart->document_date;
225         $_POST['due_date'] = $cart->due_date;
226         $_POST['Location'] = $cart->Location;
227         $_POST['Comments'] = $cart->Comments;
228         $_POST['cart_id'] = $cart->cart_id;
229         $_POST['ref'] = $cart->reference;
230 }
231 //------------------------------------------------------------------------------
232
233 function check_quantities()
234 {
235         $ok =1;
236         // Update cart delivery quantities/descriptions
237         foreach ($_SESSION['Items']->line_items as $line=>$itm) {
238                 if (isset($_POST['Line'.$line])) {
239                 if($_SESSION['Items']->trans_no) {
240                         $min = $itm->qty_done;
241                         $max = $itm->quantity;
242                 } else {
243                         $min = 0;
244                         $max = $itm->quantity - $itm->qty_done;
245                 }
246                 
247                         if (check_num('Line'.$line, $min, $max)) {
248                                 $_SESSION['Items']->line_items[$line]->qty_dispatched =
249                                   input_num('Line'.$line);
250                         } else {
251                                 set_focus('Line'.$line);
252                                 $ok = 0;
253                         }
254
255                 }
256
257                 if (isset($_POST['Line'.$line.'Desc'])) {
258                         $line_desc = $_POST['Line'.$line.'Desc'];
259                         if (strlen($line_desc) > 0) {
260                                 $_SESSION['Items']->line_items[$line]->item_description = $line_desc;
261                         }
262                 }
263         }
264 // ...
265 //      else
266 //        $_SESSION['Items']->freight_cost = input_num('ChargeFreightCost');
267         return $ok;
268 }
269 //------------------------------------------------------------------------------
270
271 function check_qoh()
272 {
273         global $SysPrefs;
274
275         if (!$SysPrefs->allow_negative_stock()) {
276                 foreach ($_SESSION['Items']->line_items as $itm) {
277
278                         if ($itm->qty_dispatched && has_stock_holding($itm->mb_flag)) {
279                                 $qoh = get_qoh_on_date($itm->stock_id, $_POST['Location'], $_POST['DispatchDate']);
280
281                                 if ($itm->qty_dispatched > $qoh) {
282                                         display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:") .
283                                                 " " . $itm->stock_id . " - " .  $itm->item_description);
284                                         return false;
285                                 }
286                         }
287                 }
288         }
289         return true;
290 }
291 //------------------------------------------------------------------------------
292
293 if (isset($_POST['process_delivery']) && check_data() && check_qoh()) {
294
295         $dn = &$_SESSION['Items'];
296
297         if ($_POST['bo_policy']) {
298                 $bo_policy = 0;
299         } else {
300                 $bo_policy = 1;
301         }
302         $newdelivery = ($dn->trans_no == 0);
303
304         copy_to_cart();
305         if ($newdelivery) new_doc_date($dn->document_date);
306         $delivery_no = $dn->write($bo_policy);
307
308         processing_end();
309         if ($newdelivery) {
310                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$delivery_no");
311         } else {
312                 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$delivery_no");
313         }
314 }
315
316 if (isset($_POST['Update']) || isset($_POST['_Location_update'])) {
317         $Ajax->activate('Items');
318 }
319 //------------------------------------------------------------------------------
320 start_form();
321 hidden('cart_id');
322
323 start_table("$table_style2 width=80%", 5);
324 echo "<tr><td>"; // outer table
325
326 start_table("$table_style width=100%");
327 start_row();
328 label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
329 label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
330 label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
331 end_row();
332 start_row();
333
334 //if (!isset($_POST['ref']))
335 //      $_POST['ref'] = $Refs->get_next(ST_CUSTDELIVERY);
336
337 if ($_SESSION['Items']->trans_no==0) {
338         ref_cells(_("Reference"), 'ref', '', null, "class='tableheader2'");
339 } else {
340         label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
341 }
342
343 label_cells(_("For Sales Order"), get_customer_trans_view_str(ST_SALESORDER, $_SESSION['Items']->order_no), "class='tableheader2'");
344
345 label_cells(_("Sales Type"), $_SESSION['Items']->sales_type_name, "class='tableheader2'");
346 end_row();
347 start_row();
348
349 if (!isset($_POST['Location'])) {
350         $_POST['Location'] = $_SESSION['Items']->Location;
351 }
352 label_cell(_("Delivery From"), "class='tableheader2'");
353 locations_list_cells(null, 'Location', null, false, true);
354
355 if (!isset($_POST['ship_via'])) {
356         $_POST['ship_via'] = $_SESSION['Items']->ship_via;
357 }
358 label_cell(_("Shipping Company"), "class='tableheader2'");
359 shippers_list_cells(null, 'ship_via', $_POST['ship_via']);
360
361 // set this up here cuz it's used to calc qoh
362 if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
363         $_POST['DispatchDate'] = new_doc_date();
364         if (!is_date_in_fiscalyear($_POST['DispatchDate'])) {
365                 $_POST['DispatchDate'] = end_fiscalyear();
366         }
367 }
368 date_cells(_("Date"), 'DispatchDate', '', $_SESSION['Items']->trans_no==0, 0, 0, 0, "class='tableheader2'");
369 end_row();
370
371 end_table();
372
373 echo "</td><td>";// outer table
374
375 start_table("$table_style width=90%");
376
377 if (!isset($_POST['due_date']) || !is_date($_POST['due_date'])) {
378         $_POST['due_date'] = get_invoice_duedate($_SESSION['Items']->customer_id, $_POST['DispatchDate']);
379 }
380 date_row(_("Invoice Dead-line"), 'due_date', '', null, 0, 0, 0, "class='tableheader2'");
381 end_table();
382
383 echo "</td></tr>";
384 end_table(1); // outer table
385
386 $row = get_customer_to_order($_SESSION['Items']->customer_id);
387 if ($row['dissallow_invoices'] == 1)
388 {
389         display_error(_("The selected customer account is currently on hold. Please contact the credit control personnel to discuss."));
390         end_form();
391         end_page();
392         exit();
393 }       
394 display_heading(_("Delivery Items"));
395 div_start('Items');
396 start_table("$table_style width=80%");
397
398 $new = $_SESSION['Items']->trans_no==0;
399 $th = array(_("Item Code"), _("Item Description"), 
400         $new ? _("Ordered") : _("Max. delivery"), _("Units"), $new ? _("Delivered") : _("Invoiced"),
401         _("This Delivery"), _("Price"), _("Tax Type"), _("Discount"), _("Total"));
402
403 table_header($th);
404 $k = 0;
405 $has_marked = false;
406
407 foreach ($_SESSION['Items']->line_items as $line=>$ln_itm) {
408         if ($ln_itm->quantity==$ln_itm->qty_done) {
409                 continue; //this line is fully delivered
410         }
411         // if it's a non-stock item (eg. service) don't show qoh
412         $show_qoh = true;
413         if ($SysPrefs->allow_negative_stock() || !has_stock_holding($ln_itm->mb_flag) ||
414                 $ln_itm->qty_dispatched == 0) {
415                 $show_qoh = false;
416         }
417
418         if ($show_qoh) {
419                 $qoh = get_qoh_on_date($ln_itm->stock_id, $_POST['Location'], $_POST['DispatchDate']);
420         }
421
422         if ($show_qoh && ($ln_itm->qty_dispatched > $qoh)) {
423                 // oops, we don't have enough of one of the component items
424                 start_row("class='stockmankobg'");
425                 $has_marked = true;
426         } else {
427                 alt_table_row_color($k);
428         }
429         view_stock_status_cell($ln_itm->stock_id);
430
431         if ($ln_itm->descr_editable)
432                 text_cells(null, 'Line'.$line.'Desc', $ln_itm->item_description, 30, 50);
433         else
434                 label_cell($ln_itm->item_description);
435         
436         label_cell($ln_itm->units);
437         $dec = get_qty_dec($ln_itm->stock_id);
438         qty_cell($ln_itm->quantity, false, $dec);
439         label_cell($ln_itm->units);
440         qty_cell($ln_itm->qty_done, false, $dec);
441
442         small_qty_cells(null, 'Line'.$line, qty_format($ln_itm->qty_dispatched, $ln_itm->stock_id, $dec), null, null, $dec);
443
444         $display_discount_percent = percent_format($ln_itm->discount_percent*100) . "%";
445
446         $line_total = ($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
447
448         amount_cell($ln_itm->price);
449         label_cell($ln_itm->tax_type_name);
450         label_cell($display_discount_percent, "nowrap align=right");
451         amount_cell($line_total);
452
453         end_row();
454 }
455
456 $_POST['ChargeFreightCost'] =  get_post('ChargeFreightCost', 
457         price_format($_SESSION['Items']->freight_cost));
458
459 $colspan = 9;
460
461 start_row();
462 label_cell(_("Shipping Cost"), "colspan=$colspan align=right");
463 small_amount_cells(null, 'ChargeFreightCost', $_SESSION['Items']->freight_cost);
464 end_row();
465
466 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
467
468 $display_sub_total = price_format($inv_items_total + input_num('ChargeFreightCost'));
469
470 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right");
471
472 $taxes = $_SESSION['Items']->get_taxes(input_num('ChargeFreightCost'));
473 $tax_total = display_edit_tax_items($taxes, $colspan, $_SESSION['Items']->tax_included);
474
475 $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
476
477 label_row(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
478
479 end_table(1);
480
481 if ($has_marked) {
482         display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='red'");
483 }
484 start_table($table_style2);
485
486 policy_list_row(_("Action For Balance"), "bo_policy", null);
487
488 textarea_row(_("Memo"), 'Comments', null, 50, 4);
489
490 end_table(1);
491 div_end();
492 submit_center_first('Update', _("Update"),
493   _('Refresh document page'), true);
494 submit_center_last('process_delivery', _("Process Dispatch"),
495   _('Check entered data and save document'), 'default');
496
497 end_form();
498
499
500 end_page();
501
502 ?>