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 write_supp_payment($trans_no, $supplier_id, $bank_account,
  13         $date_, $ref, $supp_amount, $supp_discount, $memo_, $bank_charge=0, $bank_amount=0)
  14 {
  15         global $Refs;
  16
  17         begin_transaction();
  18         $args = func_get_args(); while (count($args) < 10) $args[] = 0;
  19         $args = (object)array_combine(array('trans_no', 'supplier_id', 'bank_account', 'date_',
  20                  'ref', 'bank_amount', 'supp_amount', 'supp_discount', 'memo_', 'bank_charge'), $args);
  21         $args->trans_no = 0;
  22         hook_db_prewrite( $args, ST_SUPPAYMENT);
  23
  24         if ($trans_no != 0) {
  25           delete_comments(ST_SUPPAYMENT, $trans_no);
  26           void_bank_trans(ST_SUPPAYMENT, $trans_no, true);
  27           void_gl_trans(ST_SUPPAYMENT, $trans_no, true);
  28           void_cust_allocations(ST_SUPPAYMENT, $trans_no, $date_);
  29         }
  30
  31         /* Create a supp_trans entry for the supplier payment */
  32         $payment_id = write_supp_trans(ST_SUPPAYMENT, 0, $supplier_id, $date_, $date_,
  33                 $ref, "", -$supp_amount, 0, -$supp_discount);
  34
  35         // Now debit creditors account with payment + discount
  36
  37         $total = 0;
  38     $supplier_accounts = get_supplier_accounts($supplier_id);
  39         $total += add_gl_trans_supplier(ST_SUPPAYMENT, $payment_id, $date_, $supplier_accounts["payable_account"], 0, 0,
  40                 $supp_amount + $supp_discount, $supplier_id);
  41
  42         // Now credit discount received account with discounts
  43         if ($supp_discount != 0)
  44         {
  45                 $total += add_gl_trans_supplier(ST_SUPPAYMENT, $payment_id, $date_, $supplier_accounts["payment_discount_account"], 0, 0,
  46                         -$supp_discount, $supplier_id);
  47         }
  48
  49         $bank = get_bank_account($bank_account);
  50
  51         if ($bank_charge != 0)
  52         {
  53                 $charge_act = get_company_pref('bank_charge_act');
  54                 $total += add_gl_trans(ST_SUPPAYMENT, $payment_id, $date_, $charge_act, 0, 0, '',
  55                         $bank_charge, $bank['bank_curr_code']);
  56         }
  57
  58         $total += add_gl_trans(ST_SUPPAYMENT, $payment_id, $date_, $bank['account_code'], 0, 0, '',
  59                 -($bank_amount + $bank_charge), $bank['bank_curr_code']);
  60
  61         /*Post a balance post if $total != 0 due to variance in AP and bank posted values*/
  62         if ($total != 0)
  63         {
  64                 $variance_act = get_company_pref('exchange_diff_act');
  65                 add_gl_trans(ST_SUPPAYMENT, $payment_id, $date_, $variance_act, 0, 0, '',
  66                         -$total, null, PT_SUPPLIER,  $supplier_id);
  67         }
  68
  69    /*now enter the bank_trans entry */
  70         add_bank_trans(ST_SUPPAYMENT, $payment_id, $bank_account, $ref,
  71                 $date_, -($bank_amount + $bank_charge), PT_SUPPLIER, $supplier_id);
  72
  73         add_comments(ST_SUPPAYMENT, $payment_id, $date_, $memo_);
  74
  75         $Refs->save(ST_SUPPAYMENT, $payment_id, $ref);
  76
  77         $args->trans_no = $payment_id;
  78         hook_db_postwrite($args, ST_SUPPAYMENT);
  79
  80         commit_transaction();
  81
  82         return $payment_id;
  83 }
  84
  85 //------------------------------------------------------------------------------------------------
  86 /*
  87         This is legacy code, leaved here to provide compatibility for 2.3 extension modules.
  88         Will be removed in 2.4 due to design issues.
  89 */
  90 function add_supp_payment($supplier_id, $date_, $bank_account,
  91         $amount, $discount, $ref, $memo_, $rate=0, $charge=0)
  92 {
  93         global $Refs;
  94
  95         begin_transaction();
  96         $args = func_get_args(); while (count($args) < 9) $args[] = 0;
  97         $args = (object)array_combine(array('supplier_id', 'date_', 'bank_account',
  98                 'amount', 'discount', 'ref', 'memo_', 'rate', 'charge'), $args);
  99         $args->trans_no = 0;
 100         hook_db_prewrite( $args, ST_SUPPAYMENT);
 101
 102         $supplier_currency = get_supplier_currency($supplier_id);
 103     $bank_account_currency = get_bank_account_currency($bank_account);
 104         $bank_gl_account = get_bank_gl_account($bank_account);
 105
 106         if ($rate == 0)
 107         {
 108                 $supp_amount = exchange_from_to($amount, $bank_account_currency, $supplier_currency, $date_);
 109                 $supp_discount = exchange_from_to($discount, $bank_account_currency, $supplier_currency, $date_);
 110                 $supp_charge = exchange_from_to($charge, $bank_account_currency, $supplier_currency, $date_);
 111         }
 112         else
 113         {
 114                 $supp_amount = round($amount / $rate, user_price_dec());
 115                 $supp_discount = round($discount / $rate, user_price_dec());
 116                 $supp_charge = round($charge / $rate, user_price_dec());
 117         }
 118
 119
 120         // it's a supplier payment
 121         $trans_type = ST_SUPPAYMENT;
 122
 123         /* Create a supp_trans entry for the supplier payment */
 124         $payment_id = write_supp_trans($trans_type, 0, $supplier_id, $date_, $date_,
 125                 $ref, "", -$supp_amount, 0, -$supp_discount, "", $rate);
 126
 127         // Now debit creditors account with payment + discount
 128
 129         $total = 0;
 130     $supplier_accounts = get_supplier_accounts($supplier_id);
 131         $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $supplier_accounts["payable_account"], 0, 0,
 132                 $supp_amount + $supp_discount, $supplier_id, "", $rate);
 133
 134         // Now credit discount received account with discounts
 135         if ($supp_discount != 0)
 136         {
 137                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $supplier_accounts["payment_discount_account"], 0, 0,
 138                         -$supp_discount, $supplier_id, "", $rate);
 139         }
 140
 141         if ($supp_charge != 0)
 142         {
 143                 $charge_act = get_company_pref('bank_charge_act');
 144                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $charge_act, 0, 0,
 145                         $supp_charge, $supplier_id, "", $rate);
 146         }
 147
 148         if ($supp_amount != 0)
 149         {
 150                 $total += add_gl_trans_supplier($trans_type, $payment_id, $date_, $bank_gl_account, 0, 0,
 151                         -($supp_amount + $supp_charge), $supplier_id, "", $rate);
 152         }
 153
 154         /*Post a balance post if $total != 0 */
 155         add_gl_balance($trans_type, $payment_id, $date_, -$total, PT_SUPPLIER, $supplier_id);
 156
 157    /*now enter the bank_trans entry */
 158         add_bank_trans($trans_type, $payment_id, $bank_account, $ref,
 159                 $date_, -($amount + $charge), PT_SUPPLIER,
 160                 $supplier_id, $bank_account_currency,
 161                 "Could not add the supplier payment bank transaction");
 162
 163         add_comments($trans_type, $payment_id, $date_, $memo_);
 164
 165         $Refs->save($trans_type, $payment_id, $ref);
 166
 167         $args->trans_no = $payment_id;
 168         hook_db_postwrite($args, ST_SUPPAYMENT);
 169         commit_transaction();
 170
 171         return $payment_id;
 172 }
 173
 174 //------------------------------------------------------------------------------------------------
 175
 176 function void_supp_payment($type, $type_no)
 177 {
 178         begin_transaction();
 179         hook_db_prevoid($type, $type_no);
 180
 181         void_bank_trans($type, $type_no, true);
 182         void_gl_trans($type, $type_no, true);
 183         void_supp_allocations($type, $type_no);
 184         void_supp_trans($type, $type_no);
 185
 186         commit_transaction();
 187 }
 188
 189
 190 ?>