admin/void_transaction.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 $page_security = 'SA_VOIDTRANSACTION';
  13 $path_to_root = "..";
  14 include($path_to_root . "/includes/db_pager.inc");
  15 include_once($path_to_root . "/includes/session.inc");
  16
  17 include_once($path_to_root . "/includes/date_functions.inc");
  18 include_once($path_to_root . "/includes/ui.inc");
  19 include_once($path_to_root . "/includes/data_checks.inc");
  20 include_once($path_to_root . "/admin/db/transactions_db.inc");
  21
  22 include_once($path_to_root . "/admin/db/voiding_db.inc");
  23 $js = "";
  24 if ($use_date_picker)
  25         $js .= get_js_date_picker();
  26 if ($use_popup_windows)
  27         $js .= get_js_open_window(800, 500);
  28
  29 page(_($help_context = "Void a Transaction"), false, false, "", $js);
  30
  31 simple_page_mode(true);
  32 //----------------------------------------------------------------------------------------
  33 function exist_transaction($type, $type_no)
  34 {
  35         $void_entry = get_voided_entry($type, $type_no);
  36
  37         if ($void_entry != null)
  38                 return false;
  39
  40         switch ($type)
  41         {
  42                 case ST_JOURNAL : // it's a journal entry
  43                         if (!exists_gl_trans($type, $type_no))
  44                                 return false;
  45                         break;
  46
  47                 case ST_BANKPAYMENT : // it's a payment
  48                 case ST_BANKDEPOSIT : // it's a deposit
  49                 case ST_BANKTRANSFER : // it's a transfer
  50                         if (!exists_bank_trans($type, $type_no))
  51                                 return false;
  52                         break;
  53
  54                 case ST_SALESINVOICE : // it's a customer invoice
  55                 case ST_CUSTCREDIT : // it's a customer credit note
  56                 case ST_CUSTPAYMENT : // it's a customer payment
  57                 case ST_CUSTDELIVERY : // it's a customer dispatch
  58                         if (!exists_customer_trans($type, $type_no))
  59                                 return false;
  60                         break;
  61
  62                 case ST_LOCTRANSFER : // it's a stock transfer
  63                         if (get_stock_transfer_items($type_no) == null)
  64                                 return false;
  65                         break;
  66
  67                 case ST_INVADJUST : // it's a stock adjustment
  68                         if (get_stock_adjustment_items($type_no) == null)
  69                                 return false;
  70                         break;
  71
  72                 case ST_PURCHORDER : // it's a PO
  73                 case ST_SUPPRECEIVE : // it's a GRN
  74                         return false;
  75                 case ST_SUPPINVOICE : // it's a suppler invoice
  76                 case ST_SUPPCREDIT : // it's a supplier credit note
  77                 case ST_SUPPAYMENT : // it's a supplier payment
  78                         if (!exists_supp_trans($type, $type_no))
  79                                 return false;
  80                         break;
  81
  82                 case ST_WORKORDER : // it's a work order
  83                         if (!get_work_order($type_no, true))
  84                                 return false;
  85                         break;
  86
  87                 case ST_MANUISSUE : // it's a work order issue
  88                         if (!exists_work_order_issue($type_no))
  89                                 return false;
  90                         break;
  91
  92                 case ST_MANURECEIVE : // it's a work order production
  93                         if (!exists_work_order_produce($type_no))
  94                                 return false;
  95                         break;
  96
  97                 case ST_SALESORDER: // it's a sales order
  98                 case ST_SALESQUOTE: // it's a sales quotation
  99                         return false;
 100                 case ST_COSTUPDATE : // it's a stock cost update
 101                         return false;
 102                         break;
 103         }
 104
 105         return true;
 106 }
 107
 108 function view_link($trans)
 109 {
 110         if (!isset($trans['type']))
 111                 $trans['type'] = $_POST['filterType'];
 112         return get_trans_view_str($trans["type"], $trans["trans_no"]);
 113 }
 114
 115 function select_link($row)
 116 {
 117         if (!isset($row['type']))
 118                 $row['type'] = $_POST['filterType'];
 119         return button('Edit'.$row["trans_no"], _("Select"), _("Select"), ICON_EDIT);
 120 }
 121
 122 function gl_view($row)
 123 {
 124         if (!isset($row['type']))
 125                 $row['type'] = $_POST['filterType'];
 126         return get_gl_view_str($row["type"], $row["trans_no"]);
 127 }
 128
 129 function date_view($row)
 130 {
 131         return $row['trans_date'];
 132 }
 133
 134 function ref_view($row)
 135 {
 136         return $row['ref'];
 137 }
 138
 139 function voiding_controls()
 140 {
 141         global $selected_id;
 142
 143         $not_implemented =  array(ST_PURCHORDER, ST_SUPPRECEIVE, ST_SALESORDER,
 144                 ST_SALESQUOTE, ST_COSTUPDATE);
 145
 146         start_form();
 147
 148     start_table(TABLESTYLE_NOBORDER);
 149         start_row();
 150
 151         systypes_list_cells(_("Transaction Type:"), 'filterType', null, true, $not_implemented);
 152         if (list_updated('filterType'))
 153                 $selected_id = -1;
 154
 155         end_row();
 156     end_table(1);
 157
 158         $trans_ref = false;
 159         $sql = get_sql_for_view_transactions($_POST['filterType'], null, null, $trans_ref);
 160         if ($sql == "")
 161                 return;
 162
 163         $cols = array(
 164                 _("#") => array('insert'=>true, 'fun'=>'view_link'),
 165                 _("Reference") => array('fun'=>'ref_view'),
 166                 _("Date") => array('type'=>'date', 'fun'=>'date_view'),
 167                 _("GL") => array('insert'=>true, 'fun'=>'gl_view'),
 168                 _("Select") => array('insert'=>true, 'fun'=>'select_link')
 169         );
 170
 171         $table =& new_db_pager('transactions', $sql, $cols);
 172         $table->width = "40%";
 173         display_db_pager($table);
 174
 175         start_table(TABLESTYLE2);
 176
 177         if ($selected_id != -1)
 178         {
 179                 hidden('trans_no', $selected_id);
 180                 hidden('selected_id', $selected_id);
 181         }
 182         else
 183         {
 184                 hidden('trans_no', '');
 185                 $_POST['memo_'] = '';
 186         }
 187     label_row(_("Transaction #:"), ($selected_id==-1?'':$selected_id));
 188
 189     date_row(_("Voiding Date:"), 'date_');
 190
 191     textarea_row(_("Memo:"), 'memo_', null, 30, 4);
 192
 193         end_table(1);
 194
 195     if (!isset($_POST['ProcessVoiding']))
 196         submit_center('ProcessVoiding', _("Void Transaction"), true, '', 'default');
 197     else
 198     {
 199                 if (!exist_transaction($_POST['filterType'],$_POST['trans_no']))
 200                 {
 201                         display_error(_("The entered transaction does not exist or cannot be voided."));
 202                         unset($_POST['trans_no']);
 203                         unset($_POST['memo_']);
 204                         unset($_POST['date_']);
 205                 submit_center('ProcessVoiding', _("Void Transaction"), true, '', 'default');
 206                 }
 207                 else
 208                 {
 209                 display_warning(_("Are you sure you want to void this transaction ? This action cannot be undone."), 0, 1);
 210                         br();
 211                 submit_center_first('ConfirmVoiding', _("Proceed"), '', true);
 212                 submit_center_last('CancelVoiding', _("Cancel"), '', 'cancel');
 213         }
 214     }
 215
 216         end_form();
 217 }
 218
 219 //----------------------------------------------------------------------------------------
 220
 221 function check_valid_entries()
 222 {
 223         if (is_closed_trans($_POST['filterType'],$_POST['trans_no']))
 224         {
 225                 display_error(_("The selected transaction was closed for edition and cannot be voided."));
 226                 set_focus('trans_no');
 227                 return;
 228         }
 229         if (!is_date($_POST['date_']))
 230         {
 231                 display_error(_("The entered date is invalid."));
 232                 set_focus('date_');
 233                 return false;
 234         }
 235         if (!is_date_in_fiscalyear($_POST['date_']))
 236         {
 237                 display_error(_("The entered date is not in fiscal year."));
 238                 set_focus('date_');
 239                 return false;
 240         }
 241
 242         if (!is_numeric($_POST['trans_no']) OR $_POST['trans_no'] <= 0)
 243         {
 244                 display_error(_("The transaction number is expected to be numeric and greater than zero."));
 245                 set_focus('trans_no');
 246                 return false;
 247         }
 248
 249         return true;
 250 }
 251
 252 //----------------------------------------------------------------------------------------
 253
 254 function handle_void_transaction()
 255 {
 256         if (check_valid_entries()==true)
 257         {
 258                 $void_entry = get_voided_entry($_POST['filterType'], $_POST['trans_no']);
 259                 if ($void_entry != null)
 260                 {
 261                         display_error(_("The selected transaction has already been voided."), true);
 262                         unset($_POST['trans_no']);
 263                         unset($_POST['memo_']);
 264                         unset($_POST['date_']);
 265                         set_focus('trans_no');
 266                         return;
 267                 }
 268
 269                 $ret = void_transaction($_POST['filterType'], $_POST['trans_no'],
 270                         $_POST['date_'], $_POST['memo_']);
 271
 272                 if ($ret)
 273                 {
 274                         display_notification_centered(_("Selected transaction has been voided."));
 275                         unset($_POST['trans_no']);
 276                         unset($_POST['memo_']);
 277                         unset($_POST['date_']);
 278                 }
 279                 else {
 280                         display_error(_("The entered transaction does not exist or cannot be voided."));
 281                         set_focus('trans_no');
 282
 283                 }
 284         }
 285 }
 286
 287 //----------------------------------------------------------------------------------------
 288
 289 if (!isset($_POST['date_']))
 290 {
 291         $_POST['date_'] = Today();
 292         if (!is_date_in_fiscalyear($_POST['date_']))
 293                 $_POST['date_'] = end_fiscalyear();
 294 }
 295
 296 if (isset($_POST['ProcessVoiding']))
 297 {
 298         if (!check_valid_entries())
 299                 unset($_POST['ProcessVoiding']);
 300         $Ajax->activate('_page_body');
 301 }
 302
 303 if (isset($_POST['ConfirmVoiding']))
 304 {
 305         handle_void_transaction();
 306         $Ajax->activate('_page_body');
 307 }
 308
 309 if (isset($_POST['CancelVoiding']))
 310 {
 311         $selected_id = -1;
 312         $Ajax->activate('_page_body');
 313 }
 314
 315 //----------------------------------------------------------------------------------------
 316
 317 voiding_controls();
 318
 319 end_page();
 320
 321 ?>