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 . "/sales/includes/sales_db.inc");
23 include_once($path_to_root . "/sales/includes/sales_ui.inc");
24 include_once($path_to_root . "/reporting/includes/reporting.inc");
25 include_once($path_to_root . "/taxes/tax_calc.inc");
28 if ($SysPrefs->use_popup_windows) {
29 $js .= get_js_open_window(900, 500);
31 if (user_use_date_picker()) {
32 $js .= get_js_date_picker();
35 if (isset($_GET['ModifyDelivery'])) {
36 $_SESSION['page_title'] = sprintf(_("Modifying Delivery Note # %d."), $_GET['ModifyDelivery']);
37 $help_context = "Modifying Delivery Note";
39 } elseif (isset($_GET['OrderNumber'])) {
40 $_SESSION['page_title'] = _($help_context = "Deliver Items for a Sales Order");
44 page($_SESSION['page_title'], false, false, "", $js);
46 if (isset($_GET['AddedID'])) {
47 $dispatch_no = $_GET['AddedID'];
49 display_notification_centered(sprintf(_("Delivery # %d has been entered."),$dispatch_no));
51 display_note(get_customer_trans_view_str(ST_CUSTDELIVERY, $dispatch_no, _("&View This Delivery")), 0, 1);
53 display_note(print_document_link($dispatch_no, _("&Print Delivery Note"), true, ST_CUSTDELIVERY));
54 display_note(print_document_link($dispatch_no, _("&Email Delivery Note"), true, ST_CUSTDELIVERY, false, "printlink", "", 1), 1, 1);
55 display_note(print_document_link($dispatch_no, _("P&rint as Packing Slip"), true, ST_CUSTDELIVERY, false, "printlink", "", 0, 1));
56 display_note(print_document_link($dispatch_no, _("E&mail as Packing Slip"), true, ST_CUSTDELIVERY, false, "printlink", "", 1, 1), 1);
58 display_note(get_gl_view_str(13, $dispatch_no, _("View the GL Journal Entries for this Dispatch")),1);
60 if (!isset($_GET['prepaid']))
61 hyperlink_params("$path_to_root/sales/customer_invoice.php", _("Invoice This Delivery"), "DeliveryNumber=$dispatch_no");
63 hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select Another Order For Dispatch"), "OutstandingOnly=1");
65 display_footer_exit();
67 } elseif (isset($_GET['UpdatedID'])) {
69 $delivery_no = $_GET['UpdatedID'];
71 display_notification_centered(sprintf(_('Delivery Note # %d has been updated.'),$delivery_no));
73 display_note(get_trans_view_str(ST_CUSTDELIVERY, $delivery_no, _("View this delivery")), 0, 1);
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);
80 if (!isset($_GET['prepaid']))
81 hyperlink_params($path_to_root . "/sales/customer_invoice.php", _("Confirm Delivery and Invoice"), "DeliveryNumber=$delivery_no");
83 hyperlink_params($path_to_root . "/sales/inquiry/sales_deliveries_view.php", _("Select A Different Delivery"), "OutstandingOnly=1");
85 display_footer_exit();
87 //-----------------------------------------------------------------------------
89 if (isset($_GET['OrderNumber']) && $_GET['OrderNumber'] > 0) {
91 $ord = new Cart(ST_SALESORDER, $_GET['OrderNumber'], true);
92 if ($ord->is_prepaid())
93 check_deferred_income_act(_("You have to set Deferred Income Account in GL Setup to entry prepayment invoices."));
95 if ($ord->count_items() == 0) {
96 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
97 _("Select a different sales order to delivery"), "OutstandingOnly=1");
98 echo "<br><center><b>" . _("This order has no items. There is nothing to delivery.") .
100 display_footer_exit();
101 } else if (!$ord->is_released()) {
102 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",_("Select a different sales order to delivery"),
103 "OutstandingOnly=1");
104 echo "<br><center><b>"._("This prepayment order is not yet ready for delivery due to insufficient amount received.")
106 display_footer_exit();
108 // Adjust Shipping Charge based upon previous deliveries TAM
109 adjust_shipping_charge($ord, $_GET['OrderNumber']);
111 $_SESSION['Items'] = $ord;
114 } elseif (isset($_GET['ModifyDelivery']) && $_GET['ModifyDelivery'] > 0) {
116 check_is_editable(ST_CUSTDELIVERY, $_GET['ModifyDelivery']);
117 $_SESSION['Items'] = new Cart(ST_CUSTDELIVERY,$_GET['ModifyDelivery']);
119 if (!$_SESSION['Items']->prepaid && $_SESSION['Items']->count_items() == 0) {
120 hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
121 _("Select a different delivery"), "OutstandingOnly=1");
122 echo "<br><center><b>" . _("This delivery has all items invoiced. There is nothing to modify.") .
124 display_footer_exit();
129 } elseif ( !processing_active() ) {
130 /* This page can only be called with an order number for invoicing*/
132 display_error(_("This page can only be opened if an order or delivery note has been selected. Please select it first."));
134 hyperlink_params("$path_to_root/sales/inquiry/sales_orders_view.php", _("Select a Sales Order to Delivery"), "OutstandingOnly=1");
140 check_edit_conflicts(get_post('cart_id'));
142 if (!check_quantities()) {
143 display_error(_("Selected quantity cannot be less than quantity invoiced nor more than quantity not dispatched on sales order."));
145 } elseif(!check_num('ChargeFreightCost', 0)) {
146 display_error(_("Freight cost cannot be less than zero"));
147 set_focus('ChargeFreightCost');
151 //-----------------------------------------------------------------------------
153 function check_data()
155 global $Refs, $SysPrefs;
157 if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
158 display_error(_("The entered date of delivery is invalid."));
159 set_focus('DispatchDate');
163 if (!is_date_in_fiscalyear($_POST['DispatchDate'])) {
164 display_error(_("The entered date is out of fiscal year or is closed for further data entry."));
165 set_focus('DispatchDate');
169 if (!isset($_POST['due_date']) || !is_date($_POST['due_date'])) {
170 display_error(_("The entered dead-line for invoice is invalid."));
171 set_focus('due_date');
175 if ($_SESSION['Items']->trans_no==0) {
176 if (!$Refs->is_valid($_POST['ref'], ST_CUSTDELIVERY)) {
177 display_error(_("You must enter a reference."));
182 if ($_POST['ChargeFreightCost'] == "") {
183 $_POST['ChargeFreightCost'] = price_format(0);
186 if (!check_num('ChargeFreightCost',0)) {
187 display_error(_("The entered shipping value is not numeric."));
188 set_focus('ChargeFreightCost');
192 if ($_SESSION['Items']->has_items_dispatch() == 0 && input_num('ChargeFreightCost') == 0) {
193 display_error(_("There are no item quantities on this delivery note."));
197 if (!check_quantities()) {
203 if (!$SysPrefs->allow_negative_stock() && ($low_stock = $_SESSION['Items']->check_qoh()))
205 display_error(_("This document cannot be processed because there is insufficient quantity for items marked."));
211 //------------------------------------------------------------------------------
212 function copy_to_cart()
214 $cart = &$_SESSION['Items'];
215 $cart->ship_via = $_POST['ship_via'];
216 $cart->freight_cost = input_num('ChargeFreightCost');
217 $cart->document_date = $_POST['DispatchDate'];
218 $cart->due_date = $_POST['due_date'];
219 $cart->Location = $_POST['Location'];
220 $cart->Comments = $_POST['Comments'];
221 $cart->dimension_id = $_POST['dimension_id'];
222 $cart->dimension2_id = $_POST['dimension2_id'];
223 if ($cart->trans_no == 0)
224 $cart->reference = $_POST['ref'];
227 //------------------------------------------------------------------------------
229 function copy_from_cart()
231 $cart = &$_SESSION['Items'];
232 $_POST['ship_via'] = $cart->ship_via;
233 $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
234 $_POST['DispatchDate'] = $cart->document_date;
235 $_POST['due_date'] = $cart->due_date;
236 $_POST['Location'] = $cart->Location;
237 $_POST['Comments'] = $cart->Comments;
238 $_POST['dimension_id'] = $cart->dimension_id;
239 $_POST['dimension2_id'] = $cart->dimension2_id;
240 $_POST['cart_id'] = $cart->cart_id;
241 $_POST['ref'] = $cart->reference;
243 //------------------------------------------------------------------------------
245 function check_quantities()
248 // Update cart delivery quantities/descriptions
249 foreach ($_SESSION['Items']->line_items as $line=>$itm) {
250 if (isset($_POST['Line'.$line])) {
251 if($_SESSION['Items']->trans_no) {
252 $min = $itm->qty_done;
253 $max = $itm->quantity;
256 $max = $itm->quantity - $itm->qty_done;
259 if (check_num('Line'.$line, $min, $max)) {
260 $_SESSION['Items']->line_items[$line]->qty_dispatched =
261 input_num('Line'.$line);
263 set_focus('Line'.$line);
269 if (isset($_POST['Line'.$line.'Desc'])) {
270 $line_desc = $_POST['Line'.$line.'Desc'];
271 if (strlen($line_desc) > 0) {
272 $_SESSION['Items']->line_items[$line]->item_description = $line_desc;
279 //------------------------------------------------------------------------------
281 if (isset($_POST['process_delivery']) && check_data()) {
282 $dn = &$_SESSION['Items'];
284 if ($_POST['bo_policy']) {
289 $newdelivery = ($dn->trans_no == 0);
292 new_doc_date($dn->document_date);
294 $delivery_no = write_sales_trans($dn, $bo_policy);
296 if ($delivery_no == -1)
298 display_error(_("The entered reference is already in use."));
303 $is_prepaid = $dn->is_prepaid() ? "&prepaid=Yes" : '';
307 meta_forward($_SERVER['PHP_SELF'], "AddedID=$delivery_no$is_prepaid");
309 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$delivery_no$is_prepaid");
314 if (isset($_POST['Update']) || isset($_POST['_Location_update']) || isset($_POST['qty']) || isset($_POST['process_delivery'])) {
315 $Ajax->activate('Items');
317 //------------------------------------------------------------------------------
321 start_table(TABLESTYLE2, "width='80%'", 5);
322 echo "<tr><td>"; // outer table
324 start_table(TABLESTYLE, "width='100%'");
326 label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
327 label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
328 label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
332 if ($_SESSION['Items']->trans_no==0) {
333 ref_cells(_("Reference"), 'ref', '', null, "class='tableheader2'", false, ST_CUSTDELIVERY,
334 array('customer' => $_SESSION['Items']->customer_id,
335 'branch' => $_SESSION['Items']->Branch,
336 'date' => get_post('DispatchDate')));
338 label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
341 label_cells(_("For Sales Order"), get_customer_trans_view_str(ST_SALESORDER, $_SESSION['Items']->order_no), "class='tableheader2'");
343 label_cells(_("Sales Type"), $_SESSION['Items']->sales_type_name, "class='tableheader2'");
347 if (!isset($_POST['Location'])) {
348 $_POST['Location'] = $_SESSION['Items']->Location;
350 label_cell(_("Delivery From"), "class='tableheader2'");
351 locations_list_cells(null, 'Location', null, false, true);
353 if (!isset($_POST['ship_via'])) {
354 $_POST['ship_via'] = $_SESSION['Items']->ship_via;
356 label_cell(_("Shipping Method"), "class='tableheader2'");
357 shipping_methods_list_cells(null, 'ship_via', $_POST['ship_via']);
359 // set this up here cuz it's used to calc qoh
360 if (!isset($_POST['DispatchDate']) || !is_date($_POST['DispatchDate'])) {
361 $_POST['DispatchDate'] = new_doc_date();
362 if (!is_date_in_fiscalyear($_POST['DispatchDate'])) {
363 $_POST['DispatchDate'] = end_fiscalyear();
366 date_cells(_("Date"), 'DispatchDate', '', $_SESSION['Items']->trans_no==0, 0, 0, 0, "class='tableheader2'");
371 echo "</td><td>";// outer table
373 start_table(TABLESTYLE, "width='90%'");
375 if (!isset($_POST['due_date']) || !is_date($_POST['due_date'])) {
376 $_POST['due_date'] = get_payment_due_date($_SESSION['Items']->payment, $_POST['DispatchDate']);
378 customer_credit_row($_SESSION['Items']->customer_id, $_SESSION['Items']->credit, "class='tableheader2'");
380 $dim = get_company_pref('use_dimension');
383 label_cell(_("Dimension").":", "class='tableheader2'");
384 dimensions_list_cells(null, 'dimension_id', null, true, ' ', false, 1, false);
388 hidden('dimension_id', 0);
391 label_cell(_("Dimension")." 2:", "class='tableheader2'");
392 dimensions_list_cells(null, 'dimension2_id', null, true, ' ', false, 2, false);
396 hidden('dimension2_id', 0);
399 date_cells(_("Invoice Dead-line"), 'due_date', '', null, 0, 0, 0, "class='tableheader2'");
404 end_table(1); // outer table
406 $row = get_customer_to_order($_SESSION['Items']->customer_id);
407 if ($row['dissallow_invoices'] == 1)
409 display_error(_("The selected customer account is currently on hold. Please contact the credit control personnel to discuss."));
414 display_heading(_("Delivery Items"));
416 start_table(TABLESTYLE, "width='80%'");
418 $new = $_SESSION['Items']->trans_no==0;
419 $th = array(_("Item Code"), _("Item Description"),
420 $new ? _("Ordered") : _("Max. delivery"), _("Units"), $new ? _("Delivered") : _("Invoiced"),
421 _("This Delivery"), _("Price"), _("Tax Type"), _("Discount"), _("Total"));
427 foreach ($_SESSION['Items']->line_items as $line=>$ln_itm) {
428 if ($ln_itm->quantity==$ln_itm->qty_done) {
429 continue; //this line is fully delivered
431 if(isset($_POST['_Location_update']) || isset($_POST['clear_quantity']) || isset($_POST['reset_quantity'])) {
433 $ln_itm->qty_dispatched = $ln_itm->quantity-$ln_itm->qty_done;
435 // if it's a non-stock item (eg. service) don't show qoh
437 if (has_stock_holding($ln_itm->mb_flag) && $ln_itm->qty_dispatched) {
438 // It's a stock : call get_dispatchable_quantity hook to get which quantity to preset in the
439 // quantity input box. This allows for example a hook to modify the default quantity to what's dispatchable
440 // (if there is not enough in hand), check at other location or other order people etc ...
441 // This hook also returns a 'reason' (css classes) which can be used to theme the row.
443 // FIXME: hook_get_dispatchable definition does not allow qoh checks on transaction level
444 // (but anyway dispatch is checked again later before transaction is saved)
446 $qty = $ln_itm->qty_dispatched;
447 if ($check = check_negative_stock($ln_itm->stock_id, $ln_itm->qty_done-$ln_itm->qty_dispatched, $_POST['Location'], $_POST['DispatchDate']))
448 $qty = $check['qty'];
450 $q_class = hook_get_dispatchable_quantity($ln_itm, $_POST['Location'], $_POST['DispatchDate'], $qty);
452 // Skip line if needed
453 if($q_class === 'skip') continue;
454 if(is_array($q_class)) {
455 list($ln_itm->qty_dispatched, $row_classes) = $q_class;
460 alt_table_row_color($k, $row_classes);
461 view_stock_status_cell($ln_itm->stock_id);
463 if ($ln_itm->descr_editable)
464 text_cells(null, 'Line'.$line.'Desc', $ln_itm->item_description, 30, 50);
466 label_cell($ln_itm->item_description);
468 $dec = get_qty_dec($ln_itm->stock_id);
469 qty_cell($ln_itm->quantity, false, $dec);
470 label_cell($ln_itm->units);
471 qty_cell($ln_itm->qty_done, false, $dec);
473 if(isset($_POST['clear_quantity'])) {
474 $ln_itm->qty_dispatched = 0;
476 $_POST['Line'.$line]=$ln_itm->qty_dispatched; /// clear post so value displayed in the fiel is the 'new' quantity
477 small_qty_cells(null, 'Line'.$line, qty_format($ln_itm->qty_dispatched, $ln_itm->stock_id, $dec), null, null, $dec);
479 $display_discount_percent = percent_format($ln_itm->discount_percent*100) . "%";
481 $line_total = ($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
483 amount_cell($ln_itm->price);
484 label_cell($ln_itm->tax_type_name);
485 label_cell($display_discount_percent, "nowrap align=right");
486 amount_cell($line_total);
491 $_POST['ChargeFreightCost'] = get_post('ChargeFreightCost',
492 price_format($_SESSION['Items']->freight_cost));
497 label_cell(_("Shipping Cost"), "colspan=$colspan align=right");
498 small_amount_cells(null, 'ChargeFreightCost', $_SESSION['Items']->freight_cost);
501 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
503 $display_sub_total = price_format($inv_items_total + input_num('ChargeFreightCost'));
505 label_row(_("Sub-total"), $display_sub_total, "colspan=$colspan align=right","align=right");
507 $taxes = $_SESSION['Items']->get_taxes(input_num('ChargeFreightCost'));
508 $tax_total = display_edit_tax_items($taxes, $colspan, $_SESSION['Items']->tax_included);
510 $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
512 label_row(_("Amount Total"), $display_total, "colspan=$colspan align=right","align=right");
517 display_note(_("Marked items have insufficient quantities in stock as on day of delivery."), 0, 1, "class='stockmankofg'");
519 start_table(TABLESTYLE2);
521 policy_list_row(_("Action For Balance"), "bo_policy", null);
523 textarea_row(_("Memo"), 'Comments', null, 50, 4);
527 submit_center_first('Update', _("Update"),
528 _('Refresh document page'), true);
529 if(isset($_POST['clear_quantity'])) {
530 submit('reset_quantity', _('Reset quantity'), true, _('Refresh document page'));
533 submit('clear_quantity', _('Clear quantity'), true, _('Refresh document page'));
535 submit_center_last('process_delivery', _("Process Dispatch"),
536 _('Check entered data and save document'), 'default');