httemplate/search/elements/cust_pay_or_refund.html

   1 <%doc>
   2
   3 Examples:
   4
   5   include( 'elements/cust_pay_or_refund.html',
   6                'thing'          => 'pay',
   7                'amount_field'   => 'paid',
   8                'name_singular'  => 'payment',
   9                'name_verb'      => 'paid',
  10          )
  11
  12   include( 'elements/cust_pay_or_refund.html',
  13                'thing'          => 'refund',
  14                'amount_field'   => 'refund',
  15                'name_singular'  => 'refund',
  16                'name_verb'      => 'refunded',
  17          )
  18
  19   include( 'elements/cust_pay_or_refund.html',
  20                'thing'          => 'pay_pending',
  21                'amount_field'   => 'paid',
  22                'name_singular'  => 'pending payment',
  23                'name_verb'      => 'pending',
  24                'disable_link'   => 1,
  25                'disable_by'     => 1,
  26                'html_init'      => '',
  27                'addl_header'    => [],
  28                'addl_fields'    => [],
  29                'redirect_empty' => $redirect_empty,
  30           )
  31
  32   include( 'elements/cust_pay_or_refund.html',
  33                'table'          => 'h_cust_pay',
  34                'amount_field'   => 'paid',
  35                'name_singular'  => 'payment',
  36                'name_verb'      => 'paid',
  37                'pre_header'     => [ 'Transaction',    'By' ],
  38                'pre_fields'     => [ 'history_action', 'history_user' ],
  39          )
  40
  41 </%doc>
  42 <% include( 'search.html',
  43                 'title'          => $title,
  44                 'name_singular'  => $name_singular,
  45                 'query'          => $sql_query,
  46                 'count_query'    => $count_query,
  47                 'count_addl'     => \@count_addl,
  48                 'redirect_empty' => $opt{'redirect_empty'},
  49                 'header'         => \@header,
  50                 'fields'         => \@fields,
  51                 'sort_fields'    => \@sort_fields,
  52                 'align'          => $align,
  53                 'links'          => \@links,
  54                 'color'          => \@color,
  55                 'style'          => \@style,
  56           )
  57 %>
  58 <%init>
  59
  60 my %opt = @_;
  61
  62 my $curuser = $FS::CurrentUser::CurrentUser;
  63
  64 die "access denied"
  65   unless $curuser->access_right('Financial reports');
  66
  67 my $table = $opt{'table'} || 'cust_'.$opt{'thing'};
  68
  69 my $amount_field = $opt{'amount_field'};
  70 my $name_singular = $opt{'name_singular'};
  71
  72 my $unapplied = $cgi->param('unapplied');
  73 my $title = '';
  74 $title = 'Unapplied ' if $unapplied;
  75 $title .= "\u$name_singular Search Results";
  76
  77 my $link = '';
  78 if (    ( $curuser->access_right('View invoices') #XXX for now
  79           || $curuser->access_right('View customer payments')
  80         )
  81      && ! $opt{'disable_link'}
  82    )
  83 {
  84
  85   my $key;
  86   my $q = '';
  87   if ( $table eq 'cust_pay_void' ) {
  88     $key = 'paynum';
  89     $q .= 'void=1;';
  90   } elsif ( $table eq /^cust_(\w+)$/ ) {
  91     $key = $1.'num';
  92   }
  93
  94   if ( $key ) {
  95     $q .= "$key=";
  96     $link = [ "${p}view/$table.html?$q", $key ]
  97   }
  98 }
  99
 100 my $cust_link = sub {
 101   my $cust_thing = shift;
 102   $cust_thing->cust_main_custnum
 103     ? [ "${p}view/cust_main.cgi?", 'custnum' ]
 104     : '';
 105 };
 106
 107 # only valid for $table == 'cust_pay' atm
 108 my  $tax_names = '';
 109 if ( $cgi->param('tax_names') ) {
 110   if ( dbh->{Driver}->{Name} eq 'Pg' ) {
 111
 112     $tax_names = "
 113       array_to_string(
 114         array(
 115           SELECT itemdesc
 116             FROM cust_bill_pay
 117             LEFT JOIN cust_bill_pay_pkg USING ( billpaynum )
 118             LEFT JOIN cust_bill_pkg USING ( billpkgnum )
 119               WHERE cust_bill_pkg.pkgnum = 0
 120                 AND cust_bill_pay.paynum = cust_pay.paynum
 121         ), '|'
 122       ) AS tax_names"
 123     ;
 124
 125   } elsif ( dbh->{Driver}->{Name} =~ /^mysql/i ) {
 126
 127     $tax_names = "GROUP_CONCAT(itemdesc SEPARATOR '|') AS tax_names";
 128
 129   } else {
 130
 131     warn "warning: unknown database type ". dbh->{Driver}->{Name}.
 132          "omitting tax name information from report.";
 133
 134   }
 135 }
 136
 137 my @header = ();
 138 my @fields = ();
 139 my @sort_fields = ();
 140 my $align = '';
 141 my @links = ();
 142 if ( $opt{'pre_header'} ) {
 143   push @header, @{ $opt{'pre_header'} };
 144   $align .= 'c' x scalar(@{ $opt{'pre_header'} });
 145   push @links, map '', @{ $opt{'pre_header'} };
 146   push @fields, @{ $opt{'pre_fields'} };
 147   push @sort_fields, @{ $opt{'pre_fields'} };
 148 }
 149
 150 push @header, "\u$name_singular",
 151               'Amount',
 152 ;
 153 $align .= 'rr';
 154 push @links, '', '';
 155 push @fields, 'payby_payinfo_pretty',
 156               sub { sprintf('$%.2f', shift->$amount_field() ) },
 157 ;
 158 push @sort_fields, '', $amount_field;
 159
 160 if ( $unapplied ) {
 161   push @header, 'Unapplied';
 162   $align .= 'r';
 163   push @links, '';
 164   push @fields, sub { sprintf('$%.2f', shift->unapplied_amount) };
 165   push @sort_fields, '';
 166 }
 167
 168 push @header, 'Date';
 169 $align .= 'r';
 170 push @links, '';
 171 push @fields, sub { time2str('%b %d %Y', shift->_date ) };
 172 push @sort_fields, '_date';
 173
 174 unless ( $opt{'disable_by'} ) {
 175   push @header, 'By';
 176   $align .= 'c';
 177   push @links, '';
 178   push @fields, sub { my $o = shift->otaker;
 179                       $o = 'auto billing'          if $o eq 'fs_daily';
 180                       $o = 'customer self-service' if $o eq 'fs_selfservice';
 181                       $o;
 182                     };
 183 }
 184
 185 if ( $tax_names ) {
 186   push @header, ('Tax names', 'Tax province');
 187   $align .= 'cc';
 188   push @links, ('','');
 189   push @fields, sub { join (' + ', map { /^(.*?)(, \w\w)?$/; $1 }
 190                                    split('\|', shift->tax_names)
 191                            );
 192                     };
 193   push @fields, sub { join (' + ', map { if (/^(?:.*)(?:, )(\w\w)$/){ $1 }
 194                                          else { () }
 195                                        }
 196                                    split('\|', shift->tax_names)
 197                            );
 198                     };
 199 }
 200
 201 push @header, FS::UI::Web::cust_header();
 202 $align .=  FS::UI::Web::cust_aligns();
 203 push @links, map { $_ ne 'Cust. Status' ? $cust_link : '' }
 204                  FS::UI::Web::cust_header();
 205 my @color = ( ( map '', @fields ), FS::UI::Web::cust_colors() );
 206 my @style = ( ( map '', @fields ), FS::UI::Web::cust_styles() );
 207 push @fields, \&FS::UI::Web::cust_fields;
 208
 209 push @header, @{ $opt{'addl_header'} }
 210   if $opt{'addl_header'};
 211 push @fields, @{ $opt{'addl_fields'} }
 212   if $opt{'addl_fields'};
 213
 214 my( $count_query, $sql_query, @count_addl );
 215 if ( $cgi->param('magic') ) {
 216
 217   my @search = ();
 218   my @select = (
 219     "$table.*",
 220     FS::UI::Web::cust_sql_fields(),
 221     'cust_main.custnum AS cust_main_custnum',
 222   );
 223   push @select, $tax_names if $tax_names;
 224
 225   my $orderby;
 226   if ( $cgi->param('magic') eq '_date' ) {
 227
 228     if ( $cgi->param('agentnum') && $cgi->param('agentnum') =~ /^(\d+)$/ ) {
 229       push @search, "agentnum = $1"; # $search{'agentnum'} = $1;
 230       my $agent = qsearchs('agent', { 'agentnum' => $1 } );
 231       die "unknown agentnum $1" unless $agent;
 232       $title = $agent->agent. " $title";
 233     }
 234
 235     if ( $cgi->param('custnum') =~ /^(\d+)$/ ) {
 236       push @search, "custnum = $1";
 237     }
 238
 239     if ( $cgi->param('payby') ) {
 240       $cgi->param('payby') =~
 241         /^(CARD|CHEK|BILL|PREP|CASH|WEST|MCRD)(-(VisaMC|Amex|Discover|Maestro))?$/
 242           or die "illegal payby ". $cgi->param('payby');
 243       push @search, "$table.payby = '$1'";
 244       if ( $3 ) {
 245
 246         my $cardtype = $3;
 247
 248         my $search;
 249         if ( $cardtype eq 'VisaMC' ) {
 250           #avoid posix regexes for portability
 251           $search =
 252             " ( (     substring($table.payinfo from 1 for 1) = '4'     ".
 253             "     AND substring($table.payinfo from 1 for 4) != '4936' ".
 254             "     AND substring($table.payinfo from 1 for 6)           ".
 255             "         NOT SIMILAR TO '49030[2-9]'                        ".
 256             "     AND substring($table.payinfo from 1 for 6)           ".
 257             "         NOT SIMILAR TO '49033[5-9]'                        ".
 258             "     AND substring($table.payinfo from 1 for 6)           ".
 259             "         NOT SIMILAR TO '49110[1-2]'                        ".
 260             "     AND substring($table.payinfo from 1 for 6)           ".
 261             "         NOT SIMILAR TO '49117[4-9]'                        ".
 262             "     AND substring($table.payinfo from 1 for 6)           ".
 263             "         NOT SIMILAR TO '49118[1-2]'                        ".
 264             "   )".
 265             "   OR substring($table.payinfo from 1 for 2) = '51' ".
 266             "   OR substring($table.payinfo from 1 for 2) = '52' ".
 267             "   OR substring($table.payinfo from 1 for 2) = '53' ".
 268             "   OR substring($table.payinfo from 1 for 2) = '54' ".
 269             "   OR substring($table.payinfo from 1 for 2) = '54' ".
 270             "   OR substring($table.payinfo from 1 for 2) = '55' ".
 271             "   OR substring($table.payinfo from 1 for 2) = '36' ". #Diner's int'l processed as Visa/MC inside US
 272             " ) ";
 273         } elsif ( $cardtype eq 'Amex' ) {
 274           $search =
 275             " (    substring($table.payinfo from 1 for 2 ) = '34' ".
 276             "   OR substring($table.payinfo from 1 for 2 ) = '37' ".
 277             " ) ";
 278         } elsif ( $cardtype eq 'Discover' ) {
 279           $search =
 280             " (    substring($table.payinfo from 1 for 4 ) = '6011'  ".
 281             "   OR substring($table.payinfo from 1 for 2 ) = '65'    ".
 282             "   OR substring($table.payinfo from 1 for 3 ) = '622'   ". #China Union Pay processed as Discover outside CN
 283             " ) ";
 284         } elsif ( $cardtype eq 'Maestro' ) {
 285           $search =
 286             " (    substring($table.payinfo from 1 for 2 ) = '63'     ".
 287             "   OR substring($table.payinfo from 1 for 2 ) = '67'     ".
 288             "   OR substring($table.payinfo from 1 for 6 ) = '564182' ".
 289             "   OR substring($table.payinfo from 1 for 4 ) = '4936'   ".
 290             "   OR substring($table.payinfo from 1 for 6 )            ".
 291             "      SIMILAR TO '49030[2-9]'                             ".
 292             "   OR substring($table.payinfo from 1 for 6 )            ".
 293             "      SIMILAR TO '49033[5-9]'                             ".
 294             "   OR substring($table.payinfo from 1 for 6 )            ".
 295             "      SIMILAR TO '49110[1-2]'                             ".
 296             "   OR substring($table.payinfo from 1 for 6 )            ".
 297             "      SIMILAR TO '49117[4-9]'                             ".
 298             "   OR substring($table.payinfo from 1 for 6 )            ".
 299             "      SIMILAR TO '49118[1-2]'                             ".
 300             " ) ";
 301         } else {
 302           die "unknown card type $cardtype";
 303         }
 304
 305         my $masksearch = $search;
 306         $masksearch =~ s/$table\.payinfo/$table.paymask/gi;
 307
 308         push @search,
 309           "( $search OR ( $table.paymask IS NOT NULL AND $masksearch ) )";
 310
 311       }
 312     }
 313
 314     if ( $cgi->param('payinfo') ) {
 315       $cgi->param('payinfo') =~ /^\s*(\d+)\s*$/
 316         or die "illegal payinfo ". $cgi->param('payinfo');
 317       push @search, "$table.payinfo = '$1'";
 318     }
 319
 320     if ( $cgi->param('usernum') =~ /^(\d+)$/ ) {
 321       push @search, "$table.usernum = $1";
 322     }
 323
 324     #for cust_pay_pending...  statusNOT=done
 325     if ( $cgi->param('statusNOT') =~ /^(\w+)$/ ) {
 326       push @search, "status != '$1'";
 327     }
 328
 329     my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
 330     push @search, "_date >= $beginning ",
 331                   "_date <= $ending";
 332
 333     if ( $table eq 'cust_pay_void' ) {
 334       my($v_beginning, $v_ending) =
 335         FS::UI::Web::parse_beginning_ending($cgi, 'void');
 336       push @search, "void_date >= $v_beginning ",
 337                     "void_date <= $v_ending";
 338     }
 339
 340     push @search, FS::UI::Web::parse_lt_gt($cgi, $amount_field );
 341
 342     $orderby = '_date';
 343
 344   } elsif ( $cgi->param('magic') eq 'paybatch' ) {
 345
 346     $cgi->param('paybatch') =~ /^([\w\/\:\-\.]+)$/
 347       or die "illegal paybatch: ". $cgi->param('paybatch');
 348
 349     push @search, "paybatch = '$1'";
 350
 351     $orderby = "LOWER(company || ' ' || last || ' ' || first )";
 352
 353   } else {
 354     die "unknown search magic: ". $cgi->param('magic');
 355   }
 356
 357   #unapplied payment/refund
 358   if ( $unapplied ) {
 359     push @select, '(' . "FS::$table"->unapplied_sql . ') AS unapplied_amount';
 360     push @search, "FS::$table"->unapplied_sql . ' > 0';
 361
 362   }
 363
 364   #for the history search
 365   if ( $cgi->param('history_action') =~ /^([\w,]+)$/ ) {
 366     my @history_action = split(/,/, $1);
 367     push @search, 'history_action IN ('.
 368                     join(',', map "'$_'", @history_action ). ')';
 369   }
 370
 371   if (    $cgi->param('history_date_beginning')
 372        || $cgi->param('history_date_ending')    ) {
 373       my($h_beginning, $h_ending) =
 374         FS::UI::Web::parse_beginning_ending($cgi, 'history_date');
 375       push @search, "history_date >= $h_beginning ",
 376                     "history_date <= $h_ending";
 377   }
 378
 379   #here is the agent virtualization
 380   push @search, $curuser->agentnums_sql;
 381
 382   my $addl_from = ' LEFT JOIN cust_main USING ( custnum ) ';
 383   my $group_by = '';
 384
 385   if ( $cgi->param('tax_names') ) {
 386     if ( dbh->{Driver}->{Name} eq 'Pg' ) {
 387
 388       0;#twiddle thumbs
 389
 390     } elsif ( dbh->{Driver}->{Name} =~ /^mysql/i ) {
 391
 392       $addl_from .= "LEFT JOIN cust_bill_pay USING ( paynum )
 393                      LEFT JOIN cust_bill_pay_pkg USING ( billpaynum )
 394                      LEFT JOIN cust_bill_pkg USING ( billpkgnum ) AS tax_names";
 395       $group_by  .= "GROUP BY $table.*,cust_main_custnum,".
 396                     FS::UI::Web::cust_sql_fields();
 397       push @search,
 398        "( cust_bill_pkg.pkgnum = 0 OR cust_bill_pkg.pkgnum is NULL )";
 399
 400     } else {
 401
 402       warn "warning: unknown database type ". dbh->{Driver}->{Name}.
 403            "omitting tax name information from report.";
 404
 405     }
 406   }
 407
 408   my $search = ' WHERE '. join(' AND ', @search);
 409
 410   $count_query = "SELECT COUNT(*), SUM($amount_field) ";
 411   $count_query .= ', SUM(' . "FS::$table"->unapplied_sql . ') '
 412     if $unapplied;
 413   $count_query .= "FROM $table $addl_from".
 414                   "$search $group_by";
 415
 416   @count_addl = ( '$%.2f total '.$opt{name_verb} );
 417   push @count_addl, '$%.2f unapplied' if $unapplied;
 418
 419   $sql_query = {
 420     'table'     => $table,
 421     'select'    => join(', ', @select),
 422     'hashref'   => {},
 423     'extra_sql' => "$search $group_by",
 424     'order_by'  => "ORDER BY $orderby",
 425     'addl_from' => $addl_from,
 426   };
 427
 428 } else {
 429
 430   #hmm... is this still used?
 431
 432   $cgi->param('payinfo') =~ /^\s*(\d+)\s*$/ or die "illegal payinfo";
 433   my $payinfo = $1;
 434
 435   $cgi->param('payby') =~ /^(\w+)$/ or die "illegal payby";
 436   my $payby = $1;
 437
 438   $count_query = "SELECT COUNT(*), SUM($amount_field) FROM $table".
 439                  "  WHERE payinfo = '$payinfo' AND payby = '$payby'".
 440                  "  AND ". $curuser->agentnums_sql;
 441   @count_addl = ( '$%.2f total '.$opt{name_verb} );
 442
 443   $sql_query = {
 444     'table'     => $table,
 445     'hashref'   => { 'payinfo' => $payinfo,
 446                      'payby'   => $payby    },
 447     'extra_sql' => $curuser->agentnums_sql.
 448                    " ORDER BY _date",
 449   };
 450
 451 }
 452
 453 # for consistency
 454 $title = join('',map {ucfirst} split(/\b/,$title));
 455
 456 </%init>