2 /**********************************************************************
3 Copyright (C) FrontAccounting, LLC.
4 Released under the terms of the GNU Affero General Public License,
5 AGPL, as published by the Free Software Foundation, either version
6 3 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/agpl-3.0.html>.
11 ***********************************************************************/
12 //---------------------------------------------------------------------------
14 // Entry/Modify Credit Note for selected Sales Invoice
20 include_once($path_to_root . "/sales/includes/cart_class.inc");
21 include_once($path_to_root . "/includes/session.inc");
22 include_once($path_to_root . "/includes/data_checks.inc");
23 include_once($path_to_root . "/includes/manufacturing.inc");
24 include_once($path_to_root . "/sales/includes/sales_db.inc");
25 include_once($path_to_root . "/sales/includes/sales_ui.inc");
26 include_once($path_to_root . "/reporting/includes/reporting.inc");
29 if ($use_popup_windows) {
30 $js .= get_js_open_window(900, 500);
33 if ($use_date_picker) {
34 $js .= get_js_date_picker();
37 if (isset($_GET['ModifyCredit'])) {
38 $_SESSION['page_title'] = sprintf(_("Modifying Credit Invoice # %d."), $_GET['ModifyCredit']);
39 $help_page_title =_("Modifying Credit Invoice");
41 } elseif (isset($_GET['InvoiceNumber'])) {
42 $_SESSION['page_title'] = _("Credit all or part of an Invoice");
45 page($_SESSION['page_title'], false, false, "", $js);
47 //-----------------------------------------------------------------------------
49 if (isset($_GET['AddedID'])) {
50 $credit_no = $_GET['AddedID'];
53 display_notification_centered(_("Credit Note has been processed"));
55 display_note(get_customer_trans_view_str($trans_type, $credit_no, _("&View This Credit Note")), 0, 0);
57 display_note(print_document_link($credit_no, _("&Print This Credit Note"), true, 11),1);
59 display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL &Journal Entries for this Credit Note")),1);
61 display_footer_exit();
63 } elseif (isset($_GET['UpdatedID'])) {
64 $credit_no = $_GET['UpdatedID'];
67 display_notification_centered(_("Credit Note has been updated"));
69 display_note(get_customer_trans_view_str($trans_type, $credit_no, _("&View This Credit Note")), 0, 0);
71 display_note(print_document_link($credit_no, _("&Print This Credit Note"), true, 11),1);
73 display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL &Journal Entries for this Credit Note")),1);
75 display_footer_exit();
77 check_edit_conflicts();
80 //-----------------------------------------------------------------------------
82 function can_process()
84 if (!is_date($_POST['CreditDate'])) {
85 display_error(_("The entered date is invalid."));;
86 set_focus('CreditDate');
88 } elseif (!is_date_in_fiscalyear($_POST['CreditDate'])) {
89 display_error(_("The entered date is not in fiscal year."));
90 set_focus('CreditDate');
94 if ($_SESSION['Items']->trans_no==0) {
95 if (!references::is_valid($_POST['ref'])) {
96 display_error(_("You must enter a reference."));;
101 if (!is_new_reference($_POST['ref'], 11)) {
102 display_error(_("The entered reference is already in use."));;
107 if (!check_num('ChargeFreightCost', 0)) {
108 display_error(_("The entered shipping cost is invalid or less than zero."));;
109 set_focus('ChargeFreightCost');
112 if (!check_quantities()) {
113 display_error(_("Selected quantity cannot be less than zero nor more than quantity not credited yet."));
119 //-----------------------------------------------------------------------------
121 if (isset($_GET['InvoiceNumber']) && $_GET['InvoiceNumber'] > 0) {
123 $ci = new Cart(10, $_GET['InvoiceNumber'], true);
125 $ci->trans_type = 11;
126 $ci->src_docs = $ci->trans_no;
127 $ci->src_date = $ci->document_date;
129 $ci->document_date = Today();
130 $ci->reference = references::get_next(11);
132 for ($line_no=0; $line_no<count($ci->line_items); $line_no++) {
133 $ci->line_items[$line_no]->qty_dispatched = '0';
136 $_SESSION['Items'] = $ci;
139 } elseif ( isset($_GET['ModifyCredit']) && $_GET['ModifyCredit']>0) {
141 $_SESSION['Items'] = new Cart(11,$_GET['ModifyCredit']);
144 } elseif (!processing_active()) {
145 /* This page can only be called with an invoice number for crediting*/
146 die (_("This page can only be opened if an invoice has been selected for crediting."));
147 } elseif (!check_quantities()) {
148 display_error(_("Selected quantity cannot be less than zero nor more than quantity not credited yet."));
151 function check_quantities()
154 foreach ($_SESSION['Items']->line_items as $line_no=>$itm) {
155 if (isset($_POST['Line'.$line_no])) {
156 if (check_num('Line'.$line_no, 0, $itm->quantity)) {
157 $_SESSION['Items']->line_items[$line_no]->qty_dispatched =
158 input_num('Line'.$line_no);
165 if (isset($_POST['Line'.$line_no.'Desc'])) {
166 $line_desc = $_POST['Line'.$line_no.'Desc'];
167 if (strlen($line_desc) > 0) {
168 $_SESSION['Items']->line_items[$line_no]->item_description = $line_desc;
174 //-----------------------------------------------------------------------------
176 function copy_to_cart()
178 $cart = &$_SESSION['Items'];
179 $cart->ship_via = $_POST['ShipperID'];
180 $cart->freight_cost = input_num('ChargeFreightCost');
181 $cart->document_date = $_POST['CreditDate'];
182 $cart->Location = $_POST['Location'];
183 $cart->Comments = $_POST['CreditText'];
185 //-----------------------------------------------------------------------------
187 function copy_from_cart()
189 $cart = &$_SESSION['Items'];
190 $_POST['ShipperID'] = $cart->ship_via;
191 $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
192 $_POST['CreditDate']= $cart->document_date;
193 $_POST['Location']= $cart->Location;
194 $_POST['CreditText']= $cart->Comments;
195 $_POST['cart_id'] = $cart->cart_id;
197 //-----------------------------------------------------------------------------
199 if (isset($_POST['ProcessCredit']) && can_process()) {
201 $newcredit = ($_SESSION['Items']->trans_no == 0);
203 if (!isset($_POST['WriteOffGLCode']))
204 $_POST['WriteOffGLCode'] = 0;
207 $credit_no = $_SESSION['Items']->write($_POST['WriteOffGLCode']);
211 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
213 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$credit_no");
217 //-----------------------------------------------------------------------------
219 if (isset($_POST['Location'])) {
220 $_SESSION['Items']->Location = $_POST['Location'];
223 //-----------------------------------------------------------------------------
225 function display_credit_items()
227 global $table_style, $table_style2;
229 start_form(false, true);
232 start_table("$table_style2 width=80%", 5);
233 echo "<tr><td>"; // outer table
235 start_table("$table_style width=100%");
237 label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
238 label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
239 label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
243 // if (!isset($_POST['ref']))
244 // $_POST['ref'] = references::get_next(11);
246 if ($_SESSION['Items']->trans_no==0) {
247 ref_cells(_("Reference"), 'ref', '', $_SESSION['Items']->reference, "class='tableheader2'");
249 label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
251 // label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
252 label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, array_keys($_SESSION['Items']->src_docs)), "class='tableheader2'");
254 if (!isset($_POST['ShipperID'])) {
255 $_POST['ShipperID'] = $_SESSION['Items']->ship_via;
257 label_cell(_("Shipping Company"), "class='tableheader2'");
258 shippers_list_cells(null, 'ShipperID', $_POST['ShipperID']);
259 // if (!isset($_POST['sales_type_id']))
260 // $_POST['sales_type_id'] = $_SESSION['Items']->sales_type;
261 // label_cell(_("Sales Type"), "class='tableheader2'");
262 // sales_types_list_cells(null, 'sales_type_id', $_POST['sales_type_id']);
267 echo "</td><td>";// outer table
269 start_table("$table_style width=100%");
271 label_row(_("Invoice Date"), $_SESSION['Items']->src_date, "class='tableheader2'");
273 date_row(_("Credit Note Date"), 'CreditDate', '', null, 0, 0, 0, "class='tableheader2'");
279 end_table(1); // outer table
281 div_start('credit_items');
282 start_table("$table_style width=80%");
283 $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
284 _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
287 $k = 0; //row colour counter
289 foreach ($_SESSION['Items']->line_items as $line_no=>$ln_itm) {
290 if ($ln_itm->quantity==$ln_itm->qty_done) {
291 continue; // this line was fully credited
293 alt_table_row_color($k);
296 // view_stock_status_cell($ln_itm->stock_id); alternative view
297 label_cell($ln_itm->stock_id);
299 text_cells(null, 'Line'.$line_no.'Desc', $ln_itm->item_description, 30, 50);
300 $dec = get_qty_dec($ln_itm->stock_id);
301 qty_cell($ln_itm->quantity, false, $dec);
302 label_cell($ln_itm->units);
303 amount_cells(null, 'Line'.$line_no, number_format2($ln_itm->qty_dispatched, $dec),
305 $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
307 amount_cell($ln_itm->price);
308 percent_cell($ln_itm->discount_percent*100);
309 amount_cell($line_total);
313 if (!check_num('ChargeFreightCost')) {
314 $_POST['ChargeFreightCost'] = price_format($_SESSION['Items']->freight_cost);
318 label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
319 amount_cells_ex(null, "ChargeFreightCost", 6, 8, $_POST['ChargeFreightCost']);
322 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
324 $display_sub_total = price_format($inv_items_total + input_num($_POST['ChargeFreightCost']));
325 label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
327 $taxes = $_SESSION['Items']->get_taxes(input_num($_POST['ChargeFreightCost']));
329 $tax_total = display_edit_tax_items($taxes, 7, $_SESSION['Items']->tax_included);
331 $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
333 label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
339 //-----------------------------------------------------------------------------
340 function display_credit_options()
342 global $table_style2, $Ajax;
345 if (isset($_POST['_CreditType_update']))
346 $Ajax->activate('options');
348 div_start('options');
349 start_table("$table_style2");
351 credit_type_list_row(_("Credit Note Type"), 'CreditType', null, true);
353 if ($_POST['CreditType'] == "Return")
356 /*if the credit note is a return of goods then need to know which location to receive them into */
357 if (!isset($_POST['Location']))
358 $_POST['Location'] = $_SESSION['Items']->Location;
359 locations_list_row(_("Items Returned to Location"), 'Location', $_POST['Location']);
363 /* the goods are to be written off to somewhere */
364 gl_all_accounts_list_row(_("Write off the cost of the items to"), 'WriteOffGLCode', null);
367 textarea_row(_("Memo"), "CreditText", null, 51, 3);
372 //-----------------------------------------------------------------------------
373 if (get_post('Update'))
375 $Ajax->activate('credit_items');
377 //-----------------------------------------------------------------------------
379 display_credit_items();
380 display_credit_options();
383 submit('Update', _("Update"), true, _('Update credit value for quantities entered'), true);
385 submit('ProcessCredit', _("Process Credit Note"), true, '', true);