Difference between revisions of "Customer:OnPac"

From Freeside
Jump to: navigation, search
(Billing)
m (Reverted edits by Marjie2010 (Talk); changed back to last version by Ivan)
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= Schema changes =
+
== Schema changes ==
  
 
* Add '''usage_elec''' table and class (see [[Freeside:1.7:Documentation:Developer:Schema_changes|Schema Changes]])
 
* Add '''usage_elec''' table and class (see [[Freeside:1.7:Documentation:Developer:Schema_changes|Schema Changes]])
Line 8: Line 8:
 
** '''svcnum''' int NULL (''svc_external.id contains ESIID'')
 
** '''svcnum''' int NULL (''svc_external.id contains ESIID'')
  
= Usage import =
+
  Files to create: FS/FS/usage_elec.pm, FS/t/usage_elec.t
 +
                  (skeleton of these new files is autogenerated, see "Schema Changes" documentatinon link above)
 +
  Files to edit: FS/FS/Schema.pm
  
* Import usage charges into '''usage_elec''' table (Usage charges)
+
== Usage import ==
** Add import subroutine to usage_elec.pm
 
** Add page to web UI to accept upload
 
*** Needs to accept file first, add job to job queue for import/billing loop
 
*** Landing page that shows job progress via the JS progress popup (like service definition add/edit)
 
** Add menu entry and ACL for new page ''Tools->Importing->Import electricity usage from CSV file''
 
* Associate usage charges with specific customer/package (Static mapping)
 
* Trigger billing for that customer package (Billing)
 
  
== Usage charges ==
+
=== Overview ===
 +
 
 +
==== Import usage charges into '''usage_elec''' table (Usage charges)====
 +
 
 +
* Add import subroutine to usage_elec.pm
 +
 
 +
  Files to edit: FS/FS/usage_elec.pm
 +
 
 +
* Add page to web UI to accept upload
 +
** Needs to accept file first, add job to job queue for import/billing loop
 +
** Landing page that shows job progress via the JS progress popup (like service definition add/edit)
 +
 
 +
  Files to create: httemplate/misc/usage_elec-import.html, httemplate/misc/process/usage_elec-import.html
 +
  Files to edit: FS/FS/usage_elec.pm
 +
 
 +
* Add menu entry and ACL for new page ''Tools->Importing->Import electricity usage from CSV file''
 +
 
 +
  Files to edit: httemplate/elements/menu.html
 +
 
 +
==== Associate usage charges with specific customer/package (Static mapping) ====
 +
 
 +
====  Trigger billing for that customer package (Billing) ====
 +
 
 +
* Usage charges via new rate plan below
 +
* TDSP as a one-time charge ( cust_main->charge($amount, 'TDSP') )
 +
 
 +
  Files to edit: FS/FS/usage_elec.pm
 +
 
 +
=== Usage charges ===
  
 
* '''KW''' -> usage_elec.kwatts
 
* '''KW''' -> usage_elec.kwatts
Line 25: Line 48:
 
* '''TDSP - PASS THRU CHARGE''' -> usage_elec.tdsp
 
* '''TDSP - PASS THRU CHARGE''' -> usage_elec.tdsp
  
== Static mapping ==
+
=== Static mapping ===
  
 
* '''ESIID''' -> svc_external.id (associates with package and customer)
 
* '''ESIID''' -> svc_external.id (associates with package and customer)
Line 31: Line 54:
 
* '''CUSTOMER ACCOUNT''' -> cust_main.agent_custid (sanity check with customer via ESIID)
 
* '''CUSTOMER ACCOUNT''' -> cust_main.agent_custid (sanity check with customer via ESIID)
  
== Billing ==
+
=== Billing ===
  
 
* Add a rate plan to bill on demand, triggered by the import (FS::part_pkg::usage_elec.pm) (see [[Freeside:1.7:Documentation:Developer:Price_Plans|Price plans]])
 
* Add a rate plan to bill on demand, triggered by the import (FS::part_pkg::usage_elec.pm) (see [[Freeside:1.7:Documentation:Developer:Price_Plans|Price plans]])
* Calculate Kw difference & multiply by a rate (rate stored in part_pkg_option)
+
* Calculate Kw difference from previous usage_elec record for this meter/ESIID & multiply by a rate
* Pass through the desired details as cust_bill_pkg_detail
+
** rate stored in as package definition option in part_pkg_option (defined in FS::part_pkg::usage_elec %info hash)
 +
 
 +
  Files to create: FS/FS/part_pkg/usage_elec.pm
 +
 
 +
* Set dates via usage_elec record rather than via frequency
 +
** Add an optional FS::part_pkg::XXX method that indicates internal date increment calculation by the price plan
 +
** Have cust_main::bill method use the package method to control date incrementing, if it exists
 +
 
 +
  Files to edit: FS/FS/part_pkg.pm, FS/FS/cust_main.pm
  
== Add'l field handling ==
+
* Invoicing
 +
** service from -> cust_bill_pkg.sdate
 +
** service to -> cust_bill_pkg.edate
 +
** Number days -> (edate - date) -> added to cust_bill_pkg_detail
 +
** Rate -> stored in a part_pkg_option -> added to cust_bill_pkg_detail
 +
** Previous read (from previous usage_elec.kwatts) -> Added to cust_bill_pkg_detail
 +
** Current read (from current usage_elec.kwatts) -> Added to cust_bill_pkg_detail
 +
** Usage in Kwh (difference) -> Added to cust_bill_pkg_detail
 +
** multipler - ''store this as an additional part_pkg_option?  use it for rate calculation and pass through to cust_bill_pkg_detail to display on invoice''
 +
 
 +
  Files to edit: FS/FS/part_pkg/usage_elec.pm
 +
 
 +
