Freeside:3:Documentation:Developer/FS/cust pkg/Search

From Freeside
Jump to: navigation, search
search HASHREF
(Class method)
Returns a qsearch hash expression to search for parameters specified in HASHREF. Valid parameters are
agentnum
; status
on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
magic
Equivalent to "status", except that "canceled"/"cancelled" will exclude packages that were changed into a new package with the same pkgpart (i.e. location or quantity changes).
custom
boolean selects custom packages

classnum
; pkgpart
pkgpart or arrayref or hashref of pkgparts
setup
arrayref of beginning and ending epoch date
last_bill
arrayref of beginning and ending epoch date
bill
arrayref of beginning and ending epoch date
adjourn
arrayref of beginning and ending epoch date
susp
arrayref of beginning and ending epoch date
expire
arrayref of beginning and ending epoch date
cancel
arrayref of beginning and ending epoch date
query
pkgnum or APKG_pkgnum
cust_fields
a value suited to passing to FS::UI::Web::cust_header
CurrentUser
specifies the user for agent virtualization
fcc_line
boolean; if true, returns only packages with more than 0 FCC phone lines.
state, country
Limit to packages with a service location in the specified state and country. For FCC 477 reporting, mostly.
location_cust
Limit to packages whose service locations are the same as the customer's default service location.
location_nocust
Limit to packages whose service locations are not the customer's default service location.
location_census
Limit to packages whose service locations have census tracts.
location_nocensus
Limit to packages whose service locations do not have a census tract.
location_geocode
Limit to packages whose locations have geocodes.
location_geocode
Limit to packages whose locations do not have geocodes.
towernum
Limit to packages associated with a svc_broadband, associated with a sector, associated with this towernum (or any of these, if it's an arrayref) (or NO towernum, if it's zero). This is an extreme niche case.
477part, 477rownum, date
Limit to packages included in a specific row of one of the FCC 477 reports. '477part' is the section name (see FS::Report::FCC_477 methods), 'date' is the report as-of date (completely unrelated to the package setup/bill/ other date fields), and '477rownum' is the row number of the report starting with zero. Row numbers have no inherent meaning, so this is useful only for explaining a 477 report you've already run.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 9:
'=item' outside of any '=over'