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