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_register("Items");
119 session_register("InvoiceToCredit");
120 session_Register("Order");
122 $_SESSION['InvoiceToCredit'] = $_GET['InvoiceNumber'];
123 $_SESSION['Items'] = new cart;
125 /*read in all the guff from the selected invoice into the Items cart */
127 // we need a distinct here so that it only returns 1 line - becuase there can be mutliple moves
128 // per item (for assemblies, etc)
129 $sql = "SELECT DISTINCT ".TB_PREF."debtor_trans.*,
130 ".TB_PREF."cust_branch.default_location, ".TB_PREF."cust_branch.default_ship_via,
131 ".TB_PREF."debtors_master.name, ".TB_PREF."debtors_master.curr_code,
132 ".TB_PREF."tax_groups.name AS tax_group_name, ".TB_PREF."tax_groups.id AS tax_group_id,
133 ".TB_PREF."sales_orders.from_stk_loc
134 FROM ".TB_PREF."debtor_trans, ".TB_PREF."debtors_master, ".TB_PREF."cust_branch, ".TB_PREF."tax_groups, ".TB_PREF."sales_orders
135 WHERE ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."debtors_master.debtor_no
136 AND ".TB_PREF."debtor_trans.branch_code = ".TB_PREF."cust_branch.branch_code
137 AND ".TB_PREF."debtor_trans.debtor_no = ".TB_PREF."cust_branch.debtor_no
138 AND ".TB_PREF."cust_branch.tax_group_id = ".TB_PREF."tax_groups.id
139 AND ".TB_PREF."debtor_trans.trans_no = " . $_GET['InvoiceNumber'] . "
140 AND ".TB_PREF."debtor_trans.type=10
141 AND ".TB_PREF."sales_orders.order_no=".TB_PREF."debtor_trans.order_";
143 $result = db_query($sql,"The invoice details cannot be retrieved");
145 if (db_num_rows($result) == 1)
148 $myrow = db_fetch($result);
150 $_SESSION['Items']->customer_id = $myrow["debtor_no"];
151 $_SESSION['Items']->customer_name = $myrow["name"];
152 $_SESSION['Items']->cust_ref = $myrow["reference"];
153 $_SESSION['Items']->Branch = $myrow["branch_code"];
154 $_SESSION['Items']->customer_currency = $myrow["curr_code"];
156 $_SESSION['Items']->Comments = "";
157 $_SESSION['Items']->default_sales_type =$myrow["tpe"];
158 $_SESSION['Items']->Location = $myrow["from_stk_loc"];
160 $_SESSION['Items']->tax_group_name = $myrow["tax_group_name"];
161 $_SESSION['Items']->tax_group_id = $myrow["tax_group_id"];
163 $_SESSION['Items']->delivery_date = sql2date($myrow["tran_date"]);
164 $_SESSION['Items']->freight_cost = $myrow["ov_freight"];
166 $_SESSION['Items']->ship_via = $myrow["default_ship_via"];
168 $_SESSION['Order'] = $myrow["order_"];
170 db_free_result($result);
172 /*now populate the line items array with the detail records for the invoice*/
174 $result = get_customer_trans_details(10, $_GET['InvoiceNumber']);
176 if (db_num_rows($result) > 0)
179 while ($myrow = db_fetch($result))
182 $_SESSION['Items']->add_to_cart($_SESSION['Items']->lines_on_order+1, $myrow["id"], $myrow["stock_id"],-$myrow["quantity"],
183 $myrow["FullUnitPrice"],$myrow["discount_percent"]);
185 $_SESSION['Items']->line_items[$_SESSION['Items']->lines_on_order]->standard_cost = $myrow["standard_cost"];
189 } /*else { // there are no item records created for that invoice
190 // it's ok there might be shipping or only taxes !!
191 echo "<CENTER><A HREF='$path_to_root/index.php?" . SID . "'>" . _("Back to the main menu") . "</A>";
192 echo "<P>" . _("There are no line items that were retrieved for this invoice. A credit note cannot be created from this invoice."). "<BR><BR>";
196 }*/ //end of checks on returned data set
197 db_free_result($result);
201 display_error(_("This invoice can not be credited using the automatic facility."));
202 display_error("Please report that a duplicate debtor_trans header record was found for invoice " . $SESSION['InvoiceToCredit']);
205 } //valid invoice record returned from the entered invoice number
211 /* if processing, the page has been called and ${$StkItm->stock_id} would have been set from the post */
212 foreach ($_SESSION['Items']->line_items as $itm)
214 $_SESSION['Items']->line_items[$itm->line_no]->qty_dispatched = $_POST[$itm->stock_id];
216 if (isset($_POST[$itm->stock_id . "Desc"]) && strlen($_POST[$itm->stock_id . "Desc"]) > 0)
218 $_SESSION['Items']->line_items[$itm->line_no]->item_description = $_POST[$itm->stock_id . "Desc"];
223 //--------------------------------------------------------------------------------------
225 if (isset($_POST['ProcessCredit']))
230 //--------------------------------------------------------------------------------------
232 if (isset($_POST['Location']))
234 $_SESSION['Items']->Location = $_POST['Location'];
237 //--------------------------------------------------------------------------------------
239 function display_credit_items()
241 global $table_style, $table_style2;
243 start_form(false, true);
245 start_table("$table_style2 width=80%", 5);
246 echo "<tr><td>"; // outer table
248 start_table("$table_style width=100%");
250 label_cells(_("Customer"), $_SESSION['Items']->customer_name, "class='tableheader2'");
251 label_cells(_("Branch"), get_branch_name($_SESSION['Items']->Branch), "class='tableheader2'");
252 label_cells(_("Currency"), $_SESSION['Items']->customer_currency, "class='tableheader2'");
256 if (!isset($_POST['ref']))
257 $_POST['ref'] = references::get_next(11);
259 ref_cells(_("Reference"), 'ref', null, "class='tableheader2'");
261 label_cells(_("Crediting Invoice"), get_customer_trans_view_str(10, $_SESSION['InvoiceToCredit']), "class='tableheader2'");
263 if (!isset($_POST['tax_group_id']))
264 $_POST['tax_group_id'] = $_SESSION['Items']->tax_group_id;
265 label_cell(_("Tax Group"), "class='tableheader2'");
266 tax_groups_list_cells(null, 'tax_group_id', $_POST['tax_group_id'], false, null, true);
270 echo "</td><td>";// outer table
272 start_table("$table_style width=100%");
274 label_row(_("Invoice Date"), $_SESSION['Items']->delivery_date, "class='tableheader2'");
276 date_row(_("Credit Note Date"), 'CreditDate', null, 0, 0, 0, "class='tableheader2'");
282 end_table(1); // outer table
284 start_table("$table_style width=80%");
285 $th = array(_("Item Code"), _("Item Description"), _("Invoiced Quantity"), _("Units"),
286 _("Credit Quantity"), _("Price"), _("Discount %"), _("Total"));
289 $k = 0; //row colour counter
291 foreach ($_SESSION['Items']->line_items as $ln_itm)
294 alt_table_row_color($k);
296 $line_total =($ln_itm->qty_dispatched * $ln_itm->price * (1 - $ln_itm->discount_percent));
298 label_cell($ln_itm->stock_id);
299 text_cells(null, $ln_itm->stock_id . "Desc", $ln_itm->item_description, 30, 50);
300 qty_cell($ln_itm->quantity);
301 label_cell($ln_itm->units);
303 text_cells(null, $ln_itm->stock_id, $ln_itm->qty_dispatched, 13, 15);
305 amount_cell($ln_itm->price);
306 amount_cell($ln_itm->discount_percent*100);
307 amount_cell($line_total);
311 if (!isset($_POST['ChargeFreightCost']) || ($_POST['ChargeFreightCost'] == ""))
313 $_POST['ChargeFreightCost'] = $_SESSION['Items']->freight_cost;
316 label_cell(_("Credit Shipping Cost"), "colspan=7 align=right");
317 text_cells(null, "ChargeFreightCost", $_POST['ChargeFreightCost'], 6, 6);
320 $inv_items_total = $_SESSION['Items']->get_items_total_dispatch();
322 $display_sub_total = number_format2($inv_items_total + $_POST['ChargeFreightCost'],user_price_dec());
323 label_row(_("Sub-total"), $display_sub_total, "colspan=7 align=right", "align=right");
325 $taxes = $_SESSION['Items']->get_taxes($_POST['tax_group_id'], $_POST['ChargeFreightCost']);
327 $tax_total = display_edit_tax_items($taxes, 7);
329 $display_total = number_format2(($inv_items_total + $_POST['ChargeFreightCost'] + $tax_total), user_price_dec());
331 label_row(_("Credit Note Total"), $display_total, "colspan=7 align=right", "align=right");
336 //--------------------------------------------------------------------------------------
338 function display_credit_options()
340 global $table_style2;
343 start_table($table_style2);
345 echo "<tr><td>" . _("Credit Note Type") . "</td>";
346 echo "<td><select name='CreditType' onchange='this.form.submit();'>";
347 if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
349 echo "<option value='WriteOff'>" . _("Items Written Off") . "</option>";
350 echo "<option selected value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
354 echo "<option selected value='WriteOff'>" . _("Items Written Off") . "</option>";
355 echo "<option value='Return'>" . _("Items Returned to Inventory Location") . "</option>";
360 if (!isset($_POST['CreditType']) || $_POST['CreditType'] == "Return")
363 /*if the credit note is a return of goods then need to know which location to receive them into */
364 if (!isset($_POST['Location']))
366 $_POST['Location'] = $_SESSION['Items']->Location;
369 locations_list_row(_("Items Returned to Inventory Location"), 'Location', $_POST['Location']);
373 { /* the goods are to be written off to somewhere */
375 gl_all_accounts_list_row(_("Write Off the Cost of the Items to"), 'WriteOffGLCode', $_POST['WriteOffGLCode']);
377 textarea_row(_("Memo"), "CreditText", null, 45, 3);
381 //--------------------------------------------------------------------------------------
383 display_credit_items();
384 display_credit_options();
387 submit('Update', _("Update"));
389 submit('ProcessCredit', _("Process Credit Note"));
394 //--------------------------------------------------------------------------------------