1 package SL::Controller::BankTransaction;
3 # idee- möglichkeit bankdaten zu übernehmen in stammdaten
4 # erst Kontenabgleich, um alle gl-Einträge wegzuhaben
7 use parent qw(SL::Controller::Base);
9 use SL::Controller::Helper::GetModels;
10 use SL::Controller::Helper::ReportGenerator;
11 use SL::ReportGenerator;
13 use SL::DB::BankTransaction;
14 use SL::Helper::Flash;
15 use SL::Locale::String;
18 use SL::DB::PurchaseInvoice;
19 use SL::DB::RecordLink;
22 use SL::DB::AccTransaction;
25 use SL::DB::BankAccount;
26 use SL::DBUtils qw(like);
28 use List::Util qw(max);
30 use Rose::Object::MakeMethods::Generic
32 'scalar --get_set_init' => [ qw(models) ],
35 __PACKAGE__->run_before('check_auth');
45 my $bank_accounts = SL::DB::Manager::BankAccount->get_all_sorted( query => [ obsolete => 0 ] );
47 $self->render('bank_transactions/search',
48 BANK_ACCOUNTS => $bank_accounts);
54 $self->make_filter_summary;
55 $self->prepare_report;
57 $self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
63 if (!$::form->{filter}{bank_account}) {
64 flash('error', t8('No bank account chosen!'));
69 my $sort_by = $::form->{sort_by} || 'transdate';
70 $sort_by = 'transdate' if $sort_by eq 'proposal';
71 $sort_by .= $::form->{sort_dir} ? ' DESC' : ' ASC';
73 my $fromdate = $::locale->parse_date_to_object($::form->{filter}->{fromdate});
74 my $todate = $::locale->parse_date_to_object($::form->{filter}->{todate});
75 $todate->add( days => 1 ) if $todate;
78 push @where, (transdate => { ge => $fromdate }) if ($fromdate);
79 push @where, (transdate => { lt => $todate }) if ($todate);
80 my $bank_account = SL::DB::Manager::BankAccount->find_by( id => $::form->{filter}{bank_account} );
81 # bank_transactions no younger than starting date,
82 # including starting date (same search behaviour as fromdate)
83 # but OPEN invoices to be matched may be from before
84 if ( $bank_account->reconciliation_starting_date ) {
85 push @where, (transdate => { ge => $bank_account->reconciliation_starting_date });
88 my $bank_transactions = SL::DB::Manager::BankTransaction->get_all(where => [ amount => {ne => \'invoice_amount'},
89 local_bank_account_id => $::form->{filter}{bank_account},
91 with_objects => [ 'local_bank_account', 'currency' ],
92 sort_by => $sort_by, limit => 10000);
94 my $all_open_ar_invoices = SL::DB::Manager::Invoice->get_all(where => [amount => { gt => \'paid' }], with_objects => 'customer');
95 my $all_open_ap_invoices = SL::DB::Manager::PurchaseInvoice->get_all(where => [amount => { gt => \'paid' }], with_objects => 'vendor');
97 my @all_open_invoices;
98 # filter out invoices with less than 1 cent outstanding
99 push @all_open_invoices, grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ar_invoices };
100 push @all_open_invoices, grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ap_invoices };
102 # try to match each bank_transaction with each of the possible open invoices
105 foreach my $bt (@{ $bank_transactions }) {
106 next unless $bt->{remote_name}; # bank has no name, usually fees, use create invoice to assign
108 $bt->{remote_name} .= $bt->{remote_name_1} if $bt->{remote_name_1};
110 # try to match the current $bt to each of the open_invoices, saving the
111 # results of get_agreement_with_invoice in $open_invoice->{agreement} and
112 # $open_invoice->{rule_matches}.
114 # The values are overwritten each time a new bt is checked, so at the end
115 # of each bt the likely results are filtered and those values are stored in
116 # the arrays $bt->{proposals} and $bt->{rule_matches}, and the agreement
117 # score is stored in $bt->{agreement}
119 foreach my $open_invoice (@all_open_invoices){
120 ($open_invoice->{agreement}, $open_invoice->{rule_matches}) = $bt->get_agreement_with_invoice($open_invoice);
123 $bt->{proposals} = [];
126 my $min_agreement = 3; # suggestions must have at least this score
128 my $max_agreement = max map { $_->{agreement} } @all_open_invoices;
130 # add open_invoices with highest agreement into array $bt->{proposals}
131 if ( $max_agreement >= $min_agreement ) {
132 $bt->{proposals} = [ grep { $_->{agreement} == $max_agreement } @all_open_invoices ];
133 $bt->{agreement} = $max_agreement; #scalar @{ $bt->{proposals} } ? $agreement + 1 : '';
135 # store the rule_matches in a separate array, so they can be displayed in template
136 foreach ( @{ $bt->{proposals} } ) {
137 push(@{$bt->{rule_matches}}, $_->{rule_matches});
143 # separate filter for proposals (second tab, agreement >= 5 and exactly one match)
144 # to qualify as a proposal there has to be
145 # * agreement >= 5 TODO: make threshold configurable in configuration
146 # * there must be only one exact match
147 # * depending on whether sales or purchase the amount has to have the correct sign (so Gutschriften don't work?)
148 my $proposal_threshold = 5;
149 my @proposals = grep { $_->{agreement} >= $proposal_threshold
150 and 1 == scalar @{ $_->{proposals} }
151 and (@{ $_->{proposals} }[0]->is_sales ? abs(@{ $_->{proposals} }[0]->amount - $_->amount) < 0.01 : abs(@{ $_->{proposals} }[0]->amount + $_->amount) < 0.01) } @{ $bank_transactions };
153 # sort bank transaction proposals by quality (score) of proposal
154 $bank_transactions = [ sort { $a->{agreement} <=> $b->{agreement} } @{ $bank_transactions } ] if $::form->{sort_by} eq 'proposal' and $::form->{sort_dir} == 1;
155 $bank_transactions = [ sort { $b->{agreement} <=> $a->{agreement} } @{ $bank_transactions } ] if $::form->{sort_by} eq 'proposal' and $::form->{sort_dir} == 0;
158 $self->render('bank_transactions/list',
159 title => t8('Bank transactions MT940'),
160 BANK_TRANSACTIONS => $bank_transactions,
161 PROPOSALS => \@proposals,
162 bank_account => $bank_account );
165 sub action_assign_invoice {
168 $self->{transaction} = SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id});
170 $self->render('bank_transactions/assign_invoice', { layout => 0 },
171 title => t8('Assign invoice'),);
174 sub action_create_invoice {
176 my %myconfig = %main::myconfig;
178 $self->{transaction} = SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id});
179 my $vendor_of_transaction = SL::DB::Manager::Vendor->find_by(account_number => $self->{transaction}->{remote_account_number});
181 my $drafts = SL::DB::Manager::Draft->get_all(where => [ module => 'ap'] , with_objects => 'employee');
185 foreach my $draft ( @{ $drafts } ) {
186 my $draft_as_object = YAML::Load($draft->form);
187 my $vendor = SL::DB::Manager::Vendor->find_by(id => $draft_as_object->{vendor_id});
188 $draft->{vendor} = $vendor->name;
189 $draft->{vendor_id} = $vendor->id;
190 push @filtered_drafts, $draft;
194 @filtered_drafts = grep { $_->{vendor_id} == $vendor_of_transaction->id } @filtered_drafts if $vendor_of_transaction;
196 my $all_vendors = SL::DB::Manager::Vendor->get_all();
198 $self->render('bank_transactions/create_invoice', { layout => 0 },
199 title => t8('Create invoice'),
200 DRAFTS => \@filtered_drafts,
201 vendor_id => $vendor_of_transaction ? $vendor_of_transaction->id : undef,
202 vendor_name => $vendor_of_transaction ? $vendor_of_transaction->name : undef,
203 ALL_VENDORS => $all_vendors,
204 limit => $myconfig{vclimit},
205 callback => $self->url_for(action => 'list',
206 'filter.bank_account' => $::form->{filter}->{bank_account},
207 'filter.todate' => $::form->{filter}->{todate},
208 'filter.fromdate' => $::form->{filter}->{fromdate}),
212 sub action_ajax_payment_suggestion {
215 # based on a BankTransaction ID and a Invoice or PurchaseInvoice ID passed via $::form,
216 # create an HTML blob to be used by the js function add_invoices in templates/webpages/bank_transactions/list.html
217 # and return encoded as JSON
219 my $bt = SL::DB::Manager::BankTransaction->find_by( id => $::form->{bt_id} );
220 my $invoice = SL::DB::Manager::Invoice->find_by( id => $::form->{prop_id} );
221 $invoice = SL::DB::Manager::PurchaseInvoice->find_by( id => $::form->{prop_id} ) unless $invoice;
223 die unless $bt and $invoice;
225 my @select_options = $invoice->get_payment_select_options_for_bank_transaction($::form->{bt_id});
228 $html .= SL::Presenter->input_tag('invoice_ids.' . $::form->{bt_id} . '[]', $::form->{prop_id} , type => 'hidden');
229 $html .= SL::Presenter->escape( $invoice->invnumber );
230 $html .= SL::Presenter->select_tag('invoice_skontos.' . $::form->{bt_id} . '[]', \@select_options,
231 value_key => 'payment_type',
232 title_key => 'display' ) if @select_options;
233 $html .= '<a href=# onclick="delete_invoice(' . $::form->{bt_id} . ',' . $::form->{prop_id} . ');">x</a>';
234 $html = SL::Presenter->html_tag('div', $html, id => $::form->{bt_id} . '.' . $::form->{prop_id});
236 $self->render(\ SL::JSON::to_json( { 'html' => $html } ), { layout => 0, type => 'json', process => 0 });
239 sub action_filter_drafts {
242 $self->{transaction} = SL::DB::Manager::BankTransaction->find_by(id => $::form->{bt_id});
243 my $vendor_of_transaction = SL::DB::Manager::Vendor->find_by(account_number => $self->{transaction}->{remote_account_number});
245 my $drafts = SL::DB::Manager::Draft->get_all(with_objects => 'employee');
249 foreach my $draft ( @{ $drafts } ) {
250 my $draft_as_object = YAML::Load($draft->form);
251 my $vendor = SL::DB::Manager::Vendor->find_by(id => $draft_as_object->{vendor_id});
252 $draft->{vendor} = $vendor->name;
253 $draft->{vendor_id} = $vendor->id;
254 push @filtered_drafts, $draft;
257 my $vendor_name = $::form->{vendor};
258 my $vendor_id = $::form->{vendor_id};
261 @filtered_drafts = grep { $_->{vendor_id} == $vendor_id } @filtered_drafts if $vendor_id;
262 @filtered_drafts = grep { $_->{vendor} =~ /$vendor_name/i } @filtered_drafts if $vendor_name;
264 my $output = $self->render(
265 'bank_transactions/filter_drafts',
267 DRAFTS => \@filtered_drafts,
270 my %result = ( count => 0, html => $output );
272 $self->render(\to_json(\%result), { type => 'json', process => 0 });
275 sub action_ajax_add_list {
278 my @where_sale = (amount => { ne => \'paid' });
279 my @where_purchase = (amount => { ne => \'paid' });
281 if ($::form->{invnumber}) {
282 push @where_sale, (invnumber => { ilike => like($::form->{invnumber})});
283 push @where_purchase, (invnumber => { ilike => like($::form->{invnumber})});
286 if ($::form->{amount}) {
287 push @where_sale, (amount => $::form->parse_amount(\%::myconfig, $::form->{amount}));
288 push @where_purchase, (amount => $::form->parse_amount(\%::myconfig, $::form->{amount}));
291 if ($::form->{vcnumber}) {
292 push @where_sale, ('customer.customernumber' => { ilike => like($::form->{vcnumber})});
293 push @where_purchase, ('vendor.vendornumber' => { ilike => like($::form->{vcnumber})});
296 if ($::form->{vcname}) {
297 push @where_sale, ('customer.name' => { ilike => like($::form->{vcname})});
298 push @where_purchase, ('vendor.name' => { ilike => like($::form->{vcname})});
301 if ($::form->{transdatefrom}) {
302 my $fromdate = $::locale->parse_date_to_object($::form->{transdatefrom});
303 if ( ref($fromdate) eq 'DateTime' ) {
304 push @where_sale, ('transdate' => { ge => $fromdate});
305 push @where_purchase, ('transdate' => { ge => $fromdate});
309 if ($::form->{transdateto}) {
310 my $todate = $::locale->parse_date_to_object($::form->{transdateto});
311 if ( ref($todate) eq 'DateTime' ) {
312 $todate->add(days => 1);
313 push @where_sale, ('transdate' => { lt => $todate});
314 push @where_purchase, ('transdate' => { lt => $todate});
318 my $all_open_ar_invoices = SL::DB::Manager::Invoice->get_all(where => \@where_sale, with_objects => 'customer');
319 my $all_open_ap_invoices = SL::DB::Manager::PurchaseInvoice->get_all(where => \@where_purchase, with_objects => 'vendor');
321 my @all_open_invoices = @{ $all_open_ar_invoices };
322 # add ap invoices, filtering out subcent open amounts
323 push @all_open_invoices, grep { abs($_->amount - $_->paid) >= 0.01 } @{ $all_open_ap_invoices };
325 @all_open_invoices = sort { $a->id <=> $b->id } @all_open_invoices;
327 my $output = $self->render(
328 'bank_transactions/add_list',
330 INVOICES => \@all_open_invoices,
333 my %result = ( count => 0, html => $output );
335 $self->render(\to_json(\%result), { type => 'json', process => 0 });
338 sub action_ajax_accept_invoices {
341 my @selected_invoices;
342 foreach my $invoice_id (@{ $::form->{invoice_id} || [] }) {
343 my $invoice_object = SL::DB::Manager::Invoice->find_by(id => $invoice_id);
344 $invoice_object ||= SL::DB::Manager::PurchaseInvoice->find_by(id => $invoice_id);
346 push @selected_invoices, $invoice_object;
349 $self->render('bank_transactions/invoices', { layout => 0 },
350 INVOICES => \@selected_invoices,
351 bt_id => $::form->{bt_id} );
354 sub action_save_invoices {
357 my $invoice_hash = delete $::form->{invoice_ids}; # each key (the bt line with a bt_id) contains an array of invoice_ids
358 my $skonto_hash = delete $::form->{invoice_skontos} || {}; # array containing the payment type, could be empty
360 # a bank_transaction may be assigned to several invoices, i.e. a customer
361 # might pay several open invoices with one transaction
363 while ( my ($bt_id, $invoice_ids) = each(%$invoice_hash) ) {
364 my $bank_transaction = SL::DB::Manager::BankTransaction->find_by(id => $bt_id);
365 my $sign = $bank_transaction->amount < 0 ? -1 : 1;
366 my $amount_of_transaction = $sign * $bank_transaction->amount;
369 foreach my $invoice_id (@{ $invoice_ids }) {
370 push @invoices, (SL::DB::Manager::Invoice->find_by(id => $invoice_id) || SL::DB::Manager::PurchaseInvoice->find_by(id => $invoice_id));
372 @invoices = sort { return 1 if ($a->is_sales and $a->amount > 0);
373 return 1 if (!$a->is_sales and $a->amount < 0);
374 return -1; } @invoices if $bank_transaction->amount > 0;
375 @invoices = sort { return -1 if ($a->is_sales and $a->amount > 0);
376 return -1 if (!$a->is_sales and $a->amount < 0);
377 return 1; } @invoices if $bank_transaction->amount < 0;
379 foreach my $invoice (@invoices) {
381 # Check if bank_transaction already has a link to the invoice, may only be linked once per invoice
382 # This might be caused by the user reloading a page and resending the form
383 die t8("Bank transaction with id #1 has already been linked to #2.", $bank_transaction->id, $invoice->displayable_name)
384 if _existing_record_link($bank_transaction, $invoice);
387 if ( defined $skonto_hash->{"$bt_id"} ) {
388 $payment_type = shift(@{ $skonto_hash->{"$bt_id"} });
390 $payment_type = 'without_skonto';
392 if ($amount_of_transaction == 0) {
393 flash('warning', $::locale->text('There are invoices which could not be paid by bank transaction #1 (Account number: #2, bank code: #3)!',
394 $bank_transaction->purpose,
395 $bank_transaction->remote_account_number,
396 $bank_transaction->remote_bank_code));
399 # pay invoice or go to the next bank transaction if the amount is not sufficiently high
400 if ($invoice->amount <= $amount_of_transaction) {
401 $invoice->pay_invoice(chart_id => $bank_transaction->local_bank_account->chart_id,
402 trans_id => $invoice->id,
403 amount => $invoice->amount,
404 payment_type => $payment_type,
405 transdate => $bank_transaction->transdate->to_kivitendo);
406 if ($invoice->is_sales) {
407 $amount_of_transaction -= $sign * $invoice->amount;
408 $bank_transaction->invoice_amount($bank_transaction->invoice_amount + $invoice->amount);
410 $amount_of_transaction += $sign * $invoice->amount if (!$invoice->is_sales);
411 $bank_transaction->invoice_amount($bank_transaction->invoice_amount - $invoice->amount);
414 $invoice->pay_invoice(chart_id => $bank_transaction->local_bank_account->chart_id,
415 trans_id => $invoice->id,
416 amount => $amount_of_transaction,
417 payment_type => $payment_type,
418 transdate => $bank_transaction->transdate->to_kivitendo);
419 $bank_transaction->invoice_amount($bank_transaction->amount) if $invoice->is_sales;
420 $bank_transaction->invoice_amount($bank_transaction->amount) if !$invoice->is_sales;
421 $amount_of_transaction = 0;
424 # Record a record link from the bank transaction to the invoice
426 from_table => 'bank_transactions',
428 to_table => $invoice->is_sales ? 'ar' : 'ap',
429 to_id => $invoice->id,
432 SL::DB::RecordLink->new(@props)->save;
434 $bank_transaction->save;
437 $self->action_list();
440 sub action_save_proposals {
443 foreach my $bt_id (@{ $::form->{proposal_ids} }) {
444 my $bt = SL::DB::Manager::BankTransaction->find_by(id => $bt_id);
446 my $arap = SL::DB::Manager::Invoice->find_by(id => $::form->{"proposed_invoice_$bt_id"});
447 $arap = SL::DB::Manager::PurchaseInvoice->find_by(id => $::form->{"proposed_invoice_$bt_id"}) if not defined $arap;
449 # check for existing record_link for that $bt and $arap
450 # do this before any changes to $bt are made
451 die t8("Bank transaction with id #1 has already been linked to #2.", $bt->id, $arap->displayable_name)
452 if _existing_record_link($bt, $arap);
455 $bt->invoice_amount($bt->amount);
459 $arap->pay_invoice(chart_id => $bt->local_bank_account->chart_id,
460 trans_id => $arap->id,
461 amount => $arap->amount,
462 transdate => $bt->transdate->to_kivitendo);
467 from_table => 'bank_transactions',
469 to_table => $arap->is_sales ? 'ar' : 'ap',
473 SL::DB::RecordLink->new(@props)->save;
476 flash('ok', t8('#1 proposal(s) saved.', scalar @{ $::form->{proposal_ids} }));
478 $self->action_list();
486 $::auth->assert('bank_transaction');
493 sub make_filter_summary {
496 my $filter = $::form->{filter} || {};
500 [ $filter->{"transdate:date::ge"}, $::locale->text('Transdate') . " " . $::locale->text('From Date') ],
501 [ $filter->{"transdate:date::le"}, $::locale->text('Transdate') . " " . $::locale->text('To Date') ],
502 [ $filter->{"valutadate:date::ge"}, $::locale->text('Valutadate') . " " . $::locale->text('From Date') ],
503 [ $filter->{"valutadate:date::le"}, $::locale->text('Valutadate') . " " . $::locale->text('To Date') ],
504 [ $filter->{"amount:number"}, $::locale->text('Amount') ],
505 [ $filter->{"bank_account_id:integer"}, $::locale->text('Local bank account') ],
509 push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
512 $self->{filter_summary} = join ', ', @filter_strings;
518 my $callback = $self->models->get_callback;
520 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
521 $self->{report} = $report;
523 my @columns = qw(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);
524 my @sortable = qw(local_bank_name transdate valudate remote_name remote_account_number remote_bank_code amount purpose local_account_number local_bank_code);
527 transdate => { sub => sub { $_[0]->transdate_as_date } },
528 valutadate => { sub => sub { $_[0]->valutadate_as_date } },
530 remote_account_number => { },
531 remote_bank_code => { },
532 amount => { sub => sub { $_[0]->amount_as_number },
534 invoice_amount => { sub => sub { $_[0]->invoice_amount_as_number },
536 invoices => { sub => sub { $_[0]->linked_invoices } },
537 currency => { sub => sub { $_[0]->currency->name } },
539 local_account_number => { sub => sub { $_[0]->local_bank_account->account_number } },
540 local_bank_code => { sub => sub { $_[0]->local_bank_account->bank_code } },
541 local_bank_name => { sub => sub { $_[0]->local_bank_account->name } },
545 map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
547 $report->set_options(
548 std_column_visibility => 1,
549 controller_class => 'BankTransaction',
550 output_format => 'HTML',
551 top_info_text => $::locale->text('Bank transactions'),
552 title => $::locale->text('Bank transactions'),
553 allow_pdf_export => 1,
554 allow_csv_export => 1,
556 $report->set_columns(%column_defs);
557 $report->set_column_order(@columns);
558 $report->set_export_options(qw(list_all filter));
559 $report->set_options_from_form;
560 $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
561 $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
563 my $bank_accounts = SL::DB::Manager::BankAccount->get_all_sorted();
565 $report->set_options(
566 raw_top_info_text => $self->render('bank_transactions/report_top', { output => 0 }, BANK_ACCOUNTS => $bank_accounts),
567 raw_bottom_info_text => $self->render('bank_transactions/report_bottom', { output => 0 }),
571 sub _existing_record_link {
572 my ($bt, $invoice) = @_;
574 # check whether a record link from banktransaction $bt already exists to
575 # invoice $invoice, returns 1 if that is the case
577 die unless $bt->isa("SL::DB::BankTransaction") && ( $invoice->isa("SL::DB::Invoice") || $invoice->isa("SL::DB::PurchaseInvoice") );
579 my $linked_record_to_table = $invoice->is_sales ? 'Invoice' : 'PurchaseInvoice';
580 my $linked_records = $bt->linked_records( direction => 'to', to => $linked_record_to_table, query => [ id => $invoice->id ] );
582 return @$linked_records ? 1 : 0;
589 SL::Controller::Helper::GetModels->new(
594 dir => 0, # 1 = ASC, 0 = DESC : default sort is newest at top
596 transdate => t8('Transdate'),
597 remote_name => t8('Remote name'),
598 amount => t8('Amount'),
599 invoice_amount => t8('Assigned'),
600 invoices => t8('Linked invoices'),
601 valutadate => t8('Valutadate'),
602 remote_account_number => t8('Remote account number'),
603 remote_bank_code => t8('Remote bank code'),
604 currency => t8('Currency'),
605 purpose => t8('Purpose'),
606 local_account_number => t8('Local account number'),
607 local_bank_code => t8('Local bank code'),
608 local_bank_name => t8('Bank account'),
610 with_objects => [ 'local_bank_account', 'currency' ],