Possibility to 'Credit This' in supplier transactions like in customer transaction.
[fa-stable.git] / purchasing / includes / ui / invoice_ui.inc
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU Affero General Public License,
5         AGPL, as published by the Free Software Foundation, either version 
6         3 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/agpl-3.0.html>.
11 ***********************************************************************/
12 //--------------------------------------------------------------------------------------------------
13
14 function copy_from_trans(&$supp_trans)
15 {
16         $_POST['Comments'] = $supp_trans->Comments;
17         $_POST['tran_date'] = $supp_trans->tran_date;
18         $_POST['due_date'] = $supp_trans->due_date;
19         $_POST['supp_reference'] = $supp_trans->supp_reference;
20         $_POST['reference'] = $supp_trans->reference;
21         $_POST['supplier_id'] = $supp_trans->supplier_id;
22 }
23
24 //--------------------------------------------------------------------------------------------------
25
26 function copy_to_trans(&$supp_trans)
27 {
28         $supp_trans->Comments = $_POST['Comments'];
29         $supp_trans->tran_date = $_POST['tran_date'];
30         $supp_trans->due_date = $_POST['due_date'];
31         $supp_trans->supp_reference = $_POST['supp_reference'];
32         $supp_trans->reference = $_POST['reference'];
33
34         $supp_trans->ov_amount = 0; /* for starters */
35         if (count($supp_trans->grn_items) > 0)
36         {
37                 foreach ( $supp_trans->grn_items as $grn)
38                 {
39                         $supp_trans->ov_amount += round2(($grn->this_quantity_inv * $grn->chg_price),
40                           user_price_dec());
41                 }
42         }
43         if (count($supp_trans->gl_codes) > 0)
44         {
45                 foreach ( $supp_trans->gl_codes as $gl_line)
46                 {
47                         $supp_trans->ov_amount += $gl_line->amount;
48                 }
49         }
50 }
51
52 //--------------------------------------------------------------------------------------------------
53
54 function invoice_header(&$supp_trans)
55 {
56         global $Ajax, $table_style;
57         
58         // if vars have been lost, recopy
59         if (!isset($_POST['tran_date']))
60                 copy_from_trans($supp_trans);
61
62         start_outer_table("$table_style width=98%", 5);
63
64         table_section(1);
65
66         if (isset($_POST['invoice_no']))
67         {
68                 $trans = get_supp_trans($_POST['invoice_no'], 20);
69                 $_POST['supplier_id'] = $trans['supplier_id'];
70                 $supp = $trans['supplier_name'] . " - " . $trans['SupplierCurrCode'];
71                 label_row(_("Supplier:"), $supp.hidden('supplier_id', $_POST['supplier_id'], false));
72         }       
73         else
74         {
75         if (!isset($_POST['supplier_id']) && (get_global_supplier() != reserved_words::get_all()))
76                 $_POST['supplier_id'] = get_global_supplier();
77
78                 supplier_list_row(_("Supplier:"), 'supplier_id', $_POST['supplier_id'], false, true);
79         }
80         if ($supp_trans->supplier_id != $_POST['supplier_id'])
81         {
82                 // supplier has changed
83                 // delete all the order items - drastic but necessary because of
84                 // change of currency, etc
85                 $supp_trans->clear_items();
86                 read_supplier_details_to_trans($supp_trans, $_POST['supplier_id']);
87                 copy_from_trans($supp_trans);
88         }
89
90         if ($supp_trans->is_invoice)
91         ref_row(_("Reference:"), 'reference', '', references::get_next(20));
92     else
93         ref_row(_("Reference:"), 'reference', '', references::get_next(21));
94
95         if (isset($_POST['invoice_no']))
96         {
97                 label_row(_("Supplier's Ref.:"), $_POST['invoice_no'].hidden('invoice_no', $_POST['invoice_no'], false).hidden('supp_reference', $_POST['invoice_no'], false));
98         }       
99         else
100                 text_row(_("Supplier's Ref.:"), 'supp_reference', $_POST['supp_reference'], 20, 20);
101
102         table_section(2, "33%");
103
104         date_row(_("Date") . ":", 'tran_date', '', null, 0, 0, 0, "", true);
105         if (isset($_POST['_tran_date_changed'])) {
106                 $Ajax->activate('_ex_rate');
107                 $supp_trans->tran_date = $_POST['tran_date'];
108                 get_duedate_from_terms($supp_trans);
109                 $_POST['due_date'] = $supp_trans->due_date;
110                 $Ajax->activate('due_date');
111         }
112
113     date_row(_("Due Date") . ":", 'due_date');
114
115     label_row(_("Terms:"), $supp_trans->terms_description);
116
117         table_section(3, "33%");
118
119         $supplier_currency = get_supplier_currency($supp_trans->supplier_id);
120
121         $company_currency = get_company_currency();
122
123         if ($supplier_currency != $company_currency)
124         {
125         label_row(_("Supplier's Currency:"), "<b>" . $supplier_currency . "</b>");
126                 exchange_rate_display($supplier_currency, $company_currency, $_POST['tran_date']);
127         }
128
129         label_row(_("Tax Group:"), $supp_trans->tax_description);
130
131         end_outer_table(1);
132 }
133
134 //--------------------------------------------------------------------------------------------------
135
136 function invoice_totals(&$supp_trans)
137 {
138         global $table_style, $table_style2;
139
140         copy_to_trans($supp_trans);
141
142     start_table("$table_style width=95%");
143         label_row(_("Sub-total:"), price_format( $supp_trans->ov_amount), "align=right", "align=right");
144
145     $taxes = $supp_trans->get_taxes($supp_trans->tax_group_id);
146     $tax_total = display_edit_tax_items($taxes, 1, 0); // tax_included==0 (we are the company)
147
148     $display_total = price_format($supp_trans->ov_amount + $tax_total);
149
150         if ($supp_trans->is_invoice)
151         label_row(_("Invoice Total:"), $display_total, "align=right style='font-weight:bold;'", "align=right style='font-weight:bold;'");
152     else
153                 label_row(_("Credit Note Total"),
154                         $display_total, "align=right style='font-weight:bold;color:red;'", "nowrap align=right style='font-weight:bold;color:red;'");
155
156     end_table(1);
157     start_table($table_style2);
158     textarea_row(_("Memo:"), "Comments", null, 50, 3);
159     end_table(1);
160 }
161
162 //--------------------------------------------------------------------------------------------------
163 function display_gl_controls(&$supp_trans, $k)
164 {
165         global $table_style;
166
167         $accs = get_supplier_accounts($supp_trans->supplier_id);
168         $_POST['gl_code'] = $accs['purchase_account'];
169
170         alt_table_row_color($k);
171         gl_all_accounts_list('gl_code', null, true, true);
172         $dim = get_company_pref('use_dimension');
173         if ($dim >= 1)
174                 dimensions_list_cells(null, 'dimension_id', null, true, " ", false, 1);
175         if ($dim > 1)
176                 dimensions_list_cells(null, 'dimension2_id', null, true, " ", false, 2);
177         amount_cells(null, 'amount');
178         if ($dim < 1)   
179                 text_cells_ex(null, 'memo_', 35, 50, null, null, null, hidden('dimension_id', 0, false).hidden('dimension2_id', 0, false));
180         else if ($dim < 2)      
181                 text_cells_ex(null, 'memo_', 35, 50, null, null, null, hidden('dimension2_id', 0, false));
182         else    
183                 text_cells_ex(null, 'memo_', 35, 50, null, null, null);
184         submit_cells('AddGLCodeToTrans', _("Add"), "",
185                     _('Add GL Line'), true);
186         submit_cells('ClearFields', _("Reset"), "",
187                     _("Clear all GL entry fields"), true);
188         end_row();      
189 }
190
191 // $mode = 0 none at the moment
192 //               = 1 display on invoice/credit page
193 //               = 2 display on view invoice
194 //               = 3 display on view credit
195
196 function display_gl_items(&$supp_trans, $mode=0)
197 {
198         global $table_style, $path_to_root;
199
200     // if displaying in form, and no items, exit
201     if (($mode == 2 || $mode == 3) && count($supp_trans->gl_codes) == 0)
202         return 0;
203
204         start_outer_table("width=95%");
205
206         if ($supp_trans->is_invoice)
207                 $heading = _("GL Items for this Invoice");
208         else
209                 $heading = _("GL Items for this Credit Note");
210
211         start_outer_table("width=100%");
212
213         if ($mode == 1)
214         {
215                 $qes = has_quick_entries(-1, 0);
216                 if ($qes !== false)
217                 {
218                         echo "<div style='float:right;'>";
219                         echo _("Quick Entry:")."&nbsp;"; 
220                         quick_entries_list('qid', null, 0, 1);
221                         echo "&nbsp;"._("Amount")."&nbsp;";
222                         $amount = input_num('totamount');
223                         $dec = user_price_dec();
224                         echo "<input class='amount' type='text' name='totamount' size='7' maxlength='12' dec='$dec' value='$amount'>&nbsp;";
225                         submit('go', _("Go"), true, false, true);
226                         echo "</div>";
227                 }       
228         }
229         display_heading($heading);
230
231         end_outer_table(0, false);
232
233         vertical_space(); // ouer table
234
235         div_start('gl_items');
236         start_table("$table_style width=100%");
237
238         $dim = get_company_pref('use_dimension');
239         if ($dim == 2)
240         $th = array(_("Account"), _("Name"), _("Dimension")." 1", _("Dimension")." 2", _("Amount"), _("Memo"));
241         else if ($dim == 1)
242         $th = array(_("Account"), _("Name"), _("Dimension"), _("Amount"), _("Memo"));
243     else
244         $th = array(_("Account"), _("Name"), _("Amount"), _("Memo"));
245
246         if ($mode == 1)
247         {
248                 $th[] = "";
249                 $th[] = "";
250         }       
251         table_header($th);
252         $total_gl_value=0;
253         $i = $k = 0;
254
255         if (count($supp_trans->gl_codes) > 0)
256         {
257
258                 foreach ($supp_trans->gl_codes as $entered_gl_code)
259                 {
260
261                         alt_table_row_color($k);
262
263                         if ($mode == 3)
264                                 $entered_gl_code->amount = -$entered_gl_code->amount;
265
266                         label_cell($entered_gl_code->gl_code);
267                         label_cell($entered_gl_code->gl_act_name);
268
269                         if ($dim >= 1)
270                                 label_cell(get_dimension_string($entered_gl_code->gl_dim, true));
271                         if ($dim > 1)
272                                 label_cell(get_dimension_string($entered_gl_code->gl_dim2, true));
273
274                         amount_cell($entered_gl_code->amount, true);
275                         label_cell($entered_gl_code->memo_);
276
277                         if ($mode == 1)
278                         {
279                                 delete_button_cell("Delete2" . $entered_gl_code->Counter, _("Delete"),
280                                           _('Remove line from document'));
281                                 label_cell("");
282                         }       
283                         end_row();
284
285                         $total_gl_value += $entered_gl_code->amount;
286
287                         $i++;
288                         if ($i > 15)
289                         {
290                                 $i = 0;
291                                 table_header($th);
292                         }
293                 }
294
295         }
296         if ($mode == 1)
297                 display_gl_controls($supp_trans, $k);
298         $colspan = ($dim == 2 ? 4 : ($dim == 1 ? 3 : 2));
299         label_row(_("Total"), price_format($total_gl_value),
300                 "colspan=".$colspan." align=right", "nowrap align=right");
301
302         end_table();
303         div_end();
304
305     end_outer_table(0, false); // outertable
306         return $total_gl_value;
307 }
308
309 //--------------//-----------------------------------------------------------------------------------------
310
311 function display_grn_items_for_selection(&$supp_trans, $k)
312 {
313         global $table_style;
314
315         if ($supp_trans->is_invoice)
316                 $result = get_grn_items(0, $supp_trans->supplier_id, true);
317         else
318         {
319                 if (isset($_POST['invoice_no']))
320                         $result = get_grn_items(0, $supp_trans->supplier_id, false, true, $_POST['invoice_no']);
321                 else    
322                         $result = get_grn_items(0, $supp_trans->supplier_id, false, true);
323         }
324     if (db_num_rows($result) == 0)
325     {
326         return false;
327     }
328     
329     /*Set up a table to show the outstanding GRN items for selection */
330
331     while ($myrow = db_fetch($result))
332     {
333                 $grn_already_on_invoice = false;
334
335         foreach ($supp_trans->grn_items as $entered_grn)
336         {
337                 if ($entered_grn->id == $myrow["id"])
338                 {
339                         $grn_already_on_invoice = true;
340                 }
341         }
342         if ($grn_already_on_invoice == false)
343         {
344
345                         alt_table_row_color($k);
346
347                         $n = $myrow["id"];
348                 label_cell(get_trans_view_str(25, $myrow["grn_batch_id"]));
349                 label_cell($myrow["id"].
350                 hidden('qty_recd'.$n, $myrow["qty_recd"], false).
351                 hidden('item_code'.$n, $myrow["item_code"], false).
352                 hidden('item_description'.$n, $myrow["description"], false).
353                 hidden('prev_quantity_inv'.$n, $myrow['quantity_inv'], false).
354                 hidden('order_price'.$n, $myrow['unit_price'], false).
355                 hidden('std_cost_unit'.$n, $myrow['std_cost_unit'], false).
356                 hidden('po_detail_item'.$n, $myrow['po_detail_item'], false));
357                 label_cell(get_trans_view_str(systypes::po(), $myrow["purch_order_no"]));
358             label_cell($myrow["item_code"]);
359             label_cell($myrow["description"]);
360             label_cell(sql2date($myrow["delivery_date"]));
361             $dec = get_qty_dec($myrow["item_code"]);
362             qty_cell($myrow["qty_recd"], false, $dec);
363             qty_cell($myrow["quantity_inv"], false, $dec);
364             if ($supp_trans->is_invoice)
365                 qty_cells(null, 'this_quantity_inv'.$n, number_format2($myrow["qty_recd"] - $myrow["quantity_inv"], $dec), 
366                         null, null, $dec);
367             else                
368                 qty_cells(null, 'This_QuantityCredited'.$n, number_format2(max($myrow["quantity_inv"], 0), $dec), 
369                         null, null, $dec);
370             amount_cells(null, 'ChgPrice'.$n, price_format($myrow["unit_price"]));
371             if ($supp_trans->is_invoice)
372                 amount_cell(round2($myrow["unit_price"] * ($myrow["qty_recd"] - $myrow["quantity_inv"]), user_price_dec()));
373             else        
374                 amount_cell(round2($myrow["unit_price"] * max($myrow['quantity_inv'], 0), user_price_dec()));
375             if ($supp_trans->is_invoice)        
376                         submit_cells('grn_item_id'.$n, _("Add"), '', _("Add to Invoice"), true);
377                 else    
378                         submit_cells('grn_item_id'.$n, _("Add"), '', _("Add to Credit Note"), true);
379                 if ($supp_trans->is_invoice && $_SESSION["wa_current_user"]->access == 2)       // Added 2008-10-18 by Joe Hunt. Only admins can remove GRNs
380                         submit_cells('void_item_id'.$n, _("Remove"), '', _("WARNING! Be careful with removal. The operation is executed immediately and cannot be undone !!!"), true);
381                         end_row();
382         }
383     }
384     return true;
385 }
386
387 //------------------------------------------------------------------------------------
388
389 // $mode = 0 none at the moment
390 //               = 1 display on invoice/credit page
391 //               = 2 display on view invoice
392 //               = 3 display on view credit
393
394 function display_grn_items(&$supp_trans, $mode=0)
395 {
396         global $table_style, $path_to_root;
397
398     $ret = true;
399     // if displaying in form, and no items, exit
400     if (($mode == 2  || $mode == 3) && count($supp_trans->grn_items) == 0)
401         return 0;
402
403         start_outer_table("width=95%");
404
405         $heading2 = "";
406         if ($mode == 1)
407         {
408                 if ($supp_trans->is_invoice)
409                 {
410                         $heading = _("Items Received Yet to be Invoiced");
411                 if ($_SESSION["wa_current_user"]->access == 2)  // Added 2008-10-18 by Joe Hunt. Only admins can remove GRNs
412                                 $heading2 = _("WARNING! Be careful with removal. The operation is executed immediately and cannot be undone !!!");
413                 }
414                 else
415                         $heading = _("Delivery Item Selected For Adding To A Supplier Credit Note");
416         }
417         else
418         {
419                 if ($supp_trans->is_invoice)
420                         $heading = _("Received Items Charged on this Invoice");
421                 else
422                         $heading = _("Received Items Credited on this Note");
423         }               
424
425         start_outer_table("width=100%");
426
427         display_heading($heading);
428
429         if ($mode == 1)
430         {
431                 if ($heading2 != "")
432                 {
433                         //br();
434                         display_note($heading2, 0, 0, "class='overduefg'");
435                 }       
436                 echo "</td><td width=10% align='right'>";
437                 submit('InvGRNAll', _("Add All Items"), true, false,true);
438         }       
439
440         end_outer_table(0, false);
441
442         div_start('grn_items');
443         start_table("$table_style width=100%");
444         if ($mode == 1)
445         {
446         $th = array(_("Delivery"), _("Sequence #"), _("P.O."), _("Item"), _("Description"),
447                 _("Received On"), _("Quantity Received"), _("Quantity Invoiced"),
448                 _("Qty Yet To Invoice"), _("Order Price"), _("Total"), "");
449         if ($supp_trans->is_invoice && $_SESSION["wa_current_user"]->access == 2)       // Added 2008-10-18 by Joe Hunt. Only admins can remove GRNs
450                 $th[] = "";
451                 if (!$supp_trans->is_invoice)
452                 {
453                         $th[8] = _("Qty Yet To Credit");
454                 }
455     }
456     else
457                 $th = array(_("Delivery"), _("Item"), _("Description"),
458                         _("Quantity"), _("Price"), _("Line Value"));
459
460         table_header($th);
461     $total_grn_value = 0;
462     $i = $k = 0;
463
464         if (count($supp_trans->grn_items) > 0)
465         {
466
467         foreach ($supp_trans->grn_items as $entered_grn)
468         {
469
470                 alt_table_row_color($k);
471
472                         $grn_batch = get_grn_batch_from_item($entered_grn->id);
473                 label_cell(get_trans_view_str(25,$grn_batch));
474                 if ($mode == 1)
475                 {
476                                 label_cell($entered_grn->id);
477                                 label_cell(""); // PO
478                         }       
479                         label_cell($entered_grn->item_code);
480                         label_cell($entered_grn->item_description);
481             $dec = get_qty_dec($entered_grn->item_code);
482             if ($mode == 1)
483             {
484                 label_cell("");
485                                 qty_cell($entered_grn->qty_recd, false, $dec);
486                                 qty_cell($entered_grn->prev_quantity_inv, false, $dec);
487             }
488                         qty_cell(abs($entered_grn->this_quantity_inv), true, $dec);
489                         amount_cell($entered_grn->chg_price);
490                         amount_cell( round2($entered_grn->chg_price * abs($entered_grn->this_quantity_inv), user_price_dec()), true);
491
492                         if ($mode == 1)
493                         {
494                                 delete_button_cell("Delete" . $entered_grn->id, _("Edit"), _('Edit document line'));
495                                 if ($supp_trans->is_invoice && $_SESSION["wa_current_user"]->access == 2)         
496                                         label_cell("");
497                         }       
498                         end_row();
499
500                 $total_grn_value += round2($entered_grn->chg_price * abs($entered_grn->this_quantity_inv),
501                            user_price_dec());
502
503                 $i++;
504                 if ($i > 15)
505                 {
506                         $i = 0;
507                         table_header($th);
508                 }
509         }
510     }
511         if ($mode == 1)
512         {
513                 $ret = display_grn_items_for_selection($supp_trans, $k);
514         $colspan = 10;
515         }
516         else
517                 $colspan = 5;
518         label_row(_("Total"), price_format($total_grn_value),
519                 "colspan=$colspan align=right", "nowrap align=right");
520     end_table();
521         if (!$ret)
522         {
523                 if ($supp_trans->is_invoice)
524                         display_note(_("There are no outstanding items received from this supplier that have not been invoiced by them."), 0, 1);
525                 else
526                 {
527                         display_note(_("There are no received items for the selected supplier that have been invoiced."));
528                         display_note(_("Credits can only be applied to invoiced items."), 0, 1);
529                 }
530         }       
531     div_end();
532
533     end_outer_table(0, false); // outertable
534         return $total_grn_value;
535 }
536
537 //--------------------------------------------------------------------------------------------------
538 function get_duedate_from_terms(&$supp_trans)
539 {
540         if (!is_date($supp_trans->tran_date))
541         {
542                 $supp_trans->tran_date = Today();
543         }
544         if (substr( $supp_trans->terms, 0, 1) == "1")
545         { /*Its a day in the following month when due */
546                 $supp_trans->due_date = add_days(end_month($supp_trans->tran_date), (int) substr( $supp_trans->terms,1));
547         }
548         else
549         { /*Use the Days Before Due to add to the invoice date */
550                 $supp_trans->due_date = add_days($supp_trans->tran_date, (int) substr( $supp_trans->terms,1));
551         }
552 }
553
554 //--------------------------------------------------------------------------------------------------
555
556 ?>