Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfCustomers :: Module CustomerBillingInfo' :: Class CustomerBillingInfo

[frames] | no frames]

Class CustomerBillingInfo

                         object --+            
                                  |            
                   Element'.Element --+        
                                      |        
Core.IdentifiedObject'.IdentifiedObject --+    
                                          |    
         IEC61968.Common.Document'.Document --+
                                              |
                                             CustomerBillingInfo

The creation of the monthly customer billing statements is the method employed to notify Customers of charges, adjustments and credits applied to their account for Services and Products. The actuall billing occurs through an ErpInvoice. The CustomerBillingInfo includes information from the payment, collection, meter reading, installed meter, service, site, customer, customer account, customer agreement, services and pricing subject areas. Each component price shows up as a separate line item on the ErpInvoice. The Customer Billing Statement may include collection and account messages, marketing/civic event messages and bill inserts. One Customer Billing Statement is produced for all Agreements under a CustomerAccount per billing cycle date defined in 'CustomerAccount.billingCycle'. The history of CustomerBillingInfo, Invoices and Payments is to be maintained in associated ActivityRecords.The creation of the monthly customer billing statements is the method employed to notify Customers of charges, adjustments and credits applied to their account for Services and Products. The actuall billing occurs through an ErpInvoice. The CustomerBillingInfo includes information from the payment, collection, meter reading, installed meter, service, site, customer, customer account, customer agreement, services and pricing subject areas. Each component price shows up as a separate line item on the ErpInvoice. The Customer Billing Statement may include collection and account messages, marketing/civic event messages and bill inserts. One Customer Billing Statement is produced for all Agreements under a CustomerAccount per billing cycle date defined in 'CustomerAccount.billingCycle'. The history of CustomerBillingInfo, Invoices and Payments is to be maintained in associated ActivityRecords.

Instance Methods

[hide private]

