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 //-----------------------------------------------------------------------------
14 // Entry/Modify Delivery Note against Sales Order
16 $page_security = 'SA_SALESDELIVERY';
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");
29 if ($use_popup_windows) {
30 $js .= get_js_open_window(900, 500);
32 if (user_use_date_picker()) {
33 $js .= get_js_date_picker();
36 if (isset($_GET['ModifyDelivery'])) {
37 $_SESSION['page_title'] = sprintf(_("Modifying Delivery Note # %d."), $_GET['ModifyDelivery']);
38 $help_context = "Modifying Delivery Note";
40 } elseif (isset($_GET['OrderNumber'])) {
41 $_SESSION['page_title'] = _($help_context = "Deliver Items for a Sales Order");
45 page($_SESSION['page_title'], false, false, "", $js);
47 if (isset($_GET['AddedID'])) {
48 $dispatch_no = $_GET['AddedID'];
50 display_notification_centered(sprintf(_("Delivery # %d has been entered."),$dispatch_no));
52 display_note(get_customer_trans_view_str(ST_CUSTDELIVERY, $dispatch_no, _("&View This Delivery")), 0, 1);
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);
59 display_note(get_gl_view_str(13, $dispatch_no, _("View the GL Journal Entries for this Dispatch")),1);
61 if (!isset($_GET['prepaid']))
62 hyperlink_params("$path_to_root/sales/customer_invoice.php", _("Invoice This Delivery"), "DeliveryNumber=$dispatch_no");
64 hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select Another Order For Dispatch"), "OutstandingOnly=1");
66 display_footer_exit();
68 } elseif (isset($_GET['UpdatedID'])) {
70 $delivery_no = $_GET['UpdatedID'];
72 display_notification_centered(sprintf(_('Delivery Note # %d has been updated.'),$delivery_no));
74 display_note(get_trans_view_str(ST_CUSTDELIVERY, $delivery_no, _("View this delivery")), 0, 1);
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);
81 if (!isset($_GET['prepaid']))
82 hyperlink_params($path_to_root . "/sales/customer_invoice.php", _("Confirm Delivery and Invoice"), "DeliveryNumber=$delivery_no");
84 hyperlink_params($path_to_root . "/sales/inquiry/sales_deliveries_view.php", _("Select A Different Delivery"), "OutstandingOnly=1");
86 display_footer_exit();
88 //-----------------------------------------------------------------------------
90 if (isset($_GET['OrderNumber']) && $_GET['OrderNumber'] > 0) {
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."));
96 if ($ord->count_items() == 0) {
97 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
98 _("Select a different sales order to delivery"), "OutstandingOnly=1");
99 echo "<br><center><b>" . _("This order has no items. There is nothing to delivery.") .
101 display_footer_exit();
102 } else if (!$ord->is_released()) {
103 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",_("Select a different sales order to delivery"),
104 "OutstandingOnly=1");
105 echo "<br><center><b>"._("This prepayment order is not yet ready for delivery due to insufficient amount received.")
107 display_footer_exit();
109 // Adjust Shipping Charge based upon previous deliveries TAM
110 adjust_shipping_charge($ord, $_GET['OrderNumber']);
112 $_SESSION['Items'] = $ord;
115 } elseif (isset($_GET['ModifyDelivery']) && $_GET['ModifyDelivery'] > 0) {
117 check_is_editable(ST_CUSTDELIVERY, $_GET['ModifyDelivery']);
118 $_SESSION['Items'] = new Cart(ST_CUSTDELIVERY,$_GET['ModifyDelivery']);
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.") .
125 display_footer_exit();
130 } elseif ( !processing_active() ) {
131 /* This page can only be called with an order number for invoicing*/
133 display_error(_("This page can only be opened if an order or delivery note has been selected. Please select it first."));
135 hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select a Sales Order to Delivery"), "OutstandingOnly=1");
141 check_edit_conflicts(get_post('cart_id'));
143 if (!check_quantities()) {
144 display_error(_("Selected quantity cannot be less than quantity invoiced nor more than quantity not dispatched on sales order."));
146 } elseif(!check_num('ChargeFreightCost', 0)) {
147 display_error(_("Freight cost cannot be less than zero"));
148 set_focus('ChargeFreightCost');
152 //-----------------------------------------------------------------------------
154 function check_data()
156 global $Refs, $SysPrefs;
158 if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
159 display_error(_("The entered date of delivery is invalid."));
160 set_focus('DispatchDate');
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');
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');
176 if ($_SESSION['Items']->trans_no==0) {
177 if (!$Refs->is_valid($_POST['ref'])) {
178 display_error(_("You must enter a reference."));
183 if ($_POST['ChargeFreightCost'] == "") {
184 $_POST['ChargeFreightCost'] = price_format(0);
187 if (!check_num('ChargeFreightCost',0)) {
188 display_error(_("The entered shipping value is not numeric."));
189 set_focus('ChargeFreightCost');
193 if ($_SESSION['Items']->has_items_dispatch() == 0 && input_num('ChargeFreightCost') == 0) {
194 display_error(_("There are no item quantities on this delivery note."));
198 if (!check_quantities()) {
204 if (!$SysPrefs->allow_negative_stock() && ($low_stock = $_SESSION['Items']->check_qoh()))
206 display_error(_("This document cannot be processed because there is insufficient quantity for: ").implode(',', $low_stock));
212 //------------------------------------------------------------------------------
213 function copy_to_cart()
215 $cart = &$_SESSION['Items'];
216 $cart->ship_via = $_POST['ship_via'];
217 $cart->freight_cost = input_num('ChargeFreightCost');
218 $cart->document_date = $_POST['DispatchDate'];
219 $cart->due_date = $_POST['due_date'];
220 $cart->Location = $_POST['Location'];
221 $cart->Comments = $_POST['Comments'];
222 $cart->dimension_id = $_POST['dimension_id'];
223 $cart->dimension2_id = $_POST['dimension2_id'];
224 if ($cart->trans_no == 0)
225 $cart->reference = $_POST['ref'];
228 //------------------------------------------------------------------------------
230 function copy_from_cart()
232 $cart = &$_SESSION['Items'];
233 $_POST['ship_via'] = $cart->ship_via;
234 $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
235 $_POST['DispatchDate'] = $cart->document_date;
236 $_POST['due_date'] = $cart->due_date;
237 $_POST['Location'] = $cart->Location;
238 $_POST['Comments'] = $cart->Comments;
239 $_POST['dimension_id'] = $cart->dimension_id;
240 $_POST['dimension2_id'] = $cart->dimension2_id;
241 $_POST['cart_id'] = $cart->cart_id;
242 $_POST['ref'] = $cart->reference;
244 //------------------------------------------------------------------------------
246 function check_quantities()
249 // Update cart delivery quantities/descriptions
250 foreach ($_SESSION['Items']->line_items as $line=>$itm) {
251 if (isset($_POST['Line'.$line])) {
252 if($_SESSION['Items']->trans_no) {
253 $min = $itm->qty_done;
254 $max = $itm->quantity;
257 $max = $itm->quantity - $itm->qty_done;
260 if (check_num('Line'.$line, $min, $max)) {
261 $_SESSION['Items']->line_items[$line]->qty_dispatched =
262 input_num('Line'.$line);
264 set_focus('Line'.$line);
270 if (isset($_POST['Line'.$line.'Desc'])) {
271 $line_desc = $_POST['Line'.$line.'Desc'];
272 if (strlen($line_desc) > 0) {
273 $_SESSION['Items']->line_items[$line]->item_description = $line_desc;
279 // $_SESSION['Items']->freight_cost = input_num('ChargeFreightCost');
282 //------------------------------------------------------------------------------
284 if (isset($_POST['process_delivery']) && check_data())
287 $dn = &$_SESSION['Items'];
288 $newdelivery = ($dn->trans_no==0);
289 if (!$SysPrefs->allow_negative_stock()) {
290 foreach ($_SESSION['Items']->line_items as $itm) {
292 if ($itm->qty_dispatched && has_stock_holding($itm->mb_flag)) {
293 $qoh_by_date = get_qoh_on_date($itm->stock_id, $_POST['Location'], $_POST['DispatchDate']);
294 $qoh_abs = get_qoh_on_date($itm->stock_id, $_POST['Location'], null);
295 //If editing current delivery delivered qty should be added
298 $delivered = get_already_delivered($itm->stock_id, $_POST['Location'], key($dn->trans_no));
300 $qoh_abs = $qoh_abs - $delivered;
301 $qoh_by_date = $qoh_by_date - $delivered;
303 $qoh = ($qoh_by_date < $qoh_abs ? $qoh_by_date : $qoh_abs);
304 if ($itm->qty_dispatched > $qoh) {
305 display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:") .
306 " " . $itm->stock_id . " - " . $itm->item_description);
315 //------------------------------------------------------------------------------
317 if (isset($_POST['process_delivery']) && check_data() && check_qoh()) {
318 $dn = &$_SESSION['Items'];
320 if ($_POST['bo_policy']) {
325 $newdelivery = ($dn->trans_no == 0);
328 new_doc_date($dn->document_date);
330 $delivery_no = $dn->write($bo_policy);
332 if ($delivery_no == -1)
334 display_error(_("The entered reference is already in use."));
339 $is_prepaid = $dn->is_prepaid() ? "&prepaid=Yes" : '';
343 meta_forward($_SERVER['PHP_SELF'], "AddedID=$delivery_no$is_prepaid");
345 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$delivery_no$is_prepaid");
350 if (isset($_POST['Update']) || isset($_POST['_Location_update']) || isset($_POST['qty']) || isset($_POST['process_delivery'])) {
351 $Ajax->activate('Items');
353 //------------------------------------------------------------------------------
357 start_table(TABLESTYLE2, "width=80%", 5);
358 echo "<tr><td>"; // outer table
360 start_table(TABLESTYLE, "width=100%");
362 label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
363 label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
364 label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
368 //if (!isset($_POST['ref']))
369 // $_POST['ref'] = $Refs->get_next(ST_CUSTDELIVERY);
371 if ($_SESSION['Items']->trans_no==0) {
372 ref_cells(_("Reference"), 'ref', '', null, "class='tableheader2'");
374 label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
377 label_cells(_("For Sales Order"), get_customer_trans_view_str(ST_SALESORDER, $_SESSION['Items']->order_no), "class='tableheader2'");
379 label_cells(_("Sales Type"), $_SESSION['Items']->sales_type_name, "class='tableheader2'");
383 if (!isset($_POST['Location'])) {
384 $_POST['Location'] = $_SESSION['Items']->Location;
386 label_cell(_("Delivery From"), "class='tableheader2'");
387 locations_list_cells(null, 'Location', null, false, true);
389 if (!isset($_POST['ship_via'])) {
390 $_POST['ship_via'] = $_SESSION['Items']->ship_via;
392 label_cell(_("Shipping Company"), "class='tableheader2'");
393 shippers_list_cells(null, 'ship_via', $_POST['ship_via']);
395 // set this up here cuz it's used to calc qoh
396 if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
397 $_POST['DispatchDate'] = new_doc_date();
398 if (!is_date_in_fiscalyear($_POST['DispatchDate'])) {
399 $_POST['DispatchDate'] = end_fiscalyear();
402 date_cells(_("Date"), 'DispatchDate', '', $_SESSION['Items']->trans_no==0, 0, 0, 0, "class='tableheader2'");
407 echo "</td><td>";// outer table
409 start_table(TABLESTYLE, "width=90%");
411 if (!isset($_POST['due_date']) || !is_date($_POST['due_date'])) {
412 $_POST['due_date'] = get_invoice_duedate($_SESSION['Items']->payment, $_POST['DispatchDate']);
414 customer_credit_row($_SESSION['Items']->customer_id, $_SESSION['Items']->credit, "class='tableheader2'");
415 // 2010-09-03 Joe Hunt
416 $dim = get_company_pref('use_dimension');
419 label_cell(_("Dimension").":", "class='tableheader2'");
420 dimensions_list_cells(null, 'dimension_id', null, true, ' ', false, 1, false);
424 hidden('dimension_id', 0);
427 label_cell(_("Dimension")." 2:", "class='tableheader2'");
428 dimensions_list_cells(null, 'dimension2_id', null, true, ' ', false, 2, false);
432 hidden('dimension2_id', 0);
435 date_cells(_("Invoice Dead-line"), 'due_date', '', null, 0, 0, 0, "class='tableheader2'");
440 end_table(1); // outer table
442 $row = get_customer_to_order($_SESSION['Items']->customer_id);
443 if ($row['dissallow_invoices'] == 1)
445 display_error(_("The selected customer account is currently on hold. Please contact the credit control personnel to discuss."));
450 display_heading(_("Delivery Items"));
452 start_table(TABLESTYLE, "width=80%");
454 $new = $_SESSION['Items']->trans_no==0;
455 $th = array(_("Item Code"), _("Item Description"),
456 $new ? _("Ordered") : _("Max. delivery"), _("Units"), $new ? _("Delivered") : _("Invoiced"),
457 _("This Delivery"), _("Price"), _("Tax Type"), _("Discount"), _("Total"));
463 foreach ($_SESSION['Items']->line_items as $line=>$ln_itm) {
464 if ($ln_itm->quantity==$ln_itm->qty_done) {
465 continue; //this line is fully delivered
467 if(isset($_POST['_Location_update']) || isset($_POST['clear_quantity']) || isset($_POST['reset_quantity'])) {
469 $ln_itm->qty_dispatched = $ln_itm->quantity-$ln_itm->qty_done;
471 // if it's a non-stock item (eg. service) don't show qoh
473 if (has_stock_holding($ln_itm->mb_flag) && $ln_itm->qty_dispatched) {
474 // It's a stock : call get_dispatchable_quantity hook to get which quantity to preset in the
475 // quantity input box. This allows for example a hook to modify the default quantity to what's dispatchable
476 // (if there is not enough in hand), check at other location or other order people etc ...
477 // This hook also returns a 'reason' (css classes) which can be used to theme the row.
479 // FIXME: hook_get_dispatchable definition does not allow qoh checks on transaction level
480 // (but anyway dispatch is checked again later before transaction is saved)
482 $qty = $ln_itm->qty_dispatched;
483 if ($check = check_negative_stock($ln_itm->stock_id, $ln_itm->qty_done-$ln_itm->qty_dispatched, $_POST['Location'], $_POST['DispatchDate']))
484 $qty = $check['qty'];
486 $q_class = hook_get_dispatchable_quantity($ln_itm, $_POST['Location'], $_POST['DispatchDate'], $qty);
488 // Skip line if needed
489 if($q_class === 'skip') continue;
490 if(is_array($q_class)) {
491 list($ln_itm->qty_dispatched, $row_classes) = $q_class;
496 alt_table_row_color($k, $row_classes);
497 view_stock_status_cell($ln_itm->stock_id);
499 if ($ln_itm->descr_editable)
500 text_cells(null, 'Line'.$line.'Desc', $ln_itm->item_description, 30, 50);
502 label_cell($ln_itm->item_description);
504 $dec = get_qty_dec($ln_itm->stock_id);
505 qty_cell($ln_itm->quantity, false, $dec);
506 label_cell($ln_itm->units);
507 qty_cell($ln_itm->qty_done, false, $dec);
509 if(isset($_POST['clear_quantity'])) {
510 $ln_itm->qty_dispatched = 0;
512 $_POST['Line'.$line]=$ln_itm->qty_dispatched; /// clear post so value displayed in the fiel is the 'new' quantity
513 small_qty_cells(null, 'Line'.$line, qty_format($ln_itm->qty_dispatched, $ln_itm->stock_id, $dec), null, null, $dec);
515 $display_discount_percent = percent_format($ln_itm->discount_percent*100) . "%";
517 $line_total = ($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
519 amount_cell($ln_itm->price);
520 label_cell($ln_itm->tax_type_name);
521 label_cell($display_discount_percent, "nowrap align=right");
522 amount_cell($line_total);
527 $_POST['ChargeFreightCost'] = get_post('ChargeFreightCost',
528 price_format($_SESSION['Items']->freight_cost));
533 label_cell(_("Shipping Cost"), "colspan=$colspan align=right");
534 small_amount_cells(null, 'ChargeFreightCost', $_SESSION['Items']->freight_cost);
537 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
539 $display_sub_total = price_format($inv_items_total + input_num('ChargeFreightCost'));
541 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right");
543 $taxes = $_SESSION['Items']->get_taxes(input_num('ChargeFreightCost'));
544 $tax_total = display_edit_tax_items($taxes, $colspan, $_SESSION['Items']->tax_included);
546 $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
548 label_row(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
553 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
555 start_table(TABLESTYLE2);
557 policy_list_row(_("Action For Balance"), "bo_policy", null);
559 textarea_row(_("Memo"), 'Comments', null, 50, 4);
563 submit_center_first('Update', _("Update"),
564 _('Refresh document page'), true);
565 if(isset($_POST['clear_quantity'])) {
566 submit('reset_quantity', _('Reset quantity'), true, _('Refresh document page'));
569 submit('clear_quantity', _('Clear quantity'), true, _('Refresh document page'));
571 submit_center_last('process_delivery', _("Process Dispatch"),
572 _('Check entered data and save document'), 'default');