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