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