Package CIM14 :: Package IEC61968 :: Package PaymentMetering :: Module AuxiliaryAgreement' :: Class AuxiliaryAgreement

Class AuxiliaryAgreement

                                  object --+                
                                           |                
                            Element'.Element --+            
                                               |            
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+        
                                                   |        
                           Common.Document'.Document --+    
                                                       |    
                             Common.Agreement'.Agreement --+
                                                           |
                                                          AuxiliaryAgreement

An ad-hoc auxiliary account agreement associated with a customer agreement, not part of the customer's account, but typically subject to formal agreement between customer and supplier (utility). Typically this is used to collect revenue owing by the customer for other services or arrears accrued with the utility for other services. It is typically linked to a prepaid token purchase transaction, thus forcing the customer to make a payment towards settlement of the auxiliary account balance whenever he needs to purchase a prepaid token for electricity. The present status of AuxiliaryAgreement can be defined in the context of the utility's business rules, for example: enabled, disabled, pending, over recovered, under recovered, written off, etc.

Instance Methods

[hide private]

__init__(self, arrearsInterest=0.0, vendPortion=0.0, minAmount=0.0, auxPriorityCode='', subCategory='', auxRef='', auxCycle='', vendPortionArrear=0.0, payCycle='', fixedAmount=0.0, AuxiliaryAccounts=None, CustomerAgreement=None, *args, **kw_args)
Initialises a new 'AuxiliaryAgreement' instance.

addAuxiliaryAccounts(self, *AuxiliaryAccounts)

getAuxiliaryAccounts(self)
All auxiliary accounts regulated by this agreement.

getCustomerAgreement(self)
Customer agreement this (non-service related) auxiliary agreement refers to.

removeAuxiliaryAccounts(self, *AuxiliaryAccounts)

setAuxiliaryAccounts(self, value)

setCustomerAgreement(self, value)

Inherited from Common.Document'.Document: addActivityRecords, addMeasurements, getActivityRecords, getMeasurements, removeActivityRecords, removeMeasurements, setActivityRecords, setMeasurements

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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

Class Variables

[hide private]

_attr_types = {'arrearsInterest': <type 'float'>, 'auxCycle': ...

_attrs = ['arrearsInterest', 'vendPortion', 'minAmount', 'auxP...

_defaults = {'arrearsInterest': 0.0, 'auxCycle': '', 'auxPrior...

_many_refs = ['AuxiliaryAccounts']

_refs = ['AuxiliaryAccounts', 'CustomerAgreement']

Inherited from Common.Agreement'.Agreement: validityInterval

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

Inherited from Element'.Element (private): _enums

Properties

[hide private]

AuxiliaryAccounts
All auxiliary accounts regulated by this agreement.

CustomerAgreement
Customer agreement this (non-service related) auxiliary agreement refers to.

Inherited from Common.Document'.Document: ActivityRecords, Measurements

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details

[hide private]

init(self, arrearsInterest=0.0, vendPortion=0.0, minAmount=0.0, auxPriorityCode=`''`, subCategory=`''`, auxRef=`''`, auxCycle=`''`, vendPortionArrear=0.0, payCycle=`''`, fixedAmount=0.0, AuxiliaryAccounts=None, CustomerAgreement=None, *args, **kw_args)
(Constructor)

Initialises a new 'AuxiliaryAgreement' instance.

Parameters:

arrearsInterest - The interest per annum to be charged prorata on AuxiliaryAccount.dueArrears at the end of each payCycle.
vendPortion - The percentage of the transaction amount that must be collected from each vending transaction towards settlement of this AuxiliaryAgreement when payments are not in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
minAmount - The minimum amount that must be paid at any transaction towards settling this AuxiliryAgreement or reducing the balance.
auxPriorityCode - The coded priority indicating the priority that this AuxiliaryAgreement has above other AuxiliaryAgreements (associated with the same customer agreement) when it comes to competing for settlement from a payment transaction or token purchase.
subCategory - Sub-category of this AuxiliaryAgreement as sub-classification of the inherited 'category'.
auxRef - A local reference to this AuxiliaryAgreement defined in the context of the implementation and not related to IdentifiedObject.mRID.
auxCycle - The frequency for automatically recurring auxiliary charges, where AuxiliaryAccount.initialCharge is recursively added to AuxiliaryAccount.dueCurrent at the start of each auxCycle. For example: on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.
vendPortionArrear - The percentage of the transaction amount that must be collected from each vending transaction towards settlement of this AuxiliaryAgreement when payments are in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
payCycle - The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.
fixedAmount - The fixed amount that must be collected from each vending transaction towards settlement of this AuxiliaryAgreement. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
AuxiliaryAccounts - All auxiliary accounts regulated by this agreement.
CustomerAgreement - Customer agreement this (non-service related) auxiliary agreement refers to.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'arrearsInterest': <type 'float'>,
 'auxCycle': <type 'str'>,
 'auxPriorityCode': <type 'str'>,
 'auxRef': <type 'str'>,
 'fixedAmount': <type 'float'>,
 'minAmount': <type 'float'>,
 'payCycle': <type 'str'>,
 'subCategory': <type 'str'>,
...

_attrs

Value:

['arrearsInterest',
 'vendPortion',
 'minAmount',
 'auxPriorityCode',
 'subCategory',
 'auxRef',
 'auxCycle',
 'vendPortionArrear',
...

_defaults

Value:

{'arrearsInterest': 0.0,
 'auxCycle': '',
 'auxPriorityCode': '',
 'auxRef': '',
 'fixedAmount': 0.0,
 'minAmount': 0.0,
 'payCycle': '',
 'subCategory': '',
...

Property Details

[hide private]

AuxiliaryAccounts

All auxiliary accounts regulated by this agreement.

Get Method:: getAuxiliaryAccounts(self) - All auxiliary accounts regulated by this agreement.
Set Method:: setAuxiliaryAccounts(self, value)

CustomerAgreement

Customer agreement this (non-service related) auxiliary agreement refers to.

Get Method:: getCustomerAgreement(self) - Customer agreement this (non-service related) auxiliary agreement refers to.
Set Method:: setCustomerAgreement(self, value)

Class AuxiliaryAgreement

__init__(self, arrearsInterest=0.0, vendPortion=0.0, minAmount=0.0, auxPriorityCode='', subCategory='', auxRef='', auxCycle='', vendPortionArrear=0.0, payCycle='', fixedAmount=0.0, AuxiliaryAccounts=None, CustomerAgreement=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

AuxiliaryAccounts

CustomerAgreement

init(self, arrearsInterest=0.0, vendPortion=0.0, minAmount=0.0, auxPriorityCode=`''`, subCategory=`''`, auxRef=`''`, auxCycle=`''`, vendPortionArrear=0.0, payCycle=`''`, fixedAmount=0.0, AuxiliaryAccounts=None, CustomerAgreement=None, *args, **kw_args)
(Constructor)