Doc references saved in refs table
[fa-stable.git] / gl / includes / db / gl_db_banking.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 function add_exchange_variation($trans_type, $trans_no, $date_, $acc_id, $account,
13     $currency, $person_type_id=null, $person_id = "")
14 {
15         if (is_company_currency($currency))
16                 return;
17         if ($date_ == null)
18                 $date_ = Today();
19         $rate = get_exchange_rate_from_home_currency($currency, $date_);
20         $result = db_query("SELECT SUM(amount) FROM ".TB_PREF."bank_trans WHERE 
21                 bank_act='$acc_id' AND trans_date<='".date2sql($date_)."'", 
22                 "Transactions for account $account could not be calculated");
23         $row = db_fetch_row($result);
24         $foreign_amount = $row[0];
25         $amount = get_gl_trans_from_to("", $date_, $account);
26         $diff = $amount - (round2($foreign_amount * $rate, user_price_dec()));
27         if ($diff != 0)
28         {
29                 if ($trans_type == null)
30                         $trans_type = systypes::journal_entry();
31                 if ($trans_no == null)
32                         $trans_no = get_next_trans_no($trans_type);
33                 if ($person_type_id == null)
34                         $person_type_id = payment_person_types::misc();
35                 add_gl_trans($trans_type, $trans_no, $date_, $account, 0, 0, _("Exchange Variance"),
36                 -$diff, null, $person_type_id, $person_id);
37         add_gl_trans($trans_type, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0, 
38                 _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
39         }       
40 }
41
42 function add_exchange_variation_all()
43 {
44         $trans_no = get_next_trans_no(0);
45         $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
46         $result = db_query($sql, "could not retreive bank accounts");
47         while ($myrow = db_fetch($result))
48                 add_exchange_variation(0, $trans_no, null, $myrow['id'], $myrow['account_code'],
49                         $myrow['currency_code']);
50 }
51 //----------------------------------------------------------------------------------
52 //      Add bank tranfer to database.
53 //
54 //      $from_account - source bank account id
55 //      $to_account   - target bank account id
56 //      
57
58 function add_bank_transfer($from_account, $to_account, $date_,
59         $amount, $ref, $memo_)
60 {
61         begin_transaction();
62
63         $trans_type = systypes::bank_transfer();
64
65         $currency = get_bank_account_currency($from_account);
66
67         $trans_no = get_next_trans_no($trans_type);
68
69         $from_gl_account = get_bank_gl_account($from_account);
70         $to_gl_account = get_bank_gl_account($to_account);
71
72         $total = 0;
73         // do the source account postings
74     $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, "",
75                 -$amount, $currency);
76
77     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
78                 $date_, -$amount,
79                 payment_person_types::misc(), "", $currency,
80                 "Cannot insert a source bank transaction");
81
82         add_exchange_variation($trans_type, $trans_no, $date_, $from_account, $from_gl_account, 
83                 $currency, payment_person_types::misc(), "");
84
85         // do the destination account postings
86         $total += add_gl_trans($trans_type, $trans_no, $date_, $to_gl_account, 0, 0, "",
87                 $amount, $currency);
88                 
89         /*Post a balance post if $total != 0 */
90         add_gl_balance($trans_type, $trans_no, $date_, -$total);        
91         
92         add_bank_trans($trans_type, $trans_no, $to_account, $ref,
93                 $date_, $amount, payment_person_types::misc(), "",
94                 $currency, "Cannot insert a destination bank transaction");
95
96         add_exchange_variation($trans_type, $trans_no, $date_, $from_account, $from_gl_account, 
97                 $currency, payment_person_types::misc(), "");
98         
99         add_comments($trans_type, $trans_no, $date_, $memo_);
100
101         references::save($trans_type, $trans_no, $ref);
102         add_audit_trail($trans_type, $trans_no, $date_);
103
104         commit_transaction();
105
106         return $trans_no;
107 }
108
109 //----------------------------------------------------------------------------------
110 //      Add bank payment or deposit to database.
111 //
112 //      $from_account - bank account id
113 //  $item - transaction cart (line item's amounts in bank account's currency)
114 //  $person_type_id - defines type of $person_id identifiers
115 //  $person_id  - supplier/customer/other id
116 // $person_detail_id - customer branch id or not used
117 //
118 // returns an array of (inserted trans type, trans no)
119
120 function add_bank_transaction($trans_type, $from_account, $items, $date_,
121         $person_type_id, $person_id, $person_detail_id, $ref, $memo_)
122 {
123         // we can only handle type 1 (payment)and type 2 (deposit)
124         if ($trans_type != systypes::bank_payment() && $trans_type != systypes::bank_deposit())
125                 display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
126
127         $do_exchange_variance = false;
128         
129         begin_transaction();
130
131         $currency = get_bank_account_currency($from_account);
132         $bank_gl_account = get_bank_gl_account($from_account);
133
134         // the gl items are already inversed/negated for type 2 (deposit)
135         $total_amount = $items->gl_items_total();
136
137     if ($person_type_id == payment_person_types::customer())
138     {
139         // we need to add a customer transaction record
140
141                 // convert to customer currency
142                 $cust_amount = exchange_from_to($total_amount, $currency, get_customer_currency($person_id), $date_);
143                 // we need to negate it too
144                 $cust_amount = -$cust_amount;
145
146                 $trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
147                 $ref, $cust_amount);
148
149     }
150     elseif ($person_type_id == payment_person_types::supplier())
151     {
152         // we need to add a supplier transaction record
153                 // convert to supp currency
154                 $supp_amount = exchange_from_to($total_amount, $currency, get_supplier_currency($person_id), $date_);
155
156                 // we need to negate it too
157                 $supp_amount = -$supp_amount;
158
159                 $trans_no = add_supp_trans($trans_type, $person_id, $date_, '',
160                 $ref, "", $supp_amount, 0, 0);
161
162     }
163     else
164     {
165         $trans_no = get_next_trans_no($trans_type);
166         $do_exchange_variance = true;
167     }
168
169         // do the source account postings
170
171     add_bank_trans($trans_type, $trans_no, $from_account, $ref,
172         $date_, -$total_amount,
173         $person_type_id, $person_id,
174         $currency,
175         "Cannot insert a source bank transaction");
176         $total = 0;
177         foreach ($items->gl_items as $gl_item)
178         {
179                 $is_bank_to = is_bank_account($gl_item->code_id);
180
181                 if ($trans_type == 1 AND $is_bank_to)
182                 {
183                         // we don't allow payments to go to a bank account. use transfer for this !
184                         display_db_error("invalid payment entered. Cannot pay to another bank account", "");
185                 }
186
187         // do the destination account postings
188         $total += add_gl_trans($trans_type, $trans_no, $date_, $gl_item->code_id,
189                 $gl_item->dimension_id, $gl_item->dimension2_id, $gl_item->reference,
190                 $gl_item->amount, $currency, $person_type_id, $person_id);
191
192         if ($is_bank_to)
193         {
194                 add_bank_trans($trans_type, $trans_no, $is_bank_to, $ref,
195                         $date_, $gl_item->amount,
196                         $person_type_id, $person_id, $currency,
197                         "Cannot insert a destination bank transaction");
198                 if ($do_exchange_variance)
199                         add_exchange_variation($trans_type, $trans_no, $date_, $is_bank_to, $gl_item->code_id, 
200                                 $currency, $person_type_id, $person_id);
201         }
202                 // store tax details if the gl account is a tax account
203
204                 $amount = $gl_item->amount;
205                 $ex_rate = get_exchange_rate_from_home_currency($currency, $date_);
206                         
207                 add_gl_tax_details($gl_item->code_id, $trans_type, $trans_no, $amount,
208                         $ex_rate, $date_, $memo_);
209         }
210
211         // do the source account postings
212     add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
213         -$total, null, $person_type_id, $person_id);
214
215     if ($do_exchange_variance)
216         add_exchange_variation($trans_type, $trans_no, $date_, $from_account, $bank_gl_account, 
217                 $currency, $person_type_id, $person_id);
218
219         add_comments($trans_type, $trans_no, $date_, $memo_);
220
221         references::save($trans_type, $trans_no, $ref);
222         add_audit_trail($trans_type, $trans_no, $date_);
223
224         commit_transaction();
225
226         return array($trans_type, $trans_no);
227 }
228
229 //----------------------------------------------------------------------------------------
230
231 ?>