Difference between revisions of "Freeside:3:Documentation:Developer/FS"
(Created page with "==NAME== FS - Freeside Perl modules ==SYNOPSIS== Freeside perl modules and CLI utilities. ===Utility classes=== FS::Schema - Fr…") |
m (Edit via perl MediaWiki framework (1.13)) |
||
(11 intermediate revisions by 2 users not shown) | |||
Line 79: | Line 79: | ||
[[Freeside:3:Documentation:Developer/FS/access groupagent|FS::access_groupagent]] - Group reseller access | [[Freeside:3:Documentation:Developer/FS/access groupagent|FS::access_groupagent]] - Group reseller access | ||
− | [[Freeside:3:Documentation:Developer/FS/access | + | [[Freeside:3:Documentation:Developer/FS/access right|FS::access_right]] - Access rights |
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/sched item|FS::sched_item]] - Installers / schedulable resources | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/sched avail|FS::sched_avail]] - Installer/resource availability | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc acct pop|FS::svc_acct_pop]] - POP (Point of Presence, not Post Office Protocol) class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pop local|FS::part_pop_local]] - Local calling area class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part referral|FS::part_referral]] - Referral class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pkg referral|FS::pkg_referral]] - Package referral class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main county|FS::cust_main_county]] - Locale (tax rate) class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust tax exempt|FS::cust_tax_exempt]] - Tax exemption record class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust tax adjustment|FS::cust_tax_adjustment]] - Tax adjustment record class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust tax exempt pkg|FS::cust_tax_exempt_pkg]] - Line-item specific tax exemption record class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc Common|FS::svc_Common]] - Service base class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc Parent Mixin|FS::svc_Parent_Mixin]] - Mixin class for svc_ classes with a parent_svcnum field | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc acct|FS::svc_acct]] - Account (shell, RADIUS, POP3) class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/acct snarf|FS::acct_snarf]] - External mail account class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/acct rt transaction|FS::acct_rt_transaction]] - Time worked application to account class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/radius usergroup|FS::radius_usergroup]] - RADIUS user group membership | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/radius group|FS::radius_group]] - RADIUS groups | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc domain|FS::svc_domain]] - Domain class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/domain record|FS::domain_record]] - DNS zone entries | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/registrar|FS::registrar]] - Domain registrar class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cgp rule|FS::cgp_rule]] - Communigate pro rule class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cgp rule condition|FS::cgp_rule_condition]] - Communigate pro rule condition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cgp rule action|FS::cgp_rule_action]] - Communigate pro rule action class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc forward|FS::svc_forward]] - Mail forwarding class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc mailinglist|FS::svc_mailinglist]] - (Customer) Mailing list class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/mailinglist|FS::mailinglist]] - Mailing list class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/mailinglistmember|FS::mailinglistmember]] - Mailing list member class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc www|FS::svc_www]] - Web virtual host class. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc broadband|FS::svc_broadband]] - DSL, wireless and other broadband class. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc dsl|FS::svc_dsl]] - DSL | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/dsl device|FS::dsl_device]] - DSL device MAC addresses | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/dsl note|FS::dsl_note]] - DSL order notes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/addr block|FS::addr_block]] - Address block class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/router|FS::router]] - Router class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/tower|FS::tower]] - Tower class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/tower sector|FS::tower_sector]] - Tower sector class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part virtual field|FS::part_virtual_field]] - Broadband virtual field class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc phone|FS::svc_phone]] - Phone service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/phone device|FS::phone_device]] - Phone device class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part device|FS::part_device]] - Device definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/phone avail|FS::phone_avail]] - Phone number availability cache | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/lata|FS::lata]] - LATA number to name mapping class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/msa|FS::msa]] - MSA number to name mapping class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate center|FS::rate_center]] - Rate center list (for bulk DID orders) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/did vendor|FS::did_vendor]] - Bulk DID order vendor class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/did order|FS::did_order]] - Bulk DID order class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/did order item|FS::did_order_item]] - Bulk DID order item class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cdr|FS::cdr]] - Call Detail Record class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cdr batch|FS::cdr_batch]] - Call Detail Record batch class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cdr calltype|FS::cdr_calltype]] - CDR calltype class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cdr carrier|FS::cdr_carrier]] - CDR carrier class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cdr type|FS::cdr_type]] - CDR type class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc external|FS::svc_external]] - Externally tracked service class. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc pbx|FS::svc_pbx]] - PBX service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pbx extension|FS::pbx_extension]] - PBX extension class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc cert|FS::svc_cert]] - Certificate service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc dish|FS::svc_dish]] - Dish network service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc cable|FS::svc_cable]] - Cable service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cable model|FS::cable_model]] - Cable-modem model class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cable provider|FS::cable_provider]] - Cable provider class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc alarm|FS::svc_alarm]] - Alarm service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/alarm system|FS::alarm_system]] - Alarm system class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/alarm type|FS::alarm_type]] - Alarm type (inputs and outputs) class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/alarm station|FS::alarm_station]] - Alarm central station class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/inventory class|FS::inventory_class]] - Inventory classes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/inventory item|FS::inventory_item]] - Inventory items | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part svc|FS::part_svc]] - Service definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part svc class|FS::part_svc_class]] - Service class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part svc column|FS::part_svc_column]] - Column constraint class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/export svc|FS::export_svc]] - Class linking service definitions (see [[Freeside:3:Documentation:Developer/FS/part svc|FS::part_svc]]) with exports (see [[Freeside:3:Documentation:Developer/FS/part export|FS::part_export]]) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part export|FS::part_export]] - External provisioning export class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part export option|FS::part_export_option]] - Export option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pkg category|FS::pkg_category]] - Package category class (invoice oriented) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pkg class|FS::pkg_class]] - Package class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]] - Package definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg msgcat|FS::part_pkg_msgcat]] - Package definition localization class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg link|FS::part_pkg_link]] - Package definition link class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg taxclass|FS::part_pkg_taxclass]] - Tax class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg option|FS::part_pkg_option]] - Package definition option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg report option|FS::part_pkg_report_option]] - Package reporting classification class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part pkg vendor|FS::part_pkg_vendor]] - Package external mapping class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pkg svc|FS::pkg_svc]] - Class linking package definitions (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]]) with service definitions (see [[Freeside:3:Documentation:Developer/FS/part svc|FS::part_svc]]) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/qual|FS::qual]] - Service qualification class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/qual option|FS::qual_option]] - Qualification option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/reg code|FS::reg_code]] - One-time registration codes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/reg code pkg|FS::reg_code_pkg]] - Class linking registration codes (see [[Freeside:3:Documentation:Developer/FS/reg code|FS::reg_code]]) with package definitions (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]]) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate|FS::rate]] - Rate plans for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate region|FS::rate_region]] - Rate regions for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate prefix|FS::rate_prefix]] - Rate region prefixes for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate detail|FS::rate_detail]] - Rate plan detail for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate tier|FS::rate_tier]] - Rate tiers for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/rate tier details|FS::rate_tier_details]] - Rater tier details for call billing | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/usage class|FS::usage_class]] - Usage class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/sales|FS::sales]] - Sales person class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/sales pkg class|FS::sales_pkg_class]] - Sales person package class commission class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/agent|FS::agent]] - Agent (reseller) class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/agent pkg class|FS::agent_pkg_class]] - Agent (reseller) package class commission class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/agent type|FS::agent_type]] - Agent type class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/type pkgs|FS::type_pkgs]] - Class linking agent types (see [[Freeside:3:Documentation:Developer/FS/agent type|FS::agent_type]]) with package definitions (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]]) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/payment gateway|FS::payment_gateway]] - Payment gateway class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/payment gateway option|FS::payment_gateway_option]] - Payment gateway option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/agent payment gateway|FS::agent_payment_gateway]] - Agent payment gateway class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust svc|FS::cust_svc]] - Service class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part export machine|FS::part_export_machine]] - Export hostname choice class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/svc export machine|FS::svc_export_machine]] - Customer export hostname class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pkg|FS::cust_pkg]] - Customer package class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pkg option|FS::cust_pkg_option]] - Customer package option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pkg detail|FS::cust_pkg_detail]] - Customer package details class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pkg discount|FS::cust_pkg_discount]] - Customer package discount class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pkg discount|FS::cust_bill_pkg_discount]] - Customer package discount line item application class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/discount|FS::discount]] - Discount class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/discount class|FS::discount_class]] - Discount class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/reason type|FS::reason_type]] - Reason type class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/reason|FS::reason]] - Reason class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pkg reason|FS::cust_pkg_reason]] - Package reason class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/contact class|FS::contact_class]] - Contact class class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/contact|FS::contact]] - Contact class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/contact phone|FS::contact_phone]] - Contact phone class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/phone type|FS::phone_type]] - Phone type class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/contact email|FS::contact_email]] - Contact email class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/prospect main|FS::prospect_main]] - Prospect class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main|FS::cust_main]] - Customer class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main/Billing|FS::cust_main::Billing]] - Customer billing class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main/Billing Realtime|FS::cust_main::Billing_Realtime]] - Customer real-time billing class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main/Packages|FS::cust_main::Packages]] - Customer packages class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust location|FS::cust_location]] - Customer location class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main Mixin|FS::cust_main_Mixin]] - Mixin class for records that contain fields from cust_main | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main invoice|FS::cust_main_invoice]] - Invoice destination class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main credit limit|FS::cust_main_credit_limit]] - Customer credit limit events class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust class|FS::cust_class]] - Customer classification class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust category|FS::cust_category]] - Customer category class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust tag|FS::cust_tag]] - Customer tag class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part tag|FS::part_tag]] - Tag definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main exemption|FS::cust_main_exemption]] - Customer tax exemption class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust main note|FS::cust_main_note]] - Customer note class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust note class|FS::cust_note_class]] - Customer note classification class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/banned pay|FS::banned_pay]] - Banned payment information class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill|FS::cust_bill]] - Invoice class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust statement|FS::cust_statement]] - Informational statement class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pkg|FS::cust_bill_pkg]] - Invoice line item class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pkg detail|FS::cust_bill_pkg_detail]] - Invoice line item detail class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/legacy cust bill|FS::legacy_cust_bill]] - Legacy data invoice class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part bill event|FS::part_bill_event]] - (Old) Invoice event definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill event|FS::cust_bill_event]] - (Old) Completed invoice event class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event|FS::part_event]] - (New) Billing event definition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event option|FS::part_event_option]] - (New) Billing event option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event/Condition|FS::part_event::Condition]] - (New) Billing event condition base class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event/Action|FS::part_event::Action]] - (New) Billing event action base class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event condition|FS::part_event_condition]] - (New) Billing event condition class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event condition option|FS::part_event_condition_option]] - (New) Billing event condition option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/part event condition option option|FS::part_event_condition_option_option]] - (New) Billing event condition compound option class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust event|FS::cust_event]] - (New) Customer event class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill ApplicationCommon|FS::cust_bill_ApplicationCommon]] - Base class for bill application classes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pay|FS::cust_pay]] - Payment class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pay pending|FS::cust_pay_pending]] - Pending payment class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pay void|FS::cust_pay_void]] - Voided payment class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]] - Payment application class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pay pkg|FS::cust_bill_pay_pkg]] - Line-item specific payment application class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust bill pay batch|FS::cust_bill_pay_batch]] - Batch payment application class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust credit|FS::cust_credit]] - Credit class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust refund|FS::cust_refund]] - Refund class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust credit refund|FS::cust_credit_refund]] - Refund application to credit class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]] - Credit application to invoice class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust credit bill pkg|FS::cust_credit_bill_pkg]] - Line-item specific credit application to invoice class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pay refund|FS::cust_pay_refund]] - Refund application to payment class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/pay batch|FS::pay_batch]] - Credit card transaction queue class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/cust pay batch|FS::cust_pay_batch]] - Credit card transaction member queue class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/prepay credit|FS::prepay_credit]] - Prepaid "calling card" credit class. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/nas|FS::nas]] - Network Access Server class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/port|FS::port]] - NAS port class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/session|FS::session]] - User login session class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/queue|FS::queue]] - Job queue | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/queue arg|FS::queue_arg]] - Job arguments | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/queue depend|FS::queue_depend]] - Job dependencies | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/queue stat|FS::queue_stat]] - Job statistics | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/msg template|FS::msg_template]] - Message templates (customer notices) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/msgcat|FS::msgcat]] - Message catalogs (error messages) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/clientapi session|FS::clientapi_session]] | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/clientapi session field|FS::clientapi_session_field]] | ||
+ | |||
+ | ===Historical database record classes=== | ||
+ | [[Freeside:3:Documentation:Developer/FS/h Common|FS::h_Common]] - History table base class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h cust pay|FS::h_cust_pay]] - Historical record of customer payment changes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h cust credit|FS::h_cust_credit]] - Historical record of customer credit changes | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h cust bill|FS::h_cust_bill]] - Historical record of customer tax changes (old-style) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h cust svc|FS::h_cust_svc]] - Object method for h_cust_svc objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h cust tax exempt|FS::h_cust_tax_exempt]] - Historical record of customer tax changes (old-style) | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h domain record|FS::h_domain_record]] - Historical DNS entry objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc acct|FS::h_svc_acct]] - Historical account objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc broadband|FS::h_svc_broadband]] - Historical broadband connection objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc cert|FS::h_svc_cert]] - Historical certificate services | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc dish|FS::h_svc_dish]] - Historical Dish Network services | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc domain|FS::h_svc_domain]] - Historical domain objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc dsl|FS::h_svc_dsl]] - Historical DSL objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc external|FS::h_svc_external]] - Historical externally tracked service objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc forward|FS::h_svc_forward]] - Historical mail forwarding alias objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc hardware|FS::h_svc_hardware]] - Historical isntalled hardware service objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc mailinglist|FS::h_svc_mailinglist]] - Historical mailing list objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc pbx|FS::h_svc_pbx]] - Historical PBX objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc phone|FS::h_svc_phone]] - Historical phone number objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc port|FS::h_svc_port]] - Historical port number objects | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/h svc www|FS::h_svc_www]] - Historical web virtual host objects | ||
+ | |||
+ | ===Remote API modules=== | ||
+ | [[Freeside:3:Documentation:Developer/FS/SelfService|FS::SelfService]] - Self-service API | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/SelfService/XMLRPC|FS::SelfService::XMLRPC]] - Self-service XML-RPC API | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/API|FS::API]] - Backoffice XML-RPC API | ||
+ | |||
+ | ===User Interface classes=== | ||
+ | [[Freeside:3:Documentation:Developer/FS/UI/Web|FS::UI::Web]] - Web user-interface class | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/FS/UI/bytecount|FS::UI::bytecount]] - Byte counter user-interface class | ||
+ | |||
+ | ===Command-line utilities=== | ||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-adduser|freeside-adduser]] - Command line interface to add (freeside) users. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-daily|freeside-daily]] - Run daily billing and collection events. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-monthly|freeside-monthly]] - Run monthly billing and invoice collection events. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-dbdef-create|freeside-dbdef-create]] - Recreate database schema cache | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-deluser|freeside-deluser]] - Command line interface to delete (freeside) users. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-expiration-alerter|freeside-expiration-alerter]] - Emails notifications of credit card expirations. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-email|freeside-email]] - Prints email addresses of all users on STDOUT | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-fetch|freeside-fetch]] - Send a freeside page to a list of employees. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-prepaidd|freeside-prepaidd]] - Real-time daemon for prepaid packages | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-prune-applications|freeside-prune-applications]] - Removes stray applications of credit, payment to bills, refunds, etc. | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-queued|freeside-queued]] - Job queue daemon | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-radgroup|freeside-radgroup]] - Command line utility to manipulate radius groups | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-reexport|freeside-reexport]] - Command line tool to re-trigger export jobs for existing services | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-reset-fixed|freeside-reset-fixed]] - Command line tool to set the fixed columns for existing services | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-sqlradius-dedup-group|freeside-sqlradius-dedup-group]] - Command line tool to eliminate duplicate usergroup entries from radius tables | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-sqlradius-radacctd|freeside-sqlradius-radacctd]] - Real-time radacct import daemon | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-sqlradius-reset|freeside-sqlradius-reset]] - Command line interface to reset and recreate RADIUS SQL tables | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-sqlradius-seconds|freeside-sqlradius-seconds]] - Command line time-online tool | ||
+ | |||
+ | [[Freeside:3:Documentation:Developer/bin/freeside-upgrade|freeside-upgrade]] - Upgrades database schema for new freeside verisons. | ||
+ | |||
+ | ==Notes== | ||
+ | To quote perl(1), "If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references." | ||
+ | |||
+ | If you've never used OO modules before, http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out. | ||
+ | |||
+ | ==DESCRIPTION== | ||
+ | Freeside is a billing and administration package for wired and wireless ISPs, VoIP, hosting, service and content providers and other online businesses. | ||
+ | |||
+ | The Freeside home page is at <http://freeside.biz/>. | ||
+ | |||
+ | The main documentation is at <http://freeside.biz/mediawiki>. | ||
+ | |||
+ | ==SUPPORT== | ||
+ | A mailing list for users is available. Send a blank message to <freeside-users-subscribe@freeside.biz> to subscribe. | ||
+ | |||
+ | A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <freeside-devel-subscribe@freeside.biz> to subscribe. | ||
+ | |||
+ | Commercial products and services are available; see <http://freeside.biz/freeside/products.html> and <http://freeside.biz/freeside/services.html>. | ||
+ | |||
+ | ==AUTHORS== | ||
+ | ===CORE TEAM=== | ||
+ | Jeremy Davis | ||
+ | |||
+ | Ivan Kohler | ||
+ | |||
+ | Mark Wells | ||
+ | |||
+ | ===CORE EMERITUS=== | ||
+ | Peter Bowen | ||
+ | |||
+ | Jeff Finucane | ||
+ | |||
+ | Jason Hall | ||
+ | |||
+ | Kristian Hoffman | ||
+ | |||
+ | Erik Levinson | ||
+ | |||
+ | Brian McCane | ||
+ | |||
+ | Richard Siddall | ||
+ | |||
+ | Matt Simerson | ||
+ | |||
+ | ===CONTRIBUTORS=== | ||
+ | See httemplate/docs/credits.html | ||
+ | |||
+ | ==SEE ALSO== | ||
+ | perl(1), main Freeside documentation at <http://freeside.biz/mediawiki/> | ||
+ | |||
+ | ==BUGS== | ||
+ | Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP... |
Latest revision as of 09:56, 10 April 2015
Contents
NAME
FS - Freeside Perl modules
SYNOPSIS
Freeside perl modules and CLI utilities.
Utility classes
FS::Schema - Freeside database schema
FS::Setup - Setup subroutines
FS::Upgrade - Upgrade subroutines
FS::Conf - Freeside configuration values
FS::ConfItem - Freeside configuration option meta-data.
FS::ConfDefaults - Freeside configuration default and available values
FS::UID - User class (not yet OO)
FS::CurrentUser - Package representing the current user
FS::CGI - Non OO-subroutines for the web interface.
FS::Locales - Locales
FS::Msgcat - Message catalog
FS::SearchCache - Search cache
FS::AccessRight - Access control rights.
FS::Report - Report data objects
FS::Report::Table - Report data objects
FS::Report::Table::Monthly - Report data objects
FS::XMLRPC - Backend XML::RPC server
FS::Misc - Miscellaneous subroutines
FS::payby - Payment types
FS::ClientAPI_SessionCache - ClientAPI session cache
FS::Pony - A pony
FS::cust_main::Search - Customer searching
FS::cust_main::Import - Batch customer importing
Database record classes
FS::Record - Database record base class
FS::m2m_Common - Mixin class for classes in a many-to-many relationship
FS::m2name_Common - Base class for tables with a related table listing names
FS::option_Common - Base class for option sub-classes
FS::class_Common - Base class for classification classes
FS::category_Common - Base class for category (grooups of classifications) classes
FS::conf - Configuration value class
FS::payinfo_Mixin - Mixin class for records in tables that contain payinfo.
FS::access_user - Employees / internal users
FS::access_user_pref - Employee preferences
FS::access_group - Employee groups
FS::access_usergroup - Employee group membership
FS::access_groupagent - Group reseller access
FS::access_right - Access rights
FS::sched_item - Installers / schedulable resources
FS::sched_avail - Installer/resource availability
FS::svc_acct_pop - POP (Point of Presence, not Post Office Protocol) class
FS::part_pop_local - Local calling area class
FS::part_referral - Referral class
FS::pkg_referral - Package referral class
FS::cust_main_county - Locale (tax rate) class
FS::cust_tax_exempt - Tax exemption record class
FS::cust_tax_adjustment - Tax adjustment record class
FS::cust_tax_exempt_pkg - Line-item specific tax exemption record class
FS::svc_Common - Service base class
FS::svc_Parent_Mixin - Mixin class for svc_ classes with a parent_svcnum field
FS::svc_acct - Account (shell, RADIUS, POP3) class
FS::acct_snarf - External mail account class
FS::acct_rt_transaction - Time worked application to account class
FS::radius_usergroup - RADIUS user group membership
FS::radius_group - RADIUS groups
FS::svc_domain - Domain class
FS::domain_record - DNS zone entries
FS::registrar - Domain registrar class
FS::cgp_rule - Communigate pro rule class
FS::cgp_rule_condition - Communigate pro rule condition class
FS::cgp_rule_action - Communigate pro rule action class
FS::svc_forward - Mail forwarding class
FS::svc_mailinglist - (Customer) Mailing list class
FS::mailinglist - Mailing list class
FS::mailinglistmember - Mailing list member class
FS::svc_www - Web virtual host class.
FS::svc_broadband - DSL, wireless and other broadband class.
FS::svc_dsl - DSL
FS::dsl_device - DSL device MAC addresses
FS::dsl_note - DSL order notes
FS::addr_block - Address block class
FS::router - Router class
FS::tower - Tower class
FS::tower_sector - Tower sector class
FS::part_virtual_field - Broadband virtual field class
FS::svc_phone - Phone service class
FS::phone_device - Phone device class
FS::part_device - Device definition class
FS::phone_avail - Phone number availability cache
FS::lata - LATA number to name mapping class
FS::msa - MSA number to name mapping class
FS::rate_center - Rate center list (for bulk DID orders)
FS::did_vendor - Bulk DID order vendor class
FS::did_order - Bulk DID order class
FS::did_order_item - Bulk DID order item class
FS::cdr - Call Detail Record class
FS::cdr_batch - Call Detail Record batch class
FS::cdr_calltype - CDR calltype class
FS::cdr_carrier - CDR carrier class
FS::cdr_type - CDR type class
FS::svc_external - Externally tracked service class.
FS::svc_pbx - PBX service class
FS::pbx_extension - PBX extension class
FS::svc_cert - Certificate service class
FS::svc_dish - Dish network service class
FS::svc_cable - Cable service class
FS::cable_model - Cable-modem model class
FS::cable_provider - Cable provider class
FS::svc_alarm - Alarm service class
FS::alarm_system - Alarm system class
FS::alarm_type - Alarm type (inputs and outputs) class
FS::alarm_station - Alarm central station class
FS::inventory_class - Inventory classes
FS::inventory_item - Inventory items
FS::part_svc - Service definition class
FS::part_svc_class - Service class class
FS::part_svc_column - Column constraint class
FS::export_svc - Class linking service definitions (see FS::part_svc) with exports (see FS::part_export)
FS::part_export - External provisioning export class
FS::part_export_option - Export option class
FS::pkg_category - Package category class (invoice oriented)
FS::pkg_class - Package class class
FS::part_pkg - Package definition class
FS::part_pkg_msgcat - Package definition localization class
FS::part_pkg_link - Package definition link class
FS::part_pkg_taxclass - Tax class class
FS::part_pkg_option - Package definition option class
FS::part_pkg_report_option - Package reporting classification class
FS::part_pkg_vendor - Package external mapping class
FS::pkg_svc - Class linking package definitions (see FS::part_pkg) with service definitions (see FS::part_svc)
FS::qual - Service qualification class
FS::qual_option - Qualification option class
FS::reg_code - One-time registration codes
FS::reg_code_pkg - Class linking registration codes (see FS::reg_code) with package definitions (see FS::part_pkg)
FS::rate - Rate plans for call billing
FS::rate_region - Rate regions for call billing
FS::rate_prefix - Rate region prefixes for call billing
FS::rate_detail - Rate plan detail for call billing
FS::rate_tier - Rate tiers for call billing
FS::rate_tier_details - Rater tier details for call billing
FS::usage_class - Usage class class
FS::sales - Sales person class
FS::sales_pkg_class - Sales person package class commission class
FS::agent - Agent (reseller) class
FS::agent_pkg_class - Agent (reseller) package class commission class
FS::agent_type - Agent type class
FS::type_pkgs - Class linking agent types (see FS::agent_type) with package definitions (see FS::part_pkg)
FS::payment_gateway - Payment gateway class
FS::payment_gateway_option - Payment gateway option class
FS::agent_payment_gateway - Agent payment gateway class
FS::cust_svc - Service class
FS::part_export_machine - Export hostname choice class
FS::svc_export_machine - Customer export hostname class
FS::cust_pkg - Customer package class
FS::cust_pkg_option - Customer package option class
FS::cust_pkg_detail - Customer package details class
FS::cust_pkg_discount - Customer package discount class
FS::cust_bill_pkg_discount - Customer package discount line item application class
FS::discount - Discount class
FS::discount_class - Discount class class
FS::reason_type - Reason type class
FS::reason - Reason class
FS::cust_pkg_reason - Package reason class
FS::contact_class - Contact class class
FS::contact - Contact class
FS::contact_phone - Contact phone class
FS::phone_type - Phone type class
FS::contact_email - Contact email class
FS::prospect_main - Prospect class
FS::cust_main - Customer class
FS::cust_main::Billing - Customer billing class
FS::cust_main::Billing_Realtime - Customer real-time billing class
FS::cust_main::Packages - Customer packages class
FS::cust_location - Customer location class
FS::cust_main_Mixin - Mixin class for records that contain fields from cust_main
FS::cust_main_invoice - Invoice destination class
FS::cust_main_credit_limit - Customer credit limit events class
FS::cust_class - Customer classification class
FS::cust_category - Customer category class
FS::cust_tag - Customer tag class
FS::part_tag - Tag definition class
FS::cust_main_exemption - Customer tax exemption class
FS::cust_main_note - Customer note class
FS::cust_note_class - Customer note classification class
FS::banned_pay - Banned payment information class
FS::cust_bill - Invoice class
FS::cust_statement - Informational statement class
FS::cust_bill_pkg - Invoice line item class
FS::cust_bill_pkg_detail - Invoice line item detail class
FS::legacy_cust_bill - Legacy data invoice class
FS::part_bill_event - (Old) Invoice event definition class
FS::cust_bill_event - (Old) Completed invoice event class
FS::part_event - (New) Billing event definition class
FS::part_event_option - (New) Billing event option class
FS::part_event::Condition - (New) Billing event condition base class
FS::part_event::Action - (New) Billing event action base class
FS::part_event_condition - (New) Billing event condition class
FS::part_event_condition_option - (New) Billing event condition option class
FS::part_event_condition_option_option - (New) Billing event condition compound option class
FS::cust_event - (New) Customer event class
FS::cust_bill_ApplicationCommon - Base class for bill application classes
FS::cust_pay - Payment class
FS::cust_pay_pending - Pending payment class
FS::cust_pay_void - Voided payment class
FS::cust_bill_pay - Payment application class
FS::cust_bill_pay_pkg - Line-item specific payment application class
FS::cust_bill_pay_batch - Batch payment application class
FS::cust_credit - Credit class
FS::cust_refund - Refund class
FS::cust_credit_refund - Refund application to credit class
FS::cust_credit_bill - Credit application to invoice class
FS::cust_credit_bill_pkg - Line-item specific credit application to invoice class
FS::cust_pay_refund - Refund application to payment class
FS::pay_batch - Credit card transaction queue class
FS::cust_pay_batch - Credit card transaction member queue class
FS::prepay_credit - Prepaid "calling card" credit class.
FS::nas - Network Access Server class
FS::port - NAS port class
FS::session - User login session class
FS::queue - Job queue
FS::queue_arg - Job arguments
FS::queue_depend - Job dependencies
FS::queue_stat - Job statistics
FS::msg_template - Message templates (customer notices)
FS::msgcat - Message catalogs (error messages)
Historical database record classes
FS::h_Common - History table base class
FS::h_cust_pay - Historical record of customer payment changes
FS::h_cust_credit - Historical record of customer credit changes
FS::h_cust_bill - Historical record of customer tax changes (old-style)
FS::h_cust_svc - Object method for h_cust_svc objects
FS::h_cust_tax_exempt - Historical record of customer tax changes (old-style)
FS::h_domain_record - Historical DNS entry objects
FS::h_svc_acct - Historical account objects
FS::h_svc_broadband - Historical broadband connection objects
FS::h_svc_cert - Historical certificate services
FS::h_svc_dish - Historical Dish Network services
FS::h_svc_domain - Historical domain objects
FS::h_svc_dsl - Historical DSL objects
FS::h_svc_external - Historical externally tracked service objects
FS::h_svc_forward - Historical mail forwarding alias objects
FS::h_svc_hardware - Historical isntalled hardware service objects
FS::h_svc_mailinglist - Historical mailing list objects
FS::h_svc_pbx - Historical PBX objects
FS::h_svc_phone - Historical phone number objects
FS::h_svc_port - Historical port number objects
FS::h_svc_www - Historical web virtual host objects
Remote API modules
FS::SelfService - Self-service API
FS::SelfService::XMLRPC - Self-service XML-RPC API
FS::API - Backoffice XML-RPC API
User Interface classes
FS::UI::Web - Web user-interface class
FS::UI::bytecount - Byte counter user-interface class
Command-line utilities
freeside-adduser - Command line interface to add (freeside) users.
freeside-daily - Run daily billing and collection events.
freeside-monthly - Run monthly billing and invoice collection events.
freeside-dbdef-create - Recreate database schema cache
freeside-deluser - Command line interface to delete (freeside) users.
freeside-expiration-alerter - Emails notifications of credit card expirations.
freeside-email - Prints email addresses of all users on STDOUT
freeside-fetch - Send a freeside page to a list of employees.
freeside-prepaidd - Real-time daemon for prepaid packages
freeside-prune-applications - Removes stray applications of credit, payment to bills, refunds, etc.
freeside-queued - Job queue daemon
freeside-radgroup - Command line utility to manipulate radius groups
freeside-reexport - Command line tool to re-trigger export jobs for existing services
freeside-reset-fixed - Command line tool to set the fixed columns for existing services
freeside-sqlradius-dedup-group - Command line tool to eliminate duplicate usergroup entries from radius tables
freeside-sqlradius-radacctd - Real-time radacct import daemon
freeside-sqlradius-reset - Command line interface to reset and recreate RADIUS SQL tables
freeside-sqlradius-seconds - Command line time-online tool
freeside-upgrade - Upgrades database schema for new freeside verisons.
Notes
To quote perl(1), "If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references."
If you've never used OO modules before, http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
DESCRIPTION
Freeside is a billing and administration package for wired and wireless ISPs, VoIP, hosting, service and content providers and other online businesses.
The Freeside home page is at <http://freeside.biz/>.
The main documentation is at <http://freeside.biz/mediawiki>.
SUPPORT
A mailing list for users is available. Send a blank message to <freeside-users-subscribe@freeside.biz> to subscribe.
A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <freeside-devel-subscribe@freeside.biz> to subscribe.
Commercial products and services are available; see <http://freeside.biz/freeside/products.html> and <http://freeside.biz/freeside/services.html>.
AUTHORS
CORE TEAM
Jeremy Davis
Ivan Kohler
Mark Wells
CORE EMERITUS
Peter Bowen
Jeff Finucane
Jason Hall
Kristian Hoffman
Erik Levinson
Brian McCane
Richard Siddall
Matt Simerson
CONTRIBUTORS
See httemplate/docs/credits.html
SEE ALSO
perl(1), main Freeside documentation at <http://freeside.biz/mediawiki/>
BUGS
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...