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 ($SysPrefs->use_popup_windows) {
  30         $js .= get_js_open_window(900, 500);
  31 }
  32 if (user_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         hyperlink_params("$path_to_root/admin/attachments.php", _("Add an Attachment"), "filterType=$trans_type&trans_no=$credit_no");
  78
  79         display_footer_exit();
  80 } else
  81         check_edit_conflicts(get_post('cart_id'));
  82
  83 //--------------------------------------------------------------------------------
  84
  85 function line_start_focus() {
  86         global $Ajax;
  87         $Ajax->activate('items_table');
  88         set_focus('_stock_id_edit');
  89 }
  90
  91 //-----------------------------------------------------------------------------
  92
  93 function copy_to_cn()
  94 {
  95         $cart = &$_SESSION['Items'];
  96         $cart->Comments = $_POST['CreditText'];
  97         $cart->document_date = $_POST['OrderDate'];
  98         $cart->freight_cost = input_num('ChargeFreightCost');
  99         $cart->Location = (isset($_POST["Location"]) ? $_POST["Location"] : "");
 100         $cart->sales_type = $_POST['sales_type_id'];
 101         if ($cart->trans_no == 0)
 102                 $cart->reference = $_POST['ref'];
 103         $cart->ship_via = $_POST['ShipperID'];
 104         $cart->dimension_id = $_POST['dimension_id'];
 105         $cart->dimension2_id = $_POST['dimension2_id'];
 106 }
 107
 108 //-----------------------------------------------------------------------------
 109
 110 function copy_from_cn()
 111 {
 112         $cart = &$_SESSION['Items'];
 113         $_POST['CreditText'] = $cart->Comments;
 114         $_POST['OrderDate'] = $cart->document_date;
 115         $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
 116         $_POST['Location'] = $cart->Location;
 117         $_POST['sales_type_id'] = $cart->sales_type;
 118         if ($cart->trans_no == 0)
 119                 $_POST['ref'] = $cart->reference;
 120         $_POST['ShipperID'] = $cart->ship_via;
 121         $_POST['dimension_id'] = $cart->dimension_id;
 122         $_POST['dimension2_id'] = $cart->dimension2_id;
 123         $_POST['cart_id'] = $cart->cart_id;
 124 }
 125
 126 //-----------------------------------------------------------------------------
 127
 128 function handle_new_credit($trans_no)
 129 {
 130         processing_start();
 131         $_SESSION['Items'] = new Cart(ST_CUSTCREDIT,$trans_no);
 132         copy_from_cn();
 133 }
 134
 135 //-----------------------------------------------------------------------------
 136
 137 function can_process()
 138 {
 139         global $Refs;
 140
 141         $input_error = 0;
 142
 143         if ($_SESSION['Items']->count_items() == 0 && (!check_num('ChargeFreightCost',0)))
 144                 return false;
 145         if($_SESSION['Items']->trans_no == 0) {
 146             if (!$Refs->is_valid($_POST['ref'], ST_CUSTCREDIT)) {
 147                         display_error( _("You must enter a reference."));
 148                         set_focus('ref');
 149                         $input_error = 1;
 150                 }
 151         }
 152         if (!is_date($_POST['OrderDate'])) {
 153                 display_error(_("The entered date for the credit note is invalid."));
 154                 set_focus('OrderDate');
 155                 $input_error = 1;
 156         } elseif (!is_date_in_fiscalyear($_POST['OrderDate'])) {
 157                 display_error(_("The entered date is out of fiscal year or is closed for further data entry."));
 158                 set_focus('OrderDate');
 159                 $input_error = 1;
 160         }
 161         return ($input_error == 0);
 162 }
 163
 164 //-----------------------------------------------------------------------------
 165
 166 if (isset($_POST['ProcessCredit']) && can_process()) {
 167         copy_to_cn();
 168         if ($_POST['CreditType'] == "WriteOff" && (!isset($_POST['WriteOffGLCode']) ||
 169                 $_POST['WriteOffGLCode'] == '')) {
 170                 display_note(_("For credit notes created to write off the stock, a general ledger account is required to be selected."), 1, 0);
 171                 display_note(_("Please select an account to write the cost of the stock off to, then click on Process again."), 1, 0);
 172                 exit;
 173         }
 174         if (!isset($_POST['WriteOffGLCode'])) {
 175                 $_POST['WriteOffGLCode'] = 0;
 176         }
 177         copy_to_cn();
 178         $credit_no = $_SESSION['Items']->write($_POST['WriteOffGLCode']);
 179         if ($credit_no == -1)
 180         {
 181                 display_error(_("The entered reference is already in use."));
 182                 set_focus('ref');
 183         }
 184         else
 185         {
 186                 new_doc_date($_SESSION['Items']->document_date);
 187                 processing_end();
 188                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
 189         }
 190 } /*end of process credit note */
 191
 192   //-----------------------------------------------------------------------------
 193
 194 function check_item_data()
 195 {
 196         if (!check_num('qty',0)) {
 197                 display_error(_("The quantity must be greater than zero."));
 198                 set_focus('qty');
 199                 return false;
 200         }
 201         if (!check_num('price',0)) {
 202                 display_error(_("The entered price is negative or invalid."));
 203                 set_focus('price');
 204                 return false;
 205         }
 206         if (!check_num('Disc', 0, 100)) {
 207                 display_error(_("The entered discount percent is negative, greater than 100 or invalid."));
 208                 set_focus('Disc');
 209                 return false;
 210         }
 211         return true;
 212 }
 213
 214 //-----------------------------------------------------------------------------
 215
 216 function handle_update_item()
 217 {
 218         if ($_POST['UpdateItem'] != "" && check_item_data()) {
 219                 $_SESSION['Items']->update_cart_item($_POST['line_no'], input_num('qty'),
 220                         input_num('price'), input_num('Disc') / 100);
 221         }
 222     line_start_focus();
 223 }
 224
 225 //-----------------------------------------------------------------------------
 226
 227 function handle_delete_item($line_no)
 228 {
 229         $_SESSION['Items']->remove_from_cart($line_no);
 230     line_start_focus();
 231 }
 232
 233 //-----------------------------------------------------------------------------
 234
 235 function handle_new_item()
 236 {
 237
 238         if (!check_item_data())
 239                 return;
 240
 241         add_to_order($_SESSION['Items'], $_POST['stock_id'], input_num('qty'),
 242                 input_num('price'), input_num('Disc') / 100);
 243     line_start_focus();
 244 }
 245 //-----------------------------------------------------------------------------
 246 $id = find_submit('Delete');
 247 if ($id!=-1)
 248         handle_delete_item($id);
 249
 250 if (isset($_POST['AddItem']))
 251         handle_new_item();
 252
 253 if (isset($_POST['UpdateItem']))
 254         handle_update_item();
 255
 256 if (isset($_POST['CancelItemChanges']))
 257         line_start_focus();
 258
 259 //-----------------------------------------------------------------------------
 260
 261 if (!processing_active()) {
 262         handle_new_credit(0);
 263 }
 264
 265 //-----------------------------------------------------------------------------
 266
 267 start_form();
 268 hidden('cart_id');
 269
 270 $customer_error = display_credit_header($_SESSION['Items']);
 271
 272 if ($customer_error == "") {
 273         start_table(TABLESTYLE, "width='80%'", 10);
 274         echo "<tr><td>";
 275         display_credit_items(_("Credit Note Items"), $_SESSION['Items']);
 276         credit_options_controls($_SESSION['Items']);
 277         echo "</td></tr>";
 278         end_table();
 279 } else {
 280         display_error($customer_error);
 281 }
 282
 283 echo "<br><center><table><tr>";
 284 submit_cells('Update', _("Update"));
 285 submit_cells('ProcessCredit', _("Process Credit Note"), '', false, 'default');
 286 echo "</tr></table></center>";
 287
 288 end_form();
 289 end_page();
 290