SL/DB/Helper/Payment.pm

   1 package SL::DB::Helper::Payment;
   2
   3 use strict;
   4
   5 use parent qw(Exporter);
   6 our @EXPORT = qw(pay_invoice);
   7 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);
   8 our %EXPORT_TAGS = (
   9   "ALL" => [@EXPORT, @EXPORT_OK],
  10 );
  11
  12 require SL::DB::Chart;
  13 use Data::Dumper;
  14 use DateTime;
  15 use SL::DATEV qw(:CONSTANTS);
  16 use SL::Locale::String qw(t8);
  17 use List::Util qw(sum);
  18 use SL::DB::Exchangerate;
  19 use SL::DB::Currency;
  20 use Carp;
  21
  22 #
  23 # Public functions not exported by default
  24 #
  25
  26 sub pay_invoice {
  27   my ($self, %params) = @_;
  28
  29   require SL::DB::Tax;
  30
  31   my $is_sales = ref($self) eq 'SL::DB::Invoice';
  32   my $mult = $is_sales ? 1 : -1;  # multiplier for getting the right sign depending on ar/ap
  33
  34   my $paid_amount = 0; # the amount that will be later added to $self->paid, should be in default currency
  35
  36   # default values if not set
  37   $params{payment_type} = 'without_skonto' unless $params{payment_type};
  38   validate_payment_type($params{payment_type});
  39
  40   # check for required parameters
  41   Common::check_params(\%params, qw(chart_id transdate));
  42
  43   my $transdate_obj;
  44   if (ref($params{transdate} eq 'DateTime')) {
  45     $transdate_obj = $params{transdate};
  46   } else {
  47    $transdate_obj = $::locale->parse_date_to_object($params{transdate});
  48   };
  49   croak t8('Illegal date') unless ref $transdate_obj;
  50
  51   # check for closed period
  52   my $closedto = $::locale->parse_date_to_object($::instance_conf->get_closedto);
  53   if ( ref $closedto && $transdate_obj < $closedto ) {
  54     croak t8('Cannot post payment for a closed period!');
  55   };
  56
  57   # check for maximum number of future days
  58   if ( $::instance_conf->get_max_future_booking_interval > 0 ) {
  59     croak t8('Cannot post transaction above the maximum future booking date!') if $transdate_obj > DateTime->now->add( days => $::instance_conf->get_max_future_booking_interval );
  60   };
  61
  62   # currency is either passed or use the invoice currency if it differs from the default currency
  63   my ($exchangerate,$currency);
  64   if ($params{currency} || $params{currency_id} || $self->currency_id != $::instance_conf->get_currency_id) {
  65     if ($params{currency} || $params{currency_id} ) { # currency was specified
  66       $currency = SL::DB::Manager::Currency->find_by(name => $params{currency}) || SL::DB::Manager::Currency->find_by(id => $params{currency_id});
  67     } else { # use invoice currency
  68       $currency = SL::DB::Manager::Currency->find_by(id => $self->currency_id);
  69     };
  70     die "no currency" unless $currency;
  71     if ($currency->id == $::instance_conf->get_currency_id) {
  72       $exchangerate = 1;
  73     } else {
  74       my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $currency->id,
  75                                                         transdate   => $transdate_obj,
  76                                                        );
  77       if ($rate) {
  78         $exchangerate = $is_sales ? $rate->buy : $rate->sell;
  79       } else {
  80         die "No exchange rate for " . $transdate_obj->to_kivitendo;
  81       };
  82     };
  83   } else { # no currency param given or currency is the same as default_currency
  84     $exchangerate = 1;
  85   };
  86
  87   # input checks:
  88   if ( $params{'payment_type'} eq 'without_skonto' ) {
  89     croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n" unless abs($params{'amount'}) > 0;
  90   };
  91
  92   # options with_skonto_pt and difference_as_skonto don't require the parameter
  93   # amount, but if amount is passed, make sure it matches the expected value
  94   if ( $params{'payment_type'} eq 'difference_as_skonto' ) {
  95     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;
  96   } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) {
  97     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;
  98     croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0;
  99   };
 100
 101   # absolute skonto amount for invoice, use as reference sum to see if the
 102   # calculated skontos add up
 103   # only needed for payment_term "with_skonto_pt"
 104
 105   my $skonto_amount_check = $self->skonto_amount; # variable should be zero after calculating all skonto
 106   my $total_open_amount   = $self->open_amount;
 107
 108   # account where money is paid to/from: bank account or cash
 109   my $account_bank = SL::DB::Manager::Chart->find_by(id => $params{chart_id});
 110   croak "can't find bank account" unless ref $account_bank;
 111
 112   my $reference_account = $self->reference_account;
 113   croak "can't find reference account (link = AR/AP) for invoice" unless ref $reference_account;
 114
 115   my $memo   = $params{'memo'}   || '';
 116   my $source = $params{'source'} || '';
 117
 118   my $rounded_params_amount = _round( $params{amount} ); # / $exchangerate);
 119   my $fx_gain_loss_amount = 0; # for fx_gain and fx_loss
 120
 121   my $db = $self->db;
 122   $db->do_transaction(sub {
 123     my $new_acc_trans;
 124
 125     # all three payment type create 1 AR/AP booking (the paid part)
 126     # difference_as_skonto creates n skonto bookings (1 for each tax type)
 127     # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each tax type)
 128     # without_skonto creates 1 bank booking
 129
 130     # as long as there is no automatic tax, payments are always booked with
 131     # taxkey 0
 132
 133     unless ( $params{payment_type} eq 'difference_as_skonto' ) {
 134       # cases with_skonto_pt and without_skonto
 135
 136       # for case with_skonto_pt we need to know the corrected amount at this
 137       # stage if we are going to use $params{amount}
 138
 139       my $pay_amount = $rounded_params_amount;
 140       $pay_amount = $self->amount_less_skonto if $params{payment_type} eq 'with_skonto_pt';
 141
 142       # bank account and AR/AP
 143       $paid_amount += $pay_amount * $exchangerate;
 144
 145       my $amount = (-1 * $pay_amount) * $mult;
 146
 147
 148       # total amount against bank, do we already know this by now?
 149       $new_acc_trans = SL::DB::AccTransaction->new(trans_id   => $self->id,
 150                                                    chart_id   => $account_bank->id,
 151                                                    chart_link => $account_bank->link,
 152                                                    amount     => $amount,
 153                                                    transdate  => $transdate_obj,
 154                                                    source     => $source,
 155                                                    memo       => $memo,
 156                                                    project_id => $params{project_id} ? $params{project_id} : undef,
 157                                                    taxkey     => 0,
 158                                                    tax_id     => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
 159       $new_acc_trans->save;
 160
 161       # deal with fxtransaction
 162       if ( $self->currency_id != $::instance_conf->get_currency_id ) {
 163         my $fxamount = _round($amount - ($amount * $exchangerate));
 164         $new_acc_trans = SL::DB::AccTransaction->new(trans_id       => $self->id,
 165                                                      chart_id       => $account_bank->id,
 166                                                      chart_link     => $account_bank->link,
 167                                                      amount         => $fxamount * -1,
 168                                                      transdate      => $transdate_obj,
 169                                                      source         => $source,
 170                                                      memo           => $memo,
 171                                                      taxkey         => 0,
 172                                                      fx_transaction => 1,
 173                                                      tax_id         => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
 174         $new_acc_trans->save;
 175         # if invoice exchangerate differs from exchangerate of payment
 176         # deal with fxloss and fxamount
 177         if ($self->exchangerate and $self->exchangerate != 1 and $self->exchangerate != $exchangerate) {
 178           my $fxgain_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxgain_accno_id) || die "Can't determine fxgain chart";
 179           my $fxloss_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxloss_accno_id) || die "Can't determine fxloss chart";
 180           my $gain_loss_amount = _round($amount * ($exchangerate - $self->exchangerate ) * -1,2);
 181           my $gain_loss_chart = $gain_loss_amount > 0 ? $fxgain_chart : $fxloss_chart;
 182           $fx_gain_loss_amount = $gain_loss_amount;
 183
 184           $new_acc_trans = SL::DB::AccTransaction->new(trans_id       => $self->id,
 185                                                        chart_id       => $gain_loss_chart->id,
 186                                                        chart_link     => $gain_loss_chart->link,
 187                                                        amount         => $gain_loss_amount,
 188                                                        transdate      => $transdate_obj,
 189                                                        source         => $source,
 190                                                        memo           => $memo,
 191                                                        taxkey         => 0,
 192                                                        fx_transaction => 0,
 193                                                        tax_id         => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
 194           $new_acc_trans->save;
 195
 196         };
 197       };
 198     };
 199
 200     if ( $params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt' ) {
 201
 202       my $total_skonto_amount;
 203       if ( $params{payment_type} eq 'with_skonto_pt' ) {
 204         $total_skonto_amount = $self->skonto_amount;
 205       } elsif ( $params{payment_type} eq 'difference_as_skonto' ) {
 206         $total_skonto_amount = $self->open_amount;
 207       };
 208
 209       my @skonto_bookings = $self->skonto_charts($total_skonto_amount);
 210
 211       # error checking:
 212       if ( $params{payment_type} eq 'difference_as_skonto' ) {
 213         my $calculated_skonto_sum  = sum map { $_->{skonto_amount} } @skonto_bookings;
 214         croak "calculated skonto for difference_as_skonto = $calculated_skonto_sum doesn't add up open amount: " . $self->open_amount unless _round($calculated_skonto_sum) == _round($self->open_amount);
 215       };
 216
 217       my $reference_amount = $total_skonto_amount;
 218
 219       # create an acc_trans entry for each result of $self->skonto_charts
 220       foreach my $skonto_booking ( @skonto_bookings ) {
 221         next unless $skonto_booking->{'chart_id'};
 222         next unless $skonto_booking->{'skonto_amount'} != 0;
 223         my $amount = -1 * $skonto_booking->{skonto_amount};
 224         $new_acc_trans = SL::DB::AccTransaction->new(trans_id   => $self->id,
 225                                                      chart_id   => $skonto_booking->{'chart_id'},
 226                                                      chart_link => SL::DB::Manager::Chart->find_by(id => $skonto_booking->{'chart_id'})->link,
 227                                                      amount     => $amount * $mult,
 228                                                      transdate  => $transdate_obj,
 229                                                      source     => $params{source},
 230                                                      taxkey     => 0,
 231                                                      tax_id     => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
 232
 233         # the acc_trans entries are saved individually, not added to $self and then saved all at once
 234         $new_acc_trans->save;
 235
 236         $reference_amount -= abs($amount);
 237         $paid_amount      += -1 * $amount * $exchangerate;
 238         $skonto_amount_check -= $skonto_booking->{'skonto_amount'};
 239       };
 240       if ( $params{payment_type} eq 'difference_as_skonto' ) {
 241           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;
 242       }
 243
 244     };
 245
 246     my $arap_amount = 0;
 247
 248     if ( $params{payment_type} eq 'difference_as_skonto' ) {
 249       $arap_amount = $total_open_amount;
 250     } elsif ( $params{payment_type} eq 'without_skonto' ) {
 251       $arap_amount = $rounded_params_amount;
 252     } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
 253       # this should be amount + sum(amount+skonto), but while we only allow
 254       # with_skonto_pt for completely unpaid invoices we just use the value
 255       # from the invoice
 256       $arap_amount = $total_open_amount;
 257     };
 258
 259     # regardless of payment_type there is always only exactly one arap booking
 260     # TODO: compare $arap_amount to running total
 261     my $arap_booking= SL::DB::AccTransaction->new(trans_id   => $self->id,
 262                                                   chart_id   => $reference_account->id,
 263                                                   chart_link => $reference_account->link,
 264                                                   amount     => _round($arap_amount * $mult * $exchangerate - $fx_gain_loss_amount),
 265                                                   transdate  => $transdate_obj,
 266                                                   source     => '', #$params{source},
 267                                                   taxkey     => 0,
 268                                                   tax_id     => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
 269     $arap_booking->save;
 270
 271     $fx_gain_loss_amount *= -1 if $self->is_sales;
 272     $self->paid($self->paid + _round($paid_amount) + $fx_gain_loss_amount) if $paid_amount;
 273     $self->datepaid($transdate_obj);
 274     $self->save;
 275
 276     # make sure transactions will be reloaded the next time $self->transactions
 277     # is called, as pay_invoice saves the acc_trans objects individually rather
 278     # than adding them to the transaction relation array.
 279     $self->forget_related('transactions');
 280
 281     my $datev_check = 0;
 282     if ( $is_sales )  {
 283       if ( (  $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice  ) ||
 284            ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
 285         $datev_check = 1;
 286       }
 287     } else {
 288       if ( (  $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
 289            ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction   )) {
 290         $datev_check = 1;
 291       }
 292     }
 293
 294     if ( $datev_check ) {
 295
 296       my $datev = SL::DATEV->new(
 297         exporttype => DATEV_ET_BUCHUNGEN,
 298         format     => DATEV_FORMAT_KNE,
 299         dbh        => $db->dbh,
 300         trans_id   => $self->{id},
 301       );
 302
 303       $datev->clean_temporary_directories;
 304       $datev->export;
 305
 306       if ($datev->errors) {
 307         # this exception should be caught by do_transaction, which handles the rollback
 308         die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
 309       }
 310     }
 311
 312   }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
 313
 314   return 1;
 315 };
 316
 317 sub skonto_date {
 318
 319   my $self = shift;
 320
 321   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 322
 323   my $skonto_date;
 324
 325   if ( $is_sales ) {
 326     return undef unless ref $self->payment_terms;
 327     return undef unless $self->payment_terms->terms_skonto > 0;
 328     $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
 329   } else {
 330     return undef unless ref $self->vendor->payment_terms;
 331     return undef unless $self->vendor->payment_terms->terms_skonto > 0;
 332     $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
 333   };
 334
 335   return $skonto_date;
 336 };
 337
 338 sub reference_account {
 339   my $self = shift;
 340
 341   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 342
 343   require SL::DB::Manager::AccTransaction;
 344
 345   my $link_filter = $is_sales ? 'AR' : 'AP';
 346
 347   my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
 348      trans_id   => $self->id,
 349      SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
 350   );
 351
 352   return undef unless ref $acc_trans;
 353
 354   my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
 355
 356   return $reference_account;
 357 };
 358
 359 sub reference_amount {
 360   my $self = shift;
 361
 362   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 363
 364   require SL::DB::Manager::AccTransaction;
 365
 366   my $link_filter = $is_sales ? 'AR' : 'AP';
 367
 368   my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
 369      trans_id   => $self->id,
 370      SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
 371   );
 372
 373   return undef unless ref $acc_trans;
 374
 375   # this should be the same as $self->amount
 376   return $acc_trans->amount;
 377 };
 378
 379
 380 sub open_amount {
 381   my $self = shift;
 382
 383   # in the future maybe calculate this from acc_trans
 384
 385   # if the difference is 0.01 Cent this may end up as 0.009999999999998
 386   # numerically, so round this value when checking for cent threshold >= 0.01
 387
 388   return $self->amount - $self->paid;
 389 };
 390
 391 sub open_percent {
 392   my $self = shift;
 393
 394   return 0 if $self->amount == 0;
 395   my $open_percent;
 396   if ( $self->open_amount < 0 ) {
 397     # overpaid, currently treated identically
 398     $open_percent = $self->open_amount * 100 / $self->amount;
 399   } else {
 400     $open_percent = $self->open_amount * 100 / $self->amount;
 401   };
 402
 403   return _round($open_percent) || 0;
 404 };
 405
 406 sub skonto_amount {
 407   my $self = shift;
 408
 409   return $self->amount - $self->amount_less_skonto;
 410 };
 411
 412 sub remaining_skonto_days {
 413   my $self = shift;
 414
 415   return undef unless ref $self->skonto_date;
 416
 417   my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
 418   return $dur->delta_days();
 419
 420 };
 421
 422 sub percent_skonto {
 423   my $self = shift;
 424
 425   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 426
 427   my $percent_skonto = 0;
 428
 429   if ( $is_sales ) {
 430     return undef unless ref $self->payment_terms;
 431     return undef unless $self->payment_terms->percent_skonto > 0;
 432     $percent_skonto = $self->payment_terms->percent_skonto;
 433   } else {
 434     return undef unless ref $self->vendor->payment_terms;
 435     return undef unless $self->vendor->payment_terms->terms_skonto > 0;
 436     $percent_skonto = $self->vendor->payment_terms->percent_skonto;
 437   };
 438
 439   return $percent_skonto;
 440 };
 441
 442 sub amount_less_skonto {
 443   # amount that has to be paid if skonto applies, always return positive rounded values
 444   # the result is rounded so we can directly compare it with the user input
 445   my $self = shift;
 446
 447   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 448
 449   my $percent_skonto = $self->percent_skonto || 0;
 450
 451   return _round($self->amount - ( $self->amount * $percent_skonto) );
 452
 453 };
 454
 455 sub check_skonto_configuration {
 456   my $self = shift;
 457
 458   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 459
 460   my $skonto_configured = 1; # default is assume skonto works
 461
 462   # my $transactions = $self->transactions;
 463   foreach my $transaction (@{ $self->transactions }) {
 464     # find all transactions with an AR_amount or AP_amount link
 465     my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->taxkey]);
 466     croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
 467
 468     $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->chart_link) };
 469     if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
 470       $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
 471     } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
 472       $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
 473     };
 474   };
 475
 476   return $skonto_configured;
 477 };
 478
 479 sub open_sepa_transfer_amount {
 480   my $self = shift;
 481
 482   my ($vc, $key, $type);
 483   if ( ref($self) eq 'SL::DB::Invoice' ) {
 484     $vc   = 'customer';
 485     $key  = 'ap_id';
 486     $type = 'ar';
 487   } else {
 488     $vc   = 'vendor';
 489     $key  = 'ap_id';
 490     $type = 'ap';
 491   };
 492
 493   my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
 494             qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id)   | .
 495             qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc')       |;
 496
 497   my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
 498
 499   return $open_sepa_amount || 0;
 500
 501 };
 502
 503
 504 sub skonto_charts {
 505   my $self = shift;
 506
 507   # TODO: use param for amount, may also want to calculate skonto_amounts by
 508   # passing percentage in the future
 509
 510   my $amount = shift || $self->skonto_amount;
 511
 512   croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
 513
 514   # TODO: check whether there are negative values in invoice / acc_trans ... credited items
 515
 516   # don't check whether skonto applies, because user may want to override this
 517   # return undef unless $self->percent_skonto;  # for is_sales
 518   # return undef unless $self->vendor->payment_terms->percent_skonto;  # for purchase
 519
 520   my $is_sales = ref($self) eq 'SL::DB::Invoice';
 521
 522   my $mult = $is_sales ? 1 : -1;  # multiplier for getting the right sign
 523
 524   my @skonto_charts;  # resulting array with all income/expense accounts that have to be corrected
 525
 526   # calculate effective skonto (percentage) in difference_as_skonto mode
 527   # only works if there are no negative acc_trans values
 528   my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
 529
 530   # checks:
 531   my $total_skonto_amount  = 0;
 532   my $total_rounding_error = 0;
 533
 534   my $reference_ARAP_amount = 0;
 535
 536   # my $transactions = $self->transactions;
 537   foreach my $transaction (@{ $self->transactions }) {
 538     # find all transactions with an AR_amount or AP_amount link
 539     $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
 540     # second condition is that we can determine an automatic Skonto account for each AR_amount entry
 541
 542     if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
 543         # $reference_ARAP_amount += $transaction->{amount} * $mult;
 544
 545         # quick hack that works around problem of non-unique tax keys in SKR04
 546         my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
 547         croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
 548
 549         if ( $is_sales ) {
 550           die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
 551         } else {
 552           die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
 553         };
 554
 555         my $skonto_amount_unrounded;
 556
 557         my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
 558
 559         my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
 560         my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
 561
 562
 563         $skonto_amount_unrounded   = abs($amount * $transaction_skonto_percent);
 564         my $skonto_amount_rounded  = _round($skonto_amount_unrounded);
 565         my $rounding_error         = $skonto_amount_unrounded - $skonto_amount_rounded;
 566         my $rounded_rounding_error = _round($rounding_error);
 567
 568         $total_rounding_error += $rounding_error;
 569         $total_skonto_amount  += $skonto_amount_rounded;
 570
 571         my $rec = {
 572           # skonto_percent_abs: relative part of amount + tax to the total invoice amount
 573           'skonto_percent_abs'     => $skonto_percent_abs,
 574           'chart_id'               => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
 575           'skonto_amount'          => $skonto_amount_rounded,
 576           # 'rounding_error'         => $rounding_error,
 577           # 'rounded_rounding_error' => $rounded_rounding_error,
 578         };
 579
 580         push @skonto_charts, $rec;
 581       };
 582   };
 583
 584   # if the rounded sum of all rounding_errors reaches 0.01 this sum is
 585   # subtracted from the largest skonto_amount
 586   my $rounded_total_rounding_error = abs(_round($total_rounding_error));
 587
 588   if ( $rounded_total_rounding_error > 0 ) {
 589     my $highest_amount_pos = 0;
 590     my $highest_amount = 0;
 591     my $i = -1;
 592     foreach my $ref ( @skonto_charts ) {
 593       $i++;
 594       if ( $ref->{skonto_amount} > $highest_amount ) {
 595         $highest_amount     = $ref->{skonto_amount};
 596         $highest_amount_pos = $i;
 597       };
 598     };
 599     $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
 600   };
 601
 602   return @skonto_charts;
 603 };
 604
 605
 606 sub within_skonto_period {
 607   my $self = shift;
 608   my $dateref = shift || DateTime->now->truncate( to => 'day' );
 609
 610   return undef unless ref $dateref eq 'DateTime';
 611   return 0 unless $self->skonto_date;
 612
 613   # return 1 if requested date (or today) is inside skonto period
 614   # this will also return 1 if date is before the invoice date
 615   return $dateref <= $self->skonto_date;
 616 };
 617
 618 sub valid_skonto_amount {
 619   my $self = shift;
 620   my $amount = shift || 0;
 621   my $max_skonto_percent = 0.10;
 622
 623   return 0 unless $amount > 0;
 624
 625   # does this work for other currencies?
 626   return ($self->amount*$max_skonto_percent) > $amount;
 627 };
 628
 629 sub get_payment_select_options_for_bank_transaction {
 630   my ($self, $bt_id, %params) = @_;
 631
 632   my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id );
 633   die unless $bt;
 634
 635   my $open_amount = $self->open_amount;
 636
 637   my @options;
 638   if ( $open_amount &&                   # invoice amount not 0
 639        $self->skonto_date &&             # check whether skonto applies
 640        abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 &&
 641        $self->check_skonto_configuration) {
 642          if ( $self->within_skonto_period($bt->transdate) ) {
 643            push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
 644            push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 });
 645          } else {
 646            push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
 647            push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')});
 648          };
 649   };
 650
 651   return @options;
 652
 653 };
 654
 655 sub exchangerate {
 656   my ($self) = @_;
 657
 658   return 1 if $self->currency_id == $::instance_conf->get_currency_id;
 659
 660   die "transdate isn't a DateTime object:" . ref($self->transdate) unless ref($self->transdate) eq 'DateTime';
 661   my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $self->currency_id,
 662                                                     transdate   => $self->transdate,
 663                                                    );
 664   return undef unless $rate;
 665
 666   return $self->is_sales ? $rate->buy : $rate->sell; # also undef if not defined
 667 };
 668
 669 sub get_payment_suggestions {
 670
 671   my ($self, %params) = @_;
 672
 673   my $open_amount = $self->open_amount;
 674   $open_amount   -= $self->open_sepa_transfer_amount if $params{sepa};
 675
 676   $self->{invoice_amount_suggestion} = $open_amount;
 677   undef $self->{payment_select_options};
 678   push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto',  display => t8('without skonto') });
 679   if ( $self->within_skonto_period ) {
 680     # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
 681     if ( $open_amount &&                   # invoice amount not 0
 682          $open_amount == $self->amount &&  # no payments yet, or sum of payments and sepa export amounts is zero
 683          $self->check_skonto_configuration) {
 684       $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
 685       push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt',  display => t8('with skonto acc. to pt') , selected => 1 });
 686     } else {
 687       if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
 688         $self->{invoice_amount_suggestion} = $open_amount;
 689         # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
 690         # AND we aren't in SEPA mode
 691         my $selected = 0;
 692         $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
 693         push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto',  display => t8('difference as skonto') , selected => $selected });
 694       };
 695     };
 696   } else {
 697     # invoice was configured with skonto, but skonto date has passed, or no skonto available
 698     $self->{invoice_amount_suggestion} = $open_amount;
 699     # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
 700     if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
 701       push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto',  display => t8('difference as skonto') , selected => 0 });
 702     };
 703   };
 704   return 1;
 705 };
 706
 707 sub validate_payment_type {
 708   my $payment_type = shift;
 709
 710   my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto);
 711   croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type };
 712
 713   return 1;
 714 }
 715
 716 sub create_bank_transaction {
 717   my ($self, %params) = @_;
 718
 719   require SL::DB::Chart;
 720   require SL::DB::BankAccount;
 721
 722   my $bank_chart;
 723   if ( $params{chart_id} ) {
 724     $bank_chart = SL::DB::Manager::Chart->find_by(chart_id => $params{chart_id}) or die "Can't find bank chart";
 725   } elsif ( $::instance_conf->get_ar_paid_accno_id ) {
 726     $bank_chart   = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_ar_paid_accno_id);
 727   } else {
 728     $bank_chart = SL::DB::Manager::Chart->find_by(description => 'Bank') or die "Can't find bank chart";
 729   };
 730   my $bank_account = SL::DB::Manager::BankAccount->find_by(chart_id => $bank_chart->id) or die "Can't find bank account for chart";
 731
 732   my $multiplier = $self->is_sales ? 1 : -1;
 733   my $amount = ($params{amount} || $self->amount) * $multiplier;
 734
 735   my $transdate = $params{transdate} || DateTime->today;
 736
 737   my $bt = SL::DB::BankTransaction->new(
 738     local_bank_account_id => $bank_account->id,
 739     remote_bank_code      => $self->customervendor->bank_code,
 740     remote_account_number => $self->customervendor->account_number,
 741     transdate             => $transdate,
 742     valutadate            => $transdate,
 743     amount                => $::form->round_amount($amount, 2),
 744     currency              => $self->currency->id,
 745     remote_name           => $self->customervendor->depositor,
 746     purpose               => $params{purpose} || $self->invnumber
 747   )->save;
 748 };
 749
 750
 751 sub forex {
 752   my ($self) = @_;
 753   $self->currency_id == $::instance_conf->get_currency_id ? return 0 : return 1;
 754 };
 755
 756 sub _round {
 757   my $value = shift;
 758   my $num_dec = 2;
 759   return $::form->round_amount($value, 2);
 760 }
 761
 762 1;
 763
 764 __END__
 765
 766 =pod
 767
 768 =head1 NAME
 769
 770 SL::DB::Helper::Payment  Mixin providing helper methods for paying C<Invoice>
 771                          and C<PurchaseInvoice> objects and using skonto
 772
 773 =head1 SYNOPSIS
 774
 775 In addition to actually causing a payment via pay_invoice this helper contains
 776 many methods that help in determining information about the status of the
 777 invoice, such as the remaining open amount, whether skonto applies, until which
 778 date skonto applies, the skonto amount and relative percentages, what to do
 779 with skonto, ...
 780
 781 To prevent duplicate code this was all added in this mixin rather than directly
 782 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
 783
 784 =over 4
 785
 786 =item C<pay_invoice %params>
 787
 788 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
 789 a configured bank account.
 790
 791 This function deals with all the acc_trans entries and also updates paid and datepaid.
 792
 793 Example:
 794
 795   my $ap   = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
 796   my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
 797   $ap->pay_invoice(chart_id      => $bank->chart_id,
 798                    amount        => $ap->open_amount,
 799                    transdate     => DateTime->now->to_kivitendo,
 800                    memo          => 'foobar',
 801                    source        => 'barfoo',
 802                    payment_type  => 'without_skonto',  # default if not specified
 803                    project_id    => 25,
 804                   );
 805
 806 or with skonto:
 807   $ap->pay_invoice(chart_id      => $bank->chart_id,
 808                    amount        => $ap->amount,       # doesn't need to be specified
 809                    transdate     => DateTime->now->to_kivitendo,
 810                    memo          => 'foobar',
 811                    source        => 'barfoo',
 812                    payment_type  => 'with_skonto',
 813                   );
 814
 815 or in a certain currency:
 816   $ap->pay_invoice(chart_id      => $bank->chart_id,
 817                    amount        => 500,
 818                    currency      => 'USD',
 819                    transdate     => DateTime->now->to_kivitendo,
 820                    memo          => 'foobar',
 821                    source        => 'barfoo',
 822                    payment_type  => 'with_skonto',
 823                   );
 824
 825 Allowed payment types are:
 826   without_skonto with_skonto_pt difference_as_skonto
 827
 828 The option C<payment_type> allows for a basic skonto mechanism.
 829
 830 C<without_skonto> is the default mode, "amount" is paid to the account in
 831 chart_id. This can also be used for partial payments and corrections via
 832 negative amounts.
 833
 834 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
 835 invoices the whole amount is paid, with the skonto part automatically being
 836 booked according to the skonto chart configured in the tax settings for each
 837 tax key. If an amount is passed it is ignored and the actual configured skonto
 838 amount is used.
 839
 840 C<difference_as_skonto> can only be used after partial payments have been made,
 841 the whole specified amount is booked according to the skonto charts configured
 842 in the tax settings for each tax key.
 843
 844 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
 845 C<difference_as_skonto>, as all necessary values are taken from the stored
 846 invoice.
 847
 848 The skonto modes automatically calculate the relative amounts for a mix of
 849 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
 850 skonto_charts, which calculates the relative percentages according to the
 851 amounts in acc_trans (which are grouped by tax).
 852
 853 There is currently no way of excluding certain items in an invoice from having
 854 skonto applied to them.  If this feature was added to parts the calculation
 855 method of relative skonto would have to be completely rewritten using the
 856 invoice items rather than acc_trans.
 857
 858 The skonto modes also still don't automatically correct the tax, this still has
 859 to be done manually. Therefore all payments generated by pay_invoice have
 860 taxkey 0.
 861
 862 There is currently no way to directly pay an invoice via this method if the
 863 effective skonto differs from the skonto according to the payment terms
 864 configured for the invoice/vendor.
 865
 866 In this case one has to pay in two steps: first the actual paid amount via
 867 "without skonto", and then the remainder via "difference_as_skonto". The user
 868 has to there actively decide whether to accept the differing skonto.
 869
 870 Because of the way skonto_charts works the calculation doesn't work if there
 871 are negative values in acc_trans. E.g. one invoice with a positive value for
 872 19% tax and a negative value for the acc_trans line with 7%
 873
 874 Skonto doesn't/shouldn't apply if the invoice contains credited items.
 875
 876 If no amount is given the whole open amout is paid.
 877
 878 If neither currency or currency_id are given as params, the currency of the
 879 invoice is assumed to be the payment currency.
 880
 881 =item C<reference_account>
 882
 883 Returns a chart object which is the chart of the invoice with link AR or AP.
 884
 885 Example (1200 is the AR account for SKR04):
 886   my $invoice = invoice(invnumber => '144');
 887   $invoice->reference_account->accno
 888   # 1200
 889
 890 =item C<percent_skonto>
 891
 892 Returns the configured skonto percentage of the payment terms of an invoice,
 893 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
 894 settings for ap.
 895
 896 =item C<amount_less_skonto>
 897
 898 If the invoice has a payment term (via ar for sales, via vendor for purchase),
 899 calculate the amount to be paid in the case of skonto.  This doesn't check,
 900 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
 901 the configured percentage (e.g. 2%) from the total amount.
 902
 903 The returned value is rounded to two decimals.
 904
 905 =item C<skonto_date>
 906
 907 The date up to which skonto may be taken. This is calculated from the invoice
 908 date + the number of days configured in the payment terms.
 909
 910 This method can also be used to determine whether skonto applies for the
 911 invoice, as it returns undef if there is no payment term or skonto days is set
 912 to 0.
 913
 914 =item C<within_skonto_period [DATE]>
 915
 916 Returns 0 or 1.
 917
 918 Checks whether the invoice has payment terms configured, and whether the date
 919 is within the skonto max date. If no date is passed the current date is used.
 920
 921 You can also pass a dateref object as a parameter to check whether skonto
 922 applies for that date rather than the current date.
 923
 924 =item C<valid_skonto_amount>
 925
 926 Takes an amount as an argument and checks whether the amount is less than 10%
 927 of the total amount of the invoice. The value of 10% is currently hardcoded in
 928 the method. This method is currently used to check whether to offer the payment
 929 option "difference as skonto".
 930
 931 Example:
 932  if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
 933    # ... do something
 934  }
 935
 936 =item C<skonto_charts [$amount]>
 937
 938 Returns a list of chart_ids and some calculated numbers that can be used for
 939 paying the invoice with skonto. This function will automatically calculate the
 940 relative skonto amounts even if the invoice contains several types of taxes
 941 (e.g. 7% and 19%).
 942
 943 Example usage:
 944   my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
 945   my @skonto_charts = $invoice->skonto_charts;
 946
 947 or with the total skonto amount as an argument:
 948   my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
 949
 950 The following values are generated for each chart:
 951
 952 =over 2
 953
 954 =item C<chart_id>
 955
 956 The chart id of the skonto amount to be booked.
 957
 958 =item C<skonto_amount>
 959
 960 The total amount to be paid to the account
 961
 962 =item C<skonto_percent>
 963
 964 The relative percentage of that skonto chart. This can be useful if the actual
 965 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
 966 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
 967 the relative skonto amounts for different taxes based on the absolute
 968 percentages. Used for case C<difference_as_skonto>.
 969
 970 =item C<skonto_percent_abs>
 971
 972 The absolute percentage of that skonto chart in relation to the total amount.
 973 Used to calculate skonto_amount for case C<with_skonto_pt>.
 974
 975 =back
 976
 977 If the invoice contains several types of taxes then skonto_charts can be used
 978 to calculate the relative amounts.
 979
 980 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
 981 tax not included:
 982
 983   my $invoice = invoice(invnumber => '144');
 984   $invoice->amount
 985   226.00000
 986   $invoice->payment_terms->percent_skonto
 987   0.02
 988   $invoice->skonto_charts
 989   pp $invoice->skonto_charts
 990   #             $VAR1 = {
 991   #               'chart_id'       => 128,
 992   #               'skonto_amount'  => '2.14',
 993   #               'skonto_percent' => '47.3451327433627'
 994   #             };
 995   #             $VAR2 = {
 996   #               'chart_id'       => 130,
 997   #               'skonto_amount'  => '2.38',
 998   #               'skonto_percent' => '52.654867256637'
 999   #             };
