1 package Koha::Exceptions::Account;
3 # This file is part of Koha.
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.
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.
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>.
22 use Exception::Class (
24 'Koha::Exceptions::Account' => {
25 isa => 'Koha::Exception',
27 'Koha::Exceptions::Account::IsNotCredit' => {
28 isa => 'Koha::Exceptions::Account',
29 description => 'Account line is not a credit'
31 'Koha::Exceptions::Account::IsNotDebit' => {
32 isa => 'Koha::Exceptions::Account',
33 description => 'Account line is not a credit'
35 'Koha::Exceptions::Account::NoAvailableCredit' => {
36 isa => 'Koha::Exceptions::Account',
37 description => 'No outstanding credit'
39 'Koha::Exceptions::Account::AmountNotPositive' => {
40 isa => 'Koha::Exceptions::Account',
41 description => 'Amount should be a positive decimal'
43 'Koha::Exceptions::Account::UnrecognisedType' => {
44 isa => 'Koha::Exceptions::Account',
45 description => 'Account type was not recognised'
47 'Koha::Exceptions::Account::RegisterRequired' => {
48 isa => 'Koha::Exceptions::Account',
49 description => 'Account transaction requires a cash register'
51 'Koha::Exceptions::Account::PaymentTypeRequired' => {
52 isa => 'Koha::Exceptions::Account',
53 description => 'Account transaction requires a payment type'
55 'Koha::Exceptions::Account::InvalidPaymentType' => {
56 isa => 'Koha::Exceptions::Account',
57 description => 'Invalid payment type'
63 Koha::Exceptions::Account - Base class for Account exceptions
67 =head2 Koha::Exceptions::Account
69 Generic Account exception
71 =head2 Koha::Exceptions::Account::IsNotCredit
73 Exception to be used when an action on an account line requires it to be a
76 =head2 Koha::Exceptions::Account::IsNotDebit
78 Exception to be used when an action on an account line requires it to be a
81 =head2 Koha::Exceptions::Account::NoAvailableCredit
83 Exception to be used when a credit has no amount outstanding and is required
84 to be applied to outstanding debits.
86 =head2 Koha::Exceptions::Account::AmountNotPositive
88 Exception to be used when a passed credit or debit amount is not a positive
91 =head2 Koha::Exceptions::Account::UnrecognisedType
93 Exception to be used when a passed credit or debit is not of a recognised type.
97 =head2 Koha::Exceptions::Account::RegisterRequired
99 Exception to be used when UseCashRegisters is enabled and one is not passed for a transaction.