Changed context help organization to enable use of central, multilanguage wiki.
[fa-stable.git] / 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
23 $js = "";
24 if ($use_popup_windows) {
25         $js .= get_js_open_window(900, 500);
26 }
27 if ($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
42 if (list_updated('BranchID')) {
43         // when branch is selected via external editor also customer can change
44         $br = get_branch(get_post('BranchID'));
45         $_POST['customer_id'] = $br['debtor_no'];
46         $Ajax->activate('customer_id');
47 }
48
49 if (!isset($_POST['customer_id']))
50         $_POST['customer_id'] = get_global_customer(false);
51 if (!isset($_POST['DateBanked'])) {
52         $_POST['DateBanked'] = new_doc_date();
53         if (!is_date_in_fiscalyear($_POST['DateBanked'])) {
54                 $_POST['DateBanked'] = end_fiscalyear();
55         }
56 }
57
58 if (isset($_GET['AddedID'])) {
59         $payment_no = $_GET['AddedID'];
60
61         display_notification_centered(_("The customer payment has been successfully entered."));
62
63         display_note(get_gl_view_str(ST_CUSTPAYMENT, $payment_no, _("&View the GL Journal Entries for this Customer Payment")));
64
65 //      hyperlink_params($path_to_root . "/sales/allocations/customer_allocate.php", _("&Allocate this Customer Payment"), "trans_no=$payment_no&trans_type=12");
66
67         hyperlink_no_params($path_to_root . "/sales/customer_payments.php", _("Enter Another &Customer Payment"));
68         br(1);
69         end_page();
70         exit;
71 }
72
73 //----------------------------------------------------------------------------------------------
74
75 function can_process()
76 {
77         global $Refs;
78
79         if (!isset($_POST['DateBanked']) || !is_date($_POST['DateBanked'])) {
80                 display_error(_("The entered date is invalid. Please enter a valid date for the payment."));
81                 set_focus('DateBanked');
82                 return false;
83         } elseif (!is_date_in_fiscalyear($_POST['DateBanked'])) {
84                 display_error(_("The entered date is not in fiscal year."));
85                 set_focus('DateBanked');
86                 return false;
87         }
88
89         if (!$Refs->is_valid($_POST['ref'])) {
90                 display_error(_("You must enter a reference."));
91                 set_focus('ref');
92                 return false;
93         }
94
95         if (!is_new_reference($_POST['ref'], ST_CUSTPAYMENT)) {
96                 display_error(_("The entered reference is already in use."));
97                 set_focus('ref');
98                 return false;
99         }
100
101         if (!check_num('amount', 0)) {
102                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
103                 set_focus('amount');
104                 return false;
105         }
106
107         if (isset($_POST['charge']) && !check_num('charge', 0)) {
108                 display_error(_("The entered amount is invalid or negative and cannot be processed."));
109                 set_focus('charge');
110                 return false;
111         }
112         if (isset($_POST['charge']) && input_num('charge') > 0) {
113                 $charge_acct = get_company_pref('bank_charge_act');
114                 if (get_gl_account($charge_acct) == false) {
115                         display_error(_("The Bank Charge Account has not been set in System and General GL Setup."));
116                         set_focus('charge');
117                         return false;
118                 }       
119         }
120
121         if (isset($_POST['_ex_rate']) && !check_num('_ex_rate', 0.000001))
122         {
123                 display_error(_("The exchange rate must be numeric and greater than zero."));
124                 set_focus('_ex_rate');
125                 return false;
126         }
127
128         if ($_POST['discount'] == "") 
129         {
130                 $_POST['discount'] = 0;
131         }
132
133         if (!check_num('discount')) {
134                 display_error(_("The entered discount is not a valid number."));
135                 set_focus('discount');
136                 return false;
137         }
138
139         if ((input_num('amount') - input_num('discount') <= 0)) {
140                 display_error(_("The balance of the amount and discout is zero or negative. Please enter valid amounts."));
141                 set_focus('discount');
142                 return false;
143         }
144
145         $_SESSION['alloc']->amount = input_num('amount');
146
147         if (isset($_POST["TotalNumberOfAllocs"]))
148                 return check_allocations();
149         else
150                 return true;
151 }
152
153 //----------------------------------------------------------------------------------------------
154
155 // validate inputs
156 if (isset($_POST['AddPaymentItem'])) {
157
158         if (!can_process()) {
159                 unset($_POST['AddPaymentItem']);
160         }
161 }
162 if (isset($_POST['_customer_id_button'])) {
163 //      unset($_POST['branch_id']);
164         $Ajax->activate('BranchID');
165 }
166 if (isset($_POST['_DateBanked_changed'])) {
167   $Ajax->activate('_ex_rate');
168 }
169 if (list_updated('customer_id') || list_updated('bank_account')) {
170   $_SESSION['alloc']->read();
171   $Ajax->activate('alloc_tbl');
172 }
173 //----------------------------------------------------------------------------------------------
174
175 if (isset($_POST['AddPaymentItem'])) {
176         
177         $cust_currency = get_customer_currency($_POST['customer_id']);
178         $bank_currency = get_bank_account_currency($_POST['bank_account']);
179         $comp_currency = get_company_currency();
180         if ($comp_currency != $bank_currency && $bank_currency != $cust_currency)
181                 $rate = 0;
182         else
183                 $rate = input_num('_ex_rate');
184
185         new_doc_date($_POST['DateBanked']);
186
187         $payment_no = write_customer_payment(0, $_POST['customer_id'], $_POST['BranchID'],
188                 $_POST['bank_account'], $_POST['DateBanked'], $_POST['ref'],
189                 input_num('amount'), input_num('discount'), $_POST['memo_'], $rate, input_num('charge'));
190
191         $_SESSION['alloc']->trans_no = $payment_no;
192         $_SESSION['alloc']->write();
193
194         meta_forward($_SERVER['PHP_SELF'], "AddedID=$payment_no");
195 }
196
197 //----------------------------------------------------------------------------------------------
198
199 function read_customer_data()
200 {
201         global $Refs;
202
203         $sql = "SELECT ".TB_PREF."debtors_master.pymt_discount,
204                 ".TB_PREF."credit_status.dissallow_invoices
205                 FROM ".TB_PREF."debtors_master, ".TB_PREF."credit_status
206                 WHERE ".TB_PREF."debtors_master.credit_status = ".TB_PREF."credit_status.id
207                         AND ".TB_PREF."debtors_master.debtor_no = ".db_escape($_POST['customer_id']);
208
209         $result = db_query($sql, "could not query customers");
210
211         $myrow = db_fetch($result);
212
213         $_POST['HoldAccount'] = $myrow["dissallow_invoices"];
214         $_POST['pymt_discount'] = $myrow["pymt_discount"];
215         $_POST['ref'] = $Refs->get_next(12);
216 }
217
218 //----------------------------------------------------------------------------------------------
219
220 start_form();
221
222         start_outer_table("$table_style2 width=60%", 5);
223         table_section(1);
224
225         customer_list_row(_("From Customer:"), 'customer_id', null, false, true);
226         if (!isset($_POST['bank_account'])) // first page call
227                   $_SESSION['alloc'] = new allocation(ST_CUSTPAYMENT,0);
228
229         if (db_customer_has_branches($_POST['customer_id'])) {
230                 customer_branches_list_row(_("Branch:"), $_POST['customer_id'], 'BranchID', null, false, true, true);
231         } else {
232                 hidden('BranchID', ANY_NUMERIC);
233         }
234
235         read_customer_data();
236
237         set_global_customer($_POST['customer_id']);
238         if (isset($_POST['HoldAccount']) && $_POST['HoldAccount'] != 0) {
239                 end_outer_table();
240                 display_error(_("This customer account is on hold."));
241         } else {
242                 $display_discount_percent = percent_format($_POST['pymt_discount']*100) . "%";
243
244                 table_section(2);
245
246                 bank_accounts_list_row(_("Into Bank Account:"), 'bank_account', null, true);
247
248
249                 text_row(_("Reference:"), 'ref', null, 20, 40);
250
251                 table_section(3);
252
253                 date_row(_("Date of Deposit:"), 'DateBanked', '', true, 0, 0, 0, null, true);
254
255
256
257                 $comp_currency = get_company_currency();
258                 $cust_currency = get_customer_currency($_POST['customer_id']);
259                 $bank_currency = get_bank_account_currency($_POST['bank_account']);
260
261                 if ($cust_currency != $bank_currency) {
262                         exchange_rate_display($bank_currency, $cust_currency, $_POST['DateBanked'], ($bank_currency == $comp_currency));
263                 }
264
265                 amount_row(_("Bank Charge:"), 'charge');
266
267                 end_outer_table(1);
268
269                 if ($cust_currency == $bank_currency) {
270                         div_start('alloc_tbl');
271                         show_allocatable(false);
272                         div_end();
273                 }
274
275                 start_table("$table_style width=60%");
276
277                 label_row(_("Customer prompt payment discount :"), $display_discount_percent);
278                 amount_row(_("Amount of Discount:"), 'discount');
279
280                 amount_row(_("Amount:"), 'amount');
281
282                 textarea_row(_("Memo:"), 'memo_', null, 22, 4);
283                 end_table(1);
284
285                 if ($cust_currency != $bank_currency)
286                         display_note(_("Amount and discount are in customer's currency."));
287
288                 br();
289
290                 submit_center('AddPaymentItem', _("Add Payment"), true, '', 'default');
291         }
292
293         br();
294
295 end_form();
296 end_page();
297 ?>