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 (@$_POST['discount'] == "")
 202         {
 203                 $_POST['discount'] = 0;
 204         }
 205
 206         if (!check_num('discount')) {
 207                 display_error(_("The entered discount is not a valid number."));
 208                 set_focus('discount');
 209                 return false;
 210         }
 211
 212         if (input_num('amount') <= 0) {
 213                 display_error(_("The balance of the amount and discount is zero or negative. Please enter valid amounts."));
 214                 set_focus('discount');
 215                 return false;
 216         }
 217
 218         if (isset($_POST['bank_amount']) && input_num('bank_amount')<=0)
 219         {
 220                 display_error(_("The entered payment amount is zero or negative."));
 221                 set_focus('bank_amount');
 222                 return false;
 223         }
 224
 225         if (!db_has_currency_rates(get_customer_currency($_POST['customer_id']), $_POST['DateBanked'], true))
 226                 return false;
 227
 228         $_SESSION['alloc']->amount = input_num('amount');
 229
 230         if (isset($_POST["TotalNumberOfAllocs"]))
 231                 return check_allocations();
 232         else
 233                 return true;
 234 }
 235
 236 //----------------------------------------------------------------------------------------------
 237
 238 if (isset($_POST['_customer_id_button'])) {
 239 //      unset($_POST['branch_id']);
 240         $Ajax->activate('BranchID');
 241 }
 242
 243 //----------------------------------------------------------------------------------------------
 244
 245 if (get_post('AddPaymentItem') && can_process()) {
 246
 247         new_doc_date($_POST['DateBanked']);
 248
 249         $new_pmt = !$_SESSION['alloc']->trans_no;
 250
 251         $payment_no =  save_cust_payment($_SESSION['alloc'], get_post('customer_id'), get_post('BranchID'), get_post('bank_account'),
 252                 get_post('DateBanked'), get_post('ref'), input_num('amount'), input_num('discount'), get_post('memo_'),
 253                 input_num('charge'), input_num('bank_amount', input_num('amount')));
 254
 255         unset($_SESSION['alloc']);
 256         meta_forward($_SERVER['PHP_SELF'], $new_pmt ? "AddedID=$payment_no" : "UpdatedID=$payment_no");
 257 }
 258
 259 //----------------------------------------------------------------------------------------------
 260
 261 function read_customer_data()
 262 {
 263         global $Refs;
 264
 265         $myrow = get_customer_habit($_POST['customer_id']);
 266
 267         $_POST['HoldAccount'] = $myrow["dissallow_invoices"];
 268         // To support Edit feature
 269         // If page is called first time and New entry fetch the nex reference number
 270         if (!$_SESSION['alloc']->trans_no && !isset($_POST['charge']))
 271                 $_POST['ref'] = $Refs->get_next(ST_CUSTPAYMENT, null, array(
 272                         'customer' => get_post('customer_id'), 'date' => get_post('DateBanked')));
 273 }
 274
 275 //----------------------------------------------------------------------------------------------
 276 $new = 1;
 277
 278 // To support Edit feature
 279 if (isset($_GET['trans_no']) && $_GET['trans_no'] > 0 )
 280 {
 281         $_POST['trans_no'] = $_GET['trans_no'];
 282
 283         $new = 0;
 284         $myrow = get_customer_trans($_POST['trans_no'], ST_CUSTPAYMENT);
 285         $_POST['customer_id'] = $myrow["debtor_no"];
 286         $_POST['customer_name'] = $myrow["DebtorName"];
 287         $_POST['BranchID'] = $myrow["branch_code"];
 288         $_POST['bank_account'] = $myrow["bank_act"];
 289         $_POST['ref'] =  $myrow["reference"];
 290         $charge = get_cust_bank_charge(ST_CUSTPAYMENT, $_POST['trans_no']);
 291         $_POST['charge'] =  price_format($charge);
 292         $_POST['DateBanked'] =  sql2date($myrow['tran_date']);
 293         $_POST["amount"] = price_format($myrow['Total'] - $myrow['ov_discount']);
 294         $_POST["bank_amount"] = price_format($myrow['bank_amount']+$charge);
 295         $_POST["discount"] = price_format($myrow['ov_discount']);
 296         $_POST["memo_"] = get_comments_string(ST_CUSTPAYMENT,$_POST['trans_no']);
 297
 298         //Prepare allocation cart
 299         if (isset($_POST['trans_no']) && $_POST['trans_no'] > 0 )
 300                 $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,$_POST['trans_no']);
 301         else
 302         {
 303                 $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT, $_POST['trans_no']);
 304                 $Ajax->activate('alloc_tbl');
 305         }
 306 }
 307
 308 //----------------------------------------------------------------------------------------------
 309 $new = !$_SESSION['alloc']->trans_no;
 310 start_form();
 311
 312 hidden('trans_no');
 313
 314 start_outer_table(TABLESTYLE2, "width='60%'", 5);
 315
 316 table_section(1);
 317
 318 if ($new)
 319         customer_list_row(_("From Customer:"), 'customer_id', null, false, true);
 320 else {
 321         label_cells(_("From Customer:"), $_SESSION['alloc']->person_name, "class='label'");
 322         hidden('customer_id', $_POST['customer_id']);
 323 }
 324
 325 if (db_customer_has_branches($_POST['customer_id'])) {
 326         customer_branches_list_row(_("Branch:"), $_POST['customer_id'], 'BranchID', null, false, true, true);
 327 } else {
 328         hidden('BranchID', ANY_NUMERIC);
 329 }
 330
 331 if (list_updated('customer_id') || ($new && list_updated('bank_account'))) {
 332         $_SESSION['alloc']->set_person($_POST['customer_id'], PT_CUSTOMER);
 333         $_SESSION['alloc']->read();
 334         $_POST['memo_'] = $_POST['amount'] = $_POST['discount'] = '';
 335         if (list_updated('customer_id')) {
 336                 $dflt_act = get_default_bank_account($_SESSION['alloc']->person_curr);
 337                 $_POST['bank_account'] = $dflt_act['id'];
 338         }
 339         $Ajax->activate('_page_body');
 340 }
 341
 342 bank_accounts_list_row(_("Into Bank Account:"), 'bank_account', null, true);
 343
 344 read_customer_data();
 345
 346 set_global_customer($_POST['customer_id']);
 347 if (isset($_POST['HoldAccount']) && $_POST['HoldAccount'] != 0)
 348         display_warning(_("This customer account is on hold."));
 349
 350 table_section(2);
 351
 352 date_row(_("Date of Deposit:"), 'DateBanked', '', true, 0, 0, 0, null, true);
 353
 354 ref_row(_("Reference:"), 'ref','' , null, '', ST_CUSTPAYMENT);
 355
 356 table_section(3);
 357
 358 $comp_currency = get_company_currency();
 359 $cust_currency = $_SESSION['alloc']->set_person($_POST['customer_id'], PT_CUSTOMER);
 360 if (!$cust_currency)
 361         $cust_currency = $comp_currency;
 362 $_SESSION['alloc']->currency = $bank_currency = get_bank_account_currency($_POST['bank_account']);
 363
 364 if ($cust_currency != $bank_currency)
 365 {
 366         amount_row(_("Payment Amount:"), 'bank_amount', null, '', $bank_currency);
 367 }
 368
 369 amount_row(_("Bank Charge:"), 'charge', null, '', $bank_currency);
 370
 371 end_outer_table(1);
 372
 373 div_start('alloc_tbl');
 374 show_allocatable(false);
 375 div_end();
 376
 377 start_table(TABLESTYLE, "width='60%'");
 378
 379 amount_row(_("Amount of Discount:"), 'discount', null, '', $cust_currency);
 380
 381 amount_row(_("Amount:"), 'amount', null, '', $cust_currency);
 382
 383 textarea_row(_("Memo:"), 'memo_', null, 22, 4);
 384 end_table(1);
 385
 386 if ($new)
 387         submit_center('AddPaymentItem', _("Add Payment"), true, '', 'default');
 388 else
 389         submit_center('AddPaymentItem', _("Update Payment"), true, '', 'default');
 390
 391 br();
 392
 393 end_form();
 394 end_page();