AuxiliaryAgreement
Class 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.
Attributes
| Name | Type | Description |
|---|---|---|
| arrearsInterest | PerCent | The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'. |
| auxCycle | String | 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. |
| auxPriorityCode | String | 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 | Money | 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 | Money | The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance. |
| payCycle | String | The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc. |
| subType | String | Sub-classification of the inherited 'type' for this AuxiliaryAgreement. |
| vendPortion | PerCent | 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 | PerCent | 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. |
Relationships
Ancestors
Descendents
No descendent classes
Associations
| Source Class | Source Cardinality | Target | Target Cardinality | Source Name | Source Assoc. Description | Target Name | Target Assoc. Description |
|---|---|---|---|---|---|---|---|
| AuxiliaryAgreement | 0..1 | AuxiliaryAccount | 1..* | AuxiliaryAgreement | Auxiliary agreement regulating this account. | AuxiliaryAccounts | All auxiliary accounts regulated by this agreement. |
| AuxiliaryAgreement | 0..* | CustomerAgreement | 0..1 | AuxiliaryAgreements | All (non-service related) auxiliary agreements that refer to this customer agreement. | CustomerAgreement | Customer agreement this (non-service related) auxiliary agreement refers to. |