sales/customer_credit_invoice.php

   1 <?php
   2 //---------------------------------------------------------------------------
   3 //
   4 //      Entry/Modify Credit Note for selected Sales Invoice
   5 //
   6
   7 $page_security = 3;
   8 $path_to_root = "..";
   9
  10 include_once($path_to_root . "/sales/includes/cart_class.inc");
  11 include_once($path_to_root . "/includes/session.inc");
  12 include_once($path_to_root . "/includes/data_checks.inc");
  13 include_once($path_to_root . "/includes/manufacturing.inc");
  14 include_once($path_to_root . "/sales/includes/sales_db.inc");
  15 include_once($path_to_root . "/sales/includes/sales_ui.inc");
  16 include_once($path_to_root . "/reporting/includes/reporting.inc");
  17
  18 $js = "";
  19 if ($use_popup_windows) {
  20         $js .= get_js_open_window(900, 500);
  21 }
  22
  23 if ($use_date_picker) {
  24         $js .= get_js_date_picker();
  25 }
  26
  27 if (isset($_GET['ModifyCredit'])) {
  28         $_SESSION['page_title'] = sprintf(_("Modifying Credit Invoice # %d."), $_GET['ModifyCredit']);
  29         $help_page_title =_("Modifying Credit Invoice");
  30         processing_start();
  31 } elseif (isset($_GET['InvoiceNumber'])) {
  32         $_SESSION['page_title'] = _("Credit all or part of an Invoice");
  33         processing_start();
  34 }
  35 page($_SESSION['page_title'], false, false, "", $js);
  36
  37 //-----------------------------------------------------------------------------
  38
  39 if (isset($_GET['AddedID'])) {
  40         $credit_no = $_GET['AddedID'];
  41         $trans_type = 11;
  42         print_hidden_script(11);
  43
  44         display_notification_centered(_("Credit Note has been processed"));
  45
  46         display_note(get_customer_trans_view_str($trans_type, $credit_no, _("View This Credit Note")), 0, 0);
  47
  48         display_note(print_document_link($credit_no, _("Print This Credit Note"), true, 11),1);
  49
  50         display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL Journal Entries for this Credit Note")),1);
  51
  52         display_footer_exit();
  53
  54 } elseif (isset($_GET['UpdatedID'])) {
  55         $credit_no = $_GET['UpdatedID'];
  56         $trans_type = 11;
  57         print_hidden_script(11);
  58
  59         display_notification_centered(_("Credit Note has been updated"));
  60
  61         display_note(get_customer_trans_view_str($trans_type, $credit_no, _("View This Credit Note")), 0, 0);
  62
  63         display_note(print_document_link($credit_no, _("Print This Credit Note"), true, 11),1);
  64
  65         display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL Journal Entries for this Credit Note")),1);
  66
  67         display_footer_exit();
  68 }
  69
  70 //-----------------------------------------------------------------------------
  71
  72 function can_process()
  73 {
  74         if (!is_date($_POST['CreditDate'])) {
  75                 display_error(_("The entered date is invalid."));;
  76                 set_focus('CreditDate');
  77                 return false;
  78         } elseif (!is_date_in_fiscalyear($_POST['CreditDate'])) {
  79                 display_error(_("The entered date is not in fiscal year."));
  80                 set_focus('CreditDate');
  81                 return false;
  82         }
  83
  84     if ($_SESSION['Items']->trans_no==0) {
  85                 if (!references::is_valid($_POST['ref'])) {
  86                         display_error(_("You must enter a reference."));;
  87                         set_focus('ref');
  88                         return false;
  89                 }
  90
  91                 if (!is_new_reference($_POST['ref'], 11)) {
  92                         display_error(_("The entered reference is already in use."));;
  93                         set_focus('ref');
  94                         return false;
  95                 }
  96     }
  97         if (!check_num('ChargeFreightCost', 0)) {
  98                 display_error(_("The entered shipping cost is invalid or less than zero."));;
  99                 set_focus('ChargeFreightCost');
 100                 return false;
 101         }
 102         if (!check_quantities()) {
 103                 display_error(_("Selected quantity cannot be less than zero nor more than quantity not credited yet."));
 104                 return false;
 105         }
 106         return true;
 107 }
 108
 109 //-----------------------------------------------------------------------------
 110
 111 if (isset($_GET['InvoiceNumber']) && $_GET['InvoiceNumber'] > 0) {
 112
 113     $ci = new Cart(10, $_GET['InvoiceNumber'], true);
 114
 115     $ci->trans_type = 11;
 116     $ci->src_docs = $ci->trans_no;
 117     $ci->src_date = $ci->document_date;
 118     $ci->trans_no = 0;
 119     $ci->document_date = Today();
 120     $ci->reference = references::get_next(11);
 121
 122     for ($line_no=0; $line_no<count($ci->line_items); $line_no++) {
 123         $ci->line_items[$line_no]->qty_dispatched = '0';
 124     }
 125
 126     $_SESSION['Items'] = $ci;
 127         copy_from_cart();
 128
 129 } elseif ( isset($_GET['ModifyCredit']) && $_GET['ModifyCredit']>0) {
 130
 131         $_SESSION['Items'] = new Cart(11,$_GET['ModifyCredit']);
 132         copy_from_cart();
 133
 134 } elseif (!processing_active()) {
 135         /* This page can only be called with an invoice number for crediting*/
 136         die (_("This page can only be opened if an invoice has been selected for crediting."));
 137 } elseif (!check_quantities()) {
 138         display_error(_("Selected quantity cannot be less than zero nor more than quantity not credited yet."));
 139 }
 140
 141 function check_quantities()
 142 {
 143         $ok =1;
 144         foreach ($_SESSION['Items']->line_items as $line_no=>$itm) {
 145                 if ($itm->quantity == $itm->qty_done) {
 146                         continue; // this line was fully credited/removed
 147                 }
 148                 if (isset($_POST['Line'.$line_no])) {
 149                         if (check_num('Line'.$line_no, 0, $itm->quantity)) {
 150                                 $_SESSION['Items']->line_items[$line_no]->qty_dispatched =
 151                                   input_num('Line'.$line_no);
 152                         }
 153                 }
 154                 else {
 155                         $ok = 0;
 156                 }
 157
 158                 if (isset($_POST['Line'.$line_no.'Desc'])) {
 159                         $line_desc = $_POST['Line'.$line_no.'Desc'];
 160                         if (strlen($line_desc) > 0) {
 161                                 $_SESSION['Items']->line_items[$line_no]->item_description = $line_desc;
 162                         }
 163                 }
 164         }
 165         return $ok;
 166 }
 167 //-----------------------------------------------------------------------------
 168
 169 function copy_to_cart()
 170 {
 171   $cart = &$_SESSION['Items'];
 172   $cart->ship_via = $_POST['ShipperID'];
 173   $cart->freight_cost = input_num('ChargeFreightCost');
 174   $cart->document_date =  $_POST['CreditDate'];
 175   $cart->Location = $_POST['Location'];
 176   $cart->Comments = $_POST['CreditText'];
 177 }
 178 //-----------------------------------------------------------------------------
 179
 180 function copy_from_cart()
 181 {
 182   $cart = &$_SESSION['Items'];
 183   $_POST['ShipperID'] = $cart->ship_via;
 184   $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
 185   $_POST['CreditDate']= $cart->document_date;
 186   $_POST['Location']= $cart->Location;
 187   $_POST['CreditText']= $cart->Comments;
 188 }
 189 //-----------------------------------------------------------------------------
 190
 191 if (isset($_POST['ProcessCredit']) && can_process()) {
 192
 193     $newcredit = ($_SESSION['Items']->trans_no == 0);
 194
 195     if (!isset($_POST['WriteOffGLCode']))
 196                 $_POST['WriteOffGLCode'] = 0;
 197
 198         copy_to_cart();
 199     $credit_no = $_SESSION['Items']->write($_POST['WriteOffGLCode']);
 200
 201         processing_end();
 202         if ($newcredit) {
 203                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
 204         } else {
 205                 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$credit_no");
 206         }
 207 }
 208
 209 //-----------------------------------------------------------------------------
 210
 211 if (isset($_POST['Location'])) {
 212         $_SESSION['Items']->Location = $_POST['Location'];
 213 }
 214
 215 //-----------------------------------------------------------------------------
 216
 217 function display_credit_items()
 218 {
 219         global $table_style, $table_style2;
 220
 221     start_form(false, true);
 222
 223         start_table("$table_style2 width=80%", 5);
 224         echo "<tr><td>"; // outer table
 225
 226     start_table("$table_style width=100%");
 227     start_row();
 228     label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
 229         label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
 230     label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
 231     end_row();
 232     start_row();
 233
 234 //      if (!isset($_POST['ref']))
 235 //              $_POST['ref'] = references::get_next(11);
 236
 237     if ($_SESSION['Items']->trans_no==0) {
 238                 ref_cells(_("Reference"), 'ref', '', $_SESSION['Items']->reference, "class='tableheader2'");
 239         } else {
 240                 label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
 241         }
 242 //    label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
 243     label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, array_keys($_SESSION['Items']->src_docs)), "class='tableheader2'");
 244
 245         if (!isset($_POST['ShipperID'])) {
 246                 $_POST['ShipperID'] = $_SESSION['Items']->ship_via;
 247         }
 248         label_cell(_("Shipping Company"), "class='tableheader2'");
 249         shippers_list_cells(null, 'ShipperID', $_POST['ShipperID']);
 250 //      if (!isset($_POST['sales_type_id']))
 251 //        $_POST['sales_type_id'] = $_SESSION['Items']->sales_type;
 252 //      label_cell(_("Sales Type"), "class='tableheader2'");
 253 //      sales_types_list_cells(null, 'sales_type_id', $_POST['sales_type_id']);
 254
 255         end_row();
 256         end_table();
 257
 258     echo "</td><td>";// outer table
 259
 260     start_table("$table_style width=100%");
 261
 262     label_row(_("Invoice Date"), $_SESSION['Items']->src_date, "class='tableheader2'");
 263
 264     date_row(_("Credit Note Date"), 'CreditDate', '', null, 0, 0, 0, "class='tableheader2'");
 265
 266     end_table();
 267
 268         echo "</td></tr>";
 269
 270         end_table(1); // outer table
 271
 272         div_start('credit_items');
 273     start_table("$table_style width=80%");
 274     $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
 275         _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
 276     table_header($th);
 277
 278     $k = 0; //row colour counter
 279
 280     foreach ($_SESSION['Items']->line_items as $line_no=>$ln_itm) {
 281                 if ($ln_itm->quantity == $ln_itm->qty_done) {
 282                         continue; // this line was fully credited/removed
 283                 }
 284                 alt_table_row_color($k);
 285
 286
 287                 //      view_stock_status_cell($ln_itm->stock_id); alternative view
 288         label_cell($ln_itm->stock_id);
 289
 290                 text_cells(null, 'Line'.$line_no.'Desc', $ln_itm->item_description, 30, 50);
 291                 $dec = get_qty_dec($ln_itm->stock_id);
 292         qty_cell($ln_itm->quantity, false, $dec);
 293         label_cell($ln_itm->units);
 294                 amount_cells(null, 'Line'.$line_no, number_format2($ln_itm->qty_dispatched, $dec),
 295                         null, null, $dec);
 296         $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
 297
 298         amount_cell($ln_itm->price);
 299         percent_cell($ln_itm->discount_percent*100);
 300         amount_cell($line_total);
 301         end_row();
 302     }
 303
 304     if (!check_num('ChargeFreightCost')) {
 305         $_POST['ChargeFreightCost'] = price_format($_SESSION['Items']->freight_cost);
 306     }
 307
 308         start_row();
 309         label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
 310         amount_cells_ex(null, "ChargeFreightCost", 6, 8, $_POST['ChargeFreightCost']);
 311         end_row();
 312
 313     $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
 314
 315     $display_sub_total = price_format($inv_items_total + input_num($_POST['ChargeFreightCost']));
 316     label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
 317
 318     $taxes = $_SESSION['Items']->get_taxes(input_num($_POST['ChargeFreightCost']));
 319
 320     $tax_total = display_edit_tax_items($taxes, 7, $_SESSION['Items']->tax_included);
 321
 322     $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
 323
 324     label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
 325
 326     end_table();
 327         div_end();
 328 }
 329
 330 //-----------------------------------------------------------------------------
 331 function display_credit_options()
 332 {
 333         global $table_style2, $Ajax;
 334         echo "<br>";
 335
 336 if (isset($_POST['_CreditType_update']))
 337         $Ajax->activate('options');
 338
 339  div_start('options');
 340         start_table("$table_style2");
 341
 342         credit_type_list_row(_("Credit Note Type"), 'CreditType', null, true);
 343
 344         if ($_POST['CreditType'] == "Return")
 345         {
 346
 347                 /*if the credit note is a return of goods then need to know which location to receive them into */
 348                 if (!isset($_POST['Location']))
 349                         $_POST['Location'] = $_SESSION['Items']->Location;
 350                 locations_list_row(_("Items Returned to Location"), 'Location', $_POST['Location']);
 351         }
 352         else
 353         {
 354                 /* the goods are to be written off to somewhere */
 355                 gl_all_accounts_list_row(_("Write off the cost of the items to"), 'WriteOffGLCode', null);
 356         }
 357
 358         textarea_row(_("Memo"), "CreditText", null, 51, 3);
 359         echo "</table>";
 360  div_end();
 361 }
 362
 363 //-----------------------------------------------------------------------------
 364 if (get_post('Update'))
 365 {
 366         $Ajax->activate('credit_items');
 367 }
 368 //-----------------------------------------------------------------------------
 369
 370 display_credit_items();
 371 display_credit_options();
 372
 373 echo "<br><center>";
 374 submit('Update', _("Update"), true, _('Update credit value for quantities entered'), true);
 375 echo "&nbsp";
 376 submit('ProcessCredit', _("Process Credit Note"), true, '', true);
 377 echo "</center>";
 378
 379 end_form();
 380
 381
 382 end_page();
 383
 384 ?>