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