summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/cust_pay.txt
blob: 14843d022faacce7aceb169811e839eec4e3496d (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
67
68
69
70
71
72
73
74
75
76
NAME
    FS::cust_pay - Object methods for cust_pay objects

SYNOPSIS
      use FS::cust_pay;

      $record = new FS::cust_pay \%hash;
      $record = new FS::cust_pay { 'column' => 'value' };

      $error = $record->insert;

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

      $error = $record->delete;

      $error = $record->check;

DESCRIPTION
    An FS::cust_pay object represents a payment. FS::cust_pay
    inherits from FS::Record. The following fields are currently
    supported:

    paynum - primary key (assigned automatically for new payments)
    invnum - Invoice (see the FS::cust_bill manpage)
    paid - Amount of this payment
    _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)
    paybatch - text field for tracking card processing
METHODS
    new HASHREF
        Creates a new payment. To add the payment to the databse,
        see the section on "insert".

    insert
        Adds this payment to the databse, and updates the invoice
        (see the FS::cust_bill manpage).

    delete
        Currently unimplemented (accounting reasons).

    replace OLD_RECORD
        Currently unimplemented (accounting reasons).

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

VERSION
    $Id: cust_pay.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $

BUGS
    Delete and replace methods.

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

HISTORY
    ivan@voicenet.com 97-jul-1 - 25 - 29

    new api ivan@sisd.com 98-mar-13

    pod ivan@sisd.com 98-sep-21

    $Log: cust_pay.txt,v $
    Revision 1.3  1999-04-08 13:39:32  ivan
    convert from pod for 1.2.0 release
 Revision 1.3 1999/01/25 12:26:11 ivan yet
    more mod_perl stuff

    Revision 1.2 1998/12/29 11:59:43 ivan mostly properly OO, some
    work still to be done with svc_ stuff