SL/Controller/BankTransaction.pm

   1 package SL::Controller::BankTransaction;
   2
   3 # idee- möglichkeit bankdaten zu übernehmen in stammdaten
   4 # erst Kontenabgleich, um alle gl-Einträge wegzuhaben
   5 use strict;
   6
   7 use parent qw(SL::Controller::Base);
   8
   9 use SL::Controller::Helper::GetModels;
  10 use SL::Controller::Helper::ReportGenerator;
  11 use SL::ReportGenerator;
  12
  13 use SL::DB::BankTransaction;
  14 use SL::Helper::Flash;
  15 use SL::Locale::String;
  16 use SL::SEPA;
  17 use SL::DB::Invoice;
  18 use SL::DB::PurchaseInvoice;
  19 use SL::DB::RecordLink;
  20 use SL::DB::ReconciliationLink;
  21 use SL::JSON;
  22 use SL::DB::Chart;
  23 use SL::DB::AccTransaction;
  24 use SL::DB::BankTransactionAccTrans;
  25 use SL::DB::Tax;
  26 use SL::DB::BankAccount;
  27 use SL::DB::GLTransaction;
  28 use SL::DB::RecordTemplate;
  29 use SL::DB::SepaExportItem;
  30 use SL::DBUtils qw(like do_query);
  31
  32 use SL::Presenter::Tag qw(checkbox_tag html_tag);
  33 use Carp;
  34 use List::UtilsBy qw(partition_by);
  35 use List::MoreUtils qw(any);
  36 use List::Util qw(max);
  37
  38 use Rose::Object::MakeMethods::Generic
  39 (
  40   scalar                  => [ qw(callback transaction) ],
  41   'scalar --get_set_init' => [ qw(models problems) ],
  42 );
  43
  44 __PACKAGE__->run_before('check_auth');
  45
  46
  47 #
  48 # actions
  49 #
  50
  51 sub action_search {
  52   my ($self) = @_;
  53
  54   my $bank_accounts = SL::DB::Manager::BankAccount->get_all_sorted( query => [ obsolete => 0 ] );
  55
  56   $self->setup_search_action_bar;
  57   $self->render('bank_transactions/search',
  58                  BANK_ACCOUNTS => $bank_accounts);
  59 }
  60
  61 sub action_list_all {
  62   my ($self) = @_;
  63
  64   $self->make_filter_summary;
  65   $self->prepare_report;
  66
  67   $self->setup_list_all_action_bar;
  68   $self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
  69 }
  70
  71 sub action_list {
  72   my ($self) = @_;
  73
  74   if (!$::form->{filter}{bank_account}) {
  75     flash('error', t8('No bank account chosen!'));
  76     $self->action_search;
  77     return;
  78   }
  79
  80   my $sort_by = $::form->{sort_by} || 'transdate';
  81   $sort_by = 'transdate' if $sort_by eq 'proposal';
  82   $sort_by .= $::form->{sort_dir} ? ' DESC' : ' ASC';
  83
  84   my $fromdate = $::locale->parse_date_to_object($::form->{filter}->{fromdate});
  85   my $todate   = $::locale->parse_date_to_object($::form->{filter}->{todate});
  86   $todate->add( days => 1 ) if $todate;
  87
  88   my @where = ();
  89   push @where, (transdate => { ge => $fromdate }) if ($fromdate);
  90   push @where, (transdate => { lt => $todate })   if ($todate);
  91   my $bank_account = SL::DB::Manager::BankAccount->find_by( id => $::form->{filter}{bank_account} );
  92   # bank_transactions no younger than starting date,
  93   # including starting date (same search behaviour as fromdate)
  94   # but OPEN invoices to be matched may be from before
  95   if ( $bank_account->reconciliation_starting_date ) {
  96     push @where, (transdate => { ge => $bank_account->reconciliation_starting_date });
  97   };
  98
  99   my $bank_transactions = SL::DB::Manager::BankTransaction->get_all(
 100     with_objects => [ 'local_bank_account', 'currency' ],
 101     sort_by      => $sort_by,
 102     limit        => 10000,
 103     where        => [
 104       amount                => {ne => \'invoice_amount'},
 105       local_bank_account_id => $::form->{filter}{bank_account},
 106       cleared               => 0,
 107       @where
 108     ],
 109   );
 110   # credit notes have a negative amount, treat differently
 111   my $all_open_ar_invoices = SL::DB::Manager::Invoice        ->get_all(where => [ or => [ amount => { gt => \'paid' },
 112                                                                                           and => [ type    => 'credit_note',
 113                                                                                                    amount  => { lt => \'paid' }
 114                                                                                                  ],
 115                                                                                         ],
 116                                                                                 ],
 117                                                                        with_objects => ['customer','payment_terms']);
 118
 119   my $all_open_ap_invoices = SL::DB::Manager::PurchaseInvoice->get_all(where => [amount => { ne => \'paid' }], with_objects => ['vendor'  ,'payment_terms']);
 120   my $all_open_sepa_export_items = SL::DB::Manager::SepaExportItem->get_all(where => [chart_id => $bank_account->chart_id ,
 121                                                                              'sepa_export.executed' => 0, 'sepa_export.closed' => 0 ], with_objects => ['sepa_export']);
 122
 123   my @all_open_invoices;
 124   # filter out invoices with less than 1 cent outstanding
 125   push @all_open_invoices, map { $_->{is_ar}=1 ; $_ } grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ar_invoices };
 126   push @all_open_invoices, map { $_->{is_ar}=0 ; $_ } grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ap_invoices };
 127
 128   my %sepa_exports;
 129   my %sepa_export_items_by_id = partition_by { $_->ar_id || $_->ap_id } @$all_open_sepa_export_items;
 130
 131   # first collect sepa export items to open invoices
 132   foreach my $open_invoice (@all_open_invoices){
 133     $open_invoice->{realamount}  = $::form->format_amount(\%::myconfig,$open_invoice->amount,2);
 134     $open_invoice->{skonto_type} = 'without_skonto';
 135     foreach (@{ $sepa_export_items_by_id{ $open_invoice->id } || [] }) {
 136       my $factor                   = ($_->ar_id == $open_invoice->id ? 1 : -1);
 137       $open_invoice->{realamount}  = $::form->format_amount(\%::myconfig,$open_invoice->amount*$factor,2);
 138
 139       $open_invoice->{skonto_type} = $_->payment_type;
 140       $sepa_exports{$_->sepa_export_id} ||= { count => 0, is_ar => 0, amount => 0, proposed => 0, invoices => [], item => $_ };
 141       $sepa_exports{$_->sepa_export_id}->{count}++;
 142       $sepa_exports{$_->sepa_export_id}->{is_ar}++ if  $_->ar_id == $open_invoice->id;
 143       $sepa_exports{$_->sepa_export_id}->{amount} += $_->amount * $factor;
 144       push @{ $sepa_exports{$_->sepa_export_id}->{invoices} }, $open_invoice;
 145     }
 146   }
 147
 148   # try to match each bank_transaction with each of the possible open invoices
 149   # by awarding points
 150   my @proposals;
 151
 152   foreach my $bt (@{ $bank_transactions }) {
 153     ## 5 Stellen hinter dem Komma auf 2 Stellen reduzieren
 154     $bt->amount($bt->amount*1);
 155     $bt->invoice_amount($bt->invoice_amount*1);
 156
 157     $bt->{proposals}    = [];
 158     $bt->{rule_matches} = [];
 159
 160     $bt->{remote_name} .= $bt->{remote_name_1} if $bt->{remote_name_1};
 161
 162     if ( $bt->is_batch_transaction ) {
 163       my $found=0;
 164       foreach ( keys  %sepa_exports) {
 165         if ( abs(($sepa_exports{$_}->{amount} * 1) - ($bt->amount * 1)) < 0.01 ) {
 166           ## jupp
 167           @{$bt->{proposals}} = @{$sepa_exports{$_}->{invoices}};
 168           $bt->{sepa_export_ok} = 1;
 169           $sepa_exports{$_}->{proposed}=1;
 170           push(@proposals, $bt);
 171           $found=1;
 172           last;
 173         }
 174       }
 175       next if $found;
 176       # batch transaction has no remotename !!
 177     } else {
 178       next unless $bt->{remote_name};  # bank has no name, usually fees, use create invoice to assign
 179     }
 180
 181     # try to match the current $bt to each of the open_invoices, saving the
 182     # results of get_agreement_with_invoice in $open_invoice->{agreement} and
 183     # $open_invoice->{rule_matches}.
 184
 185     # The values are overwritten each time a new bt is checked, so at the end
 186     # of each bt the likely results are filtered and those values are stored in
 187     # the arrays $bt->{proposals} and $bt->{rule_matches}, and the agreement
 188     # score is stored in $bt->{agreement}
 189
 190     foreach my $open_invoice (@all_open_invoices) {
 191       ($open_invoice->{agreement}, $open_invoice->{rule_matches}) = $bt->get_agreement_with_invoice($open_invoice,
 192         sepa_export_items => $all_open_sepa_export_items,
 193       );
 194       $open_invoice->{realamount} = $::form->format_amount(\%::myconfig,
 195                                       $open_invoice->amount * ($open_invoice->{is_ar} ? 1 : -1), 2);
 196     }
 197
 198     my $agreement = 15;
 199     my $min_agreement = 3; # suggestions must have at least this score
 200
 201     my $max_agreement = max map { $_->{agreement} } @all_open_invoices;
 202
 203     # add open_invoices with highest agreement into array $bt->{proposals}
 204     if ( $max_agreement >= $min_agreement ) {
 205       $bt->{proposals} = [ grep { $_->{agreement} == $max_agreement } @all_open_invoices ];
 206       $bt->{agreement} = $max_agreement; #scalar @{ $bt->{proposals} } ? $agreement + 1 : '';
 207
 208       # store the rule_matches in a separate array, so they can be displayed in template
 209       foreach ( @{ $bt->{proposals} } ) {
 210         push(@{$bt->{rule_matches}}, $_->{rule_matches});
 211       };
 212     };
 213   }  # finished one bt
 214   # finished all bt
 215
 216   # separate filter for proposals (second tab, agreement >= 5 and exactly one match)
 217   # to qualify as a proposal there has to be
 218   # * agreement >= 5  TODO: make threshold configurable in configuration
 219   # * there must be only one exact match
 220   # * depending on whether sales or purchase the amount has to have the correct sign (so Gutschriften don't work?)
 221   my $proposal_threshold = 5;
 222   my @otherproposals = grep {
 223        ($_->{agreement} >= $proposal_threshold)
 224     && (1 == scalar @{ $_->{proposals} })
 225     && (@{ $_->{proposals} }[0]->is_sales ? abs(@{ $_->{proposals} }[0]->amount - $_->amount) < 0.01
 226                                           : abs(@{ $_->{proposals} }[0]->amount + $_->amount) < 0.01)
 227   } @{ $bank_transactions };
 228
 229   push @proposals, @otherproposals;
 230
 231   # sort bank transaction proposals by quality (score) of proposal
 232   if ($::form->{sort_by} && $::form->{sort_by} eq 'proposal') {
 233     if ($::form->{sort_dir}) {
 234       $bank_transactions = [ sort { $a->{agreement} <=> $b->{agreement} } @{ $bank_transactions } ];
 235     } else {
 236       $bank_transactions = [ sort { $b->{agreement} <=> $a->{agreement} } @{ $bank_transactions } ];
 237     }
 238   }
 239
 240   # for testing with t/bank/banktransaction.t :
 241   if ( $::form->{dont_render_for_test} ) {
 242     return ( $bank_transactions , \@proposals );
 243   }
 244
 245   $::request->layout->add_javascripts("kivi.BankTransaction.js");
 246   $self->render('bank_transactions/list',
 247                 title             => t8('Bank transactions MT940'),
 248                 BANK_TRANSACTIONS => $bank_transactions,
 249                 PROPOSALS         => \@proposals,
 250                 bank_account      => $bank_account,
 251                 ui_tab            => scalar(@proposals) > 0?1:0,
 252               );
 253 }
 254
 255 sub action_assign_invoice {
 256   my ($self) = @_;
 257
 258   $self->{transaction} = SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id});
 259
 260   $self->render('bank_transactions/assign_invoice',
 261                 { layout => 0 },
 262                 title => t8('Assign invoice'),);
 263 }
 264
 265 sub action_create_invoice {
 266   my ($self) = @_;
 267   my %myconfig = %main::myconfig;
 268
 269   $self->transaction(SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id}));
 270
 271   my $vendor_of_transaction = SL::DB::Manager::Vendor->find_by(iban => $self->transaction->{remote_account_number});
 272   my $use_vendor_filter     = $self->transaction->{remote_account_number} && $vendor_of_transaction;
 273
 274   my $templates_ap = SL::DB::Manager::RecordTemplate->get_all(
 275     where        => [ template_type => 'ap_transaction' ],
 276     with_objects => [ qw(employee vendor) ],
 277   );
 278   my $templates_gl = SL::DB::Manager::RecordTemplate->get_all(
 279     query        => [ template_type => 'gl_transaction',
 280                       chart_id      => SL::DB::Manager::BankAccount->find_by(id => $self->transaction->local_bank_account_id)->chart_id,
 281                     ],
 282     with_objects => [ qw(employee record_template_items) ],
 283   );
 284
 285   # pre filter templates_ap, if we have a vendor match (IBAN eq IBAN) - show and allow user to edit this via gui!
 286   $templates_ap = [ grep { $_->vendor_id == $vendor_of_transaction->id } @{ $templates_ap } ] if $use_vendor_filter;
 287
 288   $self->callback($self->url_for(
 289     action                => 'list',
 290     'filter.bank_account' => $::form->{filter}->{bank_account},
 291     'filter.todate'       => $::form->{filter}->{todate},
 292     'filter.fromdate'     => $::form->{filter}->{fromdate},
 293   ));
 294
 295   $self->render(
 296     'bank_transactions/create_invoice',
 297     { layout => 0 },
 298     title        => t8('Create invoice'),
 299     TEMPLATES_GL => $use_vendor_filter && @{ $templates_ap } ? undef : $templates_gl,
 300     TEMPLATES_AP => $templates_ap,
 301     vendor_name  => $use_vendor_filter && @{ $templates_ap } ? $vendor_of_transaction->name : undef,
 302   );
 303 }
 304
 305 sub action_ajax_payment_suggestion {
 306   my ($self) = @_;
 307
 308   # based on a BankTransaction ID and a Invoice or PurchaseInvoice ID passed via $::form,
 309   # create an HTML blob to be used by the js function add_invoices in templates/webpages/bank_transactions/list.html
 310   # and return encoded as JSON
 311
 312   croak("Need bt_id") unless $::form->{bt_id};
 313
 314   my $invoice = SL::DB::Manager::Invoice->find_by( id => $::form->{prop_id} ) || SL::DB::Manager::PurchaseInvoice->find_by( id => $::form->{prop_id} );
 315
 316   croak("No valid invoice found") unless $invoice;
 317
 318   my $html = $self->render(
 319     'bank_transactions/_payment_suggestion', { output => 0 },
 320     bt_id          => $::form->{bt_id},
 321     invoice        => $invoice,
 322   );
 323
 324   $self->render(\ SL::JSON::to_json( { 'html' => "$html" } ), { layout => 0, type => 'json', process => 0 });
 325 };
 326
 327 sub action_filter_templates {
 328   my ($self) = @_;
 329
 330   $self->{transaction}      = SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id});
 331
 332   my (@filter, @filter_ap);
 333
 334   # filter => gl and ap | filter_ap = ap (i.e. vendorname)
 335   push @filter,    ('template_name' => { ilike => '%' . $::form->{template} . '%' })  if $::form->{template};
 336   push @filter,    ('reference'     => { ilike => '%' . $::form->{reference} . '%' }) if $::form->{reference};
 337   push @filter_ap, ('vendor.name'   => { ilike => '%' . $::form->{vendor} . '%' })    if $::form->{vendor};
 338   push @filter_ap, @filter;
 339   my $templates_gl = SL::DB::Manager::RecordTemplate->get_all(
 340     query        => [ template_type => 'gl_transaction',
 341                       chart_id      => SL::DB::Manager::BankAccount->find_by(id => $self->transaction->local_bank_account_id)->chart_id,
 342                       (and => \@filter) x !!@filter
 343                     ],
 344     with_objects => [ qw(employee record_template_items) ],
 345   );
 346
 347   my $templates_ap = SL::DB::Manager::RecordTemplate->get_all(
 348     where        => [ template_type => 'ap_transaction', (and => \@filter_ap) x !!@filter_ap ],
 349     with_objects => [ qw(employee vendor) ],
 350   );
 351   $::form->{filter} //= {};
 352
 353   $self->callback($self->url_for(
 354     action                => 'list',
 355     'filter.bank_account' => $::form->{filter}->{bank_account},
 356     'filter.todate'       => $::form->{filter}->{todate},
 357     'filter.fromdate'     => $::form->{filter}->{fromdate},
 358   ));
 359
 360   my $output  = $self->render(
 361     'bank_transactions/_template_list',
 362     { output => 0 },
 363     TEMPLATES_AP => $templates_ap,
 364     TEMPLATES_GL => $templates_gl,
 365   );
 366
 367   $self->render(\to_json({ html => $output }), { type => 'json', process => 0 });
 368 }
 369
 370 sub action_ajax_add_list {
 371   my ($self) = @_;
 372
 373   my @where_sale     = (amount => { ne => \'paid' });
 374   my @where_purchase = (amount => { ne => \'paid' });
 375
 376   if ($::form->{invnumber}) {
 377     push @where_sale,     (invnumber => { ilike => like($::form->{invnumber})});
 378     push @where_purchase, (invnumber => { ilike => like($::form->{invnumber})});
 379   }
 380
 381   if ($::form->{amount}) {
 382     push @where_sale,     (amount => $::form->parse_amount(\%::myconfig, $::form->{amount}));
 383     push @where_purchase, (amount => $::form->parse_amount(\%::myconfig, $::form->{amount}));
 384   }
 385
 386   if ($::form->{vcnumber}) {
 387     push @where_sale,     ('customer.customernumber' => { ilike => like($::form->{vcnumber})});
 388     push @where_purchase, ('vendor.vendornumber'     => { ilike => like($::form->{vcnumber})});
 389   }
 390
 391   if ($::form->{vcname}) {
 392     push @where_sale,     ('customer.name' => { ilike => like($::form->{vcname})});
 393     push @where_purchase, ('vendor.name'   => { ilike => like($::form->{vcname})});
 394   }
 395
 396   if ($::form->{transdatefrom}) {
 397     my $fromdate = $::locale->parse_date_to_object($::form->{transdatefrom});
 398     if ( ref($fromdate) eq 'DateTime' ) {
 399       push @where_sale,     ('transdate' => { ge => $fromdate});
 400       push @where_purchase, ('transdate' => { ge => $fromdate});
 401     };
 402   }
 403
 404   if ($::form->{transdateto}) {
 405     my $todate = $::locale->parse_date_to_object($::form->{transdateto});
 406     if ( ref($todate) eq 'DateTime' ) {
 407       $todate->add(days => 1);
 408       push @where_sale,     ('transdate' => { lt => $todate});
 409       push @where_purchase, ('transdate' => { lt => $todate});
 410     };
 411   }
 412
 413   my $all_open_ar_invoices = SL::DB::Manager::Invoice        ->get_all(where => \@where_sale,     with_objects => 'customer');
 414   my $all_open_ap_invoices = SL::DB::Manager::PurchaseInvoice->get_all(where => \@where_purchase, with_objects => 'vendor');
 415
 416   my @all_open_invoices = @{ $all_open_ar_invoices };
 417   # add ap invoices, filtering out subcent open amounts
 418   push @all_open_invoices, grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ap_invoices };
 419
 420   @all_open_invoices = sort { $a->id <=> $b->id } @all_open_invoices;
 421
 422   my $output  = $self->render(
 423     'bank_transactions/add_list',
 424     { output => 0 },
 425     INVOICES => \@all_open_invoices,
 426   );
 427
 428   my %result = ( count => 0, html => $output );
 429
 430   $self->render(\to_json(\%result), { type => 'json', process => 0 });
 431 }
 432
 433 sub action_ajax_accept_invoices {
 434   my ($self) = @_;
 435
 436   my @selected_invoices;
 437   foreach my $invoice_id (@{ $::form->{invoice_id} || [] }) {
 438     my $invoice_object = SL::DB::Manager::Invoice->find_by(id => $invoice_id) || SL::DB::Manager::PurchaseInvoice->find_by(id => $invoice_id);
 439     push @selected_invoices, $invoice_object;
 440   }
 441
 442   $self->render(
 443     'bank_transactions/invoices',
 444     { layout => 0 },
 445     INVOICES => \@selected_invoices,
 446     bt_id    => $::form->{bt_id},
 447   );
 448 }
 449
 450 sub save_invoices {
 451   my ($self) = @_;
 452
 453   return 0 if !$::form->{invoice_ids};
 454
 455   my %invoice_hash = %{ delete $::form->{invoice_ids} };  # each key (the bt line with a bt_id) contains an array of invoice_ids
 456
 457   # e.g. three partial payments with bt_ids 54, 55 and 56 for invoice with id 74:
 458   # $invoice_hash = {
 459   #         '55' => [
 460   #                 '74'
 461   #               ],
 462   #         '54' => [
 463   #                 '74'
 464   #               ],
 465   #         '56' => [
 466   #                 '74'
 467   #               ]
 468   #       };
 469   #
 470   # or if the payment with bt_id 44 is used to pay invoices with ids 50, 51 and 52
 471   # $invoice_hash = {
 472   #           '44' => [ '50', '51', 52' ]
 473   #         };
 474
 475   $::form->{invoice_skontos} ||= {}; # hash of arrays containing the payment types, could be empty
 476
 477   # a bank_transaction may be assigned to several invoices, i.e. a customer
 478   # might pay several open invoices with one transaction
 479
 480   $self->problems([]);
 481
 482   my $count = 0;
 483
 484   if ( $::form->{proposal_ids} ) {
 485     foreach (@{ $::form->{proposal_ids} }) {
 486       my  $bank_transaction_id = $_;
 487       my  $invoice_ids = $invoice_hash{$_};
 488       push @{ $self->problems }, $self->save_single_bank_transaction(
 489         bank_transaction_id => $bank_transaction_id,
 490         invoice_ids         => $invoice_ids,
 491         sources             => ($::form->{sources} // {})->{$_},
 492         memos               => ($::form->{memos}   // {})->{$_},
 493       );
 494       $count += scalar( @{$invoice_ids} );
 495     }
 496   } else {
 497     while ( my ($bank_transaction_id, $invoice_ids) = each(%invoice_hash) ) {
 498       push @{ $self->problems }, $self->save_single_bank_transaction(
 499         bank_transaction_id => $bank_transaction_id,
 500         invoice_ids         => $invoice_ids,
 501         sources             => [  map { $::form->{"sources_${bank_transaction_id}_${_}"} } @{ $invoice_ids } ],
 502         memos               => [  map { $::form->{"memos_${bank_transaction_id}_${_}"}   } @{ $invoice_ids } ],
 503       );
 504       $count += scalar( @{$invoice_ids} );
 505     }
 506   }
 507   my $max_count = $count;
 508   foreach (@{ $self->problems }) {
 509     $count-- if $_->{result} eq 'error';
 510   }
 511   return ($count, $max_count);
 512 }
 513
 514 sub action_save_invoices {
 515   my ($self) = @_;
 516   my ($success_count, $max_count) = $self->save_invoices();
 517
 518   if ($success_count == $max_count) {
 519     flash('ok', t8('#1 invoice(s) saved.', $success_count));
 520   } else {
 521     flash('error', t8('At least #1 invoice(s) not saved', $max_count - $success_count));
 522   }
 523
 524   $self->action_list();
 525 }
 526
 527 sub action_save_proposals {
 528   my ($self) = @_;
 529
 530   if ( $::form->{proposal_ids} ) {
 531     my $propcount = scalar(@{ $::form->{proposal_ids} });
 532     if ( $propcount > 0 ) {
 533       my $count = $self->save_invoices();
 534
 535       flash('ok', t8('#1 proposal(s) with #2 invoice(s) saved.',  $propcount, $count));
 536     }
 537   }
 538   $self->action_list();
 539
 540 }
 541
 542 sub save_single_bank_transaction {
 543   my ($self, %params) = @_;
 544
 545   my %data = (
 546     %params,
 547     bank_transaction => SL::DB::Manager::BankTransaction->find_by(id => $params{bank_transaction_id}),
 548     invoices         => [],
 549   );
 550
 551   if (!$data{bank_transaction}) {
 552     return {
 553       %data,
 554       result => 'error',
 555       message => $::locale->text('The ID #1 is not a valid database ID.', $data{bank_transaction_id}),
 556     };
 557   }
 558
 559   my $bank_transaction = $data{bank_transaction};
 560
 561   if ($bank_transaction->closed_period) {
 562     return {
 563       %data,
 564       result => 'error',
 565       message => $::locale->text('Cannot post payment for a closed period!'),
 566     };
 567   }
 568   my (@warnings);
 569
 570   my $worker = sub {
 571     my $bt_id                 = $data{bank_transaction_id};
 572     my $sign                  = $bank_transaction->amount < 0 ? -1 : 1;
 573     my $not_assigned_amount   = $bank_transaction->not_assigned_amount;
 574     my $payment_received      = $bank_transaction->amount > 0;
 575     my $payment_sent          = $bank_transaction->amount < 0;
 576
 577
 578     foreach my $invoice_id (@{ $params{invoice_ids} }) {
 579       my $invoice = SL::DB::Manager::Invoice->find_by(id => $invoice_id) || SL::DB::Manager::PurchaseInvoice->find_by(id => $invoice_id);
 580       if (!$invoice) {
 581         return {
 582           %data,
 583           result  => 'error',
 584           message => $::locale->text("The ID #1 is not a valid database ID.", $invoice_id),
 585         };
 586       }
 587       push @{ $data{invoices} }, $invoice;
 588     }
 589
 590     if (   $payment_received
 591         && any {    ( $_->is_sales && ($_->amount < 0))
 592                  || (!$_->is_sales && ($_->amount > 0))
 593                } @{ $data{invoices} }) {
 594       return {
 595         %data,
 596         result  => 'error',
 597         message => $::locale->text("Received payments can only be posted for sales invoices and purchase credit notes."),
 598       };
 599     }
 600
 601     if (   $payment_sent
 602         && any {    ( $_->is_sales && ($_->amount > 0))
 603                  || (!$_->is_sales && ($_->amount < 0) && ($_->invoice_type eq 'purchase_invoice'))
 604                } @{ $data{invoices} }) {
 605       return {
 606         %data,
 607         result  => 'error',
 608         message => $::locale->text("Sent payments can only be posted for purchase invoices and sales credit notes."),
 609       };
 610     }
 611
 612     my $max_invoices = scalar(@{ $data{invoices} });
 613     my $n_invoices   = 0;
 614
 615     foreach my $invoice (@{ $data{invoices} }) {
 616       my $source = ($data{sources} // [])->[$n_invoices];
 617       my $memo   = ($data{memos}   // [])->[$n_invoices];
 618
 619       $n_invoices++ ;
 620
 621
 622       if (!$not_assigned_amount && $invoice->open_amount) {
 623         return {
 624           %data,
 625           result  => 'error',
 626           message => $::locale->text("A payment can only be posted for multiple invoices if the amount to post is equal to or bigger than the sum of the open amounts of the affected invoices."),
 627         };
 628       }
 629
 630       my ($payment_type, $free_skonto_amount);
 631       if ( defined $::form->{invoice_skontos}->{"$bt_id"} ) {
 632         $payment_type = shift(@{ $::form->{invoice_skontos}->{"$bt_id"} });
 633       } else {
 634         $payment_type = 'without_skonto';
 635       }
 636
 637       if ($payment_type eq 'free_skonto') {
 638         # parse user input > 0
 639         if ($::form->parse_amount(\%::myconfig, $::form->{"free_skonto_amount"}->{"$bt_id"}{$invoice->id}) > 0) {
 640           $free_skonto_amount = $::form->parse_amount(\%::myconfig, $::form->{"free_skonto_amount"}->{"$bt_id"}{$invoice->id});
 641         } else {
 642           return {
 643             %data,
 644             result  => 'error',
 645             message => $::locale->text("Free skonto amount has to be a positive number."),
 646           };
 647         }
 648       }
 649     # pay invoice
 650     # TODO rewrite this: really booked amount should be a return value of Payment.pm
 651     # also this controller shouldnt care about how to calc skonto. we simply delegate the
 652     # payment_type to the helper and get the corresponding bank_transaction values back
 653     # hotfix to get the signs right - compare absolute values and later set the signs
 654     # should be better done elsewhere - changing not_assigned_amount to abs feels seriously bogus
 655
 656     my $open_amount = $payment_type eq 'with_skonto_pt' ? $invoice->amount_less_skonto : $invoice->open_amount;
 657     $open_amount         = abs($open_amount);
 658     $not_assigned_amount = abs($not_assigned_amount);
 659     my $amount_for_booking = ($open_amount < $not_assigned_amount) ? $open_amount : $not_assigned_amount;
 660     my $amount_for_payment = $amount_for_booking;
 661
 662     # get the right direction for the payment bookings (all amounts < 0 are stornos, credit notes or negative ap)
 663     $amount_for_payment *= -1 if $invoice->amount < 0;
 664     $free_skonto_amount *= -1 if ($free_skonto_amount && $invoice->amount < 0);
 665     # get the right direction for the bank transaction
 666     $amount_for_booking *= $sign;
 667
 668     $bank_transaction->invoice_amount($bank_transaction->invoice_amount + $amount_for_booking);
 669
 670     # ... and then pay the invoice
 671     my @acc_ids = $invoice->pay_invoice(chart_id => $bank_transaction->local_bank_account->chart_id,
 672                           trans_id      => $invoice->id,
 673                           amount        => $amount_for_payment,
 674                           payment_type  => $payment_type,
 675                           source        => $source,
 676                           memo          => $memo,
 677                           skonto_amount => $free_skonto_amount,
 678                           transdate     => $bank_transaction->valutadate->to_kivitendo);
 679     # ... and record the origin via BankTransactionAccTrans
 680     if (scalar(@acc_ids) < 2) {
 681       return {
 682         %data,
 683         result  => 'error',
 684         message => $::locale->text("Unable to book transactions for bank purpose #1", $bank_transaction->purpose),
 685       };
 686     }
 687     foreach my $acc_trans_id (@acc_ids) {
 688         my $id_type = $invoice->is_sales ? 'ar' : 'ap';
 689         my  %props_acc = (
 690           acc_trans_id        => $acc_trans_id,
 691           bank_transaction_id => $bank_transaction->id,
 692           $id_type            => $invoice->id,
 693         );
 694         SL::DB::BankTransactionAccTrans->new(%props_acc)->save;
 695     }
 696       # Record a record link from the bank transaction to the invoice
 697       my %props = (
 698         from_table => 'bank_transactions',
 699         from_id    => $bt_id,
 700         to_table   => $invoice->is_sales ? 'ar' : 'ap',
 701         to_id      => $invoice->id,
 702       );
 703       SL::DB::RecordLink->new(%props)->save;
 704
 705       # "close" a sepa_export_item if it exists
 706       # code duplicated in action_save_proposals!
 707       # currently only works, if there is only exactly one open sepa_export_item
 708       if ( my $seis = $invoice->find_sepa_export_items({ executed => 0 }) ) {
 709         if ( scalar @$seis == 1 ) {
 710           # moved the execution and the check for sepa_export into a method,
 711           # this isn't part of a transaction, though
 712           $seis->[0]->set_executed if $invoice->id == $seis->[0]->arap_id;
 713         }
 714       }
 715
 716     }
 717     $bank_transaction->save;
 718
 719     # 'undef' means 'no error' here.
 720     return undef;
 721   };
 722
 723   my $error;
 724   my $rez = $data{bank_transaction}->db->with_transaction(sub {
 725     eval {
 726       $error = $worker->();
 727       1;
 728
 729     } or do {
 730       $error = {
 731         %data,
 732         result  => 'error',
 733         message => $@,
 734       };
 735     };
 736
 737     # Rollback Fehler nicht weiterreichen
 738     # die if $error;
 739     # aber einen rollback von hand
 740     $::lxdebug->message(LXDebug->DEBUG2(),"finish worker with ". ($error ? $error->{result} : '-'));
 741     $data{bank_transaction}->db->dbh->rollback if $error && $error->{result} eq 'error';
 742   });
 743
 744   return grep { $_ } ($error, @warnings);
 745 }
 746 sub action_unlink_bank_transaction {
 747   my ($self, %params) = @_;
 748
 749   croak("No bank transaction ids") unless scalar @{ $::form->{ids}} > 0;
 750
 751   my $success_count;
 752
 753   foreach my $bt_id (@{ $::form->{ids}} )  {
 754
 755     my $bank_transaction = SL::DB::Manager::BankTransaction->find_by(id => $bt_id);
 756     croak("No valid bank transaction found") unless (ref($bank_transaction)  eq 'SL::DB::BankTransaction');
 757     croak t8('Cannot unlink payment for a closed period!') if $bank_transaction->closed_period;
 758
 759     # everything in one transaction
 760     my $rez = $bank_transaction->db->with_transaction(sub {
 761       # 1. remove all reconciliations (due to underlying trigger, this has to be the first step)
 762       my $rec_links = SL::DB::Manager::ReconciliationLink->get_all(where => [ bank_transaction_id => $bt_id ]);
 763       $_->delete for @{ $rec_links };
 764
 765       my %trans_ids;
 766       foreach my $acc_trans_id_entry (@{ SL::DB::Manager::BankTransactionAccTrans->get_all(where => [bank_transaction_id => $bt_id ] )}) {
 767
 768         my $acc_trans = SL::DB::Manager::AccTransaction->get_all(where => [acc_trans_id => $acc_trans_id_entry->acc_trans_id]);
 769
 770         # save trans_id and type
 771         die "no type" unless ($acc_trans_id_entry->ar_id || $acc_trans_id_entry->ap_id || $acc_trans_id_entry->gl_id);
 772         $trans_ids{$acc_trans_id_entry->ar_id} = 'ar' if $acc_trans_id_entry->ar_id;
 773         $trans_ids{$acc_trans_id_entry->ap_id} = 'ap' if $acc_trans_id_entry->ap_id;
 774         $trans_ids{$acc_trans_id_entry->gl_id} = 'gl' if $acc_trans_id_entry->gl_id;
 775         # 2. all good -> ready to delete acc_trans and bt_acc link
 776         $acc_trans_id_entry->delete;
 777         $_->delete for @{ $acc_trans };
 778       }
 779       # 3. update arap.paid (may not be 0, yet)
 780       #    or in case of gl, delete whole entry
 781       while (my ($trans_id, $type) = each %trans_ids) {
 782         if ($type eq 'gl') {
 783           SL::DB::Manager::GLTransaction->delete_all(where => [ id => $trans_id ]);
 784           next;
 785         }
 786         die ("invalid type") unless $type =~ m/^(ar|ap)$/;
 787
 788         # recalc and set paid via database query
 789         my $query = qq|UPDATE $type SET paid =
 790                         (SELECT COALESCE(abs(sum(amount)),0) FROM acc_trans
 791                          WHERE trans_id = ?
 792                          AND chart_link ilike '%paid%')|;
 793
 794         die if (do_query($::form, $bank_transaction->db->dbh, $query, $trans_id) == -1);
 795       }
 796       # 4. and delete all (if any) record links
 797       my $rl = SL::DB::Manager::RecordLink->delete_all(where => [ from_id => $bt_id, from_table => 'bank_transactions' ]);
 798
 799       # 5. finally reset  this bank transaction
 800       $bank_transaction->invoice_amount(0);
 801       $bank_transaction->cleared(0);
 802       $bank_transaction->save;
 803
 804       1;
 805
 806     }) || die t8('error while unlinking payment #1 : ', $bank_transaction->purpose) . $bank_transaction->db->error . "\n";
 807
 808     $success_count++;
 809   }
 810
 811   flash('ok', t8('#1 bank transaction bookings undone.', $success_count));
 812   $self->action_list_all() unless $params{testcase};
 813 }
 814 #
 815 # filters
 816 #
 817
 818 sub check_auth {
 819   $::auth->assert('bank_transaction');
 820 }
 821
 822 #
 823 # helpers
 824 #
 825
 826 sub make_filter_summary {
 827   my ($self) = @_;
 828
 829   my $filter = $::form->{filter} || {};
 830   my @filter_strings;
 831
 832   my @filters = (
 833     [ $filter->{"transdate:date::ge"},      $::locale->text('Transdate')  . " " . $::locale->text('From Date') ],
 834     [ $filter->{"transdate:date::le"},      $::locale->text('Transdate')  . " " . $::locale->text('To Date')   ],
 835     [ $filter->{"valutadate:date::ge"},     $::locale->text('Valutadate') . " " . $::locale->text('From Date') ],
 836     [ $filter->{"valutadate:date::le"},     $::locale->text('Valutadate') . " " . $::locale->text('To Date')   ],
 837     [ $filter->{"amount:number"},           $::locale->text('Amount')                                          ],
 838     [ $filter->{"bank_account_id:integer"}, $::locale->text('Local bank account')                              ],
 839   );
 840
 841   for (@filters) {
 842     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 843   }
 844
 845   $self->{filter_summary} = join ', ', @filter_strings;
 846 }
 847
 848 sub prepare_report {
 849   my ($self)      = @_;
 850
 851   my $callback    = $self->models->get_callback;
 852
 853   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 854   $self->{report} = $report;
 855
 856   my @columns     = qw(ids local_bank_name transdate valudate remote_name remote_account_number remote_bank_code amount invoice_amount invoices currency purpose local_account_number local_bank_code id);
 857   my @sortable    = qw(local_bank_name transdate valudate remote_name remote_account_number remote_bank_code amount                                  purpose local_account_number local_bank_code);
 858
 859   my %column_defs = (
 860     ids                 => { raw_header_data => checkbox_tag("", id => "check_all", checkall  => "[data-checkall=1]"),
 861                              'align'         => 'center',
 862                              raw_data        => sub { if (@{ $_[0]->linked_invoices }) {
 863                                                         if ($_[0]->closed_period) {
 864                                                           html_tag('text', "X"); #, tooltip => t8('Bank Transaction is in a closed period.')),
 865                                                         } else {
 866                                                           checkbox_tag("ids[]", value => $_[0]->id, "data-checkall" => 1);
 867                                                         }
 868                                                 } } },
 869     transdate             => { sub   => sub { $_[0]->transdate_as_date } },
 870     valutadate            => { sub   => sub { $_[0]->valutadate_as_date } },
 871     remote_name           => { },
 872     remote_account_number => { },
 873     remote_bank_code      => { },
 874     amount                => { sub   => sub { $_[0]->amount_as_number },
 875                                align => 'right' },
 876     invoice_amount        => { sub   => sub { $_[0]->invoice_amount_as_number },
 877                                align => 'right' },
 878     invoices              => { sub   => sub { my @invnumbers; for my $obj (@{ $_[0]->linked_invoices }) {
 879                                                                 next unless $obj; push @invnumbers, $obj->invnumber } return \@invnumbers } },
 880     currency              => { sub   => sub { $_[0]->currency->name } },
 881     purpose               => { },
 882     local_account_number  => { sub   => sub { $_[0]->local_bank_account->account_number } },
 883     local_bank_code       => { sub   => sub { $_[0]->local_bank_account->bank_code } },
 884     local_bank_name       => { sub   => sub { $_[0]->local_bank_account->name } },
 885     id                    => {},
 886   );
 887
 888   map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 889
 890   $report->set_options(
 891     std_column_visibility => 1,
 892     controller_class      => 'BankTransaction',
 893     output_format         => 'HTML',
 894     top_info_text         => $::locale->text('Bank transactions'),
 895     title                 => $::locale->text('Bank transactions'),
 896     allow_pdf_export      => 1,
 897     allow_csv_export      => 1,
 898   );
 899   $report->set_columns(%column_defs);
 900   $report->set_column_order(@columns);
 901   $report->set_export_options(qw(list_all filter));
 902   $report->set_options_from_form;
 903   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 904   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 905
 906   my $bank_accounts = SL::DB::Manager::BankAccount->get_all_sorted();
 907
 908   $report->set_options(
 909     raw_top_info_text     => $self->render('bank_transactions/report_top',    { output => 0 }, BANK_ACCOUNTS => $bank_accounts),
 910     raw_bottom_info_text  => $self->render('bank_transactions/report_bottom', { output => 0 }),
 911   );
 912 }
 913
 914 sub init_problems { [] }
 915
 916 sub init_models {
 917   my ($self) = @_;
 918
 919   SL::Controller::Helper::GetModels->new(
 920     controller => $self,
 921     sorted     => {
 922       _default => {
 923         by  => 'transdate',
 924         dir => 0,   # 1 = ASC, 0 = DESC : default sort is newest at top
 925       },
 926       id                    => t8('ID'),
 927       transdate             => t8('Transdate'),
 928       remote_name           => t8('Remote name'),
 929       amount                => t8('Amount'),
 930       invoice_amount        => t8('Assigned'),
 931       invoices              => t8('Linked invoices'),
 932       valutadate            => t8('Valutadate'),
 933       remote_account_number => t8('Remote account number'),
 934       remote_bank_code      => t8('Remote bank code'),
 935       currency              => t8('Currency'),
 936       purpose               => t8('Purpose'),
 937       local_account_number  => t8('Local account number'),
 938       local_bank_code       => t8('Local bank code'),
 939       local_bank_name       => t8('Bank account'),
 940     },
 941     with_objects => [ 'local_bank_account', 'currency' ],
 942   );
 943 }
 944
 945 sub load_ap_record_template_url {
 946   my ($self, $template) = @_;
 947
 948   return $self->url_for(
 949     controller                           => 'ap.pl',
 950     action                               => 'load_record_template',
 951     id                                   => $template->id,
 952     'form_defaults.amount_1'             => $::form->format_amount(\%::myconfig, -1 * $self->transaction->amount, 2),
 953     'form_defaults.transdate'            => $self->transaction->transdate_as_date,
 954     'form_defaults.duedate'              => $self->transaction->transdate_as_date,
 955     'form_defaults.no_payment_bookings'  => 1,
 956     'form_defaults.paid_1_suggestion'    => $::form->format_amount(\%::myconfig, -1 * $self->transaction->amount, 2),
 957     'form_defaults.AP_paid_1_suggestion' => $self->transaction->local_bank_account->chart->accno,
 958     'form_defaults.callback'             => $self->callback,
 959   );
 960 }
 961
 962 sub load_gl_record_template_url {
 963   my ($self, $template) = @_;
 964
 965   return $self->url_for(
 966     controller                           => 'gl.pl',
 967     action                               => 'load_record_template',
 968     id                                   => $template->id,
 969     'form_defaults.amount_1'             => abs($self->transaction->not_assigned_amount), # always positive
 970     'form_defaults.transdate'            => $self->transaction->transdate_as_date,
 971     'form_defaults.callback'             => $self->callback,
 972     'form_defaults.bt_id'                => $self->transaction->id,
 973     'form_defaults.bt_chart_id'          => $self->transaction->local_bank_account->chart->id,
 974   );
 975 }
 976
 977 sub setup_search_action_bar {
 978   my ($self, %params) = @_;
 979
 980   for my $bar ($::request->layout->get('actionbar')) {
 981     $bar->add(
 982       action => [
 983         t8('Filter'),
 984         submit    => [ '#search_form', { action => 'BankTransaction/list' } ],
 985         accesskey => 'enter',
 986       ],
 987     );
 988   }
 989 }
 990
 991 sub setup_list_all_action_bar {
 992   my ($self, %params) = @_;
 993
 994   for my $bar ($::request->layout->get('actionbar')) {
 995     $bar->add(
 996       combobox => [
 997         action => [ t8('Actions') ],
 998         action => [
 999           t8('Unlink bank transactions'),
1000             submit => [ '#form', { action => 'BankTransaction/unlink_bank_transaction' } ],
1001             checks => [ [ 'kivi.check_if_entries_selected', '[name="ids[]"]' ] ],
1002             disabled  => $::instance_conf->get_payments_changeable ? t8('Cannot safely unlink bank transactions, please set the posting configuration for payments to unchangeable.') : undef,
1003           ],
1004         ],
1005         action => [
1006           t8('Filter'),
1007           submit    => [ '#filter_form', { action => 'BankTransaction/list_all' } ],
1008         accesskey => 'enter',
1009       ],
1010     );
1011   }
1012 }
1013
1014 1;
1015 __END__
1016
1017 =pod
1018
1019 =encoding utf8
1020
1021 =head1 NAME
1022
1023 SL::Controller::BankTransaction - Posting payments to invoices from
1024 bank transactions imported earlier
1025
1026 =head1 FUNCTIONS
1027
1028 =over 4
1029
1030 =item C<save_single_bank_transaction %params>
1031
1032 Takes a bank transaction ID (as parameter C<bank_transaction_id> and
1033 tries to post its amount to a certain number of invoices (parameter
1034 C<invoice_ids>, an array ref of database IDs to purchase or sales
1035 invoice objects).
1036
1037 This method handles already partly assigned bank transactions.
1038
1039 This method cannot handle already partly assigned bank transactions, i.e.
1040 a bank transaction that has a invoice_amount <> 0 but not the fully
1041 transaction amount (invoice_amount == amount).
1042
1043 If the amount of the bank transaction is higher than the sum of
1044 the assigned invoices (1 .. n) the bank transaction will only be
1045 partly assigned.
1046
1047 The whole function is wrapped in a database transaction. If an
1048 exception occurs the bank transaction is not posted at all. The same
1049 is true if the code detects an error during the execution, e.g. a bank
1050 transaction that's already been posted earlier. In both cases the
1051 database transaction will be rolled back.
1052
1053 If warnings but not errors occur the database transaction is still
1054 committed.
1055
1056 The return value is an error object or C<undef> if the function
1057 succeeded. The calling function will collect all warnings and errors
1058 and display them in a nicely formatted table if any occurred.
1059
1060 An error object is a hash reference containing the following members:
1061
1062 =over 2
1063
1064 =item * C<result> — can be either C<warning> or C<error>. Warnings are
1065 displayed slightly different than errors.
1066
1067 =item * C<message> — a human-readable message included in the list of
1068 errors meant as the description of why the problem happened
1069
1070 =item * C<bank_transaction_id>, C<invoice_ids> — the same parameters
1071 that the function was called with
1072
1073 =item * C<bank_transaction> — the database object
1074 (C<SL::DB::BankTransaction>) corresponding to C<bank_transaction_id>
1075
1076 =item * C<invoices> — an array ref of the database objects (either
1077 C<SL::DB::Invoice> or C<SL::DB::PurchaseInvoice>) corresponding to
1078 C<invoice_ids>
1079
1080 =back
1081
1082 =item C<action_unlink_bank_transaction>
1083
1084 Takes one or more bank transaction ID (as parameter C<form::ids>) and
1085 tries to revert all payment bookings including already cleared bookings.
1086
1087 This method won't undo payments that are in a closed period and assumes
1088 that payments are not manually changed, i.e. only imported payments.
1089
1090 GL-records will be deleted completely if a bank transaction was the source.
1091
1092 TODO: we still rely on linked_records for the check boxes
1093
1094 =back
1095
1096 =head1 AUTHOR
1097
1098 Niclas Zimmermann E<lt>niclas@kivitendo-premium.deE<gt>,
1099 Geoffrey Richardson E<lt>information@richardson-bueren.deE<gt>
1100
1101 =cut