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