sales/customer_credit_invoice.php

   1 <?php
   2
   3 $page_security =3;
   4 $path_to_root="..";
   5
   6 include_once($path_to_root . "/sales/includes/cart_class.inc");
   7 include_once($path_to_root . "/includes/session.inc");
   8
   9 include_once($path_to_root . "/includes/data_checks.inc");
  10
  11 include_once($path_to_root . "/includes/manufacturing.inc");
  12 include_once($path_to_root . "/sales/includes/sales_db.inc");
  13 include_once($path_to_root . "/sales/includes/sales_ui.inc");
  14 $js = "";
  15 if ($use_popup_windows)
  16         $js .= get_js_open_window(900, 500);
  17 page(_("Credit all or part of an Invoice"), false, false, "", $js);
  18
  19 //---------------------------------------------------------------------------------------------------------------
  20
  21 if (isset($_GET['AddedID']))
  22 {
  23         $credit_no = $_GET['AddedID'];
  24         $trans_type = 11;
  25
  26         echo "<center>";
  27         display_notification_centered(_("Credit Note has been processed"));
  28         display_note(get_customer_trans_view_str($trans_type, $credit_no, _("View this credit note")), 0, 0);
  29
  30         display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL Journal Entries for this Credit Note")));
  31
  32         display_footer_exit();
  33 }
  34
  35 //--------------------------------------------------------------------------------------
  36
  37 if (!isset($_GET['InvoiceNumber']) && !$_SESSION['InvoiceToCredit'])
  38 {
  39         /* This page can only be called with an invoice number for crediting*/
  40         die (_("This page can only be opened if an invoice has been selected for crediting."));
  41 }
  42
  43 //--------------------------------------------------------------------------------------
  44
  45 function can_process()
  46 {
  47         if (!is_date($_POST['CreditDate']))
  48         {
  49                 display_error(_("The entered date is invalid."));;
  50                 return false;
  51         }
  52         elseif (!is_date_in_fiscalyear($_POST['CreditDate']))
  53         {
  54                 display_error(_("The entered date is not in fiscal year."));
  55                 return false;
  56         }
  57
  58         if (!references::is_valid($_POST['ref']))
  59         {
  60                 display_error(_("You must enter a reference."));;
  61                 return false;
  62         }
  63
  64         if (!is_new_reference($_POST['ref'], 11))
  65         {
  66                 display_error(_("The entered reference is already in use."));;
  67                 return false;
  68         }
  69
  70         if (!is_numeric($_POST['ChargeFreightCost']) || $_POST['ChargeFreightCost'] < 0)
  71         {
  72                 display_error(_("The entered shipping cost is invalid or less than zero."));;
  73                 return false;
  74         }
  75
  76         return true;
  77 }
  78
  79 //--------------------------------------------------------------------------------------
  80
  81 function clear_globals()
  82 {
  83         if (isset($_SESSION['Items']))
  84         {
  85                 unset($_SESSION['Items']->line_items);
  86                 unset($_SESSION['Items']);
  87         }
  88         unset($_SESSION['InvoiceToCredit']);
  89 }
  90
  91 //--------------------------------------------------------------------------------------
  92
  93 function process_credit()
  94 {
  95         global $path_to_root;
  96         if (can_process())
  97         {
  98                 $credit_no = credit_invoice($_SESSION['Items'], $_SESSION['InvoiceToCredit'],
  99                         $_SESSION['Order'],     $_POST['CreditDate'], $_POST['CreditType'],
 100                         $_POST['tax_group_id'], $_POST['ChargeFreightCost'], $_POST['ref'],
 101                         $_POST['CreditText'], $_POST['WriteOffGLCode']);
 102
 103                 clear_globals();
 104
 105                 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
 106         }
 107 }
 108
 109 //--------------------------------------------------------------------------------------
 110
 111 if (isset($_GET['InvoiceNumber']) && $_GET['InvoiceNumber'] > 0)
 112 {
 113
 114         clear_globals();
 115
 116         session_register("Items");
 117         session_register("InvoiceToCredit");
 118         session_Register("Order");
 119
 120         $_SESSION['InvoiceToCredit'] = $_GET['InvoiceNumber'];
 121         $_SESSION['Items'] = new cart;
 122
 123         /*read in all the guff from the selected invoice into the Items cart    */
 124
 125         // we need a distinct here so that it only returns 1 line - becuase there can be mutliple moves
 126         // per item (for assemblies, etc)
 127         $sql = "SELECT DISTINCT ".TB_PREF."debtor_trans.*,
 128                 ".TB_PREF."cust_branch.default_location, ".TB_PREF."cust_branch.default_ship_via,
 129                 ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code,
 130         ".TB_PREF."tax_groups.name AS tax_group_name, ".TB_PREF."tax_groups.id AS tax_group_id,
 131         ".TB_PREF."sales_orders.from_stk_loc
 132         FROM ".TB_PREF."debtor_trans, ".TB_PREF."debtors_master, ".TB_PREF."cust_branch, ".TB_PREF."tax_groups, ".TB_PREF."sales_orders
 133         WHERE ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."debtors_master.debtor_no
 134         AND ".TB_PREF."debtor_trans.branch_code = ".TB_PREF."cust_branch.branch_code
 135         AND ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."cust_branch.debtor_no
 136         AND ".TB_PREF."cust_branch.tax_group_id = ".TB_PREF."tax_groups.id
 137         AND ".TB_PREF."debtor_trans.trans_no = " . $_GET['InvoiceNumber'] . "
 138                 AND ".TB_PREF."debtor_trans.type=10
 139         AND ".TB_PREF."sales_orders.order_no=".TB_PREF."debtor_trans.order_";
 140
 141         $result = db_query($sql,"The invoice details cannot be retrieved");
 142
 143         if (db_num_rows($result) == 1)
 144         {
 145
 146                 $myrow = db_fetch($result);
 147
 148                 $_SESSION['Items']->customer_id = $myrow["debtor_no"];
 149                 $_SESSION['Items']->customer_name = $myrow["name"];
 150                 $_SESSION['Items']->cust_ref = $myrow["reference"];
 151                 $_SESSION['Items']->Branch = $myrow["branch_code"];
 152                 $_SESSION['Items']->customer_currency = $myrow["curr_code"];
 153
 154                 $_SESSION['Items']->Comments = "";
 155                 $_SESSION['Items']->default_sales_type =$myrow["tpe"];
 156                 $_SESSION['Items']->Location = $myrow["from_stk_loc"];
 157
 158                 $_SESSION['Items']->tax_group_name = $myrow["tax_group_name"];
 159                 $_SESSION['Items']->tax_group_id = $myrow["tax_group_id"];
 160
 161                 $_SESSION['Items']->delivery_date = sql2date($myrow["tran_date"]);
 162                 $_SESSION['Items']->freight_cost = $myrow["ov_freight"];
 163
 164                 $_SESSION['Items']->ship_via = $myrow["default_ship_via"];
 165
 166                 $_SESSION['Order'] = $myrow["order_"];
 167
 168                 db_free_result($result);
 169
 170                 /*now populate the line items array with the detail records for the invoice*/
 171
 172                 $result = get_customer_trans_details(10, $_GET['InvoiceNumber']);
 173
 174                 if (db_num_rows($result) > 0)
 175                 {
 176
 177                         while ($myrow = db_fetch($result))
 178                         {
 179
 180                                 $_SESSION['Items']->add_to_cart($myrow["stock_id"],-$myrow["quantity"],
 181                                         $myrow["FullUnitPrice"],$myrow["discount_percent"]);
 182
 183                                 $_SESSION['Items']->line_items[$myrow["stock_id"]]->standard_cost = $myrow["standard_cost"];
 184
 185                         }
 186
 187                 } /*else { // there are no item records created for that invoice
 188                         // it's ok there might be shipping or only taxes !!
 189                         echo "<CENTER><A HREF='$path_to_root/index.php?" . SID . "'>" . _("Back to the main menu") . "</A>";
 190                         echo "<P>" . _("There are no line items that were retrieved for this invoice. A credit note cannot be created from this invoice."). "<BR><BR>";
 191                         end_page();
 192                         exit;
 193
 194                 }*/ //end of checks on returned data set
 195                 db_free_result($result);
 196         }
 197         else
 198         {
 199                 display_error(_("This invoice can not be credited using the automatic facility."));
 200                 display_error("Please report that a duplicate debtor_trans header record was found for invoice " . $SESSION['InvoiceToCredit']);
 201                 echo "<br><br>";
 202                 exit;
 203         } //valid invoice record returned from the entered invoice number
 204
 205 }
 206 else
 207 {
 208
 209 /* if processing, the page has been called and ${$StkItm->stock_id} would have been set from the post */
 210         foreach ($_SESSION['Items']->line_items as $itm)
 211         {
 212                 $_SESSION['Items']->line_items[$itm->stock_id]->qty_dispatched = $_POST[$itm->stock_id];
 213
 214                 if (isset($_POST[$itm->stock_id . "Desc"]) && strlen($_POST[$itm->stock_id . "Desc"]) > 0)
 215                 {
 216                         $_SESSION['Items']->line_items[$itm->stock_id]->item_description = $_POST[$itm->stock_id . "Desc"];
 217                 }
 218         }
 219 }
 220
 221 //--------------------------------------------------------------------------------------
 222
 223 if (isset($_POST['ProcessCredit']))
 224 {
 225         process_credit();
 226 }
 227
 228 //--------------------------------------------------------------------------------------
 229
 230 if (isset($_POST['Location']))
 231 {
 232         $_SESSION['Items']->Location = $_POST['Location'];
 233 }
 234
 235 //--------------------------------------------------------------------------------------
 236
 237 function display_credit_items()
 238 {
 239         global $table_style, $table_style2;
 240
 241     start_form(false, true);
 242
 243         start_table("$table_style2 width=80%", 5);
 244         echo "<tr><td>"; // outer table
 245
 246     start_table("$table_style width=100%");
 247     start_row();
 248     label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
 249         label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
 250     label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
 251     end_row();
 252     start_row();
 253
 254         if (!isset($_POST['ref']))
 255                 $_POST['ref'] = references::get_next(11);
 256
 257     ref_cells(_("Reference"), 'ref', null, "class='tableheader2'");
 258
 259     label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
 260
 261     if (!isset($_POST['tax_group_id']))
 262         $_POST['tax_group_id'] = $_SESSION['Items']->tax_group_id;
 263     label_cell(_("Tax Group"), "class='tableheader2'");
 264     tax_groups_list_cells(null, 'tax_group_id', $_POST['tax_group_id'], false, null, true);
 265         end_row();
 266         end_table();
 267
 268     echo "</td><td>";// outer table
 269
 270     start_table("$table_style width=100%");
 271
 272     label_row(_("Invoice Date"), $_SESSION['Items']->delivery_date, "class='tableheader2'");
 273
 274     date_row(_("Credit Note Date"), 'CreditDate', null, 0, 0, 0, "class='tableheader2'");
 275
 276     end_table();
 277
 278         echo "</td></tr>";
 279
 280         end_table(1); // outer table
 281
 282     start_table("$table_style width=80%");
 283     $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
 284         _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
 285     table_header($th);
 286
 287     $k = 0; //row colour counter
 288
 289     foreach ($_SESSION['Items']->line_items as $ln_itm)
 290     {
 291
 292         alt_table_row_color($k);
 293
 294         $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
 295
 296         label_cell($ln_itm->stock_id);
 297                 text_cells(null, $ln_itm->stock_id . "Desc", $ln_itm->item_description, 30, 50);
 298         qty_cell($ln_itm->quantity);
 299         label_cell($ln_itm->units);
 300
 301         text_cells(null, $ln_itm->stock_id, $ln_itm->qty_dispatched, 13, 15);
 302
 303         amount_cell($ln_itm->price);
 304         amount_cell($ln_itm->discount_percent*100);
 305         amount_cell($line_total);
 306         end_row();
 307     }
 308
 309     if (!isset($_POST['ChargeFreightCost']) || ($_POST['ChargeFreightCost'] == ""))
 310     {
 311         $_POST['ChargeFreightCost'] = $_SESSION['Items']->freight_cost;
 312     }
 313         start_row();
 314         label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
 315     text_cells(null, "ChargeFreightCost", $_POST['ChargeFreightCost'], 6, 6);
 316         end_row();
 317
 318     $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
 319
 320     $display_sub_total = number_format2($inv_items_total + $_POST['ChargeFreightCost'],user_price_dec());
 321     label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
 322
 323     $taxes = $_SESSION['Items']->get_taxes($_POST['tax_group_id'], $_POST['ChargeFreightCost']);
 324
 325     $tax_total = display_edit_tax_items($taxes, 7);
 326
 327     $display_total = number_format2(($inv_items_total + $_POST['ChargeFreightCost'] + $tax_total), user_price_dec());
 328
 329     label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
 330
 331     end_table();
 332 }
 333
 334 //--------------------------------------------------------------------------------------
 335
 336 function display_credit_options()
 337 {
 338         global $table_style2;
 339
 340     echo "<br>";
 341     start_table($table_style2);
 342
 343     echo "<tr><td>" . _("Credit Note Type") . "</td>";
 344     echo "<td><select name='CreditType' onchange='this.form.submit();'>";
 345     if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
 346     {
 347         echo "<option value='WriteOff'>" . _("Items Written Off") . "</option>";
 348         echo "<option selected value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
 349     }
 350     else
 351     {
 352         echo "<option selected value='WriteOff'>" . _("Items Written Off") . "</option>";
 353         echo "<option value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
 354     }
 355     echo "</select>";
 356     echo"</td></tr>";
 357
 358     if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
 359     {
 360
 361         /*if the credit note is a return of goods then need to know which location to receive them into */
 362         if (!isset($_POST['Location']))
 363         {
 364                 $_POST['Location'] = $_SESSION['Items']->Location;
 365         }
 366
 367         locations_list_row(_("Items Returned to Inventory Location"), 'Location', $_POST['Location']);
 368
 369     }
 370     else
 371     {   /* the goods are to be written off to somewhere */
 372
 373         gl_all_accounts_list_row(_("Write Off the Cost of the Items to"), 'WriteOffGLCode', $_POST['WriteOffGLCode']);
 374     }
 375     textarea_row(_("Memo"), "CreditText", null, 45, 3);
 376     end_table();
 377 }
 378
 379 //--------------------------------------------------------------------------------------
 380
 381 display_credit_items();
 382 display_credit_options();
 383
 384 echo "<br><center>";
 385 submit('Update', _("Update"));
 386 echo "&nbsp";
 387 submit('ProcessCredit', _("Process Credit Note"));
 388 echo "</center>";
 389
 390 end_form();
 391
 392 //--------------------------------------------------------------------------------------
 393
 394 end_page();
 395
 396 ?>