sales/credit_note_entry.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 free hand Credit Note
  15 //
  16 $page_security = 'SA_SALESCREDIT';
  17 $path_to_root = "..";
  18 include_once($path_to_root . "/sales/includes/cart_class.inc");
  19 include_once($path_to_root . "/includes/session.inc");
  20 include_once($path_to_root . "/includes/data_checks.inc");
  21 include_once($path_to_root . "/sales/includes/sales_db.inc");
  22 include_once($path_to_root . "/sales/includes/sales_ui.inc");
  23 include_once($path_to_root . "/sales/includes/db/sales_types_db.inc");
  24 include_once($path_to_root . "/sales/includes/ui/sales_credit_ui.inc");
  25 include_once($path_to_root . "/sales/includes/ui/sales_order_ui.inc");
  26 include_once($path_to_root . "/reporting/includes/reporting.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['NewCredit'])) {
  37         $_SESSION['page_title'] = _($help_context = "Customer Credit Note");
  38         handle_new_credit(0);
  39 } elseif (isset($_GET['ModifyCredit'])) {
  40         $_SESSION['page_title'] = sprintf(_("Modifying Customer Credit Note #%d"), $_GET['ModifyCredit']);
  41         handle_new_credit($_GET['ModifyCredit']);
  42         $help_context = "Modifying Customer Credit Note";
  43 }
  44
  45 page($_SESSION['page_title'],false, false, "", $js);
  46
  47 //-----------------------------------------------------------------------------
  48
  49 check_db_has_stock_items(_("There are no items defined in the system."));
  50
  51 check_db_has_customer_branches(_("There are no customers, or there are no customers with branches. Please define customers and customer branches."));
  52
  53 //-----------------------------------------------------------------------------
  54
  55 if (list_updated('branch_id')) {
  56         // when branch is selected via external editor also customer can change
  57         $br = get_branch(get_post('branch_id'));
  58         $_POST['customer_id'] = $br['debtor_no'];
  59         $Ajax->activate('customer_id');
  60 }
  61
  62 if (isset($_GET['AddedID'])) {
  63         $credit_no = $_GET['AddedID'];
  64         $trans_type = ST_CUSTCREDIT;
  65
  66         display_notification_centered(sprintf(_("Credit Note # %d has been processed"),$credit_no));
  67
  68         display_note(get_customer_trans_view_str($trans_type, $credit_no, _("&View this credit note")), 0, 1);
  69
  70         display_note(print_document_link($credit_no."-".$trans_type, _("&Print This Credit Invoice"), true, ST_CUSTCREDIT),0, 1);
  71         display_note(print_document_link($credit_no."-".$trans_type, _("&Email This Credit Invoice"), true, ST_CUSTCREDIT, false, "printlink", "", 1),0, 1);
  72
  73         display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL &Journal Entries for this Credit Note")));
  74
  75         hyperlink_params($_SERVER['PHP_SELF'], _("Enter Another &Credit Note"), "NewCredit=yes");
  76
  77         display_footer_exit();
  78 } else
  79         check_edit_conflicts();
  80
  81 //--------------------------------------------------------------------------------
  82
  83 function line_start_focus() {
  84   global $Ajax;
  85   $Ajax->activate('items_table');
  86   set_focus('_stock_id_edit');
  87 }
  88
  89 //-----------------------------------------------------------------------------
  90
  91 function copy_to_cn()
  92 {
  93         $cart = &$_SESSION['Items'];
  94         $cart->Comments = $_POST['CreditText'];
  95         $cart->document_date = $_POST['OrderDate'];
  96         $cart->freight_cost = input_num('ChargeFreightCost');
  97         $cart->Location = (isset($_POST["Location"]) ? $_POST["Location"] : "");
  98         $cart->sales_type = $_POST['sales_type_id'];
  99         if ($cart->trans_no == 0)
 100                 $cart->reference = $_POST['ref'];
 101         $cart->ship_via = $_POST['ShipperID'];
 102         $cart->dimension_id = $_POST['dimension_id'];
 103         $cart->dimension2_id = $_POST['dimension2_id'];
 104 }
 105
 106 //-----------------------------------------------------------------------------
 107
 108 function copy_from_cn()
 109 {
 110         $cart = &$_SESSION['Items'];
 111         $_POST['CreditText'] = $cart->Comments;
 112         $_POST['OrderDate'] = $cart->document_date;
 113         $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
 114         $_POST['Location'] = $cart->Location;
 115         $_POST['sales_type_id'] = $cart->sales_type;
 116         if ($cart->trans_no == 0)
 117                 $_POST['ref'] = $cart->reference;
 118         $_POST['ShipperID'] = $cart->ship_via;
 119         $_POST['dimension_id'] = $cart->dimension_id;
 120         $_POST['dimension2_id'] = $cart->dimension2_id;
 121         $_POST['cart_id'] = $cart->cart_id;
 122 }
 123
 124 //-----------------------------------------------------------------------------
 125
 126 function handle_new_credit($trans_no)
 127 {
 128         processing_start();
 129         $_SESSION['Items'] = new Cart(ST_CUSTCREDIT,$trans_no);
 130         copy_from_cn();
 131 }
 132
 133 //-----------------------------------------------------------------------------
 134
 135 function can_process()
 136 {
 137         global $Refs;
 138
 139         $input_error = 0;
 140
 141         if ($_SESSION['Items']->count_items() == 0 && (!check_num('ChargeFreightCost',0)))
 142                 return false;
 143         if($_SESSION['Items']->trans_no == 0) {
 144             if (!$Refs->is_valid($_POST['ref'])) {
 145                 display_error( _("You must enter a reference."));
 146                 set_focus('ref');
 147                 $input_error = 1;
 148             } elseif (!is_new_reference($_POST['ref'], ST_CUSTCREDIT))  {
 149                 display_error( _("The entered reference is already in use."));
 150                 set_focus('ref');
 151                 $input_error = 1;
 152             }
 153         }
 154         if (!is_date($_POST['OrderDate'])) {
 155                 display_error(_("The entered date for the credit note is invalid."));
 156                 set_focus('OrderDate');
 157                 $input_error = 1;
 158         } elseif (!is_date_in_fiscalyear($_POST['OrderDate'])) {
 159                 display_error(_("The entered date is not in fiscal year."));
 160                 set_focus('OrderDate');
 161                 $input_error = 1;
 162         }
 163         return ($input_error == 0);
 164 }
 165
 166 //-----------------------------------------------------------------------------
 167
 168 if (isset($_POST['ProcessCredit']) && can_process()) {
 169         copy_to_cn();
 170         if ($_POST['CreditType'] == "WriteOff" && (!isset($_POST['WriteOffGLCode']) ||
 171                 $_POST['WriteOffGLCode'] == '')) {
 172                 display_note(_("For credit notes created to write off the stock, a general ledger account is required to be selected."), 1, 0);
 173                 display_note(_("Please select an account to write the cost of the stock off to, then click on Process again."), 1, 0);
 174                 exit;
 175
 176         }
 177         if (!isset($_POST['WriteOffGLCode'])) {
 178                 $_POST['WriteOffGLCode'] = 0;
 179         }
 180         copy_to_cn();
 181         $credit_no = $_SESSION['Items']->write($_POST['WriteOffGLCode']);
 182         new_doc_date($_SESSION['Items']->document_date);
 183         processing_end();
 184         meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
 185
 186 } /*end of process credit note */
 187
 188   //-----------------------------------------------------------------------------
 189
 190 function check_item_data()
 191 {
 192         if (!check_num('qty',0)) {
 193                 display_error(_("The quantity must be greater than zero."));
 194                 set_focus('qty');
 195                 return false;
 196         }
 197         if (!check_num('price',0)) {
 198                 display_error(_("The entered price is negative or invalid."));
 199                 set_focus('price');
 200                 return false;
 201         }
 202         if (!check_num('Disc', 0, 100)) {
 203                 display_error(_("The entered discount percent is negative, greater than 100 or invalid."));
 204                 set_focus('Disc');
 205                 return false;
 206         }
 207         return true;
 208 }
 209
 210 //-----------------------------------------------------------------------------
 211
 212 function handle_update_item()
 213 {
 214         if ($_POST['UpdateItem'] != "" && check_item_data()) {
 215                 $_SESSION['Items']->update_cart_item($_POST['line_no'], input_num('qty'),
 216                         input_num('price'), input_num('Disc') / 100);
 217         }
 218     line_start_focus();
 219 }
 220
 221 //-----------------------------------------------------------------------------
 222
 223 function handle_delete_item($line_no)
 224 {
 225         $_SESSION['Items']->remove_from_cart($line_no);
 226     line_start_focus();
 227 }
 228
 229 //-----------------------------------------------------------------------------
 230
 231 function handle_new_item()
 232 {
 233
 234         if (!check_item_data())
 235                 return;
 236
 237         add_to_order($_SESSION['Items'], $_POST['stock_id'], input_num('qty'),
 238                 input_num('price'), input_num('Disc') / 100);
 239     line_start_focus();
 240 }
 241 //-----------------------------------------------------------------------------
 242 $id = find_submit('Delete');
 243 if ($id!=-1)
 244         handle_delete_item($id);
 245
 246 if (isset($_POST['AddItem']))
 247         handle_new_item();
 248
 249 if (isset($_POST['UpdateItem']))
 250         handle_update_item();
 251
 252 if (isset($_POST['CancelItemChanges']))
 253         line_start_focus();
 254
 255 //-----------------------------------------------------------------------------
 256
 257 if (!processing_active()) {
 258         handle_new_credit(0);
 259 }
 260
 261 //-----------------------------------------------------------------------------
 262
 263 start_form();
 264 hidden('cart_id');
 265
 266 $customer_error = display_credit_header($_SESSION['Items']);
 267
 268 if ($customer_error == "") {
 269         start_table(TABLESTYLE, "width=80%", 10);
 270         echo "<tr><td>";
 271         display_credit_items(_("Credit Note Items"), $_SESSION['Items']);
 272         credit_options_controls($_SESSION['Items']);
 273         echo "</td></tr>";
 274         end_table();
 275 } else {
 276         display_error($customer_error);
 277 }
 278
 279 echo "<br><center><table><tr>";
 280 submit_cells('Update', _("Update"));
 281 submit_cells('ProcessCredit', _("Process Credit Note"), '', false, 'default');
 282 echo "</tr></table></center>";
 283
 284 end_form();
 285 end_page();
 286
 287 ?>