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