Koha/Account/Credit.pm

   1 package Koha::Account::Credit;
   2
   3 # Copyright PTFS Europe 2021
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use base qw(Koha::Account::Line);
  23
  24 =head1 NAME
  25
  26 Koha::Credit - Koha Credit object class
  27
  28 This object represents a credit account line
  29
  30 =head1 API
  31
  32 =head2 Class Methods
  33
  34 =head3 to_api_mapping
  35
  36 This method returns the mapping for representing a Koha::Account::Credit object
  37 on the API.
  38
  39 =cut
  40
  41 sub to_api_mapping {
  42     return {
  43         accountlines_id   => 'account_line_id',
  44         credit_number     => undef,
  45         credit_type_code  => 'type',
  46         debit_type_code   => undef,
  47         amountoutstanding => 'amount_outstanding',
  48         borrowernumber    => 'patron_id',
  49         branchcode        => 'library_id',
  50         issue_id          => undef,
  51         itemnumber        => undef,
  52         manager_id        => 'user_id',
  53         note              => 'internal_note',
  54         register_id       => 'cash_register_id',
  55     };
  56 }
  57
  58 =head1 AUTHOR
  59
  60 Martin Renvoize <martin.renvoize@ptfs-europe.com>
  61
  62 =cut
  63
  64 1;