IEC61968::PaymentMetering::AuxiliaryAgreement Class Reference

#include <AuxiliaryAgreement.h>

Inheritance diagram for IEC61968::PaymentMetering::AuxiliaryAgreement:

Collaboration diagram for IEC61968::PaymentMetering::AuxiliaryAgreement:

Public Attributes
IEC61970::Base::Domain::PerCent	arrearsInterest
IEC61970::Base::Domain::String	auxCycle
IEC61970::Base::Domain::String	auxPriorityCode
IEC61970::Base::Domain::Money	fixedAmount
IEC61970::Base::Domain::Money	minAmount
IEC61970::Base::Domain::String	payCycle
IEC61970::Base::Domain::String	subType
IEC61970::Base::Domain::PerCent	vendPortion
IEC61970::Base::Domain::PerCent	vendPortionArrear
std::list< IEC61968::PaymentMetering::AuxiliaryAccount * >	AuxiliaryAccounts
Public Attributes inherited from IEC61968::Common::Agreement
IEC61970::Base::Domain::Date	signDate
IEC61970::Base::Domain::DateTimeInterval	validityInterval
Public Attributes inherited from IEC61968::Common::Document
IEC61970::Base::Domain::String	authorName
IEC61970::Base::Domain::String	comment
IEC61970::Base::Domain::DateTime	createdDateTime
IEC61968::Common::Status	docStatus
IEC61968::Common::ElectronicAddress	electronicAddress
IEC61970::Base::Domain::DateTime	lastModifiedDateTime
IEC61970::Base::Domain::String	revisionNumber
IEC61968::Common::Status	status
IEC61970::Base::Domain::String	subject
IEC61970::Base::Domain::String	title
IEC61970::Base::Domain::String	type
std::list< IEC61968::Common::ConfigurationEvent * >	ConfigurationEvents
Public Attributes inherited from IEC61970::Base::Core::IdentifiedObject
IEC61970::Base::Domain::String	aliasName
IEC61970::Base::Domain::String	description
IEC61970::Base::Domain::String	mRID
IEC61970::Base::Domain::String	name
std::list< IEC61970::Base::DiagramLayout::DiagramObject * >	DiagramObjects

Detailed Description

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 owed 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 the customer needs to purchase a prepaid token for electricity. The present status of the auxiliary agreement can be defined in the context of the utility's business rules, for example: enabled, disabled, pending, over recovered, under recovered, written off, etc.

Member Data Documentation

arrearsInterest

IEC61970::Base::Domain::PerCent IEC61968::PaymentMetering::AuxiliaryAgreement::arrearsInterest

The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.

auxCycle

IEC61970::Base::Domain::String IEC61968::PaymentMetering::AuxiliaryAgreement::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.

AuxiliaryAccounts

std::list<IEC61968::PaymentMetering::AuxiliaryAccount*> IEC61968::PaymentMetering::AuxiliaryAgreement::AuxiliaryAccounts

All auxiliary accounts regulated by this agreement.

auxPriorityCode

IEC61970::Base::Domain::String IEC61968::PaymentMetering::AuxiliaryAgreement::auxPriorityCode

The coded priority indicating the priority that this auxiliary agreement has above other auxiliary agreements (associated with the same customer agreement) when it comes to competing for settlement from a payment transaction or token purchase.

fixedAmount

IEC61970::Base::Domain::Money IEC61968::PaymentMetering::AuxiliaryAgreement::fixedAmount

The fixed amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

minAmount

IEC61970::Base::Domain::Money IEC61968::PaymentMetering::AuxiliaryAgreement::minAmount

The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.

payCycle

IEC61970::Base::Domain::String IEC61968::PaymentMetering::AuxiliaryAgreement::payCycle

The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.

subType

IEC61970::Base::Domain::String IEC61968::PaymentMetering::AuxiliaryAgreement::subType

Sub-classification of the inherited 'type' for this AuxiliaryAgreement.

vendPortion

IEC61970::Base::Domain::PerCent IEC61968::PaymentMetering::AuxiliaryAgreement::vendPortion

The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are not in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

vendPortionArrear

IEC61970::Base::Domain::PerCent IEC61968::PaymentMetering::AuxiliaryAgreement::vendPortionArrear

The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.

---

The documentation for this class was generated from the following files:

• /home/lukas/acs/gits/CIM/16v29a_12v08/refactored/IEC61968/PaymentMetering/AuxiliaryAgreement.h
• /home/lukas/acs/gits/CIM/16v29a_12v08/refactored/IEC61968/PaymentMetering/AuxiliaryAgreement.cpp