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/inquiry/customer_allocation_inquiry.php?customer_id=", _("Select Another &Customer Transaction for Payment"));
 101
 102         hyperlink_no_params($path_to_root . "/sales/customer_payments.php", _("Enter Another &Customer Payment"));
 103
 104         display_footer_exit();
 105 }
 106 elseif (isset($_GET['UpdatedID'])) {
 107         $payment_no = $_GET['UpdatedID'];
 108
 109         display_notification_centered(_("The customer payment has been successfully updated."));
 110
 111         submenu_print(_("&Print This Receipt"), ST_CUSTPAYMENT, $payment_no."-".ST_CUSTPAYMENT, 'prtopt');
 112
 113         display_note(get_gl_view_str(ST_CUSTPAYMENT, $payment_no, _("&View the GL Journal Entries for this Customer Payment")));
 114
 115 //      hyperlink_params($path_to_root . "/sales/allocations/customer_allocate.php", _("&Allocate this Customer Payment"), "trans_no=$payment_no&trans_type=12");
 116
 117         hyperlink_no_params($path_to_root . "/sales/inquiry/customer_inquiry.php?", _("Select Another Customer Payment for &Edition"));
 118
 119         hyperlink_no_params($path_to_root . "/sales/customer_payments.php", _("Enter Another &Customer Payment"));
 120
 121         display_footer_exit();
 122 }
 123
 124 //----------------------------------------------------------------------------------------------
 125
 126 function can_process()
 127 {
 128         global $Refs;
 129
 130         if (!get_post('customer_id'))
 131         {
 132                 display_error(_("There is no customer selected."));
 133                 set_focus('customer_id');
 134                 return false;
 135         }
 136
 137         if (!get_post('BranchID'))
 138         {
 139                 display_error(_("This customer has no branch defined."));
 140                 set_focus('BranchID');
 141                 return false;
 142         }
 143
 144         if (!isset($_POST['DateBanked']) || !is_date($_POST['DateBanked'])) {
 145                 display_error(_("The entered date is invalid. Please enter a valid date for the payment."));
 146                 set_focus('DateBanked');
 147                 return false;
 148         } elseif (!is_date_in_fiscalyear($_POST['DateBanked'])) {
 149                 display_error(_("The entered date is not in fiscal year."));
 150                 set_focus('DateBanked');
 151                 return false;
 152         }
 153
 154         if (!$Refs->is_valid($_POST['ref'])) {
 155                 display_error(_("You must enter a reference."));
 156                 set_focus('ref');
 157                 return false;
 158         }
 159
 160         //Chaitanya : 13-OCT-2011 - To support Edit feature
 161         if (isset($_POST['trans_no']) && $_POST['trans_no'] == 0 && (!is_new_reference($_POST['ref'], ST_CUSTPAYMENT))) {
 162                 display_error(_("The entered reference is already in use."));
 163                 set_focus('ref');
 164                 return false;
 165         }
 166         //Avoid duplicate reference while modifying
 167         elseif ($_POST['ref'] != $_POST['old_ref'] && !is_new_reference($_POST['ref'], ST_CUSTPAYMENT))
 168         {
 169                 display_error( _("The entered reference is already in use."));
 170                 set_focus('ref');
 171                 return false;
 172         }
 173
 174         if (!check_num('amount', 0)) {
 175                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
 176                 set_focus('amount');
 177                 return false;
 178         }
 179
 180         if (isset($_POST['charge']) && !check_num('charge', 0)) {
 181                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
 182                 set_focus('charge');
 183                 return false;
 184         }
 185         if (isset($_POST['charge']) && input_num('charge') > 0) {
 186                 $charge_acct = get_company_pref('bank_charge_act');
 187                 if (get_gl_account($charge_acct) == false) {
 188                         display_error(_("The Bank Charge Account has not been set in System and General GL Setup."));
 189                         set_focus('charge');
 190                         return false;
 191                 }
 192         }
 193
 194         if (isset($_POST['_ex_rate']) && !check_num('_ex_rate', 0.000001))
 195         {
 196                 display_error(_("The exchange rate must be numeric and greater than zero."));
 197                 set_focus('_ex_rate');
 198                 return false;
 199         }
 200
 201         if ($_POST['discount'] == "")
 202         {
 203                 $_POST['discount'] = 0;
 204         }
 205
 206         if (!check_num('discount')) {
 207                 display_error(_("The entered discount is not a valid number."));
 208                 set_focus('discount');
 209                 return false;
 210         }
 211
 212         //if ((input_num('amount') - input_num('discount') <= 0)) {
 213         if (input_num('amount') <= 0) {
 214                 display_error(_("The balance of the amount and discout is zero or negative. Please enter valid amounts."));
 215                 set_focus('discount');
 216                 return false;
 217         }
 218         if (!db_has_currency_rates(get_customer_currency($_POST['customer_id']), $_POST['DateBanked'], true))
 219                 return false;
 220
 221         $_SESSION['alloc']->amount = input_num('amount');
 222
 223         if (isset($_POST["TotalNumberOfAllocs"]))
 224                 return check_allocations();
 225         else
 226                 return true;
 227 }
 228
 229 //----------------------------------------------------------------------------------------------
 230
 231 if (isset($_POST['_customer_id_button'])) {
 232 //      unset($_POST['branch_id']);
 233         $Ajax->activate('BranchID');
 234 }
 235 if (isset($_POST['_DateBanked_changed'])) {
 236   $Ajax->activate('_ex_rate');
 237 }
 238
 239 //----------------------------------------------------------------------------------------------
 240
 241 if (get_post('AddPaymentItem') && can_process()) {
 242
 243         $cust_currency = get_customer_currency($_POST['customer_id']);
 244         $bank_currency = get_bank_account_currency($_POST['bank_account']);
 245         $comp_currency = get_company_currency();
 246         if ($comp_currency != $bank_currency && $bank_currency != $cust_currency)
 247                 $rate = 0;
 248         else
 249                 $rate = input_num('_ex_rate');
 250
 251         new_doc_date($_POST['DateBanked']);
 252
 253         //Chaitanya : 13-OCT-2011 - To support Edit feature
 254         $payment_no = write_customer_payment($_SESSION['alloc']->trans_no, $_POST['customer_id'], $_POST['BranchID'],
 255                 $_POST['bank_account'], $_POST['DateBanked'], $_POST['ref'],
 256                 input_num('amount'), input_num('discount'), $_POST['memo_'], $rate, input_num('charge'));
 257
 258         $_SESSION['alloc']->trans_no = $payment_no;
 259         $_SESSION['alloc']->write();
 260
 261         unset($_POST);
 262         unset($_SESSION);
 263
 264         //Chaitanya : 13-OCT-2011 - To support Edit feature
 265         //meta_forward($_SERVER['PHP_SELF'], "AddedID=$payment_no");
 266         meta_forward($_SERVER['PHP_SELF'], !$_SESSION['alloc']->trans_no ? "AddedID=$payment_no" : "UpdatedID=$payment_no");
 267 }
 268
 269 //----------------------------------------------------------------------------------------------
 270
 271 function read_customer_data()
 272 {
 273         global $Refs;
 274
 275         $myrow = get_customer_habit($_POST['customer_id']);
 276
 277         $_POST['HoldAccount'] = $myrow["dissallow_invoices"];
 278         $_POST['pymt_discount'] = $myrow["pymt_discount"];
 279         //Chaitanya : 13-OCT-2011 - To support Edit feature
 280         //If page is called first time and New entry fetch the nex reference number
 281         if (!$_SESSION['alloc']->trans_no && !isset($_POST['charge']))
 282                 $_POST['ref'] = $Refs->get_next(ST_CUSTPAYMENT);
 283 }
 284
 285 //----------------------------------------------------------------------------------------------
 286 $new = 1;
 287 $old_ref = 0;
 288
 289 //Chaitanya : 13-OCT-2011 - To support Edit feature
 290 if (isset($_GET['trans_no']) && $_GET['trans_no'] > 0 )
 291 {
 292         $_POST['trans_no'] = $_GET['trans_no'];
 293
 294         $new = 0;
 295         $myrow = get_customer_trans($_POST['trans_no'], ST_CUSTPAYMENT);
 296         $_POST['customer_id'] = $myrow["debtor_no"];
 297         $_POST['customer_name'] = $myrow["DebtorName"];
 298         $_POST['BranchID'] = $myrow["branch_code"];
 299         $_POST['bank_account'] = $myrow["bank_act"];
 300         $_POST['ref'] =  $myrow["reference"];
 301         $old_ref = $myrow["reference"];
 302         //$_POST['charge'] =  $myrow[""];
 303         $_POST['DateBanked'] =  sql2date($myrow['tran_date']);
 304         $_POST["amount"] = price_format($myrow['Total'] - $myrow['ov_discount']);
 305         $_POST["discount"] = price_format($myrow['ov_discount']);
 306         $_POST["memo_"] = get_comments_string(ST_CUSTPAYMENT,$_POST['trans_no']);
 307
 308         if (!isset($_POST['charge'])) // first page call
 309         {
 310                 //Prepare allocation cart
 311                 if (isset($_POST['trans_no']) && $_POST['trans_no'] > 0 )
 312                         $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,$_POST['trans_no']);
 313                 else
 314                 {
 315                         $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,0);
 316                         $Ajax->activate('alloc_tbl');
 317                 }
 318         }
 319
 320 }
 321
 322 //----------------------------------------------------------------------------------------------
 323 $new = !$_SESSION['alloc']->trans_no;
 324 start_form();
 325
 326         hidden('trans_no');
 327         hidden('old_ref', $old_ref);
 328
 329         start_outer_table(TABLESTYLE2, "width=60%", 5);
 330         table_section(1);
 331
 332         if ($new)
 333                 customer_list_row(_("From Customer:"), 'customer_id', null, false, true);
 334         else {
 335                 label_cells(_("From Customer:"), $_POST['customer_name'], "class='label'");
 336                 hidden('customer_id', $_POST['customer_id']);
 337         }
 338
 339         if (list_updated('customer_id') || ($new && list_updated('bank_account'))) {
 340                 $_SESSION['alloc']->read();
 341                 $_POST['memo_'] = $_POST['amount'] = $_POST['discount'] = '';
 342                 $Ajax->activate('alloc_tbl');
 343         }
 344
 345         if (db_customer_has_branches($_POST['customer_id'])) {
 346                 customer_branches_list_row(_("Branch:"), $_POST['customer_id'], 'BranchID', null, false, true, true);
 347         } else {
 348                 hidden('BranchID', ANY_NUMERIC);
 349         }
 350
 351         read_customer_data();
 352
 353         set_global_customer($_POST['customer_id']);
 354         if (isset($_POST['HoldAccount']) && $_POST['HoldAccount'] != 0)
 355                 display_warning(_("This customer account is on hold."));
 356         $display_discount_percent = percent_format($_POST['pymt_discount']*100) . "%";
 357
 358         table_section(2);
 359         if (!list_updated('bank_account'))
 360                 $_POST['bank_account'] = get_default_customer_bank_account($_POST['customer_id']);
 361
 362         //Chaitanya : 13-OCT-2011 - Is AJAX call really needed ???
 363         //bank_accounts_list_row(_("Into Bank Account:"), 'bank_account', null, true);
 364         bank_accounts_list_row(_("Into Bank Account:"), 'bank_account', null, false);
 365
 366         text_row(_("Reference:"), 'ref', null, 20, 40);
 367
 368         table_section(3);
 369
 370         date_row(_("Date of Deposit:"), 'DateBanked', '', true, 0, 0, 0, null, true);
 371
 372         $comp_currency = get_company_currency();
 373         $cust_currency = get_customer_currency($_POST['customer_id']);
 374         $bank_currency = get_bank_account_currency($_POST['bank_account']);
 375
 376         if ($cust_currency != $bank_currency) {
 377                 exchange_rate_display($bank_currency, $cust_currency, $_POST['DateBanked'], ($bank_currency == $comp_currency));
 378         }
 379
 380         amount_row(_("Bank Charge:"), 'charge');
 381
 382         end_outer_table(1);
 383
 384         if ($cust_currency == $bank_currency) {
 385                 div_start('alloc_tbl');
 386                 show_allocatable(false);
 387                 div_end();
 388         }
 389
 390         start_table(TABLESTYLE, "width=60%");
 391
 392         label_row(_("Customer prompt payment discount :"), $display_discount_percent);
 393         amount_row(_("Amount of Discount:"), 'discount');
 394
 395         amount_row(_("Amount:"), 'amount');
 396
 397         textarea_row(_("Memo:"), 'memo_', null, 22, 4);
 398         end_table(1);
 399
 400         if ($cust_currency != $bank_currency)
 401                 display_note(_("Amount and discount are in customer's currency."));
 402
 403         br();
 404
 405         if ($new)
 406                 submit_center('AddPaymentItem', _("Update Payment"), true, '', 'default');
 407         else
 408                 submit_center('AddPaymentItem', _("Add Payment"), true, '', 'default');
 409
 410         br();
 411
 412 end_form();
 413 end_page();
 414 ?>