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 = array($_GET['InvoiceNumber'], $ci->trans_no);
 117     $ci->src_docs = $ci->trans_no;
 118     $ci->src_date = $ci->document_date;
 119     $ci->trans_no = 0;
 120     $ci->document_date = Today();
 121     $ci->reference = references::get_next(11);
 122
 123     for ($line_no=0; $line_no<count($ci->line_items); $line_no++) {
 124         $ci->line_items[$line_no]->qty_dispatched = '0';
 125     }
 126
 127     $_SESSION['Items'] = $ci;
 128         copy_from_cart();
 129
 130 } elseif ( isset($_GET['ModifyCredit']) && $_GET['ModifyCredit']>0) {
 131
 132         $_SESSION['Items'] = new Cart(11,$_GET['ModifyCredit']);
 133         copy_from_cart();
 134
 135 } elseif (!processing_active()) {
 136         /* This page can only be called with an invoice number for crediting*/
 137         die (_("This page can only be opened if an invoice has been selected for crediting."));
 138 } elseif (!check_quantities()) {
 139         display_error(_("Selected quantity cannot be less than zero nor more than quantity not credited yet."));
 140 }
 141
 142 function check_quantities()
 143 {
 144         $ok =1;
 145         foreach ($_SESSION['Items']->line_items as $line_no=>$itm) {
 146                 if (isset($_POST['Line'.$line_no])) {
 147                         if (check_num('Line'.$line_no, 0, $itm->quantity)) {
 148                                 $_SESSION['Items']->line_items[$line_no]->qty_dispatched =
 149                                   input_num('Line'.$line_no);
 150                         }
 151                 }
 152                 else {
 153                         $ok = 0;
 154                 }
 155
 156                 if (isset($_POST['Line'.$line_no.'Desc'])) {
 157                         $line_desc = $_POST['Line'.$line_no.'Desc'];
 158                         if (strlen($line_desc) > 0) {
 159                                 $_SESSION['Items']->line_items[$line_no]->item_description = $line_desc;
 160                         }
 161                 }
 162         }
 163         return $ok;
 164 }
 165 //-----------------------------------------------------------------------------
 166
 167 function copy_to_cart()
 168 {
 169   $cart = &$_SESSION['Items'];
 170   $cart->ship_via = $_POST['ShipperID'];
 171   $cart->freight_cost = input_num('ChargeFreightCost');
 172   $cart->document_date =  $_POST['CreditDate'];
 173   $cart->Location = $_POST['Location'];
 174   $cart->Comments = $_POST['CreditText'];
 175 }
 176 //-----------------------------------------------------------------------------
 177
 178 function copy_from_cart()
 179 {
 180   $cart = &$_SESSION['Items'];
 181   $_POST['ShipperID'] = $cart->ship_via;
 182   $_POST['ChargeFreightCost'] = price_format($cart->freight_cost);
 183   $_POST['CreditDate']= $cart->document_date;
 184   $_POST['Location']= $cart->Location;
 185   $_POST['CreditText']= $cart->Comments;
 186 }
 187 //-----------------------------------------------------------------------------
 188
 189 if (isset($_POST['ProcessCredit']) && can_process()) {
 190
 191     $newcredit = ($_SESSION['Items']->trans_no == 0);
 192
 193     if (!isset($_POST['WriteOffGLCode']))
 194                 $_POST['WriteOffGLCode'] = 0;
 195
 196         copy_to_cart();
 197     $credit_no = $_SESSION['Items']->write($_POST['WriteOffGLCode']);
 198
 199         processing_end();
 200         if ($newcredit) {
 201                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
 202         } else {
 203                 meta_forward($_SERVER['PHP_SELF'], "UpdatedID=$credit_no");
 204         }
 205 }
 206
 207 //-----------------------------------------------------------------------------
 208
 209 if (isset($_POST['Location'])) {
 210         $_SESSION['Items']->Location = $_POST['Location'];
 211 }
 212
 213 //-----------------------------------------------------------------------------
 214
 215 function display_credit_items()
 216 {
 217         global $table_style, $table_style2;
 218
 219     start_form(false, true);
 220
 221         start_table("$table_style2 width=80%", 5);
 222         echo "<tr><td>"; // outer table
 223
 224     start_table("$table_style width=100%");
 225     start_row();
 226     label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
 227         label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
 228     label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
 229     end_row();
 230     start_row();
 231
 232 //      if (!isset($_POST['ref']))
 233 //              $_POST['ref'] = references::get_next(11);
 234
 235     if ($_SESSION['Items']->trans_no==0) {
 236                 ref_cells(_("Reference"), 'ref', '', $_SESSION['Items']->reference, "class='tableheader2'");
 237         } else {
 238                 label_cells(_("Reference"), $_SESSION['Items']->reference, "class='tableheader2'");
 239         }
 240 //    label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
 241     label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, array_keys($_SESSION['Items']->src_docs)), "class='tableheader2'");
 242
 243         if (!isset($_POST['ShipperID'])) {
 244                 $_POST['ShipperID'] = $_SESSION['Items']->ship_via;
 245         }
 246         label_cell(_("Shipping Company"), "class='tableheader2'");
 247         shippers_list_cells(null, 'ShipperID', $_POST['ShipperID']);
 248 //      if (!isset($_POST['sales_type_id']))
 249 //        $_POST['sales_type_id'] = $_SESSION['Items']->sales_type;
 250 //      label_cell(_("Sales Type"), "class='tableheader2'");
 251 //      sales_types_list_cells(null, 'sales_type_id', $_POST['sales_type_id']);
 252
 253         end_row();
 254         end_table();
 255
 256     echo "</td><td>";// outer table
 257
 258     start_table("$table_style width=100%");
 259
 260     label_row(_("Invoice Date"), $_SESSION['Items']->src_date, "class='tableheader2'");
 261
 262     date_row(_("Credit Note Date"), 'CreditDate', '', null, 0, 0, 0, "class='tableheader2'");
 263
 264     end_table();
 265
 266         echo "</td></tr>";
 267
 268         end_table(1); // outer table
 269
 270         div_start('credit_items');
 271     start_table("$table_style width=80%");
 272     $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
 273         _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
 274     table_header($th);
 275
 276     $k = 0; //row colour counter
 277
 278     foreach ($_SESSION['Items']->line_items as $line_no=>$ln_itm) {
 279                 if ($ln_itm->quantity==$ln_itm->qty_done) {
 280                         continue; // this line was fully credited
 281                 }
 282                 alt_table_row_color($k);
 283
 284
 285                 //      view_stock_status_cell($ln_itm->stock_id); alternative view
 286         label_cell($ln_itm->stock_id);
 287
 288                 text_cells(null, 'Line'.$line_no.'Desc', $ln_itm->item_description, 30, 50);
 289                 $dec = get_qty_dec($ln_itm->stock_id);
 290         qty_cell($ln_itm->quantity, false, $dec);
 291         label_cell($ln_itm->units);
 292                 amount_cells(null, 'Line'.$line_no, number_format2($ln_itm->qty_dispatched, $dec),
 293                         null, null, $dec);
 294         $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
 295
 296         amount_cell($ln_itm->price);
 297         percent_cell($ln_itm->discount_percent*100);
 298         amount_cell($line_total);
 299         end_row();
 300     }
 301
 302     if (!check_num('ChargeFreightCost')) {
 303         $_POST['ChargeFreightCost'] = price_format($_SESSION['Items']->freight_cost);
 304     }
 305
 306         start_row();
 307         label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
 308         amount_cells_ex(null, "ChargeFreightCost", 6, 8, $_POST['ChargeFreightCost']);
 309         end_row();
 310
 311     $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
 312
 313     $display_sub_total = price_format($inv_items_total + input_num($_POST['ChargeFreightCost']));
 314     label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
 315
 316     $taxes = $_SESSION['Items']->get_taxes(input_num($_POST['ChargeFreightCost']));
 317
 318     $tax_total = display_edit_tax_items($taxes, 7, $_SESSION['Items']->tax_included);
 319
 320     $display_total = price_format(($inv_items_total + input_num('ChargeFreightCost') + $tax_total));
 321
 322     label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
 323
 324     end_table();
 325         div_end();
 326 }
 327
 328 //-----------------------------------------------------------------------------
 329 function display_credit_options()
 330 {
 331         global $table_style2, $Ajax;
 332         echo "<br>";
 333
 334 if (isset($_POST['_CreditType_update']))
 335         $Ajax->activate('options');
 336
 337  div_start('options');
 338         start_table("$table_style2");
 339
 340         credit_type_list_row(_("Credit Note Type"), 'CreditType', null, true);
 341
 342         if ($_POST['CreditType'] == "Return")
 343         {
 344
 345                 /*if the credit note is a return of goods then need to know which location to receive them into */
 346                 if (!isset($_POST['Location']))
 347                         $_POST['Location'] = $_SESSION['Items']->Location;
 348                 locations_list_row(_("Items Returned to Location"), 'Location', $_POST['Location']);
 349         }
 350         else
 351         {
 352                 /* the goods are to be written off to somewhere */
 353                 gl_all_accounts_list_row(_("Write off the cost of the items to"), 'WriteOffGLCode', null);
 354         }
 355
 356         textarea_row(_("Memo"), "CreditText", null, 51, 3);
 357         echo "</table>";
 358  div_end();
 359 }
 360
 361 //-----------------------------------------------------------------------------
 362 if (get_post('Update'))
 363 {
 364         $Ajax->activate('credit_items');
 365 }
 366 //-----------------------------------------------------------------------------
 367
 368 display_credit_items();
 369 display_credit_options();
 370
 371 echo "<br><center>";
 372 submit('Update', _("Update"), true, _('Update credit value for quantities entered'), true);
 373 echo "&nbsp";
 374 submit('ProcessCredit', _("Process Credit Note"), true, '', true);
 375 echo "</center>";
 376
 377 end_form();
 378
 379
 380 end_page();
 381
 382 ?>