=== Add'l field handling in import ===
  
 
Handle these additional fields:
 
Handle these additional fields:
Line 44: Line 87:
 
** Add new cust_bill column to store per-invoice due dates
 
** Add new cust_bill column to store per-invoice due dates
 
** Have import associate this with the bills it triggers
 
** Have import associate this with the bills it triggers
 +
 +
  Files to edit: FS/FS/Schema.pm, FS/FS/cust_bill.pm, FS/FS/part_pkg/usage_elec.pm
  
 
* '''Invoice number''' -> need to store/use somehow instead of autogenerated invoice number?
 
* '''Invoice number''' -> need to store/use somehow instead of autogenerated invoice number?
Line 49: Line 94:
 
** Use this field when displaying instead of the internal invoice # (option to turn on)
 
** Use this field when displaying instead of the internal invoice # (option to turn on)
 
** Search this field exclusively when searching for invoice numbers (option to turn on)
 
** Search this field exclusively when searching for invoice numbers (option to turn on)
 +
 +
  Files to edit: FS/FS/Schema.pm, FS/FS/cust_bill.pm, httemplate/search/cust_bill.html
  
 
* '''Cross reference''' -> what is this for?
 
* '''Cross reference''' -> what is this for?
 +
 +
= Add'l charge handling =
 +
 +
Determine precisely how each of these fees are charged, spec & write any necessary code
 +
 +
* Energy base
 +
* GR Fee
 +
* Taxes

Latest revision as of 06:23, 7 September 2010

Schema changes

  • Add usage_elec table and class (see Schema Changes)
    • id serial primary_key
    • _date @date_type
    • kwatts int
    • tdsp @money_type
    • svcnum int NULL (svc_external.id contains ESIID)
 Files to create: FS/FS/usage_elec.pm, FS/t/usage_elec.t
                  (skeleton of these new files is autogenerated, see "Schema Changes" documentatinon link above)
 Files to edit: FS/FS/Schema.pm

Usage import

Overview

Import usage charges into usage_elec table (Usage charges)

  • Add import subroutine to usage_elec.pm
 Files to edit: FS/FS/usage_elec.pm
  • Add page to web UI to accept upload
    • Needs to accept file first, add job to job queue for import/billing loop
    • Landing page that shows job progress via the JS progress popup (like service definition add/edit)
 Files to create: httemplate/misc/usage_elec-import.html, httemplate/misc/process/usage_elec-import.html
 Files to edit: FS/FS/usage_elec.pm
  • Add menu entry and ACL for new page Tools->Importing->Import electricity usage from CSV file
 Files to edit: httemplate/elements/menu.html

Associate usage charges with specific customer/package (Static mapping)

Trigger billing for that customer package (Billing)

  • Usage charges via new rate plan below
  • TDSP as a one-time charge ( cust_main->charge($amount, 'TDSP') )
 Files to edit: FS/FS/usage_elec.pm

Usage charges

  • KW -> usage_elec.kwatts
  • Invoice date -> usage_elec._date
  • TDSP - PASS THRU CHARGE -> usage_elec.tdsp

Static mapping

  • ESIID -> svc_external.id (associates with package and customer)
  • CUSTOMER NAME -> informational only, or sanity check w/ Freeside data
  • CUSTOMER ACCOUNT -> cust_main.agent_custid (sanity check with customer via ESIID)

Billing

  • Add a rate plan to bill on demand, triggered by the import (FS::part_pkg::usage_elec.pm) (see Price plans)
  • Calculate Kw difference from previous usage_elec record for this meter/ESIID & multiply by a rate
    • rate stored in as package definition option in part_pkg_option (defined in FS::part_pkg::usage_elec %info hash)
 Files to create: FS/FS/part_pkg/usage_elec.pm
  • Set dates via usage_elec record rather than via frequency
    • Add an optional FS::part_pkg::XXX method that indicates internal date increment calculation by the price plan
    • Have cust_main::bill method use the package method to control date incrementing, if it exists
 Files to edit: FS/FS/part_pkg.pm, FS/FS/cust_main.pm
  • Invoicing
    • service from -> cust_bill_pkg.sdate
    • service to -> cust_bill_pkg.edate
    • Number days -> (edate - date) -> added to cust_bill_pkg_detail
    • Rate -> stored in a part_pkg_option -> added to cust_bill_pkg_detail
    • Previous read (from previous usage_elec.kwatts) -> Added to cust_bill_pkg_detail
    • Current read (from current usage_elec.kwatts) -> Added to cust_bill_pkg_detail
    • Usage in Kwh (difference) -> Added to cust_bill_pkg_detail
    • multipler - store this as an additional part_pkg_option? use it for rate calculation and pass through to cust_bill_pkg_detail to display on invoice
 Files to edit: FS/FS/part_pkg/usage_elec.pm

Add'l field handling in import

Handle these additional fields:

  • Handle Due Date
    • Add new cust_bill column to store per-invoice due dates
    • Have import associate this with the bills it triggers
 Files to edit: FS/FS/Schema.pm, FS/FS/cust_bill.pm, FS/FS/part_pkg/usage_elec.pm
  • Invoice number -> need to store/use somehow instead of autogenerated invoice number?
    • Add new cust_bill column if necessary (cust_bill.agent_invoiceid)
    • Use this field when displaying instead of the internal invoice # (option to turn on)
    • Search this field exclusively when searching for invoice numbers (option to turn on)
 Files to edit: FS/FS/Schema.pm, FS/FS/cust_bill.pm, httemplate/search/cust_bill.html
  • Cross reference -> what is this for?

Add'l charge handling

Determine precisely how each of these fees are charged, spec & write any necessary code

  • Energy base
  • GR Fee
  • Taxes