: Public Class
Created: 22/05/2008 00:21:57
Modified: 26/05/2016 16:02:38
Project:
Advanced:
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.<br/>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.<br/>
Attribute
Public PerCent
  arrearsInterest
Details:
Notes: The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.<br/><br/>
Public String
  auxCycle
Details:
Notes: 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.<br/><br/>
Public String
  auxPriorityCode
Details:
Notes: 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.<br/><br/>
Public Money
  fixedAmount
Details:
Notes: 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.<br/>
Public Money
  minAmount
Details:
Notes: The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.<br/>
Public String
  payCycle
Details:
Notes: The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.<br/>
Public String
  subType
Details:
Notes: Sub-classification of the inherited 'type' for this AuxiliaryAgreement.<br/><br/>
Public PerCent
  vendPortion
Details:
Notes: 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.<br/>
Public PerCent
  vendPortionArrear
Details:
Notes: 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.<br/>
Element Source Role Target Role
AuxiliaryAccount
Class  
Name: AuxiliaryAgreement
Auxiliary agreement regulating this account.
Name: AuxiliaryAccounts
All auxiliary accounts regulated by this agreement.
Details:
 
Element Source Role Target Role
CustomerAgreement
Class  
Name: CustomerAgreement
Customer agreement this (non-service related) auxiliary agreement refers to.
Name: AuxiliaryAgreements
All (non-service related) auxiliary agreements that refer to this customer agreement.
Details:
 
Object Type Connection Direction Notes
Agreement Class Generalization To