Koha/Acquisition/Invoice.pm

   1 package Koha::Acquisition::Invoice;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Koha::Database;
  21
  22 use base qw(Koha::Object);
  23
  24 =head1 NAME
  25
  26 Koha::Acquisition::Invoice object class
  27
  28 =head1 API
  29
  30
  31 =head3 to_api
  32
  33     my $json = $invoice->to_api;
  34
  35 Overloaded method that returns a JSON representation of the Koha::Acquisition::Invoice object,
  36 suitable for API output.
  37
  38 =cut
  39
  40 sub to_api {
  41     my ( $self ) = @_;
  42
  43     my $json = $self->SUPER::to_api;
  44
  45     $json->{closed} = ( $self->closedate )
  46                                     ? Mojo::JSON->true
  47                                     : Mojo::JSON->false;
  48
  49     return $json;
  50 }
  51
  52 =head3 to_api_mapping
  53
  54 This method returns the mapping for representing a Koha::Acquisition::Invoice object
  55 on the API.
  56
  57 =cut
  58
  59 sub to_api_mapping {
  60     return {
  61         invoiceid             => 'invoice_id',
  62         invoicenumber         => 'invoice_number',
  63         booksellerid          => 'vendor_id',
  64         shipmentdate          => 'shipping_date',
  65         billingdate           => 'invoice_date',
  66         closedate             => 'close_date',
  67         shipmentcost          => 'shipping_cost',
  68         shipmentcost_budgetid => 'shipping_cost_budget_id',
  69         message_id            => undef
  70     };
  71 }
  72
  73 =head2 Internal methods
  74
  75 =head3 _type
  76
  77 =cut
  78
  79 sub _type {
  80     return 'Aqinvoice';
  81 }
  82
  83 1;