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