Added db_write/db_void hooks.
[fa-stable.git] / purchasing / includes / db / supp_payment_db.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_supp_payment($supplier_id, $date_, $bank_account,
13         $amount, $discount, $ref, $memo_, $rate=0, $charge=0)
14 {
15         global $Refs;
16
17         begin_transaction();
18         $args = func_get_args(); while (count($args) < 9) $args[] = 0;
19         $args = (object)array_combine(array('supplier_id', 'date_', 'bank_account', 
20                 'amount', 'discount', 'ref', 'memo_', 'rate', 'charge'), $args);
21         $args->trans_no = 0;
22         hook_db_prewrite( $args, ST_SUPPAYMENT);
23
24         $supplier_currency = get_supplier_currency($supplier_id);
25     $bank_account_currency = get_bank_account_currency($bank_account);
26         $bank_gl_account = get_bank_gl_account($bank_account);
27
28         if ($rate == 0)
29         {
30                 $supp_amount = exchange_from_to($amount, $bank_account_currency, $supplier_currency, $date_);
31                 $supp_discount = exchange_from_to($discount, $bank_account_currency, $supplier_currency, $date_);
32                 $supp_charge = exchange_from_to($charge, $bank_account_currency, $supplier_currency, $date_);
33         }
34         else
35         {
36                 $supp_amount = round($amount / $rate, user_price_dec());
37                 $supp_discount = round($discount / $rate, user_price_dec());
38                 $supp_charge = round($charge / $rate, user_price_dec());
39         }
40         
41
42         // it's a supplier payment
43         $trans_type = ST_SUPPAYMENT;
44
45         /* Create a supp_trans entry for the supplier payment */
46         $payment_id = write_supp_trans($trans_type, 0, $supplier_id, $date_, $date_,
47                 $ref, "", -$supp_amount, 0, -$supp_discount, "", $rate);
48
49         // Now debit creditors account with payment + discount
50
51         $total = 0;
52     $supplier_accounts = get_supplier_accounts($supplier_id);
53         $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $supplier_accounts["payable_account"], 0, 0,
54                 $supp_amount + $supp_discount, $supplier_id, "", $rate);
55
56         // Now credit discount received account with discounts
57         if ($supp_discount != 0)
58         {
59                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $supplier_accounts["payment_discount_account"], 0, 0,
60                         -$supp_discount, $supplier_id, "", $rate);
61         }
62
63         if ($supp_charge != 0)
64         {
65                 $charge_act = get_company_pref('bank_charge_act');
66                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $charge_act, 0, 0,
67                         $supp_charge, $supplier_id, "", $rate);
68         }
69
70         if ($supp_amount != 0)
71         {
72                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $bank_gl_account, 0, 0,
73                         -($supp_amount + $supp_charge), $supplier_id, "", $rate);
74         }
75
76         /*Post a balance post if $total != 0 */
77         add_gl_balance($trans_type, $payment_id, $date_, -$total, PT_SUPPLIER, $supplier_id);   
78
79    /*now enter the bank_trans entry */
80         add_bank_trans($trans_type, $payment_id, $bank_account, $ref,
81                 $date_, -($amount + $supp_charge), PT_SUPPLIER,
82                 $supplier_id, $bank_account_currency,
83                 "Could not add the supplier payment bank transaction");
84
85         add_comments($trans_type, $payment_id, $date_, $memo_);
86
87         $Refs->save($trans_type, $payment_id, $ref);
88
89         $args->trans_no = $payment_id;
90         hook_db_postwrite($args, ST_SUPPAYMENT);
91         commit_transaction();
92
93         return $payment_id;
94 }
95
96 //------------------------------------------------------------------------------------------------
97
98 function void_supp_payment($type, $type_no)
99 {
100         begin_transaction();
101         hook_db_prevoid($type, $type_no);
102
103         void_bank_trans($type, $type_no, true);
104         void_gl_trans($type, $type_no, true);
105         void_supp_allocations($type, $type_no);
106         void_supp_trans($type, $type_no);
107
108         commit_transaction();
109 }
110
111
112 ?>