FS::cust_main - Object methods for cust_main records
use FS::cust_main;
$record = new FS::cust_main \%hash;
$record = new FS::cust_main { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
@cust_pkg = $record->all_pkgs;
@cust_pkg = $record->ncancelled_pkgs;
@cust_pkg = $record->suspended_pkgs;
$error = $record->bill;
$error = $record->bill %options;
$error = $record->bill 'time' => $time;
$error = $record->collect;
$error = $record->collect %options;
$error = $record->collect 'invoice_time' => $time,
;
An FS::cust_main object represents a customer. FS::cust_main inherits from FS::Record. The following fields are currently supported:
Primary key (assigned automatically for new customers)
Agent (see FS::agent)
Advertising source (see FS::part_referral)
First name
Last name
Cocial security number (optional)
(optional)
phone (optional)
phone (optional)
phone (optional)
phone (optional)
Payment Type (See FS::payinfo_Mixin for valid payby values)
Payment Information (See FS::payinfo_Mixin for data format)
Masked payinfo (See FS::payinfo_Mixin for how this works)
Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
Start date month (maestro/solo cards only)
Start date year (maestro/solo cards only)
Issue number (maestro/solo cards only)
Name on card or billing name
IP address from which payment information was received
Tax exempt, empty or `Y'
Order taker (see FS::access_user)
Comments (optional)
Referring customer number
Enable individual CDR spooling, empty or `Y'
A suggestion to events (see FS::part_bill_event) to delay until this unix timestamp
Discourage individual CDR printing, empty or `Y'
Allow self-service editing of ticket subjects, empty or 'Y'
Do not call, empty or 'Y'
Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
Creates a new customer. To add the customer to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
Adds this customer to the database. If there is an error, returns the error, otherwise returns false.
Usually the customer's location will not yet exist in the database, and the bill_location and ship_location pseudo-fields must be set to uninserted FS::cust_location objects. These will be inserted and linked (in both directions) to the new customer record. If they're references to the same object, they will become the same location.
CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert method containing FS::cust_pkg and FS::svc_tablename objects, all records are inserted atomicly, or the transaction is rolled back. Passing an empty hash reference is equivalent to not supplying this parameter. There should be a better explanation of this, but until then, here's an example:
use Tie::RefHash;
tie %hash, 'Tie::RefHash'; #this part is important
%hash = (
$cust_pkg => [ $svc_acct ],
...
);
$cust_main->insert( \%hash );
INVOICING_LIST_ARYREF: No longer supported.
Currently available options are: depend_jobnum, noexport, tax_exemption, prospectnum, contact and contact_params.
If depend_jobnum is set, all provisioning jobs will have a dependancy on the supplied jobnum (they will not run until the specific job completes). This can be used to defer provisioning until some action completes (such as running the customer's credit card successfully).
The noexport option is deprecated. If noexport is set true, no provisioning jobs (exports) are scheduled. (You can schedule them later with the reexport method.)
The tax_exemption option can be set to an arrayref of tax names or a hashref of tax names and exemption numbers. FS::cust_main_exemption records will be created and inserted.
If prospectnum is set, moves contacts and locations from that prospect.
If contact is set to an arrayref of FS::contact objects, those will be inserted.
If contact_params is set to a hashref of CGI parameters (and contact is unset), inserts those new contacts with this new customer. Handles CGI paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
If cust_payby_params is set to a hashref o fCGI parameters, inserts those new stored payment records with this new customer. Handles CGI parameters for an "m2" multiple entry field as passed by edit/cust_main.cgi
Documentation on customer package methods has been moved to FS::cust_main::Packages.
Recharges this (existing) customer with the specified prepaid card (see FS::prepay_credit), specified either by identifier or as an FS::prepay_credit object. If there is an error, returns the error, otherwise returns false.
Optionally, five scalar references can be passed as well. They will have their values filled in with the amount, number of seconds, and number of upload, download, and total bytes applied by this prepaid card.
Looks up and deletes a prepaid card (see FS::prepay_credit), specified either by identifier or as an FS::prepay_credit object.
Available options are: amount_ref, seconds_ref, upbytes_ref, downbytes_ref, and totalbytes_ref. The scalars (provided by references) will be incremented by the values of the prepaid card.
If the prepaid card specifies an agentnum (see FS::agent), it is used to check or set this customer's agentnum.
If there is an error, returns the error, otherwise returns false.
Updates this customer's single or primary account (see FS::svc_acct) by the specified number of upbytes. If there is an error, returns the error, otherwise returns false.
Updates this customer's single or primary account (see FS::svc_acct) by the specified number of downbytes. If there is an error, returns the error, otherwise returns false.
Updates this customer's single or primary account (see FS::svc_acct) by the specified number of totalbytes. If there is an error, returns the error, otherwise returns false.
Updates this customer's single or primary account (see FS::svc_acct) by the specified number of seconds. If there is an error, returns the error, otherwise returns false.
Updates this customer's single or primary account (see FS::svc_acct) by the specified number of seconds or bytes. If there is an error, returns the error, otherwise returns false.
Inserts a prepayment in the specified amount for this customer. An optional second argument can specify the prepayment identifier for tracking purposes. If there is an error, returns the error, otherwise returns false.
Inserts a cash payment in the specified amount for this customer. An optional second argument can specify the payment identifier for tracking purposes. If there is an error, returns the error, otherwise returns false.
Inserts a Western Union payment in the specified amount for this customer. An optional second argument can specify the prepayment identifier for tracking purposes. If there is an error, returns the error, otherwise returns false.
This deletes the customer. If there is an error, returns the error, otherwise returns false.
This will completely remove all traces of the customer record. This is not what you want when a customer cancels service; for that, cancel all of the customer's packages (see "cancel").
If the customer has any uncancelled packages, you need to pass a new (valid) customer number for those packages to be transferred to, as the "new_customer" option. Cancelled packages will be deleted. Did I mention that this is NOT what you want when a customer cancels service and that you really should be looking at "cancel" in FS::cust_pkg?
You can't delete a customer with invoices (see FS::cust_bill), statements (see FS::cust_statement), credits (see FS::cust_credit), payments (see FS::cust_pay) or refunds (see FS::cust_refund), unless you set the "delete_financials" option to a true value.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
To change the customer's address, set the pseudo-fields bill_location and ship_location. The address will still only change if at least one of the address fields differs from the existing values.
INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be set as the contact email address for a default contact with the same name as the customer.
Currently available options are: tax_exemption, cust_payby_params, contact_params, invoicing_list.
The tax_exemption option can be set to an arrayref of tax names or a hashref of tax names and exemption numbers. FS::cust_main_exemption records will be deleted and inserted as appropriate.
cust_payby_params and contact_params can be hashrefs of named parameter groups (describing the customer's payment methods and contacts, respectively) in the style supported by "process_o2m" in FS::o2m_Common. See FS::cust_payby and FS::contact for the fields these can contain.
invoicing_list is a synonym for the INVOICING_LIST_ARYREF parameter, and should be used instead if possible.
Used by insert & replace to update the fuzzy search cache
Checks all fields to make sure this is a valid customer record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Additional checks for replace only.
Returns a list of fields which have ship_ duplicates.
Returns true if this customer record has a separate shipping address.
Returns a list of key/value pairs, with the following keys: address1, adddress2, city, county, state, zip, country, district, and geocode. The shipping address is used if present.
Returns all locations (see FS::cust_location) for this customer.
Returns all contact associations (see FS::cust_contact) for this customer.
Returns all payment methods (see FS::cust_payby) for this customer.
If one or more PAYBY are specified, returns only payment methods for specified PAYBY. Does not validate PAYBY.
Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
Unsuspends all unflagged suspended packages (see "unflagged_suspended_pkgs" and FS::cust_pkg) for this customer, except those on hold.
Returns a list: an empty list on success or a list of errors.
Unsuspends all suspended packages in the on-hold state (those without setup dates) for this customer.
Suspends all unsuspended packages (see FS::cust_pkg) for this customer.
Returns a list: an empty list on success or a list of errors.
Suspends all unsuspended packages (see FS::cust_pkg) matching the listed PKGPARTs (see FS::part_pkg). Preferred usage is to pass a hashref instead of a list of pkgparts; the hashref has the following keys:
Returns a list: an empty list on success or a list of errors.
Suspends all unsuspended packages (see FS::cust_pkg) unless they match the given PKGPARTs (see FS::part_pkg). Preferred usage is to pass a hashref instead of a list of pkgparts; the hashref has the following keys:
Returns a list: an empty list on success or a list of errors.
Cancels all uncancelled packages (see FS::cust_pkg) for this customer. The cancellation time will be now.
Always returns a list: an empty list on success or a list of errors.
Cancels a specified list of packages. OPTIONS can include:
cust_pkg argument. The reason and reason_otaker arguments will be taken from those objects.Returns all notes (see FS::cust_main_note) for this customer.
Returns the agent (see FS::agent) for this customer.
Returns the agent name (see FS::agent) for this customer.
Returns any tags associated with this customer, as FS::cust_tag objects, or an empty list if there are no tags.
Returns any tags associated with this customer, as FS::part_tag objects, or an empty list if there are no tags.
Returns the customer class, as an FS::cust_class object, or the empty string if there is no customer class.
Returns the customer category name, or the empty string if there is no customer category.
Returns the customer class name, or the empty string if there is no customer class.
Returns the external tax status, as an FS::tax_status object, or the empty string if there is no tax status.
Returns the tax status code if there is one.
Documentation on billing methods has been moved to FS::cust_main::Billing.
Documentation on realtime billing methods has been moved to FS::cust_main::Billing_Realtime.
Removes the paycvv field from the database directly.
If there is an error, returns the error, otherwise returns false.
DEPRECATED. Use "remove_cvv_from_cust_payby" instead.
Returns the total owed for this customer on all invoices (see "owed" in FS::cust_bill).
Returns the total owed for this customer on all invoices with date earlier than TIME. TIME is specified as a UNIX timestamp; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions.
Returns the total owed on all invoices for this customer's specific package when using experimental package balances (see "owed_pkgnum" in FS::cust_bill).
Returns the total owed for this customer's specific package when using experimental package balances on all invoices with date earlier than TIME. TIME is specified as a UNIX timestamp; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions.
Returns the total amount of all payments.
Returns the total outstanding credit (see FS::cust_credit) for this customer. See "credited" in FS::cust_credit.
Old name for total_unapplied_credits. Don't use.
Returns the total outstanding credit (see FS::cust_credit) for this customer. See "credited" in FS::cust_credit.
Returns the total unapplied payments (see FS::cust_pay) for this customer. See "unapplied" in FS::cust_pay.
Returns the total unapplied payments (see FS::cust_pay) for this customer's specific package when using experimental package balances. See "unapplied" in FS::cust_pay.
Returns the total unrefunded refunds (see FS::cust_refund) for this customer. See "unapplied" in FS::cust_refund.
Returns the balance for this customer (total_owed plus total_unrefunded, minus total_unapplied_credits minus total_unapplied_payments).
Returns the balance for this customer, only considering invoices with date earlier than TIME (total_owed_date minus total_credited minus total_unapplied_payments). TIME is specified as a UNIX timestamp; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions.
Returns the balance for this customer, optionally considering invoices with date earlier than START_TIME, and not later than END_TIME (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
Times are specified as SQL fragments or numeric UNIX timestamps; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions. The empty string can be passed to disable that time constraint completely.
Accepts the same options as "balance_date_sql":
set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
An absolute cutoff time. Payments, credits, and refunds applied after this time will be ignored. Note that START_TIME and END_TIME only limit the date range for invoices and unapplied payments, credits, and refunds.
Returns the balance for this customer's specific package when using experimental package balances (total_owed plus total_unrefunded, minus total_unapplied_credits minus total_unapplied_payments)
Returns a hash of useful information for making a payment.
Current balance.
'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand), 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand), 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
For credit card transactions:
Exact name on card
For electronic check transactions:
Returns the next payment expiration date for this customer. If they have no payment methods that will expire, returns 0.
Returns an SQL expression to get the next payment expiration date for a customer. Returns 2143260000 (2037-12-01) if there are no payment expiration dates, so that it's safe to test for "will it expire before date X" for any date up to then.
Returns a list of email addresses (with svcnum entries expanded), and the word 'POST' if the customer receives postal invoices.
Checks these arguements as valid input for the invoicing_list method. If there is an error, returns the error, otherwise returns false.
Returns the email addresses of all accounts provisioned for this customer.
Adds postal invoicing to this customer. If this customer is already configured to receive postal invoices, does nothing.
Returns the list of email invoice recipients (invoicing_list without non-email destinations such as POST and FAX).
Returns the list of email invoice recipients (invoicing_list without non-email destinations such as POST and FAX) as a comma-separated scalar.
Returns a list of contacts (FS::contact objects) for the customer.
If no arguments are given, returns all contacts for the customer.
Arguments may contain classnums. When classnums are specified, only contacts with a matching cust_contact.classnum are returned. When a classnum of 0 is given, contacts with a null classnum are also included.
Arguments may also contain the dest flag names 'invoice' or 'message'. If given, contacts who's invoice_dest and/or message_dest flags are not set to 'Y' will be excluded.
Same as "contact_list", but returns email destinations instead of contact objects.
Returns a list of contact phone numbers. { phonetypenum => '1', phonenum => 'xxxxxxxxxx', first => 'firstname', last => 'lastname', countrycode => '1' }
Returns the customer who referred this customer (or the empty string, if this customer was not referred).
Note the difference with referral_cust_main method: This method, referral_custnum_cust_main returns the single customer (if any) who referred this customer, while referral_cust_main returns an array of customers referred BY this customer.
Returns an array of customers referred by this customer (referral_custnum set to this custnum). If DEPTH is given, recurses up to the given depth, returning customers referred by customers referred by this customer and so on, inclusive. The default behavior is DEPTH 1 (no recursion).
Note the difference with referral_custnum_cust_main method: This method, referral_cust_main, returns an array of customers referred BY this customer, while referral_custnum_cust_main returns the single customer (if any) who referred this customer.
Same as referral_cust_main, except only returns customers with uncancelled packages.
Like referral_cust_main, except returns a flat list of all unsuspended (and uncancelled) packages for each customer. The number of items in this list may be useful for commission calculations (perhaps after a grep { my $pkgpart = $_-pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
Returns the single cust_main record for the customer who referred this customer (referral_custnum), or false.
Applies a credit to this customer. If there is an error, returns the error, otherwise returns false.
REASON can be a text string, an FS::reason object, or a scalar reference to a reasonnum. If a text string, it will be automatically inserted as a new reason, and a 'reason_type' option must be passed to indicate the FS::reason_type for the new reason.
An addlinfo option may be passed to set the credit's addlinfo field. Likewise for eventnum, commission_agentnum, commission_salesnum and commission_pkgnum.
Any other options are passed to FS::cust_credit::insert.
Creates a one-time charge for this customer. If there is an error, returns the error, otherwise returns false.
New-style, with a hashref of options:
my $error = $cust_main->charge(
{
'amount' => 54.32,
'quantity' => 1,
'start_date' => str2time('7/4/2009'),
'pkg' => 'Description',
'comment' => 'Comment',
'additional' => [], #extra invoice detail
'classnum' => 1, #pkg_class
'setuptax' => '', # or 'Y' for tax exempt
'locationnum'=> 1234, # optional
#internal taxation
'taxclass' => 'Tax class',
#vendor taxation
'taxproduct' => 2, #part_pkg_taxproduct
'override' => {}, #XXX describe
#will be filled in with the new object
'cust_pkg_ref' => \$cust_pkg,
#generate an invoice immediately
'bill_now' => 0,
'invoice_terms' => '', #with these terms
}
);
Old-style:
my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
Returns the number of deleted attachments for this customer (see FS::num_cust_attachment).
Returns the most recent invnum (invoice number) for this customer.
Returns all the invoices (see FS::cust_bill) for this customer.
Optionally, a list or hashref of additional arguments to the qsearch call can be passed.
Returns all the open (owed > 0) invoices (see FS::cust_bill) for this customer.
Returns all the legacy invoices (see FS::legacy_cust_bill) for this customer.
Returns all the statements (see FS::cust_statement) for this customer.
Optionally, a list or hashref of additional arguments to the qsearch call can be passed.
Returns all the voided invoices (see FS::cust_bill_void) for this customer.
Returns all services of type SVCDB (such as 'svc_acct') for this customer.
Optionally, a list or hashref of additional arguments to the qsearch call can be passed following the SVCDB.
Returns all the credits (see FS::cust_credit) for this customer.
Returns all the credits (see FS::cust_credit) for this customer's specific package when using experimental package balances.
Returns all voided credits (see FS::cust_credit_void) for this customer.
Returns all the payments (see FS::cust_pay) for this customer.
Returns the number of payments (see FS::cust_pay) for this customer. Also called automatically when the cust_pay method is used in a scalar context.
Returns all the unapplied payments (see FS::cust_pay) for this customer.
Returns all the payments (see FS::cust_pay) for this customer's specific package when using experimental package balances.
Returns all voided payments (see FS::cust_pay_void) for this customer.
Returns all pending payments (see FS::cust_pay_pending) for this customer (without status "done").
Returns all payment attempts / declined payments for this customer, as pending payments objects (see FS::cust_pay_pending), with status "done" but without a corresponding payment (see FS::cust_pay).
Returns the number of pending payments (see FS::cust_pay_pending) for this customer (without status "done"). Also called automatically when the cust_pay_pending method is used in a scalar context.
Returns the number of pending payments (see FS::cust_pay_pending) for this customer, with status "done" but without a corresp. Also called automatically when the cust_pay_pending method is used in a scalar context.
Returns all the refunds (see FS::cust_refund) for this customer.
Returns the displayed customer number for this customer: agent_custid if cust_main-default_agent_custid is set and it has a value, custnum otherwise.
Returns a name string for this customer, either "Company (Last, First)" or "Last, First".
Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company, based on if a company name exists and is the account being used a business account.
Returns the FS::contact object for this customer that has the 'Service' contact class, or undef if there is no such contact. Deprecated; don't use this in new code.
Returns a name string for this (service/shipping) contact, either "Company (Last, First)" or "Last, First".
Returns a name string for this customer, either "Company" or "First Last".
Returns a name string for this (service/shipping) contact, either "Company" or "First Last".
Returns this customer's full (billing) contact name only, "Last, First"
Returns this customer's full (shipping) contact name only, "Last, First"
Returns this customers full (billing) contact name only, "First Last".
Returns this customer's full (shipping) contact name only, "First Last".
Returns a string consisting of just the county, state and country.
Returns a value for the customer location as encoded by DATA_VENDOR. Currently this only makes sense for "CCH" as DATA_VENDOR.
Returns a status string for this customer, currently:
No packages have ever been ordered. Displayed as "No packages".
Recurring packages all are new (not yet billed).
One or more recurring packages is active.
No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
All non-cancelled recurring packages are suspended.
All recurring packages are cancelled.
Behavior of inactive vs. cancelled edge cases can be adjusted with the cust_main-status_module configuration option.
Returns true if customer status is 'suspended' and all suspended cust_pkg return true for cust_pkg->is_status_delay_cancel.
This is not a real status, this only meant for hacking display values, because otherwise treating the customer as suspended is really the whole point of the delay_cancel option.
Deprecated, use the cust_status_label method instead.
Returns the status with the first character capitalized.
Returns the display label for this status.
Returns a hex triplet color string for this customer's status.
Returns an array of hashes representing the customer's RT tickets.
An optional status (or arrayref or hashref of statuses) may be specified.
Returns an array of hashes representing the customer's RT tickets which are appointments.
Returns a masked version of the named field
Returns an array of hashrefs standardizing information from cust_bill, cust_pay, cust_credit and cust_refund objects. Each hashref has the following fields:
type - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
date - value of _date field, unix timestamp
date_pretty - user-friendly date
description - user-friendly description of item
amount - impact of item on user's balance (positive for Invoice/Refund/Line item, negative for Payment/Credit.) Not to be confused with the native 'amount' field in cust_credit, see below.
amount_pretty - includes money char
balance - customer balance, chronologically as of this item
balance_pretty - includes money char
charged - amount charged for cust_bill (Invoice or Line item) records, undef for other types
paid - amount paid for cust_pay records, undef for other types
credit - amount credited for cust_credit records, undef for other types. Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
refund - amount refunded for cust_refund records, undef for other types
The four table-specific keys always have positive values, whether they reflect charges or payments.
The following options may be passed to this method:
line_items - if true, returns charges ('Line item') rather than invoices
start_date - unix timestamp, only include records on or after. If specified, an item of type 'Previous' will also be included. It does not have table-specific fields.
end_date - unix timestamp, only include records before
reverse_sort - order from newest to oldest (default is oldest to newest)
conf - optional already-loaded FS::Conf object.
Saves a new cust_payby for this customer, replacing an existing entry only in select circumstances. Does not validate input.
If auto is specified, marks this as the customer's primary method, or the specified weight. Existing payment methods have their weight incremented as appropriate.
If bill_location is specified with auto, also sets location in cust_main.
Will not insert complete duplicates of existing records, or records in which the only difference from an existing record is to turn off automatic payment (will return without error.) Will replace existing records in which the only difference is to add a value to a previously empty preserved field and/or turn on automatic payment. Fields marked as preserved are optional, and existing values will not be overwritten with blanks when replacing.
Accepts the following named parameters:
either CARD or CHEK
save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
optional, set higher than 1 for secondary, etc.
required
optional, but should be specified for anything that might be tokenized, will be preserved when replacing
required
optional, will be preserved when replacing
CARD only, required
CARD only, required, FS::cust_location object
CARD only, optional, will be preserved when replacing
CARD only, optional, will be preserved when replacing
CARD only, optional, will be preserved when replacing
CARD only, only used if conf cvv-save is set appropriately
CHEK only
CHEK only
scalar reference, for returning saved object
Removes paycvv from associated cust_payby with matching PAYINFO.
Class method that returns the list of possible status strings for customers (see the status method). For example:
@statuses = FS::cust_main->statuses();
Returns an SQL fragment to determine the status of a cust_main record, as a string.
Returns an SQL expression identifying prospective cust_main records (customers with no packages ever ordered)
Returns an SQL expression identifying ordered cust_main records (customers with no active packages, but recurring packages not yet setup or one time charges not yet billed).
Returns an SQL expression identifying active cust_main records (customers with active recurring packages).
Returns an SQL expression identifying cust_main records with no active recurring packages. This includes customers of status prospect, ordered, inactive, and suspended.
Returns an SQL expression identifying inactive cust_main records (customers with no active recurring packages, but otherwise unsuspended/uncancelled).
Returns an SQL expression identifying suspended cust_main records.
Returns an SQL expression identifying cancelled cust_main records.
Returns an SQL expression identifying un-cancelled cust_main records.
Returns an SQL fragment to retreive the balance.
Returns an SQL fragment to retreive the balance for this customer, optionally considering invoices with date earlier than START_TIME, and not later than END_TIME (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
Times are specified as SQL fragments or numeric UNIX timestamps; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions. The empty string can be passed to disable that time constraint completely.
Available options are:
set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
(unused. obsolete?) set to true to remove all customer comparison clauses, for totals
(unused. obsolete?) WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
(unused. obsolete?) JOIN clause (typically used with the total option)
An absolute cutoff time. Payments, credits, and refunds applied after this time will be ignored. Note that START_TIME and END_TIME only limit the date range for invoices and unapplied payments, credits, and refunds.
Returns an SQL fragment to retreive the total unapplied payments for this customer, only considering payments with date earlier than START_TIME, and optionally not later than END_TIME.
Times are specified as SQL fragments or numeric UNIX timestamps; see "time" in perlfunc). Also see Time::Local and Date::Parse for conversion functions. The empty string can be passed to disable that time constraint completely.
Available options are:
Helper method for balance_date_sql; name (and usage) subject to change (suggestions welcome).
Returns a WHERE clause for the specified monetary TABLE (cust_bill, cust_refund, cust_credit or cust_pay).
If TABLE is "cust_bill" or the unapplied_date option is true, only considers records with date earlier than START_TIME, and optionally not later than END_TIME .
#=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
#Deprecated. Use event notification and message templates #(FS::msg_template) instead.
#Sends a templated email notification to the customer (see Text::Template).
#OPTIONS is a hash and may include
#from - the email sender (default is invoice_from)
#to - comma-separated scalar or arrayref of recipients # (default is invoicing_list)
#subject - The subject line of the sent email notification # (default is "Notice from company_name")
#extra_fields - a hashref of name/value pairs which will be substituted # into the template
#The following variables are vavailable in the template.
#$first - the customer first name #$last - the customer last name #$company - the customer company #$payby - a description of the method of payment for the customer # # would be nice to use FS::payby::shortname #$payinfo - the account information used to collect for this customer #$expdate - the expiration of the customer payment in seconds from epoch
#=cut
#sub notify { # my ($self, $template, %options) = @_;
# return unless $conf->exists($template);
# my $from = $conf->invoice_from_full($self->agentnum) # if $conf->exists('invoice_from', $self->agentnum); # $from = $options{from} if exists($options{from});
# my $to = join(',', $self->invoicing_list_emailonly); # $to = $options{to} if exists($options{to}); # # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum) # if $conf->exists('company_name', $self->agentnum); # $subject = $options{subject} if exists($options{subject});
# my $notify_template = new Text::Template (TYPE => 'ARRAY', # SOURCE => [ map "$_\n", # $conf->config($template)] # ) # or die "can't create new Text::Template object: Text::Template::ERROR"; # $notify_template->compile() # or die "can't compile template: Text::Template::ERROR";
# $FS::notify_template::_template::company_name = # $conf->config('company_name', $self->agentnum); # $FS::notify_template::_template::company_address = # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
# my $paydate = $self->paydate || '2037-12-31'; # $FS::notify_template::_template::first = $self->first; # $FS::notify_template::_template::last = $self->last; # $FS::notify_template::_template::company = $self->company; # $FS::notify_template::_template::payinfo = $self->mask_payinfo; # my $payby = $self->payby; # my ($payyear,$paymonth,$payday) = split (/-/,$paydate); # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
# #credit cards expire at the end of the month/year of their exp date # if ($payby eq 'CARD' || $payby eq 'DCRD') { # $FS::notify_template::_template::payby = 'credit card'; # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++); # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear); # $expire_time--; # }elsif ($payby eq 'COMP') { # $FS::notify_template::_template::payby = 'complimentary account'; # }else{ # $FS::notify_template::_template::payby = 'current method'; # } # $FS::notify_template::_template::expdate = $expire_time;
# for (keys %{$options{extra_fields}}){ # no strict "refs"; # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_}; # }
# send_email(from => $from, # to => $to, # subject => $subject, # body => $notify_template->fill_in( PACKAGE => # 'FS::notify_template::_template' ), # );
#}
generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
Generates a templated notification to the customer (see Text::Template).
OPTIONS is a hash and may include
extra_fields - a hashref of name/value pairs which will be substituted into the template. These values may override values mentioned below and those from the customer record.
template_text - if present, ignores TEMPLATE_NAME and uses the provided text
The following variables are available in the template instead of or in addition to the fields of the customer record.
$payby - a description of the method of payment for the customer # would be nice to use FS::payby::shortname $payinfo - the masked account information used to collect for this customer $expdate - the expiration of the customer payment method in seconds from epoch $returnaddress - the return address defaults to invoice_latexreturnaddress or company_address
print_ps TEMPLATE
Returns an postscript letter filled in from TEMPLATE, as a scalar.
print TEMPLATE
Prints the filled in template.
TEMPLATE is the name of a Text::Template to fill in and print.
queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
Subroutine (not a method), designed to be called from the queue.
Takes a list of options and values.
Pulls up the customer record via the custnum option and calls bill_and_collect.
queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
Like queued_bill, but instead of
bill_and_collect, just runs thecollectpart. This is used in batch tax calculation, where invoice generation and collection events have to be completely separated.pending_invoice_count
Return number of cust_bill with pending=Y for this customer
cust_locations_missing_district
Always returns empty list, unless tax_district_method eq 'wa_sales'
Return cust_location rows for this customer, associated with active customer packages, where tax district column is empty. Presense of these rows should block billing, because invoice would be generated with incorrect taxes
The delete method.
The delete method should possibly take an FS::cust_main object reference instead of a scalar customer number.
Bill and collect options should probably be passed as references instead of a list.
There should probably be a configuration file with a list of allowed credit card types.
No multiple currency support (probably a larger project than just this module).
payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
Birthdates rely on negative epoch values.
The payby for card/check batches is broken. With mixed batching, bad things will happen.
collect invoice_time should be renamed time, like bill.
FS::Record, FS::cust_pkg, FS::cust_bill, FS::cust_credit FS::agent, FS::part_referral, FS::cust_main_county, FS::cust_main_invoice, FS::UID, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
'=item' outside of any '=over'
You forgot a '=back' before '=head1'
You can't have =items (as at line 5480) unless the first thing after the =over is an =item