Merged changes up to 2.3.16 into unstable
[fa-stable.git] / purchasing / supplier_credit.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_SUPPLIERCREDIT';
13 $path_to_root = "..";
14
15 include_once($path_to_root . "/purchasing/includes/supp_trans_class.inc");
16
17 include_once($path_to_root . "/includes/session.inc");
18
19 include_once($path_to_root . "/includes/data_checks.inc");
20
21 include_once($path_to_root . "/purchasing/includes/purchasing_db.inc");
22 include_once($path_to_root . "/purchasing/includes/purchasing_ui.inc");
23 $js = "";
24 if ($use_popup_windows)
25         $js .= get_js_open_window(900, 500);
26 if ($use_date_picker)
27         $js .= get_js_date_picker();
28
29 //----------------------------------------------------------------------------------------
30
31 check_db_has_suppliers(_("There are no suppliers defined in the system."));
32
33 if (isset($_GET['ModifyCredit']))
34         check_is_editable(ST_SUPPINVOICE, $_GET['ModifyCredit']);
35
36 //---------------------------------------------------------------------------------------------------
37
38 if (isset($_GET['New']))
39 {
40         if (isset( $_SESSION['supp_trans']))
41         {
42                 unset ($_SESSION['supp_trans']->grn_items);
43                 unset ($_SESSION['supp_trans']->gl_codes);
44                 unset ($_SESSION['supp_trans']);
45         }
46
47         if (isset($_GET['invoice_no']))
48         {
49                 $_SESSION['supp_trans'] = new supp_trans(ST_SUPPINVOICE, $_GET['invoice_no']);
50                 $_SESSION['supp_trans']->src_doc = $_GET['invoice_no'];
51
52
53                 $_SESSION['supp_trans']->trans_type = ST_SUPPCREDIT;
54                 $_SESSION['supp_trans']->trans_no = 0;
55                 $_SESSION['supp_trans']->supp_reference = '';
56                 //              $_SESSION['supp_trans']->supp_reference = $_POST['invoice_no'] = $_GET['invoice_no'];
57                 $help_context = "Supplier Credit Note";
58                 $_SESSION['page_title'] = _("Supplier Credit Note");
59
60                 $_SESSION['supp_trans'] = new supp_trans(ST_SUPPCREDIT);
61         } elseif (isset($_GET['ModifyInvoice'])) {
62                 $help_context = 'Modifying Purchase Invoice';
63                 $_SESSION['page_title'] = sprintf( _("Modifying Supplier Credit # %d"), $_GET['ModifyCredit']);
64                 $_SESSION['supp_trans'] = new supp_trans(ST_SUPPCREDIT, $_GET['ModifyCredit']);
65         }
66 }
67 page($_SESSION['page_title'], false, false, "", $js);
68
69 //---------------------------------------------------------------------------------------------------------------
70
71 if (isset($_GET['AddedID'])) 
72 {
73         $invoice_no = $_GET['AddedID'];
74         $trans_type = ST_SUPPCREDIT;
75
76
77     echo "<center>";
78     display_notification_centered(_("Supplier credit note has been processed."));
79     display_note(get_trans_view_str($trans_type, $invoice_no, _("View this Credit Note")));
80
81         display_note(get_gl_view_str($trans_type, $invoice_no, _("View the GL Journal Entries for this Credit Note")), 1);
82
83     hyperlink_params($_SERVER['PHP_SELF'], _("Enter Another Credit Note"), "New=1");
84         hyperlink_params("$path_to_root/admin/attachments.php", _("Add an Attachment"), "filterType=$trans_type&trans_no=$invoice_no");
85
86         display_footer_exit();
87 }
88
89 function clear_fields()
90 {
91         global $Ajax;
92         
93         unset($_POST['gl_code']);
94         unset($_POST['dimension_id']);
95         unset($_POST['dimension2_id']);
96         unset($_POST['amount']);
97         unset($_POST['memo_']);
98         unset($_POST['AddGLCodeToTrans']);
99         $Ajax->activate('gl_items');
100         set_focus('gl_code');
101 }
102 //------------------------------------------------------------------------------------------------
103 //      GL postings are often entered in the same form to two accounts
104 //  so fileds are cleared only on user demand.
105 //
106 if (isset($_POST['ClearFields']))
107 {
108         clear_fields();
109 }
110
111 if (isset($_POST['AddGLCodeToTrans'])) {
112
113         $Ajax->activate('gl_items');
114         $input_error = false;
115
116         $result = get_gl_account_info($_POST['gl_code']);
117         if (db_num_rows($result) == 0)
118         {
119                 display_error(_("The account code entered is not a valid code, this line cannot be added to the transaction."));
120                 set_focus('gl_code');
121                 $input_error = true;
122         }
123         else
124         {
125                 $myrow = db_fetch_row($result);
126                 $gl_act_name = $myrow[1];
127                 if (!check_num('amount'))
128                 {
129                         display_error(_("The amount entered is not numeric. This line cannot be added to the transaction."));
130                         set_focus('amount');
131                         $input_error = true;
132                 }
133         }
134
135         if (!is_tax_gl_unique(get_post('gl_code'))) {
136                 display_error(_("Cannot post to GL account used by more than one tax type."));
137                 set_focus('gl_code');
138                 $input_error = true;
139         }
140
141         if ($input_error == false)
142         {
143                 $_SESSION['supp_trans']->add_gl_codes_to_trans($_POST['gl_code'], $gl_act_name,
144                         $_POST['dimension_id'], $_POST['dimension2_id'], 
145                         input_num('amount'), $_POST['memo_']);
146                 set_focus('gl_code');
147         }
148 }
149
150
151 //---------------------------------------------------------------------------------------------------
152
153 function check_data()
154 {
155         global $total_grn_value, $total_gl_value, $Refs, $SysPrefs;
156
157         if (!$_SESSION['supp_trans']->is_valid_trans_to_post())
158         {
159                 display_error(_("The credit note cannot be processed because the there are no items or values on the invoice.  Credit notes are expected to have a charge."));
160                 set_focus('');
161                 return false;
162         }
163
164         if (!$Refs->is_valid($_SESSION['supp_trans']->reference)) 
165         {
166                 display_error(_("You must enter an credit note reference."));
167                 set_focus('reference');
168                 return false;
169         }
170
171         if (!is_new_reference($_SESSION['supp_trans']->reference, ST_SUPPCREDIT, $_SESSION['supp_trans']->trans_no))
172         {
173                 display_error(_("The entered reference is already in use."));
174                 set_focus('reference');
175                 return false;
176         }
177
178         if (!$Refs->is_valid($_SESSION['supp_trans']->supp_reference)) 
179         {
180                 display_error(_("You must enter a supplier's credit note reference."));
181                 set_focus('supp_reference');
182                 return false;
183         }
184
185         if (!is_date($_SESSION['supp_trans']->tran_date))
186         {
187                 display_error(_("The credit note as entered cannot be processed because the date entered is not valid."));
188                 set_focus('tran_date');
189                 return false;
190         } 
191         elseif (!is_date_in_fiscalyear($_SESSION['supp_trans']->tran_date)) 
192         {
193                 display_error(_("The entered date is out of fiscal year or is closed for further data entry."));
194                 set_focus('tran_date');
195                 return false;
196         }
197         if (!is_date( $_SESSION['supp_trans']->due_date))
198         {
199                 display_error(_("The invoice as entered cannot be processed because the due date is in an incorrect format."));
200                 set_focus('due_date');
201                 return false;
202         }
203
204         if ($_SESSION['supp_trans']->ov_amount < ($total_gl_value + $total_grn_value))
205         {
206                 display_error(_("The credit note total as entered is less than the sum of the the general ledger entires (if any) and the charges for goods received. There must be a mistake somewhere, the credit note as entered will not be processed."));
207                 return false;
208         }
209
210         if (!$SysPrefs->allow_negative_stock()) {
211                 foreach ($_SESSION['supp_trans']->grn_items as $n => $item) {
212                         if (is_inventory_item($item->item_code))
213                         {
214                                 $qoh = get_qoh_on_date($item->item_code, null, $_SESSION['supp_trans']->tran_date);
215                                 if ($item->this_quantity_inv > $qoh)
216                                 {
217                                         $stock = get_item($item->item_code);
218                                         display_error(_("The return cannot be processed because there is an insufficient quantity for item:") .
219                                                 " " . $stock['stock_id'] . " - " . $stock['description'] . " - " .
220                                                 _("Quantity On Hand") . " = " . number_format2($qoh, get_qty_dec($stock['stock_id'])));
221                                         return false;
222                                 }
223                         }
224                 }
225         }
226         return true;
227 }
228
229 //---------------------------------------------------------------------------------------------------
230
231 function handle_commit_credit_note()
232 {
233         copy_to_trans($_SESSION['supp_trans']);
234
235         if (!check_data())
236                 return;
237
238         if (isset($_POST['invoice_no']))
239                 $invoice_no = add_supp_invoice($_SESSION['supp_trans'], $_POST['invoice_no']);
240         else
241                 $invoice_no = add_supp_invoice($_SESSION['supp_trans']);
242
243     $_SESSION['supp_trans']->clear_items();
244     unset($_SESSION['supp_trans']);
245
246         meta_forward($_SERVER['PHP_SELF'], "AddedID=$invoice_no");
247 }
248
249 //--------------------------------------------------------------------------------------------------
250
251 if (isset($_POST['PostCreditNote']))
252 {
253         handle_commit_credit_note();
254 }
255
256 function check_item_data($n)
257 {
258
259         if (!check_num('This_QuantityCredited'.$n, 0))
260         {
261                 display_error(_("The quantity to credit must be numeric and greater than zero."));
262                 set_focus('This_QuantityCredited'.$n);
263                 return false;
264         }
265
266         if (!check_num('ChgPrice'.$n, 0))
267         {
268                 display_error(_("The price is either not numeric or negative."));
269                 set_focus('ChgPrice'.$n);
270                 return false;
271         }
272
273         return true;
274 }
275
276 function commit_item_data($n)
277 {
278         if (check_item_data($n))
279         {
280                 $_SESSION['supp_trans']->add_grn_to_trans($n,
281                 $_POST['po_detail_item'.$n], $_POST['item_code'.$n],
282                 $_POST['item_description'.$n], $_POST['qty_recd'.$n],
283                 $_POST['prev_quantity_inv'.$n], input_num('This_QuantityCredited'.$n),
284                 $_POST['order_price'.$n], input_num('ChgPrice'.$n),
285                 $_POST['std_cost_unit'.$n], "");
286         }
287 }
288
289 //-----------------------------------------------------------------------------------------
290
291 $id = find_submit('grn_item_id');
292 if ($id != -1)
293 {
294         commit_item_data($id);
295 }
296
297 if (isset($_POST['InvGRNAll']))
298 {
299         foreach($_POST as $postkey=>$postval )
300     {
301                 if (strpos($postkey, "qty_recd") === 0)
302                 {
303                         $id = substr($postkey, strlen("qty_recd"));
304                         $id = (int)$id;
305                         commit_item_data($id);
306                 }
307     }
308 }       
309
310
311 //--------------------------------------------------------------------------------------------------
312 $id3 = find_submit('Delete');
313 if ($id3 != -1)
314 {
315         $_SESSION['supp_trans']->remove_grn_from_trans($id3);
316         $Ajax->activate('grn_items');
317         $Ajax->activate('inv_tot');
318 }
319
320 $id4 = find_submit('Delete2');
321 if ($id4 != -1)
322 {
323         $_SESSION['supp_trans']->remove_gl_codes_from_trans($id4);
324         clear_fields();
325         $Ajax->activate('gl_items');
326         $Ajax->activate('inv_tot');
327 }
328 if (isset($_POST['RefreshInquiry']))
329 {
330         $Ajax->activate('grn_items');
331         $Ajax->activate('inv_tot');
332 }
333
334 if (isset($_POST['go']))
335 {
336         $Ajax->activate('gl_items');
337         display_quick_entries($_SESSION['supp_trans'], $_POST['qid'], input_num('totamount'), QE_SUPPINV);
338         $_POST['totamount'] = price_format(0); $Ajax->activate('totamount');
339         $Ajax->activate('inv_tot');
340 }
341
342
343 //--------------------------------------------------------------------------------------------------
344
345 start_form();
346
347 invoice_header($_SESSION['supp_trans']);
348 if ($_POST['supplier_id']=='') 
349         display_error('No supplier found for entered search text');
350 else {
351         $total_grn_value = display_grn_items($_SESSION['supp_trans'], 1);
352
353         $total_gl_value = display_gl_items($_SESSION['supp_trans'], 1);
354
355         div_start('inv_tot');
356         invoice_totals($_SESSION['supp_trans']);
357         div_end();
358 }
359
360 if ($id != -1)
361 {
362         $Ajax->activate('grn_items');
363         $Ajax->activate('inv_tot');
364 }
365
366 if (get_post('AddGLCodeToTrans'))
367         $Ajax->activate('inv_tot');
368
369 br();
370 submit_center('PostCreditNote', _("Enter Credit Note"), true, '', 'default');
371 br();
372
373 end_form();
374 end_page();
375 ?>