Customer Payments, Payments to Supplier: improved readbility and multiply cleanups...
[fa-stable.git] / sales / customer_payments.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_SALESPAYMNT';
13 $path_to_root = "..";
14 include_once($path_to_root . "/includes/ui/allocation_cart.inc");
15 include_once($path_to_root . "/includes/session.inc");
16 include_once($path_to_root . "/includes/date_functions.inc");
17 include_once($path_to_root . "/includes/ui.inc");
18 include_once($path_to_root . "/includes/banking.inc");
19 include_once($path_to_root . "/includes/data_checks.inc");
20 include_once($path_to_root . "/sales/includes/sales_db.inc");
21 include_once($path_to_root . "/reporting/includes/reporting.inc");
22
23 $js = "";
24 if ($use_popup_windows) {
25         $js .= get_js_open_window(900, 500);
26 }
27 if ($use_date_picker) {
28         $js .= get_js_date_picker();
29 }
30 add_js_file('payalloc.js');
31
32 page(_($help_context = "Customer Payment Entry"), false, false, "", $js);
33
34 //----------------------------------------------------------------------------------------------
35
36 check_db_has_customers(_("There are no customers defined in the system."));
37
38 check_db_has_bank_accounts(_("There are no bank accounts defined in the system."));
39
40 //----------------------------------------------------------------------------------------
41 if (isset($_GET['customer_id']))
42 {
43         $_POST['customer_id'] = $_GET['customer_id'];
44 }
45
46 if (!isset($_POST['bank_account'])) { // first page call
47         $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT, 0, get_post('customer_id'));
48
49         if (isset($_GET['SInvoice'])) {
50                 //  get date and supplier
51                 $inv = get_customer_trans($_GET['SInvoice'], ST_SALESINVOICE);
52                 if($inv) {
53                         $_POST['customer_id'] = $inv['debtor_no'];
54                         $_POST['DateBanked'] = sql2date($inv['tran_date']);
55                         foreach($_SESSION['alloc']->allocs as $line => $trans) {
56                                 if ($trans->type == ST_SALESINVOICE && $trans->type_no == $_GET['SInvoice']) {
57                                         $un_allocated = $trans->amount - $trans->amount_allocated;
58                                         if($un_allocated){
59                                         $_POST['amount'] = $_SESSION['alloc']->amount = 
60 //                                              price_format($trans->amount);
61                                         $_SESSION['alloc']->allocs[$line]->current_allocated =
62 //                                              $trans->amount;
63                                                 price_format($un_allocated);}
64                                         break;
65                                 }
66                         }
67                         unset($inv);
68                 } else
69                         display_error(_("Invalid sales invoice number."));
70         }
71 }
72
73 if (list_updated('BranchID')) {
74         // when branch is selected via external editor also customer can change
75         $br = get_branch(get_post('BranchID'));
76         $_POST['customer_id'] = $br['debtor_no'];
77         $_SESSION['alloc']->person_id = $br['debtor_no'];
78         $Ajax->activate('customer_id');
79 }
80
81 if (!isset($_POST['customer_id'])) {
82         $_SESSION['alloc']->person_id = $_POST['customer_id'] = get_global_customer(false);
83         $_SESSION['alloc']->read();
84 }
85 if (!isset($_POST['DateBanked'])) {
86         $_POST['DateBanked'] = new_doc_date();
87         if (!is_date_in_fiscalyear($_POST['DateBanked'])) {
88                 $_POST['DateBanked'] = end_fiscalyear();
89         }
90 }
91
92
93 if (isset($_GET['AddedID'])) {
94         $payment_no = $_GET['AddedID'];
95
96         display_notification_centered(_("The customer payment has been successfully entered."));
97
98         submenu_print(_("&Print This Receipt"), ST_CUSTPAYMENT, $payment_no."-".ST_CUSTPAYMENT, 'prtopt');
99
100         submenu_view(_("&View this Customer Payment"), ST_CUSTPAYMENT, $payment_no);
101
102         submenu_option(_("Enter Another &Customer Payment"), "/sales/customer_payments.php");
103         submenu_option(_("Enter Other &Deposit"), "/gl/gl_bank.php?NewDeposit=Yes");
104         submenu_option(_("Enter Payment to &Supplier"), "/purchasing/supplier_payment.php");
105         submenu_option(_("Enter Other &Payment"), "/gl/gl_bank.php?NewPayment=Yes");
106         submenu_option(_("Bank Account &Transfer"), "/gl/bank_transfer.php");
107
108         display_note(get_gl_view_str(ST_CUSTPAYMENT, $payment_no, _("&View the GL Journal Entries for this Customer Payment")));
109
110         display_footer_exit();
111 }
112 elseif (isset($_GET['UpdatedID'])) {
113         $payment_no = $_GET['UpdatedID'];
114
115         display_notification_centered(_("The customer payment has been successfully updated."));
116
117         submenu_print(_("&Print This Receipt"), ST_CUSTPAYMENT, $payment_no."-".ST_CUSTPAYMENT, 'prtopt');
118
119         display_note(get_gl_view_str(ST_CUSTPAYMENT, $payment_no, _("&View the GL Journal Entries for this Customer Payment")));
120
121 //      hyperlink_params($path_to_root . "/sales/allocations/customer_allocate.php", _("&Allocate this Customer Payment"), "trans_no=$payment_no&trans_type=12");
122
123         hyperlink_no_params($path_to_root . "/sales/inquiry/customer_inquiry.php?", _("Select Another Customer Payment for &Edition"));
124
125         hyperlink_no_params($path_to_root . "/sales/customer_payments.php", _("Enter Another &Customer Payment"));
126
127         display_footer_exit();
128 }
129
130 //----------------------------------------------------------------------------------------------
131
132 function can_process()
133 {
134         global $Refs;
135
136         if (!get_post('customer_id'))
137         {
138                 display_error(_("There is no customer selected."));
139                 set_focus('customer_id');
140                 return false;
141         } 
142         
143         if (!get_post('BranchID'))
144         {
145                 display_error(_("This customer has no branch defined."));
146                 set_focus('BranchID');
147                 return false;
148         } 
149         
150         if (!isset($_POST['DateBanked']) || !is_date($_POST['DateBanked'])) {
151                 display_error(_("The entered date is invalid. Please enter a valid date for the payment."));
152                 set_focus('DateBanked');
153                 return false;
154         } elseif (!is_date_in_fiscalyear($_POST['DateBanked'])) {
155                 display_error(_("The entered date is not in fiscal year."));
156                 set_focus('DateBanked');
157                 return false;
158         }
159
160         if (!$Refs->is_valid($_POST['ref'])) {
161                 display_error(_("You must enter a reference."));
162                 set_focus('ref');
163                 return false;
164         }
165
166         //Chaitanya : 13-OCT-2011 - To support Edit feature
167         if (isset($_POST['trans_no']) && $_POST['trans_no'] == 0 && (!is_new_reference($_POST['ref'], ST_CUSTPAYMENT))) {
168                 display_error(_("The entered reference is already in use."));
169                 set_focus('ref');
170                 return false;
171         }
172         //Avoid duplicate reference while modifying
173         elseif ($_POST['ref'] != $_POST['old_ref'] && !is_new_reference($_POST['ref'], ST_CUSTPAYMENT))
174         {
175                 display_error( _("The entered reference is already in use."));
176                 set_focus('ref');
177                 return false;
178         }
179
180         if (!check_num('amount', 0)) {
181                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
182                 set_focus('amount');
183                 return false;
184         }
185
186         if (isset($_POST['charge']) && !check_num('charge', 0)) {
187                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
188                 set_focus('charge');
189                 return false;
190         }
191         if (isset($_POST['charge']) && input_num('charge') > 0) {
192                 $charge_acct = get_company_pref('bank_charge_act');
193                 if (get_gl_account($charge_acct) == false) {
194                         display_error(_("The Bank Charge Account has not been set in System and General GL Setup."));
195                         set_focus('charge');
196                         return false;
197                 }       
198         }
199
200 //      if (isset($_POST['_ex_rate']) && !check_num('_ex_rate', 0.000001))
201 //      {
202 //              display_error(_("The exchange rate must be numeric and greater than zero."));
203 //              set_focus('_ex_rate');
204 //              return false;
205 //      }
206
207         if (@$_POST['discount'] == "") 
208         {
209                 $_POST['discount'] = 0;
210         }
211
212         if (!check_num('discount')) {
213                 display_error(_("The entered discount is not a valid number."));
214                 set_focus('discount');
215                 return false;
216         }
217
218         //if ((input_num('amount') - input_num('discount') <= 0)) {
219         if (input_num('amount') <= 0) {
220                 display_error(_("The balance of the amount and discount is zero or negative. Please enter valid amounts."));
221                 set_focus('discount');
222                 return false;
223         }
224
225         if (isset($_POST['bank_amount']) && input_num('bank_amount')<=0)
226         {
227                 display_error(_("The entered payment amount is zero or negative."));
228                 set_focus('bank_amount');
229                 return false;
230         }
231
232         if (!db_has_currency_rates(get_customer_currency($_POST['customer_id']), $_POST['DateBanked'], true))
233                 return false;
234
235         $_SESSION['alloc']->amount = input_num('amount');
236
237         if (isset($_POST["TotalNumberOfAllocs"]))
238                 return check_allocations();
239         else
240                 return true;
241 }
242
243 //----------------------------------------------------------------------------------------------
244
245 if (isset($_POST['_customer_id_button'])) {
246 //      unset($_POST['branch_id']);
247         $Ajax->activate('BranchID');
248 }
249 //if (isset($_POST['_DateBanked_changed'])) {
250 //  $Ajax->activate('_ex_rate');
251 //}
252
253 //----------------------------------------------------------------------------------------------
254
255 if (get_post('AddPaymentItem') && can_process()) {
256
257         new_doc_date($_POST['DateBanked']);
258
259         $new_pmt = !$_SESSION['alloc']->trans_no;
260         //Chaitanya : 13-OCT-2011 - To support Edit feature
261         $payment_no = write_customer_payment($_SESSION['alloc']->trans_no, $_POST['customer_id'], $_POST['BranchID'],
262                 $_POST['bank_account'], $_POST['DateBanked'], $_POST['ref'],
263                 input_num('amount'), input_num('discount'), $_POST['memo_'], 0, input_num('charge'), input_num('bank_amount', input_num('amount')));
264
265         $_SESSION['alloc']->trans_no = $payment_no;
266         $_SESSION['alloc']->write();
267
268         unset($_SESSION['alloc']);
269         meta_forward($_SERVER['PHP_SELF'], $new_pmt ? "AddedID=$payment_no" : "UpdatedID=$payment_no");
270 }
271
272 //----------------------------------------------------------------------------------------------
273
274 function read_customer_data()
275 {
276         global $Refs;
277
278         $myrow = get_customer_habit($_POST['customer_id']);
279
280         $_POST['HoldAccount'] = $myrow["dissallow_invoices"];
281         $_POST['pymt_discount'] = $myrow["pymt_discount"];
282         //Chaitanya : 13-OCT-2011 - To support Edit feature
283         //If page is called first time and New entry fetch the nex reference number
284         if (!$_SESSION['alloc']->trans_no && !isset($_POST['charge'])) 
285                 $_POST['ref'] = $Refs->get_next(ST_CUSTPAYMENT);
286 }
287
288 //----------------------------------------------------------------------------------------------
289 $new = 1;
290 $old_ref = 0;
291
292 //Chaitanya : 13-OCT-2011 - To support Edit feature
293 if (isset($_GET['trans_no']) && $_GET['trans_no'] > 0 )
294 {
295         $_POST['trans_no'] = $_GET['trans_no'];
296
297         $new = 0;
298         $myrow = get_customer_trans($_POST['trans_no'], ST_CUSTPAYMENT);
299         $_POST['customer_id'] = $myrow["debtor_no"];
300         $_POST['customer_name'] = $myrow["DebtorName"];
301         $_POST['BranchID'] = $myrow["branch_code"];
302         $_POST['bank_account'] = $myrow["bank_act"];
303         $_POST['ref'] =  $myrow["reference"];
304         $old_ref = $myrow["reference"];
305         $charge = get_cust_bank_charge(ST_CUSTPAYMENT, $_POST['trans_no']);
306         $_POST['charge'] =  price_format($charge);
307         $_POST['DateBanked'] =  sql2date($myrow['tran_date']);
308         $_POST["amount"] = price_format($myrow['Total'] - $myrow['ov_discount']);
309         $_POST["bank_amount"] = price_format($myrow['bank_amount']+$charge);
310         $_POST["discount"] = price_format($myrow['ov_discount']);
311         $_POST["memo_"] = get_comments_string(ST_CUSTPAYMENT,$_POST['trans_no']);
312
313         //Prepare allocation cart 
314         if (isset($_POST['trans_no']) && $_POST['trans_no'] > 0 )
315                 $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,$_POST['trans_no']);
316         else
317         {
318                 $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,0);
319                 $Ajax->activate('alloc_tbl');
320         }
321 }
322
323 //----------------------------------------------------------------------------------------------
324 $new = !$_SESSION['alloc']->trans_no;
325 start_form();
326
327         hidden('trans_no');
328         hidden('old_ref', $old_ref);
329
330         start_outer_table(TABLESTYLE2, "width=60%", 5);
331
332         table_section(1);
333
334         bank_accounts_list_row(_("Into Bank Account:"), 'bank_account', null, true);
335
336         if ($new)
337                 customer_list_row(_("From Customer:"), 'customer_id', null, false, true);
338         else {
339                 label_cells(_("From Customer:"), $_SESSION['alloc']->person_name, "class='label'");
340                 hidden('customer_id', $_POST['customer_id']);
341         }
342
343         if (db_customer_has_branches($_POST['customer_id'])) {
344                 customer_branches_list_row(_("Branch:"), $_POST['customer_id'], 'BranchID', null, false, true, true);
345         } else {
346                 hidden('BranchID', ANY_NUMERIC);
347         }
348
349         if (list_updated('customer_id') || ($new && list_updated('bank_account'))) {
350                 $_SESSION['alloc']->set_person($_POST['customer_id'], PT_CUSTOMER);
351                 $_SESSION['alloc']->read();
352                 $_POST['memo_'] = $_POST['amount'] = $_POST['discount'] = '';
353                 $Ajax->activate('alloc_tbl');
354         }
355
356         read_customer_data();
357
358         set_global_customer($_POST['customer_id']);
359         if (isset($_POST['HoldAccount']) && $_POST['HoldAccount'] != 0) 
360                 display_warning(_("This customer account is on hold."));
361         $display_discount_percent = percent_format($_POST['pymt_discount']*100) . "%";
362
363         table_section(2);
364
365         date_row(_("Date of Deposit:"), 'DateBanked', '', true, 0, 0, 0, null, true);
366
367         ref_row(_("Reference:"), 'ref','' , null, '', ST_CUSTPAYMENT);
368
369         table_section(3);
370
371         $comp_currency = get_company_currency();
372         $cust_currency = $_SESSION['alloc']->set_person($_POST['customer_id'], PT_CUSTOMER);
373         if (!$cust_currency)
374                 $cust_currency = $comp_currency;
375         $_SESSION['alloc']->currency = $bank_currency = get_bank_account_currency($_POST['bank_account']);
376
377         if ($cust_currency != $bank_currency)
378         {
379                 amount_row(_("Payment Amount:"), 'bank_amount', null, '', $bank_currency);
380         }
381
382         amount_row(_("Bank Charge:"), 'charge', null, '', $bank_currency);
383
384         end_outer_table(1);
385
386         div_start('alloc_tbl');
387         show_allocatable(false);
388         div_end();
389
390         start_table(TABLESTYLE, "width=60%");
391
392         label_row(_("Customer prompt payment discount :"), $display_discount_percent);
393
394         amount_row(_("Amount of Discount:"), 'discount', null, '', $cust_currency);
395
396         amount_row(_("Amount:"), 'amount', null, '', $cust_currency);
397
398         textarea_row(_("Memo:"), 'memo_', null, 22, 4);
399         end_table(1);
400
401         if ($new)
402                 submit_center('AddPaymentItem', _("Add Payment"), true, '', 'default');
403         else
404                 submit_center('AddPaymentItem', _("Update Payment"), true, '', 'default');
405
406         br();
407
408 end_form();
409 end_page();
410 ?>