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