Difference between revisions of "Freeside:3:Documentation:Developer/FS/Misc/Geo"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
Line 3: Line 3:
  
 
==CLASS METHODS==
 
==CLASS METHODS==
; get_censustract LOCATION YEAR
+
; get_censustract_ffiec LOCATION YEAR
 
:Given a location hash (see [[Freeside:3:Documentation:Developer/FS/location Mixin|FS::location_Mixin]]) and a census map year, returns a census tract code (consisting of state, county, and tract codes) or an error message.
 
:Given a location hash (see [[Freeside:3:Documentation:Developer/FS/location Mixin|FS::location_Mixin]]) and a census map year, returns a census tract code (consisting of state, county, and tract codes) or an error message.
 
; get_district LOCATION METHOD
 
; get_district LOCATION METHOD
Line 21: Line 21:
 
Hey! '''The above document had some coding errors, which are explained below:'''
 
Hey! '''The above document had some coding errors, which are explained below:'''
  
; Around line 524:
+
; Around line 483:
 
:Unknown directive: =iten
 
:Unknown directive: =iten

Revision as of 05:46, 10 February 2015

NAME

FS::Misc::Geo - routines to fetch geographic information

CLASS METHODS

get_censustract_ffiec LOCATION YEAR
Given a location hash (see FS::location_Mixin) and a census map year, returns a census tract code (consisting of state, county, and tract codes) or an error message.
get_district LOCATION METHOD
For the location hash in LOCATION, using lookup method METHOD, fetch tax district information. Currently the only available method is 'wa_sales' (the Washington Department of Revenue sales tax lookup).
Returns a hash reference containing the following fields:
- district - tax (percentage) - taxname - exempt_amount (currently zero) - city, county, state, country (from
The intent is that you can assign this to an FS::cust_main_county object and insert it if there's not yet a tax rate defined for that district.
get_district will die on error.
Given 'address1' and 'address2' strings, extract the sublocation part (from either one) and return it. If the sublocation was found in ADDRESS1, also return ADDRESS2 (cleaned up for postal standards) as it's assumed to contain something relevant.

POD ERRORS

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

Around line 483:
Unknown directive: =iten