SL/DB/BankTransaction.pm

   1 # This file has been auto-generated only because it didn't exist.
   2 # Feel free to modify it at will; it will not be overwritten automatically.
   3
   4 package SL::DB::BankTransaction;
   5
   6 use strict;
   7
   8 use SL::DB::MetaSetup::BankTransaction;
   9 use SL::DB::Manager::BankTransaction;
  10 use SL::DB::Helper::LinkedRecords;
  11 use Carp;
  12
  13 require SL::DB::Invoice;
  14 require SL::DB::PurchaseInvoice;
  15
  16 __PACKAGE__->meta->initialize;
  17
  18
  19 # Creates get_all, get_all_count, get_all_iterator, delete_all and update_all.
  20 #__PACKAGE__->meta->make_manager_class;
  21
  22 sub compare_to {
  23   my ($self, $other) = @_;
  24
  25   return  1 if  $self->transdate && !$other->transdate;
  26   return -1 if !$self->transdate &&  $other->transdate;
  27
  28   my $result = 0;
  29   $result    = $self->transdate <=> $other->transdate if $self->transdate;
  30   return $result || ($self->id <=> $other->id);
  31 }
  32
  33 sub linked_invoices {
  34   my ($self) = @_;
  35
  36   #my $record_links = $self->linked_records(direction => 'both');
  37
  38   my @linked_invoices;
  39
  40   my $record_links = SL::DB::Manager::RecordLink->get_all(where => [ from_table => 'bank_transactions', from_id => $self->id ]);
  41
  42   foreach my $record_link (@{ $record_links }) {
  43     push @linked_invoices, SL::DB::Manager::Invoice->find_by(id => $record_link->to_id)->invnumber         if $record_link->to_table eq 'ar';
  44     push @linked_invoices, SL::DB::Manager::PurchaseInvoice->find_by(id => $record_link->to_id)->invnumber if $record_link->to_table eq 'ap';
  45   }
  46
  47   return [ @linked_invoices ];
  48 }
  49
  50 sub is_batch_transaction {
  51   ($_[0]->transaction_code // '') eq "191";
  52 }
  53
  54
  55 sub get_agreement_with_invoice {
  56   my ($self, $invoice, %params) = @_;
  57
  58   carp "get_agreement_with_invoice needs an invoice object as its first argument"
  59     unless ref($invoice) eq 'SL::DB::Invoice' or ref($invoice) eq 'SL::DB::PurchaseInvoice';
  60
  61   my %points = (
  62     cust_vend_name_in_purpose   => 1,
  63     cust_vend_number_in_purpose => 1,
  64     datebonus0                  => 3,
  65     datebonus14                 => 2,
  66     datebonus35                 => 1,
  67     datebonus120                => 0,
  68     datebonus_negative          => -1,
  69     depositor_matches           => 2,
  70     exact_amount                => 4,
  71     exact_open_amount           => 4,
  72     invoice_in_purpose          => 2,
  73     own_invoice_in_purpose      => 5,
  74     invnumber_in_purpose        => 1,
  75     own_invnumber_in_purpose    => 4,
  76     # overpayment                 => -1, # either other invoice is more likely, or several invoices paid at once
  77     payment_before_invoice      => -2,
  78     payment_within_30_days      => 1,
  79     remote_account_number       => 3,
  80     skonto_exact_amount         => 5,
  81     wrong_sign                  => -1,
  82     sepa_export_item            => 5,
  83     batch_sepa_transaction      => 20,
  84   );
  85
  86   my ($agreement,$rule_matches);
  87
  88   if ( $self->is_batch_transaction && $self->{sepa_export_ok}) {
  89     $agreement += $points{batch_sepa_transaction};
  90     $rule_matches .= 'batch_sepa_transaction(' . $points{'batch_sepa_transaction'} . ') ';
  91   }
  92
  93   # compare banking arrangements
  94   my ($iban, $bank_code, $account_number);
  95   $bank_code      = $invoice->customer->bank_code      if $invoice->is_sales;
  96   $account_number = $invoice->customer->account_number if $invoice->is_sales;
  97   $iban           = $invoice->customer->iban           if $invoice->is_sales;
  98   $bank_code      = $invoice->vendor->bank_code        if ! $invoice->is_sales;
  99   $iban           = $invoice->vendor->iban             if ! $invoice->is_sales;
 100   $account_number = $invoice->vendor->account_number   if ! $invoice->is_sales;
 101   if ( $bank_code eq $self->remote_bank_code && $account_number eq $self->remote_account_number ) {
 102     $agreement += $points{remote_account_number};
 103     $rule_matches .= 'remote_account_number(' . $points{'remote_account_number'} . ') ';
 104   }
 105   if ( $iban eq $self->remote_account_number ) {
 106     $agreement += $points{remote_account_number};
 107     $rule_matches .= 'remote_account_number(' . $points{'remote_account_number'} . ') ';
 108   }
 109
 110   my $datediff = $self->transdate->{utc_rd_days} - $invoice->transdate->{utc_rd_days};
 111   $invoice->{datediff} = $datediff;
 112
 113   # compare amount
 114   if (abs(abs($invoice->amount) - abs($self->amount)) < 0.01) {
 115     $agreement += $points{exact_amount};
 116     $rule_matches .= 'exact_amount(' . $points{'exact_amount'} . ') ';
 117   }
 118
 119   # compare open amount, preventing double points when open amount = invoice amount
 120   if ( $invoice->amount != $invoice->open_amount && abs(abs($invoice->open_amount) - abs($self->amount)) < 0.01) {
 121     $agreement += $points{exact_open_amount};
 122     $rule_matches .= 'exact_open_amount(' . $points{'exact_open_amount'} . ') ';
 123   }
 124
 125   if ( $invoice->skonto_date && abs(abs($invoice->amount_less_skonto) - abs($self->amount)) < 0.01) {
 126     $agreement += $points{skonto_exact_amount};
 127     $rule_matches .= 'skonto_exact_amount(' . $points{'skonto_exact_amount'} . ') ';
 128     $invoice->{skonto_type} = 'with_skonto_pt';
 129   }
 130
 131   #search invoice number in purpose
 132   my $invnumber = $invoice->invnumber;
 133   # invnumber has to have at least 3 characters
 134   my $squashed_purpose = $self->purpose;
 135   $squashed_purpose =~ s/ //g;
 136   if (length($invnumber) > 4 && $squashed_purpose =~ /$invnumber/ && $invoice->is_sales){
 137     $agreement      += $points{own_invoice_in_purpose};
 138     $rule_matches   .= 'own_invoice_in_purpose(' . $points{'own_invoice_in_purpose'} . ') ';
 139   } elsif (length($invnumber) > 3 && $squashed_purpose =~ /$invnumber/ ) {
 140     $agreement      += $points{invoice_in_purpose};
 141     $rule_matches   .= 'invoice_in_purpose(' . $points{'invoice_in_purpose'} . ') ';
 142   } else {
 143     # only check number part of invoice number
 144     $invnumber      =~ s/[A-Za-z_]+//g;
 145     if (length($invnumber) > 4 && $squashed_purpose =~ /$invnumber/ && $invoice->is_sales){
 146       $agreement    += $points{own_invnumber_in_purpose};
 147       $rule_matches .= 'own_invnumber_in_purpose(' . $points{'own_invnumber_in_purpose'} . ') ';
 148     } elsif (length($invnumber) > 3 && $squashed_purpose =~ /$invnumber/ ) {
 149       $agreement    += $points{invnumber_in_purpose};
 150       $rule_matches .= 'invnumber_in_purpose(' . $points{'invnumber_in_purpose'} . ') ';
 151     }
 152   }
 153
 154   #check sign
 155   if ( $invoice->is_sales && $self->amount < 0 ) {
 156     $agreement += $points{wrong_sign};
 157     $rule_matches .= 'wrong_sign(' . $points{'wrong_sign'} . ') ';
 158   }
 159   if ( ! $invoice->is_sales && $self->amount > 0 ) {
 160     $agreement += $points{wrong_sign};
 161     $rule_matches .= 'wrong_sign(' . $points{'wrong_sign'} . ') ';
 162   }
 163
 164   # search customer/vendor number in purpose
 165   my $cvnumber;
 166   $cvnumber = $invoice->customer->customernumber if $invoice->is_sales;
 167   $cvnumber = $invoice->vendor->vendornumber     if ! $invoice->is_sales;
 168   if ( $cvnumber && $self->purpose =~ /\b$cvnumber\b/i ) {
 169     $agreement += $points{cust_vend_number_in_purpose};
 170     $rule_matches .= 'cust_vend_number_in_purpose(' . $points{'cust_vend_number_in_purpose'} . ') ';
 171   }
 172
 173   # search for customer/vendor name in purpose (may contain GMBH, CO KG, ...)
 174   my $cvname;
 175   $cvname = $invoice->customer->name if $invoice->is_sales;
 176   $cvname = $invoice->vendor->name   if ! $invoice->is_sales;
 177   if ( $cvname && $self->purpose =~ /\b\Q$cvname\E\b/i ) {
 178     $agreement += $points{cust_vend_name_in_purpose};
 179     $rule_matches .= 'cust_vend_name_in_purpose(' . $points{'cust_vend_name_in_purpose'} . ') ';
 180   }
 181
 182   # compare depositorname, don't try to match empty depositors
 183   my $depositorname;
 184   $depositorname = $invoice->customer->depositor if $invoice->is_sales;
 185   $depositorname = $invoice->vendor->depositor   if ! $invoice->is_sales;
 186   if ( $depositorname && $self->remote_name =~ /$depositorname/ ) {
 187     $agreement += $points{depositor_matches};
 188     $rule_matches .= 'depositor_matches(' . $points{'depositor_matches'} . ') ';
 189   }
 190
 191   #Check if words in remote_name appear in cvname
 192   my $check_string_points = _check_string($self->remote_name,$cvname);
 193   if ( $check_string_points ) {
 194     $agreement += $check_string_points;
 195     $rule_matches .= 'remote_name(' . $check_string_points . ') ';
 196   }
 197
 198   # transdate prefilter: compare transdate of bank_transaction with transdate of invoice
 199   if ( $datediff < -5 ) { # this might conflict with advance payments
 200     $agreement += $points{payment_before_invoice};
 201     $rule_matches .= 'payment_before_invoice(' . $points{'payment_before_invoice'} . ') ';
 202   }
 203   if ( $datediff < 30 ) {
 204     $agreement += $points{payment_within_30_days};
 205     $rule_matches .= 'payment_within_30_days(' . $points{'payment_within_30_days'} . ') ';
 206   }
 207
 208   # only if we already have a good agreement, let date further change value of agreement.
 209   # this is so that if there are several plausible open invoices which are all equal
 210   # (rent jan, rent feb...) the one with the best date match is chosen over
 211   # the others
 212
 213   # another way around this is to just pre-filter by periods instead of matching everything
 214   if ( $agreement > 5 ) {
 215     if ( $datediff == 0 ) {
 216       $agreement += $points{datebonus0};
 217       $rule_matches .= 'datebonus0(' . $points{'datebonus0'} . ') ';
 218     } elsif  ( $datediff > 0 and $datediff <= 14 ) {
 219       $agreement += $points{datebonus14};
 220       $rule_matches .= 'datebonus14(' . $points{'datebonus14'} . ') ';
 221     } elsif  ( $datediff >14 and $datediff < 35) {
 222       $agreement += $points{datebonus35};
 223       $rule_matches .= 'datebonus35(' . $points{'datebonus35'} . ') ';
 224     } elsif  ( $datediff >34 and $datediff < 120) {
 225       $agreement += $points{datebonus120};
 226       $rule_matches .= 'datebonus120(' . $points{'datebonus120'} . ') ';
 227     } elsif  ( $datediff < 0 ) {
 228       $agreement += $points{datebonus_negative};
 229       $rule_matches .= 'datebonus_negative(' . $points{'datebonus_negative'} . ') ';
 230     } else {
 231       # e.g. datediff > 120
 232     }
 233   }
 234
 235   # if there is exactly one non-executed sepa_export_item for the invoice
 236   my $seis = $params{sepa_export_items}
 237            ? [ grep { $invoice->id == ($invoice->is_sales ? $_->ar_id : $_->ap_id) } @{ $params{sepa_export_items} } ]
 238            : $invoice->find_sepa_export_items({ executed => 0 });
 239   if ($seis) {
 240     if (scalar @$seis == 1) {
 241       my $sei = $seis->[0];
 242
 243       # test for amount and id matching only, sepa transfer date and bank
 244       # transaction date needn't match
 245       if (abs($self->amount) == ($sei->amount) && $invoice->id == $sei->arap_id) {
 246         $agreement    += $points{sepa_export_item};
 247         $rule_matches .= 'sepa_export_item(' . $points{'sepa_export_item'} . ') ';
 248       }
 249     } else {
 250       # zero or more than one sepa_export_item, do nothing for this invoice
 251       # zero: do nothing, no sepa_export_item exists, no match
 252       # more than one: does this ever apply? Currently you can't create sepa
 253       # exports for invoices that already have a non-executed sepa_export
 254       # TODO: Catch the more than one case. User is allowed to split
 255       # payments for one invoice item in one sepa export.
 256     }
 257   }
 258
 259   return ($agreement,$rule_matches);
 260 };
 261
 262 sub _check_string {
 263     my $bankstring = shift;
 264     my $namestring = shift;
 265     return 0 unless $bankstring and $namestring;
 266
 267     my @bankwords = grep(/^\w+$/, split(/\b/,$bankstring));
 268
 269     my $match = 0;
 270     foreach my $bankword ( @bankwords ) {
 271         # only try to match strings with more than 2 characters
 272         next unless length($bankword)>2;
 273         if ( $namestring =~ /\b$bankword\b/i ) {
 274             $match++;
 275         };
 276     };
 277     return $match;
 278 };
 279
 280 1;
 281
 282 __END__
 283
 284 =pod
 285
 286 =head1 NAME
 287
 288 SL::DB::BankTransaction
 289
 290 =head1 FUNCTIONS
 291
 292 =over 4
 293
 294 =item C<get_agreement_with_invoice $invoice>
 295
 296 Using a point system this function checks whether the bank transaction matches
 297 an invoices, using a variety of tests, such as
 298
 299 =over 2
 300
 301 =item * amount
 302
 303 =item * amount_less_skonto
 304
 305 =item * payment date
 306
 307 =item * invoice number in purpose
 308
 309 =item * customer or vendor name in purpose
 310
 311 =item * account number matches account number of customer or vendor
 312
 313 =back
 314
 315 The total number of points, and the rules that matched, are returned.
 316
 317 Example:
 318   my $bt      = SL::DB::Manager::BankTransaction->find_by(id => 522);
 319   my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '198');
 320   my ($agreement,rule_matches) = $bt->get_agreement_with_invoice($invoice);
 321
 322 =back
 323
 324 =head1 AUTHOR
 325
 326 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>
 327
 328 =cut