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