Added helpers for list editor F4 calls.
[fa-stable.git] / sales / sales_order_entry.php
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU Affero General Public License,
5         AGPL, as published by the Free Software Foundation, either version 
6         3 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/agpl-3.0.html>.
11 ***********************************************************************/
12 //-----------------------------------------------------------------------------
13 //
14 //      Entry/Modify Sales Order
15 //      Entry Direct Delivery
16 //      Entry Direct Invoice
17 //
18
19 $page_security = 1;
20 $path_to_root="..";
21
22 include_once($path_to_root . "/sales/includes/cart_class.inc");
23 include_once($path_to_root . "/includes/session.inc");
24 include_once($path_to_root . "/sales/includes/sales_ui.inc");
25 include_once($path_to_root . "/sales/includes/ui/sales_order_ui.inc");
26 include_once($path_to_root . "/sales/includes/sales_db.inc");
27 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
28 include_once($path_to_root . "/reporting/includes/reporting.inc");
29 $js = '';
30
31 editor_redirect( array(
32         'customer_id' => $path_to_root.'/sales/manage/customers.php?debtor_no='.get_post('customer_id'),
33         'branch_id' => $path_to_root.'/sales/manage/customer_branches.php?branch_id='.get_post('branch_id'),
34         ));
35
36 editor_return( array(
37         'customer_id'=>'customer_id',
38         'branch_id'=>'branch_id'));
39
40 if ($use_popup_windows) {
41         $js .= get_js_open_window(900, 500);
42 }
43
44 if ($use_date_picker) {
45         $js .= get_js_date_picker();
46 }
47
48 if (isset($_GET['NewDelivery']) && is_numeric($_GET['NewDelivery'])) {
49
50         $_SESSION['page_title'] = _("Direct Sales Delivery");
51         create_cart(13, $_GET['NewDelivery']);
52
53 } elseif (isset($_GET['NewInvoice']) && is_numeric($_GET['NewInvoice'])) {
54
55         $_SESSION['page_title'] = _("Direct Sales Invoice");
56         create_cart(10, $_GET['NewInvoice']);
57
58 } elseif (isset($_GET['ModifyOrderNumber']) && is_numeric($_GET['ModifyOrderNumber'])) {
59
60         $help_page_title = _('Modifying Sales Order');
61         $_SESSION['page_title'] = sprintf( _("Modifying Sales Order # %d"), $_GET['ModifyOrderNumber']);
62         create_cart(30, $_GET['ModifyOrderNumber']);
63
64 } elseif (isset($_GET['NewOrder'])) {
65
66         $_SESSION['page_title'] = _("New Sales Order Entry");
67         create_cart(30, 0);
68 }
69
70 page($_SESSION['page_title'], false, false, "", $js);
71 //-----------------------------------------------------------------------------
72
73 if (isset($_GET['AddedID'])) {
74         $order_no = $_GET['AddedID'];
75
76         display_notification_centered(sprintf( _("Order # %d has been entered."),$order_no));
77
78         display_note(get_trans_view_str(30, $order_no, _("&View This Order")));
79         echo '<br>';
80         display_note(print_document_link($order_no, _("&Print This Order"), true, 30));
81
82         hyperlink_params($path_to_root . "/sales/customer_delivery.php",
83                 _("Make &Delivery Against This Order"), "OrderNumber=$order_no");
84
85         hyperlink_params($_SERVER['PHP_SELF'], _("Enter a &New Order"), "NewOrder=0");
86
87         display_footer_exit();
88
89 } elseif (isset($_GET['UpdatedID'])) {
90         $order_no = $_GET['UpdatedID'];
91
92         display_notification_centered(sprintf( _("Order # %d has been updated."),$order_no));
93
94         display_note(get_trans_view_str(30, $order_no, _("&View This Order")));
95         echo '<br>';
96         display_note(print_document_link($order_no, _("&Print This Order"), true, 30));
97
98         hyperlink_params($path_to_root . "/sales/customer_delivery.php",
99                 _("Confirm Order Quantities and Make &Delivery"), "OrderNumber=$order_no");
100
101         hyperlink_params($path_to_root . "/sales/inquiry/sales_orders_view.php",
102                 _("Select A Different &Order"), "OutstandingOnly=1");
103
104         display_footer_exit();
105
106 } elseif (isset($_GET['AddedDN'])) {
107         $delivery = $_GET['AddedDN'];
108
109         display_notification_centered(sprintf(_("Delivery # %d has been entered."),$delivery));
110
111         display_note(get_trans_view_str(13, $delivery, _("&View This Delivery")));
112         echo '<br>';
113         display_note(print_document_link($delivery, _("&Print Delivery Note"), true, 13));
114
115         hyperlink_params($path_to_root . "/sales/customer_invoice.php",
116         _("Make &Invoice Against This Delivery"), "DeliveryNumber=$delivery");
117
118         if ((isset($_GET['Type']) && $_GET['Type'] == 1))
119         hyperlink_params("inquiry/sales_orders_view.php",
120                 _("Enter a New Template &Delivery"), "DeliveryTemplates=Yes");
121         else
122         hyperlink_params($_SERVER['PHP_SELF'], _("Enter a &New Delivery"), "NewDelivery=0");
123
124         display_footer_exit();
125
126 } elseif (isset($_GET['AddedDI'])) {
127         $invoice = $_GET['AddedDI'];
128
129         display_notification_centered(sprintf(_("Invoice # %d has been entered."),$invoice));
130
131         display_note(get_trans_view_str(10, $invoice, _("&View This Invoice")));
132         echo '<br>';
133         display_note(print_document_link($invoice, _("&Print Sales Invoice"), true, 10));
134
135         if ((isset($_GET['Type']) && $_GET['Type'] == 1))
136         hyperlink_params("inquiry/sales_orders_view.php",
137                 _("Enter a &New Template Invoice"), "InvoiceTemplates=Yes");
138         else
139         hyperlink_params($_SERVER['PHP_SELF'], _("Enter a &New Direct Invoice"), "NewInvoice=0");
140
141         display_footer_exit();
142 }
143
144 //-----------------------------------------------------------------------------
145
146 function copy_to_cart()
147 {
148         $cart = &$_SESSION['Items'];
149
150         if ($cart->trans_type!=30) {
151                 $cart->reference = $_POST['ref'];
152         } 
153         $cart->Comments =  $_POST['Comments'];
154
155         $cart->document_date = $_POST['OrderDate'];
156         if ($cart->trans_type == 10)
157                 $cart->cash = $_POST['cash']; 
158         if ($cart->cash) {
159                 $cart->due_date = $cart->document_date;
160                 $cart->phone = $cart->cust_ref = $cart->delivery_address = '';
161                 $cart->freight_cost = 0;
162                 $cart->ship_via = 1;
163                 $cart->deliver_to = '';//$_POST['deliver_to'];
164         } else {
165                 $cart->due_date = $_POST['delivery_date'];
166                 $cart->cust_ref = $_POST['cust_ref'];
167                 $cart->freight_cost = input_num('freight_cost');
168                 $cart->deliver_to = $_POST['deliver_to'];
169                 $cart->delivery_address = $_POST['delivery_address'];
170                 $cart->phone = $_POST['phone'];
171                 $cart->Location = $_POST['Location'];
172                 $cart->ship_via = $_POST['ship_via'];
173         }
174         if (isset($_POST['email']))
175                 $cart->email =$_POST['email'];
176         else
177                 $cart->email = '';
178         $cart->customer_id      = $_POST['customer_id'];
179         $cart->Branch = $_POST['branch_id'];
180         $cart->sales_type = $_POST['sales_type'];
181         // POS
182         if ($cart->trans_type!=30) { // 2008-11-12 Joe Hunt
183                 $cart->dimension_id = $_POST['dimension_id'];
184                 $cart->dimension2_id = $_POST['dimension2_id'];
185         }       
186 }
187
188 //-----------------------------------------------------------------------------
189
190 function copy_from_cart()
191 {
192         $cart = &$_SESSION['Items'];
193         if ($cart->trans_type!=30) {
194                 $_POST['ref'] = $cart->reference;
195         }
196         $_POST['Comments'] = $cart->Comments;
197
198         $_POST['OrderDate'] = $cart->document_date;
199         $_POST['delivery_date'] = $cart->due_date;
200         $_POST['cust_ref'] = $cart->cust_ref;
201         $_POST['freight_cost'] = price_format($cart->freight_cost);
202
203         $_POST['deliver_to'] = $cart->deliver_to;
204         $_POST['delivery_address'] = $cart->delivery_address;
205         $_POST['phone'] = $cart->phone;
206         $_POST['Location'] = $cart->Location;
207         $_POST['ship_via'] = $cart->ship_via;
208
209         $_POST['customer_id'] = $cart->customer_id;
210
211         $_POST['branch_id'] = $cart->Branch;
212         $_POST['sales_type'] = $cart->sales_type;
213         // POS 
214         if ($cart->trans_type == 10)
215                 $_POST['cash'] = $cart->cash;
216         if ($cart->trans_type!=30) { // 2008-11-12 Joe Hunt
217                 $_POST['dimension_id'] = $cart->dimension_id;
218                 $_POST['dimension2_id'] = $cart->dimension2_id;
219         }       
220                 
221 }
222 //--------------------------------------------------------------------------------
223
224 function line_start_focus() {
225   global        $Ajax;
226
227   $Ajax->activate('items_table');
228   set_focus('_stock_id_edit');
229 }
230 //--------------------------------------------------------------------------------
231
232 function can_process() {
233         if (!is_date($_POST['OrderDate'])) {
234                 display_error(_("The entered date is invalid."));
235                 set_focus('OrderDate');
236                 return false;
237         }
238         if ($_SESSION['Items']->trans_type!=30 && !is_date_in_fiscalyear($_POST['OrderDate'])) {
239                 display_error(_("The entered date is not in fiscal year"));
240                 set_focus('OrderDate');
241                 return false;
242         }
243         if (count($_SESSION['Items']->line_items) == 0) {
244                 display_error(_("You must enter at least one non empty item line."));
245                 set_focus('AddItem');
246                 return false;
247         }
248         if ($_SESSION['Items']->cash == 0) {
249         if (strlen($_POST['deliver_to']) <= 1) {
250                 display_error(_("You must enter the person or company to whom delivery should be made to."));
251                 set_focus('deliver_to');
252                 return false;
253         }
254
255                 if (strlen($_POST['delivery_address']) <= 1) {
256                         display_error( _("You should enter the street address in the box provided. Orders cannot be accepted without a valid street address."));
257                         set_focus('delivery_address');
258                         return false;
259                 }
260
261                 if ($_POST['freight_cost'] == "")
262                         $_POST['freight_cost'] = price_format(0);
263
264                 if (!check_num('freight_cost',0)) {
265                         display_error(_("The shipping cost entered is expected to be numeric."));
266                         set_focus('freight_cost');
267                         return false;
268                 }
269                 if (!is_date($_POST['delivery_date'])) {
270                         display_error(_("The delivery date is invalid."));
271                         set_focus('delivery_date');
272                         return false;
273                 }
274                 //if (date1_greater_date2($_SESSION['Items']->document_date, $_POST['delivery_date'])) {
275                 if (date1_greater_date2($_POST['OrderDate'], $_POST['delivery_date'])) {
276                         display_error(_("The requested delivery date is before the date of the order."));
277                         set_focus('delivery_date');
278                         return false;
279                 }
280         }
281         if ($_SESSION['Items']->trans_type != 30 && !references::is_valid($_POST['ref'])) {
282                 display_error(_("You must enter a reference."));
283                 set_focus('ref');
284                 return false;
285         }
286         return true;
287 }
288
289 //-----------------------------------------------------------------------------
290
291 if (isset($_POST['ProcessOrder']) && can_process()) {
292         copy_to_cart();
293
294         $modified = ($_SESSION['Items']->trans_no != 0);
295         $so_type = $_SESSION['Items']->so_type;
296         $_SESSION['Items']->write(1);
297         if (count($messages)) { // abort on failure or error messages are lost
298                 $Ajax->activate('_page_body');
299                 display_footer_exit();
300         }
301         $trans_no = key($_SESSION['Items']->trans_no);
302         $trans_type = $_SESSION['Items']->trans_type;
303
304         processing_end();
305         if ($modified) {
306                 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$trans_no");
307         } elseif ($trans_type == 30) {
308                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$trans_no");
309         } elseif ($trans_type == 10) {
310                 meta_forward($_SERVER['PHP_SELF'], "AddedDI=$trans_no&Type=$so_type");
311         } else {
312                 meta_forward($_SERVER['PHP_SELF'], "AddedDN=$trans_no&Type=$so_type");
313         }
314 }
315
316 //--------------------------------------------------------------------------------
317
318 function check_item_data()
319 {
320         if (!check_num('qty', 0) || !check_num('Disc', 0, 100)) {
321                 display_error( _("The item could not be updated because you are attempting to set the quantity ordered to less than 0, or the discount percent to more than 100."));
322                 set_focus('qty');
323                 return false;
324         } elseif (!check_num('price', 0)) {
325                 display_error( _("Price for item must be entered and can not be less than 0"));
326                 set_focus('price');
327                 return false;
328         } elseif (isset($_POST['LineNo']) && isset($_SESSION['Items']->line_items[$_POST['LineNo']])
329             && !check_num('qty', $_SESSION['Items']->line_items[$_POST['LineNo']]->qty_done)) {
330
331                 set_focus('qty');
332                 display_error(_("You attempting to make the quantity ordered a quantity less than has already been delivered. The quantity delivered cannot be modified retrospectively."));
333                 return false;
334         } // Joe Hunt added 2008-09-22 -------------------------
335         elseif ($_SESSION['Items']->trans_type!=30 && !sys_prefs::allow_negative_stock() &&
336                 is_inventory_item($_POST['stock_id']))
337         {
338                 $qoh = get_qoh_on_date($_POST['stock_id'], $_POST['Location'], $_POST['OrderDate']);
339                 if (input_num('qty') > $qoh)
340                 {
341                         $stock = get_item($_POST['stock_id']);
342                         display_error(_("The delivery cannot be processed because there is an insufficient quantity for item:") .
343                                 " " . $stock['stock_id'] . " - " . $stock['description'] . " - " .
344                                 _("Quantity On Hand") . " = " . number_format2($qoh, get_qty_dec($_POST['stock_id'])));
345                         return false;
346                 }
347                 return true;
348         }
349         return true;
350 }
351
352 //--------------------------------------------------------------------------------
353
354 function handle_update_item()
355 {
356         if ($_POST['UpdateItem'] != '' && check_item_data()) {
357                 $_SESSION['Items']->update_cart_item($_POST['LineNo'],
358                  input_num('qty'), input_num('price'),
359                  input_num('Disc') / 100 );
360         }
361   line_start_focus();
362 }
363
364 //--------------------------------------------------------------------------------
365
366 function handle_delete_item($line_no)
367 {
368     if ($_SESSION['Items']->some_already_delivered($line_no) == 0) {
369             $_SESSION['Items']->remove_from_cart($line_no);
370     } else {
371         display_error(_("This item cannot be deleted because some of it has already been delivered."));
372     }
373     line_start_focus();
374 }
375
376 //--------------------------------------------------------------------------------
377
378 function handle_new_item()
379 {
380
381         if (!check_item_data()) {
382                         return;
383         }
384         add_to_order($_SESSION['Items'], $_POST['stock_id'], input_num('qty'),
385                 input_num('price'), input_num('Disc') / 100);
386         $_POST['_stock_id_edit'] = $_POST['stock_id']   = "";
387         line_start_focus();
388 }
389
390 //--------------------------------------------------------------------------------
391
392 function  handle_cancel_order()
393 {
394         global $path_to_root, $Ajax;
395
396
397         if ($_SESSION['Items']->trans_type == 13) {
398                         display_note(_("Direct delivery entry has been cancelled as requested."), 1);
399                         hyperlink_params($path_to_root . "/sales/sales_order_entry.php",
400                                         _("Enter a New Sales Delivery"), SID . "&NewDelivery=0");
401         } elseif ($_SESSION['Items']->trans_type == 10) {
402                         display_note(_("Direct invoice entry has been cancelled as requested."), 1);
403                         hyperlink_params($path_to_root . "/sales/sales_order_entry.php",
404                                         _("Enter a New Sales Delivery"), SID . "&NewDelivery=0");
405         } else {
406                 if ($_SESSION['Items']->trans_no != 0) {
407                         if (sales_order_has_deliveries(key($_SESSION['Items']->trans_no)))
408                                 display_error(_("This order cannot be cancelled because some of it has already been invoiced or dispatched. However, the line item quantities may be modified."));
409                         else {
410                                 delete_sales_order(key($_SESSION['Items']->trans_no));
411
412                         display_note(_("This sales order has been cancelled as requested."), 1);
413                                 hyperlink_params($path_to_root . "/sales/sales_order_entry.php",
414                                 _("Enter a New Sales Order"), SID . "&NewOrder=Yes");
415                         }
416                 } else {
417                         processing_end();
418                         meta_forward($path_to_root.'/index.php?application=orders');
419                 }
420         }
421         $Ajax->activate('_page_body');
422         processing_end();
423         br(1);
424         end_page();
425         exit;
426 }
427
428 //--------------------------------------------------------------------------------
429
430 function create_cart($type, $trans_no)
431 {
432         processing_start();
433         $doc_type = $type;
434
435         if($type != 30 && $trans_no != 0) { // this is template
436                 $doc_type = 30;
437
438                 $doc = new Cart(30, array($trans_no));
439                 $doc->trans_type = $type;
440                 $doc->trans_no = 0;
441                 $doc->document_date = Today(); // 2006-06-15. Added so Invoices and Deliveries get current day
442                 if ($type == 10) {
443                         $doc->due_date = get_invoice_duedate($doc->customer_id, $doc->document_date);
444                         $doc->pos = user_pos();
445                         $pos = get_sales_point($doc->pos);
446                         $doc->cash = $pos['cash_sale'];
447                         if (!$pos['cash_sale'] || !$pos['credit_sale']) 
448                                 $doc->pos = -1; // mark not editable payment type
449                         else
450                                 $doc->cash = date_diff($doc->due_date, Today(), 'd')<2;
451                 } else
452                         $doc->due_date = $doc->document_date;
453                 $doc->reference = references::get_next($doc->trans_type);
454                 $doc->Comments='';
455                 foreach($doc->line_items as $line_no => $line) {
456                         $doc->line_items[$line_no]->qty_done = 0;
457                 }
458                 $_SESSION['Items'] = $doc;
459         } else
460                 $_SESSION['Items'] = new Cart($type,array($trans_no));
461         copy_from_cart();
462 }
463
464 //--------------------------------------------------------------------------------
465
466 if (isset($_POST['CancelOrder']))
467         handle_cancel_order();
468
469 $id = find_submit('Delete');
470 if ($id!=-1)
471         handle_delete_item($id);
472
473 if (isset($_POST['UpdateItem']))
474         handle_update_item();
475
476 if (isset($_POST['AddItem']))
477         handle_new_item();
478
479 if (isset($_POST['CancelItemChanges'])) {
480         line_start_focus();
481 }
482
483 //--------------------------------------------------------------------------------
484 check_db_has_stock_items(_("There are no inventory items defined in the system."));
485
486 check_db_has_customer_branches(_("There are no customers, or there are no customers with branches. Please define customers and customer branches."));
487
488 if ($_SESSION['Items']->trans_type == 10) {
489         $idate = _("Invoice Date:");
490         $orderitems = _("Sales Invoice Items");
491         $deliverydetails = _("Enter Delivery Details and Confirm Invoice");
492         $cancelorder = _("Cancel Invoice");
493         $porder = _("Place Invoice");
494 } elseif ($_SESSION['Items']->trans_type == 13) {
495         $idate = _("Delivery Date:");
496         $orderitems = _("Delivery Note Items");
497         $deliverydetails = _("Enter Delivery Details and Confirm Dispatch");
498         $cancelorder = _("Cancel Delivery");
499         $porder = _("Place Delivery");
500 } else {
501         $idate = _("Order Date:");
502         $orderitems = _("Sales Order Items");
503         $deliverydetails = _("Enter Delivery Details and Confirm Order");
504         $cancelorder = _("Cancel Order");
505         $porder = _("Place Order");
506         $corder = _("Commit Order Changes");
507 }
508 start_form(false, true);
509
510 $customer_error = display_order_header($_SESSION['Items'],
511         ($_SESSION['Items']->any_already_delivered() == 0), $idate);
512
513 if ($customer_error == "") {
514         start_table("$table_style width=80%", 10);
515         echo "<tr><td>";
516         display_order_summary($orderitems, $_SESSION['Items'], true);
517         echo "</td></tr>";
518         echo "<tr><td>";
519         display_delivery_details($_SESSION['Items']);
520         echo "</td></tr>";
521         end_table(1);
522
523         if ($_SESSION['Items']->trans_no == 0) {
524
525                 submit_center_first('ProcessOrder', $porder,
526                     _('Check entered data and save document'), true, ICON_OK);
527         } else {
528                 submit_center_first('ProcessOrder', $corder,
529                     _('Validate changes and update document'), true, ICON_OK);
530         }
531
532         submit_center_last('CancelOrder', $cancelorder,
533            _('Cancels document entry or removes sales order when editing an old document'),
534            true, ICON_CANCEL);
535 } else {
536         display_error($customer_error);
537 }
538 end_form();
539 end_page();
540
541 ?>