Added tax calcualtion algorithm selection in sales and purchasing, driven by company...
[fa-stable.git] / includes / types.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 //      FrontAccounting system transaction types
14 //
15 define('ST_JOURNAL', 0);
16
17 define('ST_BANKPAYMENT', 1);
18 define('ST_BANKDEPOSIT', 2);
19 define('ST_BANKTRANSFER', 4);
20
21 define('ST_SALESINVOICE', 10);
22 define('ST_CUSTCREDIT', 11);
23 define('ST_CUSTPAYMENT', 12);
24 define('ST_CUSTDELIVERY', 13);
25
26 define('ST_LOCTRANSFER', 16);
27 define('ST_INVADJUST', 17);
28
29 define('ST_PURCHORDER', 18);
30 define('ST_SUPPINVOICE', 20);
31 define('ST_SUPPCREDIT', 21);
32 define('ST_SUPPAYMENT', 22);
33 define('ST_SUPPRECEIVE', 25);
34
35 define('ST_WORKORDER', 26);
36 define('ST_MANUISSUE', 28);
37 define('ST_MANURECEIVE', 29);
38
39
40 define('ST_SALESORDER', 30);
41 define('ST_SALESQUOTE', 32);
42 define('ST_COSTUPDATE', 35);
43 define('ST_DIMENSION', 40);
44
45 // Don't include these defines in the $systypes_array.
46 // They are used for documents only.
47 define ('ST_STATEMENT', 91);
48 define ('ST_CHEQUE', 92);
49
50 // document inheritance
51 $document_child_types = array(
52                 ST_SALESQUOTE => ST_SALESORDER,
53                 ST_SALESORDER => ST_CUSTDELIVERY,
54                 ST_CUSTDELIVERY => ST_SALESINVOICE,
55                 ST_SALESINVOICE => ST_CUSTCREDIT,
56
57                 ST_PURCHORDER => ST_SUPPRECEIVE,
58                 ST_SUPPRECEIVE => ST_SUPPINVOICE,
59                 ST_SUPPINVOICE => ST_SUPPCREDIT,
60 );
61
62 function get_child_type($type)
63 {
64         global $document_child_types;
65         return isset($document_child_types[$type]) ? $document_child_types[$type] : 0;
66 }
67
68 function get_parent_type($type)
69 {
70         global $document_child_types;
71         $child = array_search($type, $document_child_types);
72         return $child ? $child : 0;
73 }
74
75 //----------------------------------------------------------------------------------
76 //              Bank transaction types
77 //
78 define('BT_TRANSFER', 0);
79 define('BT_CHEQUE', 1);
80 define('BT_CREDIT', 2);
81 define('BT_CASH', 3);
82
83 include_once($path_to_root . "/manufacturing/includes/manufacturing_db.inc");
84 include_once($path_to_root . "/purchasing/includes/purchasing_db.inc");
85 include_once($path_to_root . "/sales/includes/sales_db.inc");
86 include_once($path_to_root . "/dimensions/includes/dimensions_db.inc");
87 //----------------------------------------------------------------------------------
88 //      Payment types
89 //
90 define('PT_MISC', 0);
91 define('PT_WORKORDER', 1);
92 define('PT_CUSTOMER', 2);
93 define('PT_SUPPLIER', 3);
94 define('PT_QUICKENTRY', 4);
95 define('PT_DIMESION', 5);
96
97 function payment_person_currency($type, $person_id)  {
98         switch ($type)
99         {
100                 case PT_MISC :
101                 case PT_QUICKENTRY :
102                 case PT_WORKORDER :
103                         return get_company_currency();
104
105                 case PT_CUSTOMER :
106                         return get_customer_currency($person_id);
107
108                 case PT_SUPPLIER :
109                         return get_supplier_currency($person_id);
110
111                 default :
112                         return get_company_currency();
113         }
114 }
115
116 function payment_person_name($type, $person_id, $full=true) {
117         global $payment_person_types;
118
119         switch ($type)
120         {
121                 case PT_MISC :
122                         return $person_id;
123                 case PT_QUICKENTRY :
124                         $qe = get_quick_entry($person_id);
125                         return ($full ? $payment_person_types[$type] . " ":"") . $qe["description"];
126                 case PT_WORKORDER :
127                         global $wo_cost_types;
128                         return $wo_cost_types[$person_id];
129                 case PT_CUSTOMER :
130                         return ($full ?$payment_person_types[$type] . " ":"") . get_customer_name($person_id);
131                 case PT_SUPPLIER :
132                         return ($full ? $payment_person_types[$type] . " ":"") . get_supplier_name($person_id);
133                 default :
134                         //DisplayDBerror("Invalid type sent to person_name");
135                         //return;
136                         return '';
137         }
138 }
139
140 function payment_person_has_items($type) {
141         switch ($type)
142         {
143                 case PT_MISC :
144                         return true;
145                 case PT_QUICKENTRY :
146                         return db_has_quick_entries();
147                 case PT_WORKORDER : // 070305 changed to open workorders JH
148                         return db_has_open_workorders();
149                 case PT_CUSTOMER :
150                         return db_has_customers();
151                 case PT_SUPPLIER :
152                         return db_has_suppliers();
153                 default :
154                         display_db_error("Invalid type sent to has_items", "");
155                         return false;
156         }
157 }
158 //----------------------------------------------------------------------------------
159 //      Payment terms categories
160 //
161 define('PM_ANY', 0);
162 define('PM_CASH', 1);
163 define('PM_CREDIT', 2);
164
165 //----------------------------------------------------------------------------------
166 //      Manufacturing types
167 //
168 define('WO_ASSEMBLY', 0);
169 define('WO_UNASSEMBLY', 1);
170 define('WO_ADVANCED', 2);
171
172 define('WO_LABOUR', 0);
173 define('WO_OVERHEAD', 1);
174
175 //----------------------------------------------------------------------------------
176 //      GL account classes
177 //
178 define('CL_NONE', 0); // for backward compatibility
179 define('CL_ASSETS', 1);
180 define('CL_LIABILITIES', 2);
181 define('CL_EQUITY', 3);
182 define('CL_INCOME', 4);
183 define('CL_COGS', 5);
184 define('CL_EXPENSE', 6);
185
186 function get_class_type_convert($ctype)
187 {
188         global $use_oldstyle_convert;
189         if (isset($use_oldstyle_convert) && $use_oldstyle_convert == 1)
190                 return (($ctype >= CL_INCOME || $ctype == CL_NONE) ? -1 : 1);
191         else    
192                 return ((($ctype >= CL_LIABILITIES && $ctype <= CL_INCOME) || $ctype == CL_NONE) ? -1 : 1);
193 }
194 //----------------------------------------------------------------------------------
195 //      Quick entry types
196 //
197 define('QE_PAYMENT', '1');
198 define('QE_DEPOSIT', '2');
199 define('QE_JOURNAL', '3');
200 define('QE_SUPPINV', '4');
201
202 //----------------------------------------------------------------------------------
203 //      Special option values for various list selectors.
204 //
205 define('ANY_TEXT', '');
206 define('ANY_NUMERIC', -1);
207 define('ALL_TEXT', '');
208 define('ALL_NUMERIC', -1);
209
210 //----------------------------------------------------------------------------------
211 // Special class values for tables (start_table())
212 define('TABLESTYLE',  1);
213 define('TABLESTYLE2', 2);
214 define('TABLESTYLE_NOBORDER', 3);
215
216 //----------------------------------------------------------------------------------
217
218 define('TAG_ACCOUNT',   1);
219 define('TAG_DIMENSION', 2);
220
221 //----------------------------------------------------------------------------------
222 // Payment term types
223
224 define('PTT_PRE', 1);
225 define('PTT_CASH', 2);
226 define('PTT_DAYS', 3);
227 define('PTT_FOLLOWING', 4);
228
229 //----------------------------------------------------------------------------------
230 // Tax calculation algorithms used in als and purchase (depends on supplier's invoicing software)
231
232 define('TCA_TOTALS', 1); // taxes are calculated from respective net totals for all lines
233 define('TCA_LINES', 2); // taxes calculated for every line, then summed
234
235 include_once($path_to_root . '/includes/sysnames.inc');
236
237 ?>