1000
1001 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
1002 C<skonto_percent>.
1003
1004 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
1005 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%).  This
1006 is because all the items are grouped according to the Buchungsgruppen mechanism
1007 and the totals are written to acc_trans.  For is and ir it is possible to have
1008 several acc_trans entries with the same tax. In this case skonto_charts
1009 generates a skonto booking for each acc_trans income/expense entry.
1010
1011 In the future this function may also be used to calculate the corrections for
1012 the income tax.
1013
1014 =item C<open_amount>
1015
1016 Unrounded total open amount of invoice (amount - paid).
1017 Doesn't take into account pending SEPA transfers.
1018
1019 =item C<open_percent>
1020
1021 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
1022 been made yet, 0,00 if fully paid.
1023
1024 =item C<remaining_skonto_days>
1025
1026 How many days skonto can still be taken, calculated from current day. Returns 0
1027 if current day is the max skonto date, and negative number if skonto date has
1028 already passed.
1029
1030 Returns undef if skonto is not configured for that invoice.
1031
1032 =item C<get_payment_suggestions %params>
1033
1034 Creates data intended for an L.select_tag dropdown that can be used in a
1035 template. Depending on the rules it will choose from the options
1036 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
1037 likely one.
1038
1039 If the parameter "sepa" is passed, the SEPA export payments that haven't been
1040 executed yet are considered when determining the open amount of the invoice.
1041
1042 The current rules are:
1043
1044 =over 2
1045
1046 =item * without_skonto is always an option
1047
1048 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
1049
1050 =item * difference_as_skonto is only offered if there have already been payments made and the open amount is smaller than 10% of the total amount.
1051
1052 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
1053 taxkey with a configured skonto chart
1054
1055 =back
1056
1057 It will also fill $self->{invoice_amount_suggestion} with either the open
1058 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
1059 template can fill the input with the likely amount.
1060
1061 Example in console:
1062   my $ar = invoice( invnumber => '257');
1063   $ar->get_payment_suggestions;
1064   print $ar->{invoice_amount_suggestion} . "\n";
1065   # 97.23
1066   pp $ar->{payment_select_options}
1067   # $VAR1 = [
1068   #         {
1069   #           'display' => 'ohne Skonto',
1070   #           'payment_type' => 'without_skonto'
1071   #         },
1072   #         {
1073   #           'display' => 'mit Skonto nach ZB',
1074   #           'payment_type' => 'with_skonto_pt',
1075   #           'selected' => 1
1076   #         }
1077   #       ];
1078
1079 The resulting array $ar->{payment_select_options} can be used in a template
1080 select_tag using value_key and title_key:
1081
1082 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
1083
1084 It would probably make sense to have different rules for the pre-selected items
1085 for sales and purchase, and to also make these rules configurable in the
1086 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
1087 might always want to pay quickly making use of skonto, while another company
1088 might always want to pay as late as possible.
1089
1090 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
1091
1092 Make suggestion for a skonto payment type by returning an HTML blob of the options
1093 of a HTML drop-down select with the most likely option preselected.
1094
1095 This is a helper function for BankTransaction/ajax_payment_suggestion.
1096
1097 We are working with an existing payment, so difference_as_skonto never makes sense.
1098
1099 If skonto is possible (skonto_date exists), add two possibilities:
1100 without_skonto and with_skonto_pt if payment date is within skonto_date,
1101 preselect with_skonto_pt, otherwise preselect without skonto.
1102
1103 =item C<create_bank_transaction %params>
1104
1105 Method used for testing purposes, allows you to quickly create bank
1106 transactions from invoices to have something to test payments against.
1107
1108  my $ap = SL::DB::Manager::Invoice->find_by(id => 41);
1109  $ap->create_bank_transaction(amount => $ap->amount/2, transdate => DateTime->today->add(days => 5));
1110
1111 To create a payment for 3 invoices that were all paid together, all with skonto:
1112  my $ar1 = SL::DB::Manager::Invoice->find_by(invnumber=>'20');
1113  my $ar2 = SL::DB::Manager::Invoice->find_by(invnumber=>'21');
1114  my $ar3 = SL::DB::Manager::Invoice->find_by(invnumber=>'22');
1115  $ar1->create_bank_transaction(amount  => ($ar1->amount_less_skonto + $ar2->amount_less_skonto + $ar2->amount_less_skonto),
1116                                purpose => 'Rechnungen 20, 21, 22',
1117                               );
1118
1119 Amount is always relative to the absolute amount of the invoice, use positive
1120 values for sales and purchases.
1121
1122 The following params can be passed to override the defaults:
1123
1124 =over 2
1125
1126 =item * amount
1127
1128 =item * purpose
1129
1130 =item * chart_id (the chart the amount is to be paid to)
1131
1132 =item * transdate
1133
1134 =back
1135
1136 =item C<exchangerate>
1137
1138 Returns 1 immediately if the record uses the default currency.
1139
1140 Returns the exchangerate in database format for the invoice according to that
1141 invoice's transdate, returning 'buy' for sales, 'sell' for purchases.
1142
1143 If no exchangerate can be found for that day undef is returned.
1144
1145 =item C<forex>
1146
1147 Returns 1 if record uses a different currency, 0 if the default currency is used.
1148
1149 =back
1150
1151 =head1 TODO AND CAVEATS
1152
1153 =over 4
1154
1155 =item *
1156
1157 when looking at open amount, maybe consider that there may already be queued
1158 amounts in SEPA Export
1159
1160 =back
1161
1162 =head1 AUTHOR
1163
1164 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>
1165
1166 =cut