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