X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FDB%2FHelper%2FPayment.pm;h=3522e64f611dc68f24c33aaf96332866dc019a51;hb=45d6fc385606d960c57d9bf1ec79bbc256f9a5a2;hp=3d97be0f6ca870216ea80dc99f7b3f1d907995bd;hpb=c6af9711e167b2bba757e337bca50861e60d34f5;p=kivitendo-erp.git diff --git a/SL/DB/Helper/Payment.pm b/SL/DB/Helper/Payment.pm index 3d97be0f6..3522e64f6 100644 --- a/SL/DB/Helper/Payment.pm +++ b/SL/DB/Helper/Payment.pm @@ -4,7 +4,7 @@ use strict; use parent qw(Exporter); our @EXPORT = qw(pay_invoice); -our @EXPORT_OK = qw(skonto_date skonto_charts amount_less_skonto within_skonto_period percent_skonto reference_account reference_amount open_amount open_percent remaining_skonto_days skonto_amount check_skonto_configuration valid_skonto_amount get_payment_suggestions validate_payment_type open_sepa_transfer_amount get_payment_select_options_for_bank_transaction create_bank_transaction exchangerate forex); +our @EXPORT_OK = qw(skonto_date skonto_charts amount_less_skonto within_skonto_period percent_skonto reference_account reference_amount open_amount open_percent remaining_skonto_days skonto_amount check_skonto_configuration valid_skonto_amount get_payment_suggestions validate_payment_type open_sepa_transfer_amount get_payment_select_options_for_bank_transaction exchangerate forex); our %EXPORT_TAGS = ( "ALL" => [@EXPORT, @EXPORT_OK], ); @@ -30,15 +30,32 @@ sub pay_invoice { my $is_sales = ref($self) eq 'SL::DB::Invoice'; my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign depending on ar/ap - + my @new_acc_ids; my $paid_amount = 0; # the amount that will be later added to $self->paid, should be in default currency # default values if not set $params{payment_type} = 'without_skonto' unless $params{payment_type}; validate_payment_type($params{payment_type}); - # check for required parameters + # check for required parameters and optional params depending on payment_type Common::check_params(\%params, qw(chart_id transdate)); + if ( $params{'payment_type'} eq 'without_skonto' && abs($params{'amount'}) < 0) { + croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n"; + } + if ($params{'payment_type'} eq 'free_skonto') { + # we dont like too much automagic for this payment type. + # we force caller input for amount and skonto amount + Common::check_params(\%params, qw(amount skonto_amount)); + # secondly we dont want to handle credit notes and purchase credit notes + croak("Cannot use 'free skonto' for credit or debit notes") if ($params{amount} <= 0 || $params{skonto_amount} <= 0); + # both amount have to be rounded + $params{skonto_amount} = _round($params{skonto_amount}); + $params{amount} = _round($params{amount}); + # lastly skonto_amount has to be smaller than the open invoice amount or payment amount ;-) + if ($params{skonto_amount} > abs($self->open_amount) || $params{skonto_amount} > $params{amount}) { + croak("Skonto amount higher than the payment or invoice amount"); + } + } my $transdate_obj; if (ref($params{transdate} eq 'DateTime')) { @@ -84,17 +101,12 @@ sub pay_invoice { $exchangerate = 1; }; - # input checks: - if ( $params{'payment_type'} eq 'without_skonto' ) { - croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n" unless abs($params{'amount'}) > 0; - }; - # options with_skonto_pt and difference_as_skonto don't require the parameter # amount, but if amount is passed, make sure it matches the expected value if ( $params{'payment_type'} eq 'difference_as_skonto' ) { croak "amount $params{amount} doesn't match open amount " . $self->open_amount . ", diff = " . ($params{amount}-$self->open_amount) if $params{amount} && abs($self->open_amount - $params{amount} ) > 0.0000001; } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) { - croak "amount $params{amount} doesn't match amount less skonto: " . $self->open_amount . "\n" if $params{amount} && abs($self->amount_less_skonto - $params{amount} ) > 0.0000001; + croak "amount $params{amount} doesn't match amount less skonto: " . $self->amount_less_skonto . "\n" if $params{amount} && abs($self->amount_less_skonto - $params{amount} ) > 0.0000001; croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0; }; @@ -107,31 +119,31 @@ sub pay_invoice { # account where money is paid to/from: bank account or cash my $account_bank = SL::DB::Manager::Chart->find_by(id => $params{chart_id}); - croak "can't find bank account" unless ref $account_bank; + croak "can't find bank account with id " . $params{chart_id} unless ref $account_bank; my $reference_account = $self->reference_account; croak "can't find reference account (link = AR/AP) for invoice" unless ref $reference_account; - my $memo = $params{'memo'} || ''; - my $source = $params{'source'} || ''; + my $memo = $params{memo} // ''; + my $source = $params{source} // ''; my $rounded_params_amount = _round( $params{amount} ); # / $exchangerate); my $fx_gain_loss_amount = 0; # for fx_gain and fx_loss my $db = $self->db; - $db->do_transaction(sub { + $db->with_transaction(sub { my $new_acc_trans; # all three payment type create 1 AR/AP booking (the paid part) - # difference_as_skonto creates n skonto bookings (1 for each tax type) - # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each tax type) + # difference_as_skonto creates n skonto bookings (1 for each buchungsgruppe type) + # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each buchungsgruppe type) # without_skonto creates 1 bank booking # as long as there is no automatic tax, payments are always booked with # taxkey 0 unless ( $params{payment_type} eq 'difference_as_skonto' ) { - # cases with_skonto_pt and without_skonto + # cases with_skonto_pt, free_skonto and without_skonto # for case with_skonto_pt we need to know the corrected amount at this # stage if we are going to use $params{amount} @@ -158,6 +170,7 @@ sub pay_invoice { tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id); $new_acc_trans->save; + push @new_acc_ids, $new_acc_trans->acc_trans_id; # deal with fxtransaction if ( $self->currency_id != $::instance_conf->get_currency_id ) { my $fxamount = _round($amount - ($amount * $exchangerate)); @@ -172,6 +185,7 @@ sub pay_invoice { fx_transaction => 1, tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id); $new_acc_trans->save; + push @new_acc_ids, $new_acc_trans->acc_trans_id; # if invoice exchangerate differs from exchangerate of payment # deal with fxloss and fxamount if ($self->exchangerate and $self->exchangerate != 1 and $self->exchangerate != $exchangerate) { @@ -192,20 +206,23 @@ sub pay_invoice { fx_transaction => 0, tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id); $new_acc_trans->save; + push @new_acc_ids, $new_acc_trans->acc_trans_id; - }; - }; - }; - - if ( $params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt' ) { + } + } + } + # better everything except without_skonto + if ($params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt' + or $params{payment_type} eq 'free_skonto' ) { my $total_skonto_amount; if ( $params{payment_type} eq 'with_skonto_pt' ) { $total_skonto_amount = $self->skonto_amount; } elsif ( $params{payment_type} eq 'difference_as_skonto' ) { $total_skonto_amount = $self->open_amount; - }; - + } elsif ( $params{payment_type} eq 'free_skonto') { + $total_skonto_amount = $params{skonto_amount}; + } my @skonto_bookings = $self->skonto_charts($total_skonto_amount); # error checking: @@ -232,6 +249,7 @@ sub pay_invoice { # the acc_trans entries are saved individually, not added to $self and then saved all at once $new_acc_trans->save; + push @new_acc_ids, $new_acc_trans->acc_trans_id; $reference_amount -= abs($amount); $paid_amount += -1 * $amount * $exchangerate; @@ -240,8 +258,7 @@ sub pay_invoice { if ( $params{payment_type} eq 'difference_as_skonto' ) { die "difference_as_skonto calculated incorrectly, sum of calculated payments doesn't add up to open amount $total_open_amount, reference_amount = $reference_amount\n" unless _round($reference_amount) == 0; } - - }; + } my $arap_amount = 0; @@ -254,7 +271,11 @@ sub pay_invoice { # with_skonto_pt for completely unpaid invoices we just use the value # from the invoice $arap_amount = $total_open_amount; - }; + } elsif ( $params{payment_type} eq 'free_skonto' ) { + # we forced positive values and forced rounding at the beginning + # therefore the above comment can be safely applied for this payment type + $arap_amount = $params{amount} + $params{skonto_amount}; + } # regardless of payment_type there is always only exactly one arap booking # TODO: compare $arap_amount to running total @@ -267,6 +288,7 @@ sub pay_invoice { taxkey => 0, tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id); $arap_booking->save; + push @new_acc_ids, $arap_booking->acc_trans_id; $fx_gain_loss_amount *= -1 if $self->is_sales; $self->paid($self->paid + _round($paid_amount) + $fx_gain_loss_amount) if $paid_amount; @@ -294,25 +316,23 @@ sub pay_invoice { if ( $datev_check ) { my $datev = SL::DATEV->new( - exporttype => DATEV_ET_BUCHUNGEN, - format => DATEV_FORMAT_KNE, dbh => $db->dbh, trans_id => $self->{id}, ); - $datev->clean_temporary_directories; - $datev->export; + $datev->generate_datev_data; if ($datev->errors) { - # this exception should be caught by do_transaction, which handles the rollback + # this exception should be caught by with_transaction, which handles the rollback die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors; } } - }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n"; + 1; - return 1; -}; + }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n"; + return wantarray ? @new_acc_ids : 1; +} sub skonto_date { @@ -385,7 +405,7 @@ sub open_amount { # if the difference is 0.01 Cent this may end up as 0.009999999999998 # numerically, so round this value when checking for cent threshold >= 0.01 - return $self->amount - $self->paid; + return ($self->amount // 0) - ($self->paid // 0); }; sub open_percent { @@ -441,11 +461,11 @@ sub percent_skonto { sub amount_less_skonto { # amount that has to be paid if skonto applies, always return positive rounded values + # no, rare case, but credit_notes and negative ap have negative amounts + # and therefore this comment may be misguiding # the result is rounded so we can directly compare it with the user input my $self = shift; - my $is_sales = ref($self) eq 'SL::DB::Invoice'; - my $percent_skonto = $self->percent_skonto || 0; return _round($self->amount - ( $self->amount * $percent_skonto) ); @@ -462,7 +482,7 @@ sub check_skonto_configuration { # my $transactions = $self->transactions; foreach my $transaction (@{ $self->transactions }) { # find all transactions with an AR_amount or AP_amount link - my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->taxkey]); + my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->taxkey, id => $transaction->tax_id ]); croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax; $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->chart_link) }; @@ -543,7 +563,8 @@ sub skonto_charts { # $reference_ARAP_amount += $transaction->{amount} * $mult; # quick hack that works around problem of non-unique tax keys in SKR04 - my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]); + # ? use tax_id in acc_trans + my $tax = SL::DB::Manager::Tax->get_first( where => [id => $transaction->{tax_id}]); croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax; if ( $is_sales ) { @@ -629,28 +650,30 @@ sub valid_skonto_amount { sub get_payment_select_options_for_bank_transaction { my ($self, $bt_id, %params) = @_; - my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id ); - die unless $bt; - - my $open_amount = $self->open_amount; + # CAVEAT template code expects with_skonto_pt at position 1 for visual help + # due to skonto_charts, we cannot offer skonto for credit notes and neg ap + my $skontoable = $self->amount > 0 ? 1 : 0; my @options; - if ( $open_amount && # invoice amount not 0 - $self->skonto_date && # check whether skonto applies - abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 && - $self->check_skonto_configuration) { - if ( $self->within_skonto_period($bt->transdate) ) { - push(@options, { payment_type => 'without_skonto', display => t8('without skonto') }); - push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 }); - } else { - push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 }); - push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')}); - }; - }; - + if(!$self->skonto_date) { + push(@options, { payment_type => 'without_skonto', display => t8('without skonto'), selected => 1 }); + # wrong call to presenter or not implemented? disabled option is ignored + # push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), disabled => 1 }); + push(@options, { payment_type => 'free_skonto', display => t8('free skonto') }) if $skontoable; + return @options; + } + # valid skonto date, check if skonto is preferred + my $bt = SL::DB::BankTransaction->new(id => $bt_id)->load; + if ($self->skonto_date && $self->within_skonto_period($bt->transdate)) { + push(@options, { payment_type => 'without_skonto', display => t8('without skonto') }); + push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 }) if $skontoable; + } else { + push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 }); + push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')}) if $skontoable; + } + push(@options, { payment_type => 'free_skonto', display => t8('free skonto') }) if $skontoable; return @options; - -}; +} sub exchangerate { my ($self) = @_; @@ -704,50 +727,22 @@ sub get_payment_suggestions { return 1; }; +# locales for payment type +# +# $main::locale->text('without_skonto') +# $main::locale->text('with_skonto_pt') +# $main::locale->text('difference_as_skonto') +# + sub validate_payment_type { my $payment_type = shift; - my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto); + my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto free_skonto); croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type }; return 1; } -sub create_bank_transaction { - my ($self, %params) = @_; - - require SL::DB::Chart; - require SL::DB::BankAccount; - - my $bank_chart; - if ( $params{chart_id} ) { - $bank_chart = SL::DB::Manager::Chart->find_by(chart_id => $params{chart_id}) or die "Can't find bank chart"; - } elsif ( $::instance_conf->get_ar_paid_accno_id ) { - $bank_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_ar_paid_accno_id); - } else { - $bank_chart = SL::DB::Manager::Chart->find_by(description => 'Bank') or die "Can't find bank chart"; - }; - my $bank_account = SL::DB::Manager::BankAccount->find_by(chart_id => $bank_chart->id) or die "Can't find bank account for chart"; - - my $multiplier = $self->is_sales ? 1 : -1; - my $amount = ($params{amount} || $self->amount) * $multiplier; - - my $transdate = $params{transdate} || DateTime->today; - - my $bt = SL::DB::BankTransaction->new( - local_bank_account_id => $bank_account->id, - remote_bank_code => $self->customervendor->bank_code, - remote_account_number => $self->customervendor->account_number, - transdate => $transdate, - valutadate => $transdate, - amount => $::form->round_amount($amount, 2), - currency => $self->currency->id, - remote_name => $self->customervendor->depositor, - purpose => $params{purpose} || $self->invnumber - )->save; -}; - - sub forex { my ($self) = @_; $self->currency_id == $::instance_conf->get_currency_id ? return 0 : return 1; @@ -789,6 +784,17 @@ Create a payment booking for an existing invoice object (type ar/ap/is/ir) via a configured bank account. This function deals with all the acc_trans entries and also updates paid and datepaid. +The params C and C are mandantory. +If the default payment ('without_skonto') is used the param amount is also +mandantory. +If the payment type ('free_skonto') is used the number params skonto_amount and amount +are as well mandantory and need to be positive. Furthermore the skonto amount has +to be lower than the payment or open invoice amount. + +Transdate can either be a date object or a date string. +Chart_id is the id of the payment booking chart. +Amount is either a postive or negative number, but never 0. + Example: @@ -819,7 +825,7 @@ or in a certain currency: transdate => DateTime->now->to_kivitendo, memo => 'foobar', source => 'barfoo', - payment_type => 'with_skonto', + payment_type => 'with_skonto_pt', ); Allowed payment types are: @@ -878,6 +884,9 @@ If no amount is given the whole open amout is paid. If neither currency or currency_id are given as params, the currency of the invoice is assumed to be the payment currency. +If successful the return value will be 1 in scalar context or in list context +the two ids (acc_trans_id) of the newly created bookings. + =item C Returns a chart object which is the chart of the invoice with link AR or AP. @@ -1092,47 +1101,18 @@ might always want to pay as late as possible. Make suggestion for a skonto payment type by returning an HTML blob of the options of a HTML drop-down select with the most likely option preselected. -This is a helper function for BankTransaction/ajax_payment_suggestion. +This is a helper function for BankTransaction/ajax_payment_suggestion and +template/webpages/bank_transactions/invoices.html We are working with an existing payment, so difference_as_skonto never makes sense. +If skonto is not possible (skonto_date does not exists) simply return +the single 'no skonto' option as a visual hint. + If skonto is possible (skonto_date exists), add two possibilities: without_skonto and with_skonto_pt if payment date is within skonto_date, preselect with_skonto_pt, otherwise preselect without skonto. -=item C - -Method used for testing purposes, allows you to quickly create bank -transactions from invoices to have something to test payments against. - - my $ap = SL::DB::Manager::Invoice->find_by(id => 41); - $ap->create_bank_transaction(amount => $ap->amount/2, transdate => DateTime->today->add(days => 5)); - -To create a payment for 3 invoices that were all paid together, all with skonto: - my $ar1 = SL::DB::Manager::Invoice->find_by(invnumber=>'20'); - my $ar2 = SL::DB::Manager::Invoice->find_by(invnumber=>'21'); - my $ar3 = SL::DB::Manager::Invoice->find_by(invnumber=>'22'); - $ar1->create_bank_transaction(amount => ($ar1->amount_less_skonto + $ar2->amount_less_skonto + $ar2->amount_less_skonto), - purpose => 'Rechnungen 20, 21, 22', - ); - -Amount is always relative to the absolute amount of the invoice, use positive -values for sales and purchases. - -The following params can be passed to override the defaults: - -=over 2 - -=item * amount - -=item * purpose - -=item * chart_id (the chart the amount is to be paid to) - -=item * transdate - -=back - =item C Returns 1 immediately if the record uses the default currency. @@ -1157,6 +1137,12 @@ Returns 1 if record uses a different currency, 0 if the default currency is used when looking at open amount, maybe consider that there may already be queued amounts in SEPA Export +=item * C + +Cannot handle negative skonto amounts, will always calculate the skonto amount +for credit notes or negative ap transactions with a positive sign. + + =back =head1 AUTHOR