6 include_once($path_to_root . "/sales/includes/cart_class.inc");
7 include_once($path_to_root . "/includes/session.inc");
9 include_once($path_to_root . "/includes/data_checks.inc");
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");
15 if ($use_popup_windows)
16 $js .= get_js_open_window(900, 500);
18 $js .= get_js_date_picker();
19 page(_("Credit all or part of an Invoice"), false, false, "", $js);
21 //---------------------------------------------------------------------------------------------------------------
23 if (isset($_GET['AddedID']))
25 $credit_no = $_GET['AddedID'];
29 display_notification_centered(_("Credit Note has been processed"));
30 display_note(get_customer_trans_view_str($trans_type, $credit_no, _("View this credit note")), 0, 0);
32 display_note(get_gl_view_str($trans_type, $credit_no, _("View the GL Journal Entries for this Credit Note")));
34 display_footer_exit();
37 //--------------------------------------------------------------------------------------
39 if (!isset($_GET['InvoiceNumber']) && !$_SESSION['InvoiceToCredit'])
41 /* This page can only be called with an invoice number for crediting*/
42 die (_("This page can only be opened if an invoice has been selected for crediting."));
45 //--------------------------------------------------------------------------------------
47 function can_process()
49 if (!is_date($_POST['CreditDate']))
51 display_error(_("The entered date is invalid."));;
54 elseif (!is_date_in_fiscalyear($_POST['CreditDate']))
56 display_error(_("The entered date is not in fiscal year."));
60 if (!references::is_valid($_POST['ref']))
62 display_error(_("You must enter a reference."));;
66 if (!is_new_reference($_POST['ref'], 11))
68 display_error(_("The entered reference is already in use."));;
72 if (!is_numeric($_POST['ChargeFreightCost']) || $_POST['ChargeFreightCost'] < 0)
74 display_error(_("The entered shipping cost is invalid or less than zero."));;
81 //--------------------------------------------------------------------------------------
83 function clear_globals()
85 if (isset($_SESSION['Items']))
87 unset($_SESSION['Items']->line_items);
88 unset($_SESSION['Items']);
90 unset($_SESSION['InvoiceToCredit']);
93 //--------------------------------------------------------------------------------------
95 function process_credit()
100 $credit_no = credit_invoice($_SESSION['Items'], $_SESSION['InvoiceToCredit'],
101 $_SESSION['Order'], $_POST['CreditDate'], $_POST['CreditType'],
102 $_POST['tax_group_id'], $_POST['ChargeFreightCost'], $_POST['ref'],
103 $_POST['CreditText'], $_POST['WriteOffGLCode']);
107 meta_forward($_SERVER['PHP_SELF'], "AddedID=$credit_no");
111 //--------------------------------------------------------------------------------------
113 if (isset($_GET['InvoiceNumber']) && $_GET['InvoiceNumber'] > 0)
118 $_SESSION['InvoiceToCredit'] = $_GET['InvoiceNumber'];
119 $_SESSION['Items'] = new cart;
121 /*read in all the guff from the selected invoice into the Items cart */
123 // we need a distinct here so that it only returns 1 line - because there can be multiple moves
124 // per item (for assemblies, etc)
125 $sql = "SELECT DISTINCT ".TB_PREF."debtor_trans.*,
126 ".TB_PREF."cust_branch.default_location, ".TB_PREF."cust_branch.default_ship_via,
127 ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code,
128 ".TB_PREF."tax_groups.name AS tax_group_name, ".TB_PREF."tax_groups.id AS tax_group_id,
129 ".TB_PREF."sales_orders.from_stk_loc
130 FROM ".TB_PREF."debtor_trans, ".TB_PREF."debtors_master, ".TB_PREF."cust_branch, ".TB_PREF."tax_groups, ".TB_PREF."sales_orders
131 WHERE ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."debtors_master.debtor_no
132 AND ".TB_PREF."debtor_trans.branch_code = ".TB_PREF."cust_branch.branch_code
133 AND ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."cust_branch.debtor_no
134 AND ".TB_PREF."cust_branch.tax_group_id = ".TB_PREF."tax_groups.id
135 AND ".TB_PREF."debtor_trans.trans_no = " . $_GET['InvoiceNumber'] . "
136 AND ".TB_PREF."debtor_trans.type=10
137 AND ".TB_PREF."sales_orders.order_no=".TB_PREF."debtor_trans.order_";
139 $result = db_query($sql,"The invoice details cannot be retrieved");
141 if (db_num_rows($result) == 1)
144 $myrow = db_fetch($result);
146 $_SESSION['Items']->customer_id = $myrow["debtor_no"];
147 $_SESSION['Items']->customer_name = $myrow["name"];
148 $_SESSION['Items']->cust_ref = $myrow["reference"];
149 $_SESSION['Items']->Branch = $myrow["branch_code"];
150 $_SESSION['Items']->customer_currency = $myrow["curr_code"];
152 $_SESSION['Items']->Comments = "";
153 $_SESSION['Items']->default_sales_type =$myrow["tpe"];
154 $_SESSION['Items']->Location = $myrow["from_stk_loc"];
156 $_SESSION['Items']->tax_group_name = $myrow["tax_group_name"];
157 $_SESSION['Items']->tax_group_id = $myrow["tax_group_id"];
159 $_SESSION['Items']->delivery_date = sql2date($myrow["tran_date"]);
160 $_SESSION['Items']->freight_cost = $myrow["ov_freight"];
162 $_SESSION['Items']->ship_via = $myrow["default_ship_via"];
164 $_SESSION['Order'] = $myrow["order_"];
166 db_free_result($result);
168 /*now populate the line items array with the detail records for the invoice*/
170 $result = get_customer_trans_details(10, $_GET['InvoiceNumber']);
172 if (db_num_rows($result) > 0)
175 while ($myrow = db_fetch($result))
178 $_SESSION['Items']->add_to_cart($myrow["stock_id"],-$myrow["quantity"],
179 $myrow["FullUnitPrice"],$myrow["discount_percent"],$myrow["qty_done"],
180 $myrow["standard_cost"],$myrow["description"],$myrow["id"]);
182 $_SESSION['Items']->line_items[$_SESSION['Items']->lines_on_order]->standard_cost = $myrow["standard_cost"];
186 } /*else { // there are no item records created for that invoice
187 // it's ok there might be shipping or only taxes !!
188 echo "<CENTER><A HREF='$path_to_root/index.php?" . SID . "'>" . _("Back to the main menu") . "</A>";
189 echo "<P>" . _("There are no line items that were retrieved for this invoice. A credit note cannot be created from this invoice."). "<BR><BR>";
193 }*/ //end of checks on returned data set
194 db_free_result($result);
198 display_error(_("This invoice can not be credited using the automatic facility."));
199 display_error("Please report that a duplicate debtor_trans header record was found for invoice " . $SESSION['InvoiceToCredit']);
202 } //valid invoice record returned from the entered invoice number
208 /* if processing, the page has been called and ${$StkItm->stock_id} would have been set from the post */
209 foreach ($_SESSION['Items']->line_items as $itm)
211 $_SESSION['Items']->line_items[$itm->line_no]->qty_dispatched = $_POST[$itm->stock_id];
213 if (isset($_POST[$itm->stock_id . "Desc"]) && strlen($_POST[$itm->stock_id . "Desc"]) > 0)
215 $_SESSION['Items']->line_items[$itm->line_no]->item_description = $_POST[$itm->stock_id . "Desc"];
220 //--------------------------------------------------------------------------------------
222 if (isset($_POST['ProcessCredit']))
227 //--------------------------------------------------------------------------------------
229 if (isset($_POST['Location']))
231 $_SESSION['Items']->Location = $_POST['Location'];
234 //--------------------------------------------------------------------------------------
236 function display_credit_items()
238 global $table_style, $table_style2;
240 start_form(false, true);
242 start_table("$table_style2 width=80%", 5);
243 echo "<tr><td>"; // outer table
245 start_table("$table_style width=100%");
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'");
253 if (!isset($_POST['ref']))
254 $_POST['ref'] = references::get_next(11);
256 ref_cells(_("Reference"), 'ref', null, "class='tableheader2'");
258 label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
260 if (!isset($_POST['tax_group_id']))
261 $_POST['tax_group_id'] = $_SESSION['Items']->tax_group_id;
262 label_cell(_("Tax Group"), "class='tableheader2'");
263 tax_groups_list_cells(null, 'tax_group_id', $_POST['tax_group_id'], false, null, true);
267 echo "</td><td>";// outer table
269 start_table("$table_style width=100%");
271 label_row(_("Invoice Date"), $_SESSION['Items']->delivery_date, "class='tableheader2'");
273 date_row(_("Credit Note Date"), 'CreditDate', null, 0, 0, 0, "class='tableheader2'");
279 end_table(1); // outer table
281 start_table("$table_style width=80%");
282 $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
283 _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
286 $k = 0; //row colour counter
288 foreach ($_SESSION['Items']->line_items as $ln_itm)
291 alt_table_row_color($k);
293 $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
295 label_cell($ln_itm->stock_id);
296 text_cells(null, $ln_itm->stock_id . "Desc", $ln_itm->item_description, 30, 50);
297 qty_cell($ln_itm->quantity);
298 label_cell($ln_itm->units);
300 text_cells(null, $ln_itm->stock_id, $ln_itm->qty_dispatched, 13, 15);
302 amount_cell($ln_itm->price);
303 amount_cell($ln_itm->discount_percent*100);
304 amount_cell($line_total);
308 if (!isset($_POST['ChargeFreightCost']) || ($_POST['ChargeFreightCost'] == ""))
310 $_POST['ChargeFreightCost'] = $_SESSION['Items']->freight_cost;
313 label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
314 text_cells(null, "ChargeFreightCost", $_POST['ChargeFreightCost'], 6, 6);
317 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
319 $display_sub_total = number_format2($inv_items_total + $_POST['ChargeFreightCost'],user_price_dec());
320 label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
322 $taxes = $_SESSION['Items']->get_taxes($_POST['tax_group_id'], $_POST['ChargeFreightCost']);
324 $tax_total = display_edit_tax_items($taxes, 7);
326 $display_total = number_format2(($inv_items_total + $_POST['ChargeFreightCost'] + $tax_total), user_price_dec());
328 label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
333 //--------------------------------------------------------------------------------------
335 function display_credit_options()
337 global $table_style2;
340 start_table($table_style2);
342 echo "<tr><td>" . _("Credit Note Type") . "</td>";
343 echo "<td><select name='CreditType' onchange='this.form.submit();'>";
344 if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
346 echo "<option value='WriteOff'>" . _("Items Written Off") . "</option>";
347 echo "<option selected value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
351 echo "<option selected value='WriteOff'>" . _("Items Written Off") . "</option>";
352 echo "<option value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
357 if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
360 /*if the credit note is a return of goods then need to know which location to receive them into */
361 if (!isset($_POST['Location']))
363 $_POST['Location'] = $_SESSION['Items']->Location;
366 locations_list_row(_("Items Returned to Inventory Location"), 'Location', $_POST['Location']);
370 { /* the goods are to be written off to somewhere */
372 gl_all_accounts_list_row(_("Write Off the Cost of the Items to"), 'WriteOffGLCode', $_POST['WriteOffGLCode']);
374 textarea_row(_("Memo"), "CreditText", null, 45, 3);
378 //--------------------------------------------------------------------------------------
380 display_credit_items();
381 display_credit_options();
384 submit('Update', _("Update"));
386 submit('ProcessCredit', _("Process Credit Note"));
391 //--------------------------------------------------------------------------------------