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