1 package Koha::Account::Offsets;
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>.
23 use Koha::Account::Offset;
25 use base qw(Koha::Objects);
29 Koha::Account::Offsets - Koha Account Offset Object set class
31 Account offsets track the changes made to the balance of account lines
39 my $offsets = Koha::Account::Offsets->search({ ... });
40 my $total = $offsets->total;
42 Returns the sum of the amounts of the account offsets resultset. If the resultset is
50 my $offsets = $self->search(
53 select => [ { sum => 'me.amount' } ],
54 as => ['total_amount'],
58 return $offsets->count
59 ? $offsets->next->get_column('total_amount') + 0
63 =head3 filter_by_non_reversible
65 my $non_reversible_offsets = Koha::Account::Offsets->search(..)->filter_by_non_reversible;
67 Filter offsets so only non-reversible ones are left in the resultset.
71 sub filter_by_non_reversible {
74 my $me = $self->_resultset()->current_source_alias;
77 debit_id => { '!=' => undef },
78 credit_id => { '!=' => undef },
80 'credit.credit_type_code' => [ 'WRITEOFF', 'DISCOUNT', 'CANCELLATION' ],
81 'credit.status' => [ { '!=' => 'VOID' }, undef ],
82 $me . '.amount' => { '<' => 0 }
84 my $attr = { join => 'credit' };
86 return $self->search( $where, $attr );
89 =head3 filter_by_reversible
91 my $reversible_offsets = Koha::Account::Offsets->search(..)->filter_by_reversible;
93 Filter offsets so only reversible ones are left in the resultset.
97 sub filter_by_reversible {
100 my $me = $self->_resultset()->current_source_alias;
103 debit_id => { '!=' => undef },
104 credit_id => { '!=' => undef },
106 'credit.credit_type_code' => { -not_in => [ 'WRITEOFF', 'DISCOUNT', 'CANCELLATION' ] },
107 'credit.status' => [ { '!=' => 'VOID' }, undef ],
108 $me . '.amount' => { '<' => 0 }
110 my $attr = { join => 'credit' };
112 return $self->search( $where, $attr );
115 =head2 Internal methods
122 return 'AccountOffset';
130 return 'Koha::Account::Offset';