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';
14 include($path_to_root . "/includes/db_pager.inc");
15 include_once($path_to_root . "/includes/session.inc");
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");
22 include_once($path_to_root . "/admin/db/voiding_db.inc");
24 if (user_use_date_picker())
25 $js .= get_js_date_picker();
26 if ($SysPrefs->use_popup_windows)
27 $js .= get_js_open_window(800, 500);
29 page(_($help_context = "Void a Transaction"), false, false, "", $js);
31 simple_page_mode(true);
32 //----------------------------------------------------------------------------------------
33 function exist_transaction($type, $type_no)
35 $void_entry = get_voided_entry($type, $type_no);
37 if ($void_entry != null)
42 case ST_JOURNAL : // it's a journal entry
43 if (!exists_gl_trans($type, $type_no))
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))
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))
62 case ST_LOCTRANSFER : // it's a stock transfer
63 if (get_stock_transfer_items($type_no) == null)
67 case ST_INVADJUST : // it's a stock adjustment
68 if (get_stock_adjustment_items($type_no) == null)
72 case ST_PURCHORDER : // it's a PO
75 case ST_SUPPRECEIVE : // it's a GRN
76 if (!exists_grn($type_no))
80 case ST_SUPPINVOICE : // it's a suppler invoice
81 case ST_SUPPCREDIT : // it's a supplier credit note
82 case ST_SUPPAYMENT : // it's a supplier payment
83 if (!exists_supp_trans($type, $type_no))
87 case ST_WORKORDER : // it's a work order
88 if (!get_work_order($type_no, true))
92 case ST_MANUISSUE : // it's a work order issue
93 if (!exists_work_order_issue($type_no))
97 case ST_MANURECEIVE : // it's a work order production
98 if (!exists_work_order_produce($type_no))
102 case ST_SALESORDER: // it's a sales order
103 case ST_SALESQUOTE: // it's a sales quotation
105 case ST_COSTUPDATE : // it's a stock cost update
112 function view_link($trans)
114 if (!isset($trans['type']))
115 $trans['type'] = $_POST['filterType'];
116 return get_trans_view_str($trans["type"], $trans["trans_no"]);
119 function select_link($row)
121 if (!isset($row['type']))
122 $row['type'] = $_POST['filterType'];
123 if (!is_date_in_fiscalyear($row['trans_date'], true))
125 return button('Edit'.$row["trans_no"], _("Select"), _("Select"), ICON_EDIT);
128 function gl_view($row)
130 if (!isset($row['type']))
131 $row['type'] = $_POST['filterType'];
132 return get_gl_view_str($row["type"], $row["trans_no"]);
135 function date_view($row)
137 return $row['trans_date'];
140 function ref_view($row)
145 function voiding_controls()
149 $not_implemented = array(ST_PURCHORDER, ST_SALESORDER, ST_SALESQUOTE, ST_COSTUPDATE);
153 start_table(TABLESTYLE_NOBORDER);
156 systypes_list_cells(_("Transaction Type:"), 'filterType', null, true, $not_implemented);
157 if (list_updated('filterType'))
160 if (!isset($_POST['FromTransNo']))
161 $_POST['FromTransNo'] = "1";
162 if (!isset($_POST['ToTransNo']))
163 $_POST['ToTransNo'] = "999999";
165 ref_cells(_("from #:"), 'FromTransNo');
167 ref_cells(_("to #:"), 'ToTransNo');
169 submit_cells('ProcessSearch', _("Search"), '', '', 'default');
175 $sql = get_sql_for_view_transactions(get_post('filterType'), get_post('FromTransNo'), get_post('ToTransNo'), $trans_ref);
180 _("#") => array('insert'=>true, 'fun'=>'view_link'),
181 _("Reference") => array('fun'=>'ref_view'),
182 _("Date") => array('type'=>'date', 'fun'=>'date_view'),
183 _("GL") => array('insert'=>true, 'fun'=>'gl_view'),
184 _("Select") => array('insert'=>true, 'fun'=>'select_link')
187 $table =& new_db_pager('transactions', $sql, $cols);
188 $table->width = "40%";
189 display_db_pager($table);
191 start_table(TABLESTYLE2);
193 if ($selected_id != -1)
195 hidden('trans_no', $selected_id);
196 hidden('selected_id', $selected_id);
200 hidden('trans_no', '');
201 $_POST['memo_'] = '';
203 label_row(_("Transaction #:"), ($selected_id==-1?'':$selected_id));
205 date_row(_("Voiding Date:"), 'date_');
207 textarea_row(_("Memo:"), 'memo_', null, 30, 4);
211 if (!isset($_POST['ProcessVoiding']))
212 submit_center('ProcessVoiding', _("Void Transaction"), true, '', 'default');
215 if (!exist_transaction($_POST['filterType'],$_POST['trans_no']))
217 display_error(_("The entered transaction does not exist or cannot be voided."));
218 unset($_POST['trans_no']);
219 unset($_POST['memo_']);
220 unset($_POST['date_']);
221 submit_center('ProcessVoiding', _("Void Transaction"), true, '', 'default');
225 display_warning(_("Are you sure you want to void this transaction ? This action cannot be undone."), 0, 1);
227 submit_center_first('ConfirmVoiding', _("Proceed"), '', true);
228 submit_center_last('CancelVoiding', _("Cancel"), '', 'cancel');
235 //----------------------------------------------------------------------------------------
237 function check_valid_entries()
239 if (is_closed_trans($_POST['filterType'],$_POST['trans_no']))
241 display_error(_("The selected transaction was closed for edition and cannot be voided."));
242 set_focus('trans_no');
245 if (!is_date($_POST['date_']))
247 display_error(_("The entered date is invalid."));
251 if (!is_date_in_fiscalyear($_POST['date_']))
253 display_error(_("The entered date is out of fiscal year or is closed for further data entry."));
258 if (!is_numeric($_POST['trans_no']) OR $_POST['trans_no'] <= 0)
260 display_error(_("The transaction number is expected to be numeric and greater than zero."));
261 set_focus('trans_no');
268 //----------------------------------------------------------------------------------------
270 function handle_void_transaction()
272 if (check_valid_entries()==true)
274 $void_entry = get_voided_entry($_POST['filterType'], $_POST['trans_no']);
275 if ($void_entry != null)
277 display_error(_("The selected transaction has already been voided."), true);
278 unset($_POST['trans_no']);
279 unset($_POST['memo_']);
280 unset($_POST['date_']);
281 set_focus('trans_no');
285 $msg = void_transaction($_POST['filterType'], $_POST['trans_no'],
286 $_POST['date_'], $_POST['memo_']);
290 display_notification_centered(_("Selected transaction has been voided."));
291 unset($_POST['trans_no']);
292 unset($_POST['memo_']);
293 unset($_POST['date_']);
297 set_focus('trans_no');
303 //----------------------------------------------------------------------------------------
305 if (!isset($_POST['date_']))
307 $_POST['date_'] = Today();
308 if (!is_date_in_fiscalyear($_POST['date_']))
309 $_POST['date_'] = end_fiscalyear();
312 if (isset($_POST['ProcessVoiding']))
314 if (!check_valid_entries())
315 unset($_POST['ProcessVoiding']);
316 $Ajax->activate('_page_body');
319 if (isset($_POST['ConfirmVoiding']))
321 handle_void_transaction();
323 $Ajax->activate('_page_body');
326 if (isset($_POST['CancelVoiding']))
329 $Ajax->activate('_page_body');
332 //----------------------------------------------------------------------------------------