$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')) {
+ if (ref($params{transdate}) eq 'DateTime') {
$transdate_obj = $params{transdate};
} else {
- $transdate_obj = $::locale->parse_date_to_object($params{transdate});
+ $transdate_obj = $::locale->parse_date_to_object($params{transdate});
};
croak t8('Illegal date') unless ref $transdate_obj;
};
# currency is either passed or use the invoice currency if it differs from the default currency
+ # TODO remove
my ($exchangerate,$currency);
- if ($params{currency} || $params{currency_id} || $self->currency_id != $::instance_conf->get_currency_id) {
+ if ($params{currency} || $params{currency_id}) {
if ($params{currency} || $params{currency_id} ) { # currency was specified
$currency = SL::DB::Manager::Currency->find_by(name => $params{currency}) || SL::DB::Manager::Currency->find_by(id => $params{currency_id});
} else { # use invoice currency
$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' ) {
# 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}
}
}
}
-
- 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:
# 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
$arap_booking->save;
push @new_acc_ids, $arap_booking->acc_trans_id;
+ # hook for invoice_for_advance_payment DATEV always pairs, acc_trans_id has to be higher than arap_booking ;-)
+ if ($self->invoice_type eq 'invoice_for_advance_payment') {
+ my $clearing_chart = SL::DB::Chart->new(id => $::instance_conf->get_advance_payment_clearing_chart_id)->load;
+ die "No Clearing Chart for Advance Payment" unless ref $clearing_chart eq 'SL::DB::Chart';
+
+ # what does ptc say
+ my %inv_calc = $self->calculate_prices_and_taxes();
+ my @trans_ids = keys %{ $inv_calc{amounts} };
+ die "Invalid state for advance payment more than one trans_id" if (scalar @trans_ids > 1);
+ my $entry = delete $inv_calc{amounts}{$trans_ids[0]};
+ my $tax;
+ if ($entry->{tax_id}) {
+ $tax = SL::DB::Manager::Tax->find_by(id => $entry->{tax_id}); # || die "Can't find tax with id " . $entry->{tax_id};
+ }
+ if ($tax and $tax->rate != 0) {
+ my ($netamount, $taxamount);
+ my $roundplaces = 2;
+ # we dont have a clue about skonto, that's why we use $arap_amount as taxincluded
+ ($netamount, $taxamount) = Form->calculate_tax($arap_amount, $tax->rate, 1, $roundplaces);
+ # for debugging database set
+ my $fullmatch = $netamount == $entry->{amount} ? '::netamount total true' : '';
+ my $transfer_chart = $tax->taxkey == 2 ? SL::DB::Chart->new(id => $::instance_conf->get_advance_payment_taxable_7_id)->load
+ : $tax->taxkey == 3 ? SL::DB::Chart->new(id => $::instance_conf->get_advance_payment_taxable_19_id)->load
+ : undef;
+ die "No Transfer Chart for Advance Payment" unless ref $transfer_chart eq 'SL::DB::Chart';
+
+ my $arap_full_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
+ chart_id => $clearing_chart->id,
+ chart_link => $clearing_chart->link,
+ amount => $arap_amount * -1, # full amount
+ transdate => $transdate_obj,
+ source => 'Automatic Tax Booking for Payment in Advance' . $fullmatch,
+ taxkey => 0,
+ tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
+ $arap_full_booking->save;
+ push @new_acc_ids, $arap_full_booking->acc_trans_id;
+
+ my $arap_tax_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
+ chart_id => $transfer_chart->id,
+ chart_link => $transfer_chart->link,
+ amount => _round($netamount), # full amount
+ transdate => $transdate_obj,
+ source => 'Automatic Tax Booking for Payment in Advance' . $fullmatch,
+ taxkey => $tax->taxkey,
+ tax_id => $tax->id);
+ $arap_tax_booking->save;
+ push @new_acc_ids, $arap_tax_booking->acc_trans_id;
+
+ my $tax_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
+ chart_id => $tax->chart_id,
+ chart_link => $tax->chart->link,
+ amount => _round($taxamount),
+ transdate => $transdate_obj,
+ source => 'Automatic Tax Booking for Payment in Advance' . $fullmatch,
+ taxkey => 0,
+ tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
+
+ $tax_booking->save;
+ push @new_acc_ids, $tax_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;
$self->datepaid($transdate_obj);
my $self = shift;
- my $is_sales = ref($self) eq 'SL::DB::Invoice';
-
- my $skonto_date;
-
- if ( $is_sales ) {
- return undef unless ref $self->payment_terms;
- return undef unless $self->payment_terms->terms_skonto > 0;
- $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
- } else {
- return undef unless ref $self->vendor->payment_terms;
- return undef unless $self->vendor->payment_terms->terms_skonto > 0;
- $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
- };
-
- return $skonto_date;
+ return undef unless ref $self->payment_terms;
+ return undef unless $self->payment_terms->terms_skonto > 0;
+ return DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
};
sub reference_account {
sub percent_skonto {
my $self = shift;
- my $is_sales = ref($self) eq 'SL::DB::Invoice';
-
my $percent_skonto = 0;
- if ( $is_sales ) {
- return undef unless ref $self->payment_terms;
- return undef unless $self->payment_terms->percent_skonto > 0;
- $percent_skonto = $self->payment_terms->percent_skonto;
- } else {
- return undef unless ref $self->vendor->payment_terms;
- return undef unless $self->vendor->payment_terms->terms_skonto > 0;
- $percent_skonto = $self->vendor->payment_terms->percent_skonto;
- };
+ return undef unless ref $self->payment_terms;
+ return undef unless $self->payment_terms->percent_skonto > 0;
+ $percent_skonto = $self->payment_terms->percent_skonto;
return $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;
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, id => $transaction->tax_id ]);
+
+ # acc_trans entries for the taxes (chart_link == A[RP]_tax) often
+ # have combinations of taxkey & tax_id that don't exist in
+ # tax. Those must be skipped.
+ next if !$tax && ($transaction->chart_link !~ m{A[RP]_amount});
+
croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
$transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->chart_link) };
# TODO: check whether there are negative values in invoice / acc_trans ... credited items
# don't check whether skonto applies, because user may want to override this
- # return undef unless $self->percent_skonto; # for is_sales
- # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
+ # return undef unless $self->percent_skonto;
my $is_sales = ref($self) eq 'SL::DB::Invoice';
};
push @skonto_charts, $rec;
- };
- };
+ }
+ }
# if the rounded sum of all rounding_errors reaches 0.01 this sum is
# subtracted from the largest skonto_amount
sub get_payment_select_options_for_bank_transaction {
my ($self, $bt_id, %params) = @_;
- # no skonto date -> no select option
- return { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 } unless $self->skonto_date;
-
- my $bt = SL::DB::BankTransaction->new(id => $bt_id)->load;
+ # 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(!$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 });
+ 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')});
+ 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 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;
a configured bank account.
This function deals with all the acc_trans entries and also updates paid and datepaid.
+The params C<transdate> and C<chart_id> 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 positive or negative number, but never 0.
+
+CAVEAT! The helper tries to get the sign right and all calls from BankTransaction are
+positive (abs($value)) values.
+
Example:
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<reference_account>
Returns a chart object which is the chart of the invoice with link AR or AP.
=item C<percent_skonto>
Returns the configured skonto percentage of the payment terms of an invoice,
-e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
-settings for ap.
+e.g. 0.02 for 2%. Payment terms come from invoice settingssettings for ap.
=item C<amount_less_skonto>
-If the invoice has a payment term (via ar for sales, via vendor for purchase),
+If the invoice has a payment term,
calculate the amount to be paid in the case of skonto. This doesn't check,
whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
the configured percentage (e.g. 2%) from the total amount.
when looking at open amount, maybe consider that there may already be queued
amounts in SEPA Export
+=item * C<skonto_charts>
+
+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
projects / kivitendo-erp.git / blobdiff