FS::cust_location - Object methods for cust_location records
use FS::cust_location;
$record = new FS::cust_location \%hash;
$record = new FS::cust_location { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::cust_location object represents a customer (or prospect) location. FS::cust_location inherits from FS::Record. The following fields are currently supported:
primary key
Customer (see FS::cust_main).
Prospect (see FS::prospect_main).
Optional location name.
Address line one (required)
Address line two (optional)
City (if cust_main-no_city_in_address config is set when inserting, this will be forced blank)
County (optional, see FS::cust_main_county)
State (see FS::cust_main_county)
Zip
Country (see FS::cust_main_county)
Geocode
Flag indicating whether coordinates were obtained automatically or manually entered
Flag indicating whether address has been normalized
Tax district code (optional)
Incorporated city flag: set to 'Y' if the address is in the legal borders of an incorporated city.
Disabled flag; set to 'Y' to disable the location.
Creates a new location. To add the location 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.
Finds an existing location matching the customer and address values in this location, if one exists, and sets the contents of this location equal to that one (including its locationnum).
If an existing location is not found, this one will be inserted. (This is a change from the "new_or_existing" method that this replaces.)
The following fields are considered "essential" and must match: custnum, address1, address2, city, county, state, zip, country, location_number, location_type, location_kind. Disabled locations will be found only if this location is set to disabled.
All other fields are considered "non-essential" and will be ignored in finding a matching location. If the existing location doesn't match in these fields, it will be updated in-place to match.
Returns an error string if inserting or updating a location failed.
It is unfortunately hard to determine if this created a new location or not.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid location. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns this location's full country name
Synonym for location_label
Returns false since cust_location objects do not have a separate shipping address.
Returns a list of key/value pairs, with the following keys: address1, address2, city, county, state, zip, country, geocode, location_type, location_number, location_kind.
Sets the "disabled" flag on the location if it is no longer in use as a prospect location, package location, or a customer's billing or default service address.
Takes a new FS::cust_location object. Moves all packages that use the existing location to the new one, then sets the "disabled" flag on the old location. Returns nothing on success, an error message on error.
Attempts to parse data for location_type and location_number from address1 and address2.
Moves data from location_type and location_number to the end of address1.
Returns the label of the location object.
Options:
Customer object (see FS::cust_main)
Prospect object (see FS::prospect_main)
String used to join location elements
Don't label the default service location as "Default service location". May become the default at some point.
Returns the optional site ID string (based on the cust_location-label_prefix config option), "Default service location", or the empty string.
Options:
Customer object (see FS::cust_main)
Prospect object (see FS::prospect_main)
Returns a string consisting of just the county, state and country.
Queueable function to update the census tract to the current year (as set in the 'census_year' configuration variable) and retrieve the new tract code.
Queueable function to find and fill in coordinates for all locations that lack them. Because this uses the Google Maps API, it's internally rate limited and must run in a single process.
Performs address standardization on locations with unclean addresses, using whatever method you have configured. If the standardize_* method returns a clean address match, the location will be updated. This is always an in-place update (because the physical location is the same, and is just being referred to by a more accurate name).
Disabled locations will be skipped, as nobody cares.
If any LOCATIONNUMS are provided, only those locations will be updated.
FS::cust_main_county, FS::cust_pkg, FS::Record, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
You forgot a '=back' before '=head1'