__init__(self, pymtPlanType='', kind='consolidatedUdc', pymtPlanAmt=0.0, lastPaymentAmt=0.0, dueDate='', outBalance=0.0, lastPaymentDate='', billingDate='', ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
Initialises a new 'CustomerBillingInfo' instance.

addErpInvoiceLineItems(self, *ErpInvoiceLineItems)

getCustomerAccount(self)

getErpInvoiceLineItems(self)

removeErpInvoiceLineItems(self, *ErpInvoiceLineItems)

setCustomerAccount(self, value)

setErpInvoiceLineItems(self, value)

Inherited from IEC61968.Common.Document'.Document: addActivityRecords, addAssetRoles, addChangeItems, addChangeSets, addErpOrganisationRoles, addErpPersonRoles, addFromDocumentRoles, addMeasurements, addNetworkDataSets, addPowerSystemResourceRoles, addScheduleParameterInfos, addScheduledEvents, addToDocumentRoles, getActivityRecords, getAssetRoles, getChangeItems, getChangeSets, getErpOrganisationRoles, getErpPersonRoles, getFromDocumentRoles, getMeasurements, getNetworkDataSets, getPowerSystemResourceRoles, getScheduleParameterInfos, getScheduledEvents, getToDocumentRoles, removeActivityRecords, removeAssetRoles, removeChangeItems, removeChangeSets, removeErpOrganisationRoles, removeErpPersonRoles, removeFromDocumentRoles, removeMeasurements, removeNetworkDataSets, removePowerSystemResourceRoles, removeScheduleParameterInfos, removeScheduledEvents, removeToDocumentRoles, setActivityRecords, setAssetRoles, setChangeItems, setChangeSets, setErpOrganisationRoles, setErpPersonRoles, setFromDocumentRoles, setMeasurements, setNetworkDataSets, setPowerSystemResourceRoles, setScheduleParameterInfos, setScheduledEvents, setToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_attr_types = {'billingDate': <type 'str'>, 'dueDate': <type '...

_attrs = ['pymtPlanType', 'kind', 'pymtPlanAmt', 'lastPaymentA...

_defaults = {'billingDate': '', 'dueDate': '', 'kind': 'consol...

_enums = {'kind': 'CustomerBillingKind'}

_many_refs = ['ErpInvoiceLineItems']

_refs = ['ErpInvoiceLineItems', 'CustomerAccount']

Inherited from IEC61968.Common.Document'.Document: docStatus, electronicAddress, status

Properties

[hide private]

CustomerAccount

ErpInvoiceLineItems

Inherited from IEC61968.Common.Document'.Document: ActivityRecords, AssetRoles, ChangeItems, ChangeSets, ErpOrganisationRoles, ErpPersonRoles, FromDocumentRoles, Measurements, NetworkDataSets, PowerSystemResourceRoles, ScheduleParameterInfos, ScheduledEvents, ToDocumentRoles

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details

[hide private]

init(self, pymtPlanType=`''`, kind=`'consolidatedUdc'`, pymtPlanAmt=0.0, lastPaymentAmt=0.0, dueDate=`''`, outBalance=0.0, lastPaymentDate=`''`, billingDate=`''`, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
(Constructor)

Initialises a new 'CustomerBillingInfo' instance.

Parameters:

pymtPlanType - Type of payment plan.
kind - Kind of bill customer receives. Values are: "consolidatedUdc", "other", "separateEssUdc", "consolidatedEss"
pymtPlanAmt - Monthly amortized amount due during each billing cycle for the CustomerAccount balance for which the Payment Plan is set-up.
lastPaymentAmt - Amount of the last payment received from the customer. It is retained in the Customer Billing system, although the details of each payment are tracked in the ERP system.
dueDate - Calculated date upon which a customer billing amount is due, used in the invoicing process to determine when a Customer's Payment is delinquent. It takes into consideration the regulatory criteria and the Customer's requested due date. In the absence of a Customer requested due date, the due date is typically calculated from the regulated number of days and the 'billingDate'.
outBalance - Outstanding balance on the CustomerAccount as of the statement date.
lastPaymentDate - Date of the last payment received from the customer. It is retained in the Customer Billing system, although the details of each payment are tracked in the ERP system.
billingDate - Business date designated for the billing run which produced this CustomerBillingInfo.
ErpInvoiceLineItems
CustomerAccount

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'billingDate': <type 'str'>,
 'dueDate': <type 'str'>,
 'kind': <type 'str'>,
 'lastPaymentAmt': <type 'float'>,
 'lastPaymentDate': <type 'str'>,
 'outBalance': <type 'float'>,
 'pymtPlanAmt': <type 'float'>,
 'pymtPlanType': <type 'str'>}

_attrs

Value:

['pymtPlanType',
 'kind',
 'pymtPlanAmt',
 'lastPaymentAmt',
 'dueDate',
 'outBalance',
 'lastPaymentDate',
 'billingDate']

_defaults

Value:

{'billingDate': '',
 'dueDate': '',
 'kind': 'consolidatedUdc',
 'lastPaymentAmt': 0.0,
 'lastPaymentDate': '',
 'outBalance': 0.0,
 'pymtPlanAmt': 0.0,
 'pymtPlanType': ''}

Property Details

[hide private]

CustomerAccount

Get Method:: getCustomerAccount(self)
Set Method:: setCustomerAccount(self, value)

ErpInvoiceLineItems

Get Method:: getErpInvoiceLineItems(self)
Set Method:: setErpInvoiceLineItems(self, value)

Class CustomerBillingInfo

__init__(self, pymtPlanType='', kind='consolidatedUdc', pymtPlanAmt=0.0, lastPaymentAmt=0.0, dueDate='', outBalance=0.0, lastPaymentDate='', billingDate='', ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

CustomerAccount

ErpInvoiceLineItems

init(self, pymtPlanType=`''`, kind=`'consolidatedUdc'`, pymtPlanAmt=0.0, lastPaymentAmt=0.0, dueDate=`''`, outBalance=0.0, lastPaymentDate=`''`, billingDate=`''`, ErpInvoiceLineItems=None, CustomerAccount=None, *args, **kw_args)
(Constructor)