htdocs/docs/man/cust_main_invoice.txt

   1 NAME
   2     FS::cust_main_invoice - Object methods for cust_main_invoice
   3     records
   4
   5 SYNOPSIS
   6       use FS::cust_main_invoice;
   7
   8       $record = new FS::cust_main_invoice \%hash;
   9       $record = new FS::cust_main_invoice { 'column' => 'value' };
  10
  11       $error = $record->insert;
  12
  13       $error = $new_record->replace($old_record);
  14
  15       $error = $record->delete;
  16
  17       $error = $record->check;
  18
  19       $email_address = $record->address;
  20
  21 DESCRIPTION
  22     An FS::cust_main_invoice object represents an invoice
  23     destination. FS::cust_main_invoice inherits from FS::Record. The
  24     following fields are currently supported:
  25
  26     destnum - primary key
  27     custnum - customer (see the FS::cust_main manpage)
  28     dest - Invoice destination: If numeric, a <a href="#svc_acct">svcnum</a>, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)
  29 METHODS
  30     new HASHREF
  31         Creates a new invoice destination. To add the invoice
  32         destination to the database, see the section on "insert".
  33
  34         Note that this stores the hash reference, not a distinct
  35         copy of the hash it points to. You can ask the object for a
  36         copy with the *hash* method.
  37
  38     insert
  39         Adds this record to the database. If there is an error,
  40         returns the error, otherwise returns false.
  41
  42     delete
  43         Delete this record from the database.
  44
  45     replace OLD_RECORD
  46         Replaces the OLD_RECORD with this one in the database. If
  47         there is an error, returns the error, otherwise returns
  48         false.
  49
  50     check
  51         Checks all fields to make sure this is a valid invoice
  52         destination. If there is an error, returns the error,
  53         otherwise returns false. Called by the insert and repalce
  54         methods.
  55
  56     checkdest
  57         Checks the dest field only.
  58
  59     address
  60         Returns the literal email address for this record (or
  61         `POST').
  62
  63 VERSION
  64     $Id: cust_main_invoice.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $
  65
  66 BUGS
  67 SEE ALSO
  68     the FS::Record manpage, the FS::cust_main manpage
  69
  70 HISTORY
  71     ivan@voicenet.com 97-jul-1
  72
  73     added hfields ivan@sisd.com 97-nov-13
  74
  75     $Log: cust_main_invoice.txt,v $
  76     Revision 1.1  1999-04-08 13:39:32  ivan
  77     convert from pod for 1.2.0 release
  78  Revision 1.6 1999/01/25 12:26:10
  79     ivan yet more mod_perl stuff
  80
  81     Revision 1.5 1999/01/18 21:58:05 ivan esthetic: eq and ne were
  82     used in a few places instead of == and !=
  83
  84     Revision 1.4 1999/01/18 09:22:42 ivan changes to track email
  85     addresses for email invoicing
  86
  87     Revision 1.3 1998/12/29 11:59:42 ivan mostly properly OO, some
  88     work still to be done with svc_ stuff
  89
  90     Revision 1.2 1998/12/16 09:58:53 ivan library support for
  91     editing email invoice destinations (not in sub collect yet)
  92
  93     Revision 1.1 1998/12/16 07:40:02 ivan new table
  94
  95     Revision 1.3 1998/11/15 04:33:00 ivan updates for newest versoin
  96
  97     Revision 1.2 1998/11/15 03:48:49 ivan update for current version
  98