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