Open-ILS/src/perlmods/OpenILS/Application/Acq/Invoice.pm

   1 package OpenILS::Application::Acq::Invoice;
   2 use base qw/OpenILS::Application/;
   3 use strict; use warnings;
   4
   5 use OpenSRF::Utils::Logger qw(:logger);
   6 use OpenILS::Utils::Fieldmapper;
   7 use OpenILS::Utils::CStoreEditor q/:funcs/;
   8 use OpenILS::Application::AppUtils;
   9 use OpenILS::Event;
  10 my $U = 'OpenILS::Application::AppUtils';
  11
  12
  13 __PACKAGE__->register_method(
  14         method => 'build_invoice_api',
  15         api_name        => 'open-ils.acq.invoice.update',
  16         signature => {
  17         desc => q/Creates, updates, and deletes invoices, and related invoice entries, and invoice items/,
  18         params => [
  19             {desc => 'Authentication token', type => 'string'},
  20             {desc => q/Invoice/, type => 'number'},
  21             {desc => q/Entries.  Array of 'acqie' objects/, type => 'array'},
  22             {desc => q/Items.  Array of 'acqii' objects/, type => 'array'},
  23         ],
  24         return => {desc => 'The invoice w/ entries and items attached', type => 'object', class => 'acqinv'}
  25     }
  26 );
  27
  28 sub build_invoice_api {
  29     my($self, $conn, $auth, $invoice, $entries, $items) = @_;
  30
  31     my $e = new_editor(xact => 1, authtoken=>$auth);
  32     return $e->die_event unless $e->checkauth;
  33     my $evt;
  34
  35     if(ref $invoice) {
  36         if($invoice->isnew) {
  37             $invoice->receiver($e->requestor->ws_ou) unless $invoice->receiver;
  38             $invoice->recv_method('PPR') unless $invoice->recv_method;
  39             $invoice->recv_date('now') unless $invoice->recv_date;
  40             $e->create_acq_invoice($invoice) or return $e->die_event;
  41         } elsif($invoice->isdeleted) {
  42             i$e->delete_acq_invoice($invoice) or return $e->die_event;
  43         } else {
  44             $e->update_acq_invoice($invoice) or return $e->die_event;
  45         }
  46     } else {
  47         # caller only provided the ID
  48         $invoice = $e->retrieve_acq_invoice($invoice) or return $e->die_event;
  49     }
  50
  51     return $e->die_event unless $e->allowed('CREATE_INVOICE', $invoice->receiver);
  52
  53     if($entries) {
  54         for my $entry (@$entries) {
  55             $entry->invoice($invoice->id);
  56
  57             if($entry->isnew) {
  58
  59                 $e->create_acq_invoice_entry($entry) or return $e->die_event;
  60                 return $evt if $evt = update_entry_debits($e, $entry);
  61
  62             } elsif($entry->isdeleted) {
  63
  64                 return $evt if $evt = rollback_entry_debits($e, $entry);
  65                 $e->delete_acq_invoice_entry($entry) or return $e->die_event;
  66
  67             } elsif($entry->ischanged) {
  68
  69                 my $orig_entry = $e->retrieve_acq_invoice_entry($entry->id) or return $e->die_event;
  70
  71                 if($orig_entry->amount_paid != $entry->amount_paid or
  72                         $entry->phys_item_count != $orig_entry->phys_item_count) {
  73
  74                     return $evt if $evt = rollback_entry_debits($e, $orig_entry);
  75                     return $evt if $evt = update_entry_debits($e, $entry);
  76
  77                 }
  78
  79                 $e->update_acq_invoice_entry($entry) or return $e->die_event;
  80             }
  81         }
  82     }
  83
  84     if($items) {
  85         for my $item (@$items) {
  86             $item->invoice($invoice->id);
  87
  88             if($item->isnew) {
  89
  90                 $e->create_acq_invoice_item($item) or return $e->die_event;
  91
  92                 # future: cache item types
  93                 my $item_type = $e->retrieve_acq_invoice_item_type(
  94                     $item->inv_item_type) or return $e->die_event;
  95
  96                 # prorated items are handled separately
  97                 unless($U->is_true($item_type->prorate)) {
  98                     my $debit;
  99                     if($item->po_item) {
 100                         my $po_item = $e->retrieve_acq_po_item($item->po_item) or return $e->die_event;
 101                         $debit = $e->retrieve_acq_fund_debit($po_item->fund_debit) or return $e->die_event;
 102                     } else {
 103                         $debit = Fieldmapper::acq::fund_debit->new;
 104                         $debit->isnew(1);
 105                     }
 106                     $debit->fund($item->fund);
 107                     $debit->amount($item->amount_paid);
 108                     $debit->origin_amount($item->amount_paid);
 109                     $debit->origin_currency_type($e->retrieve_acq_fund($item->fund)->currency_type); # future: cache funds locally
 110                     $debit->encumbrance('f');
 111                     $debit->debit_type('direct_charge');
 112
 113                     if($debit->isnew) {
 114                         $e->create_acq_fund_debit($debit) or return $e->die_event;
 115                     } else {
 116                         $e->update_acq_fund_debit($debit) or return $e->die_event;
 117                     }
 118
 119                     $item->fund_debit($debit->id);
 120                     $e->update_acq_invoice_item($item) or return $e->die_event;
 121                 }
 122
 123             } elsif($item->isdeleted) {
 124
 125                 $e->delete_acq_invoice_item($item) or return $e->die_event;
 126
 127                 if($item->po_item and $e->retrieve_acq_po_item($item->po_item)->fund_debit == $item->fund_debit) {
 128                     # the debit is attached to the po_item.  instead of deleting it, roll it back
 129                     # to being an encumbrance.  Note: a prorated invoice_item that points to a po_item
 130                     # could point to a different fund_debit.  We can't go back in time to collect all the
 131                     # prorated invoice_items (nor is the caller asking us too), so when that happens,
 132                     # just delete the extraneous debit (in the else block).
 133                     my $debit = $e->retrieve_acq_fund_debit($item->fund_debit);
 134                     $debit->encumbrance('t');
 135                     $e->update_acq_fund_debit($debit) or return $e->die_event;
 136                 } else {
 137                     $e->delete_acq_fund_debit($e->retrieve_acq_fund_debit($item->fund_debit))
 138                         or return $e->die_event;
 139                 }
 140
 141
 142             } elsif($item->ischanged) {
 143
 144                 my $debit = $e->retrieve_acq_fund_debit($item->fund_debit) or return $e->die_event;
 145                 $debit->amount($item->amount_paid);
 146                 $debit->fund($item->fund);
 147                 $e->update_acq_fund_debit($debit) or return $e->die_event;
 148                 $e->update_acq_invoice_item($item) or return $e->die_event;
 149             }
 150         }
 151     }
 152
 153     $invoice = fetch_invoice_impl($e, $invoice->id);
 154     $e->commit;
 155
 156     return $invoice;
 157 }
 158
 159
 160 sub rollback_entry_debits {
 161     my($e, $entry) = @_;
 162     my $debits = find_entry_debits($e, $entry, 'f', entry_amount_per_item($entry));
 163     my $lineitem = $e->retrieve_acq_lineitem($entry->lineitem) or return $e->die_event;
 164
 165     for my $debit (@$debits) {
 166         # revert to the original estimated amount re-encumber
 167         $debit->encumbrance('t');
 168         $debit->amount($lineitem->estimated_unit_price());
 169         $e->update_acq_fund_debit($debit) or return $e->die_event;
 170         update_copy_cost($e, $debit) or return $e->die_event; # clear the cost
 171     }
 172
 173     return undef;
 174 }
 175
 176 sub update_entry_debits {
 177     my($e, $entry) = @_;
 178
 179     my $debits = find_entry_debits($e, $entry, 't');
 180     return undef unless @$debits;
 181
 182     if($entry->phys_item_count > @$debits) {
 183         $e->rollback;
 184         # We can't invoice for more items than we have debits for
 185         return OpenILS::Event->new(
 186             'ACQ_INVOICE_ENTRY_COUNT_EXCEEDS_DEBITS',
 187             payload => {entry => $entry->id});
 188     }
 189
 190     for my $debit (@$debits) {
 191         my $amount = entry_amount_per_item($entry);
 192         $debit->amount($amount);
 193         $debit->encumbrance('f');
 194         $e->update_acq_fund_debit($debit) or return $e->die_event;
 195
 196         # TODO: this does not reflect ancillary charges, like taxes, etc.
 197         # We may need a way to indicate whether the amount attached to an
 198         # invoice_item should be prorated and included in the copy cost.
 199         # Note that acq.invoice_item_type.prorate does not necessarily
 200         # mean a charge should be included in the copy price, only that
 201         # it should spread accross funds.
 202         update_copy_cost($e, $debit, $amount) or return $e->die_event;
 203     }
 204
 205     return undef;
 206 }
 207
 208 # update the linked copy to reflect the amount paid for the item
 209 # returns true on success, false on error
 210 sub update_copy_cost {
 211     my ($e, $debit, $amount) = @_;
 212
 213     my $lid = $e->search_acq_lineitem_detail([
 214         {fund_debit => $debit->id},
 215         {flesh => 1, flesh_fields => {acqlid => ['eg_copy_id']}}
 216     ])->[0];
 217
 218     if($lid and my $copy = $lid->eg_copy_id) {
 219         defined $amount and $copy->cost($amount) or $copy->clear_cost;
 220         $copy->editor($e->requestor->id);
 221         $copy->edit_date('now');
 222         $e->update_asset_copy($copy) or return 0;
 223     }
 224
 225     return 1;
 226 }
 227
 228
 229 sub entry_amount_per_item {
 230     my $entry = shift;
 231     return $entry->amount_paid if $U->is_true($entry->billed_per_item);
 232     return 0 if $entry->phys_item_count == 0;
 233     return $entry->amount_paid / $entry->phys_item_count;
 234 }
 235
 236
 237 # there is no direct link between invoice_entry and fund debits.
 238 # when we need to retrieve the related debits, we have to do some searching
 239 sub find_entry_debits {
 240     my($e, $entry, $encumbrance, $amount) = @_;
 241
 242     my $query = {
 243         select => {acqfdeb => ['id']},
 244         from => {
 245             acqfdeb => {
 246                 acqlid => {
 247                     join => {
 248                         jub =>  {
 249                             join => {
 250                                 acqie => {
 251                                     filter => {id => $entry->id}
 252                                 }
 253                             }
 254                         }
 255                     }
 256                 }
 257             }
 258         },
 259         where => {'+acqfdeb' => {encumbrance => $encumbrance}},
 260         order_by => {'acqlid' => ['recv_time']}, # un-received items will sort to the end
 261         limit => $entry->phys_item_count
 262     };
 263
 264     $query->{where}->{'+acqfdeb'}->{amount} = $amount if $amount;
 265
 266     my $debits = $e->json_query($query);
 267     my $debit_ids = [map { $_->{id} } @$debits];
 268     return (@$debit_ids) ? $e->search_acq_fund_debit({id => $debit_ids}) : [];
 269 }
 270
 271
 272 __PACKAGE__->register_method(
 273         method => 'build_invoice_api',
 274         api_name        => 'open-ils.acq.invoice.retrieve',
 275         signature => {
 276         desc => q/Creates a new stub invoice/,
 277         params => [
 278             {desc => 'Authentication token', type => 'string'},
 279             {desc => q/Invoice Id/, type => 'number'},
 280         ],
 281         return => {desc => 'The new invoice w/ entries and items attached', type => 'object', class => 'acqinv'}
 282     }
 283 );
 284
 285
 286 sub fetch_invoice_api {
 287     my($self, $conn, $auth, $invoice_id, $options) = @_;
 288
 289     my $e = new_editor(authtoken=>$auth);
 290     return $e->event unless $e->checkauth;
 291
 292     my $invoice = fetch_invoice_impl($e, $invoice_id, $options) or
 293         return $e->event;
 294     return $e->event unless $e->allowed(['VIEW_INVOICE', 'CREATE_INVOICE'], $invoice->receiver);
 295
 296     return $invoice;
 297 }
 298
 299 sub fetch_invoice_impl {
 300     my ($e, $invoice_id, $options) = @_;
 301
 302     $options ||= {};
 303
 304     my $args = $options->{"no_flesh_misc"} ? $invoice_id : [
 305         $invoice_id,
 306         {
 307             "flesh" => 6,
 308             "flesh_fields" => {
 309                 "acqinv" => ["entries", "items"],
 310                 "acqii" => ["fund_debit", "purchase_order", "po_item"]
 311             }
 312         }
 313     ];
 314
 315     return $e->retrieve_acq_invoice($args);
 316 }
 317
 318 __PACKAGE__->register_method(
 319         method => 'prorate_invoice',
 320         api_name        => 'open-ils.acq.invoice.apply_prorate',
 321         signature => {
 322         desc => q/
 323             For all invoice items that have the prorate flag set to true, this will create the necessary
 324             additional invoice_item's to prorate the cost across all affected funds by percent spent for each fund.
 325         /,
 326         params => [
 327             {desc => 'Authentication token', type => 'string'},
 328             {desc => q/Invoice Id/, type => 'number'},
 329         ],
 330         return => {desc => 'The updated invoice w/ entries and items attached', type => 'object', class => 'acqinv'}
 331     }
 332 );
 333
 334
 335 sub prorate_invoice {
 336     my($self, $conn, $auth, $invoice_id) = @_;
 337
 338     my $e = new_editor(xact => 1, authtoken=>$auth);
 339     return $e->die_event unless $e->checkauth;
 340
 341     my $invoice = fetch_invoice_impl($e, $invoice_id) or return $e->die_event;
 342     return $e->die_event unless $e->allowed('CREATE_INVOICE', $invoice->receiver);
 343
 344     my @lid_debits;
 345     push(@lid_debits, @{find_entry_debits($e, $_, 'f', entry_amount_per_item($_))}) for @{$invoice->entries};
 346
 347     my %fund_totals;
 348     my $total_entry_paid = 0;
 349     for my $debit (@lid_debits) {
 350         $fund_totals{$debit->fund} = 0 unless $fund_totals{$debit->fund};
 351         $fund_totals{$debit->fund} += $debit->amount;
 352         $total_entry_paid += $debit->amount;
 353     }
 354
 355     $logger->info("invoice: prorating against invoice amount $total_entry_paid");
 356
 357     for my $item (@{$invoice->items}) {
 358
 359         next if $item->fund_debit; # item has already been processed
 360
 361         # future: cache item types locally
 362         my $item_type = $e->retrieve_acq_invoice_item_type($item->inv_item_type) or return $e->die_event;
 363         next unless $U->is_true($item_type->prorate);
 364
 365         # Prorate charges across applicable funds
 366         my $full_item_paid = $item->amount_paid; # total amount paid for this item before splitting
 367         my $full_item_cost = $item->cost_billed; # total amount invoiced for this item before splitting
 368         my $first_round = 1;
 369         my $largest_debit;
 370         my $largest_item;
 371         my $total_debited = 0;
 372         my $total_costed = 0;
 373
 374         for my $fund_id (keys %fund_totals) {
 375
 376             my $spent_for_fund = $fund_totals{$fund_id};
 377             next unless $spent_for_fund > 0;
 378
 379             my $prorated_amount = ($spent_for_fund / $total_entry_paid) * $full_item_paid;
 380             my $prorated_cost = ($spent_for_fund / $total_entry_paid) * $full_item_cost;
 381             $logger->info("invoice: attaching prorated amount $prorated_amount to fund $fund_id for invoice $invoice_id");
 382
 383             my $debit;
 384             if($first_round and $item->po_item) {
 385                 # if this item is the result of a PO item, repurpose the original debit
 386                 # for the first chunk of the prorated amount
 387                 $debit = $e->retrieve_acq_fund_debit($item->po_item->fund_debit);
 388             } else {
 389                 $debit = Fieldmapper::acq::fund_debit->new;
 390                 $debit->isnew(1);
 391             }
 392
 393             $debit->fund($fund_id);
 394             $debit->amount($prorated_amount);
 395             $debit->origin_amount($prorated_amount);
 396             $debit->origin_currency_type($e->retrieve_acq_fund($fund_id)->currency_type); # future: cache funds locally
 397             $debit->encumbrance('f');
 398             $debit->debit_type('prorated_charge');
 399
 400             if($debit->isnew) {
 401                 $e->create_acq_fund_debit($debit) or return $e->die_event;
 402             } else {
 403                 $e->update_acq_fund_debit($debit) or return $e->die_event;
 404             }
 405
 406             $total_debited += $prorated_amount;
 407             $total_costed += $prorated_cost;
 408             $largest_debit = $debit if !$largest_debit or $prorated_amount > $largest_debit->amount;
 409
 410             if($first_round) {
 411
 412                 # re-purpose the original invoice_item for the first prorated amount
 413                 $item->fund($fund_id);
 414                 $item->fund_debit($debit->id);
 415                 $item->amount_paid($prorated_amount);
 416                 $item->cost_billed($prorated_cost);
 417                 $e->update_acq_invoice_item($item) or return $e->die_event;
 418                 $largest_item = $item if !$largest_item or $prorated_amount > $largest_item->amount_paid;
 419
 420             } else {
 421
 422                 # for subsequent prorated amounts, create a new invoice_item
 423                 my $new_item = $item->clone;
 424                 $new_item->clear_id;
 425                 $new_item->fund($fund_id);
 426                 $new_item->fund_debit($debit->id);
 427                 $new_item->amount_paid($prorated_amount);
 428                 $new_item->cost_billed($prorated_cost);
 429                 $e->create_acq_invoice_item($new_item) or return $e->die_event;
 430                 $largest_item = $new_item if !$largest_item or $prorated_amount > $largest_item->amount_paid;
 431             }
 432
 433             $first_round = 0;
 434         }
 435
 436         # make sure the percentages didn't leave a small sliver of money over/under-debited
 437         # if so, tweak the largest debit to smooth out the difference
 438         if($total_debited != $full_item_paid or $total_costed != $full_item_cost) {
 439
 440             my $paid_diff = $full_item_paid - $total_debited;
 441             my $cost_diff = $full_item_cost - $total_debited;
 442             $logger->info("invoice: repairing prorate descrepency of paid:$paid_diff and cost:$cost_diff");
 443             my $new_paid = $largest_item->amount + $paid_diff;
 444             my $new_cost = $largest_item->cost_billed + $cost_diff;
 445
 446             $largest_debit = $e->retrieve_acq_fund_debit($largest_debit->id); # get latest copy
 447             $largest_debit->amount($new_paid);
 448             $e->update_acq_fund_debit($largest_debit) or return $e->die_event;
 449
 450             $largest_item = $e->retrieve_acq_invoice_item($largest_item->id); # get latest copy
 451             $largest_item->amount_paid($new_paid);
 452             $largest_item->cost_billed($new_cost);
 453
 454             $e->update_acq_invoice_item($largest_item) or return $e->die_event;
 455         }
 456     }
 457
 458     $invoice = fetch_invoice_impl($e, $invoice_id);
 459     $e->commit;
 460
 461     return $invoice;
 462 }
 463
 464
 465 __PACKAGE__->register_method(
 466     method      => "print_html_invoice",
 467     api_name    => "open-ils.acq.invoice.print.html",
 468     stream      => 1,
 469     signature   => {
 470         desc    => "Retrieve printable HTML vouchers for each given invoice",
 471         params => [
 472             {desc => "Authentication token", type => "string"},
 473             {desc => "Invoice ID or a list of them", type => "mixed"},
 474         ],
 475         return => {
 476             desc => q{One A/T event containing a printable HTML voucher for
 477                 each given invoice},
 478             type => "object", class => "atev"}
 479     }
 480 );
 481
 482
 483 sub print_html_invoice {
 484     my ($self, $conn, $auth, $id_list) = @_;
 485
 486     my $e = new_editor("authtoken" => $auth);
 487     return $e->die_event unless $e->checkauth;
 488
 489     $id_list = [$id_list] unless ref $id_list;
 490
 491     my $invoices = $e->search_acq_invoice({"id" => $id_list}) or
 492         return $e->die_event;
 493
 494     foreach my $invoice (@$invoices) {
 495         return $e->die_event unless
 496             $e->allowed("VIEW_INVOICE", $invoice->receiver);
 497
 498         $conn->respond(
 499             $U->fire_object_event(
 500                 undef, "format.acqinv.html", $invoice, $invoice->receiver,
 501                 "print-on-demand"
 502             )
 503         );
 504     }
 505
 506     $e->disconnect;
 507     undef;
 508 }
 509
 510 1;