Bug 32366: (bug 30460 follow-up) Add tests
[koha.git] / 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
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
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 =head2 Class methods
31
32 =head3 to_api
33
34     my $json = $invoice->to_api;
35
36 Overloaded method that returns a JSON representation of the Koha::Acquisition::Invoice object,
37 suitable for API output.
38
39 =cut
40
41 sub to_api {
42     my ( $self, $params ) = @_;
43
44     my $json = $self->SUPER::to_api( $params );
45
46     $json->{closed} = ( $self->closedate )
47                                     ? Mojo::JSON->true
48                                     : Mojo::JSON->false;
49
50     return $json;
51 }
52
53 =head3 to_api_mapping
54
55 This method returns the mapping for representing a Koha::Acquisition::Invoice object
56 on the API.
57
58 =cut
59
60 sub to_api_mapping {
61     return {
62         invoiceid             => 'invoice_id',
63         invoicenumber         => 'invoice_number',
64         booksellerid          => 'vendor_id',
65         shipmentdate          => 'shipping_date',
66         billingdate           => 'invoice_date',
67         closedate             => 'closed_date',
68         shipmentcost          => 'shipping_cost',
69         shipmentcost_budgetid => 'shipping_fund_id',
70         message_id            => undef
71     };
72 }
73
74 =head2 Internal methods
75
76 =head3 _type
77
78 =cut
79
80 sub _type {
81     return 'Aqinvoice';
82 }
83
84 1;