summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/cust_refund.txt
blob: 392a0b57ac2aae1f42d09e3018305aacc651b67c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
NAME
    FS::cust_refund - Object method for cust_refund objects

SYNOPSIS
      use FS::cust_refund;

      $record = create FS::cust_refund \%hash;
      $record = create FS::cust_refund { 'column' => 'value' };

      $error = $record->insert;

      $error = $new_record->replace($old_record);

      $error = $record->delete;

      $error = $record->check;

DESCRIPTION
    An FS::cust_refund represents a refund. FS::cust_refund inherits
    from FS::Record. The following fields are currently supported:

    refundnum - primary key (assigned automatically for new refunds)
    crednum - Credit (see the FS::cust_credit manpage)
    refund - Amount of the refund
    _date - specified as a UNIX timestamp; see the section on "time" in the perlfunc manpage.  Also see
    the Time::Local manpage and the Date::Parse manpage for conversion functions.
    payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
    payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
    otaker - order taker (assigned automatically, see the FS::UID manpage)
METHODS
    create HASHREF
        Creates a new refund. To add the refund to the database, see
        the section on "insert".

    insert
        Adds this refund to the database, and updates the credit
        (see the FS::cust_credit manpage).

    delete
        Currently unimplemented (accounting reasons).

    replace OLD_RECORD
        Currently unimplemented (accounting reasons).

    check
        Checks all fields to make sure this is a valid refund. If
        there is an error, returns the error, otherwise returns
        false. Called by the insert method.

BUGS
    It doesn't properly override FS::Record yet.

    Delete and replace methods.

SEE ALSO
    the FS::Record manpage, the FS::cust_credit manpage, schema.html
    from the base documentation.

HISTORY
    ivan@sisd.com 98-mar-18

    ->create had wrong tablename ivan@sisd.com 98-jun-16 (finish
    me!)

    pod and finish up ivan@sisd.com 98-sep-21