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