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 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.
Type |
Class |
|---|---|
URI |
|
CIM standard (perspective) |
IEC61968 (Enterprise) |
Slots
| Name | Cardinality | Type | Description |
|---|---|---|---|
1..* |
All auxiliary accounts regulated by this agreement. |
||
1 |
Dataset containing the data objects. |
||
0..1 |
Customer agreement this (non-service related) auxiliary agreement refers to. |
||
0..1 |
The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'. |
||
0..1 |
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. |
||
0..1 |
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. |
||
0..1 |
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. |
||
0..1 |
The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance. |
||
0..1 |
The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc. |
||
0..1 |
Sub-classification of the inherited 'type' for this AuxiliaryAgreement. |
||
0..1 |
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. |
||
0..1 |
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. |
||
0..1 |
Approver of this document. |
||
0..1 |
Author of this document. |
||
0..1 |
Editor of this document. |
||
0..1 |
Issuer of this document. |
||
0..1 |
The single CIM data object in the appropriate dataset context. |
||
0..1 |
The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time. |
||
0..1 |
Name of the author of this document. |
||
0..1 |
Free text comment. |
||
0..1 |
Date and time that this document was created. |
||
0..1 |
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. |
||
0..1 |
Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute. Example values for 'docStatus.status' are draft, approved, cancelled, etc. |
||
0..1 |
Electronic address. |
||
0..1 |
Date and time this document was last modified. Documents may potentially be modified many times during their lifetime. |
||
0..1 |
Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. |
||
0..1 |
The name is any free human readable and possibly non unique text naming the object. |
||
0..1 |
Revision number for this document. |
||
0..1 |
Date this agreement was consummated among associated persons and/or organisations. |
||
0..1 |
Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute. |
||
0..1 |
Document subject. |
||
0..1 |
Document title. |
||
0..1 |
Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.). |
||
0..1 |
Date and time interval this agreement is valid (from going into effect to termination). |
||
0..* |
The activity record for a document |
||
0..* |
All configuration events created for this document. |
||
0..* |
The diagram objects that are associated with the domain object. |
||
0..* |
All names of this identified object. |
||
0..* |
Data objects registered. |
ActivityRecord
The activity record for a document
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
aliasName
The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
arrearsInterest
The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
authorName
Name of the author of this document.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
AuxiliaryAccounts
All auxiliary accounts regulated by this agreement.
URI |
|
|---|---|
Cardinality |
1..* |
Type |
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.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
ConfigurationEvents
All configuration events created for this document.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
createdDateTime
Date and time that this document was created.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
CustomerAgreement
Customer agreement this (non-service related) auxiliary agreement refers to.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
description
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
DiagramObjects
The diagram objects that are associated with the domain object.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
docStatus
Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute. Example values for 'docStatus.status' are draft, approved, cancelled, etc.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
electronicAddress
Electronic address.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
InstanceSet
Dataset containing the data objects.
URI |
|
|---|---|
Cardinality |
1 |
Type |
|
Inherited from |
lastModifiedDateTime
Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
minAmount
The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
mRID
Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
name
The name is any free human readable and possibly non unique text naming the object.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
Names
All names of this identified object.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
payCycle
The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
PropertiesCIMDataObject
The single CIM data object in the appropriate dataset context.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
revisionNumber
Revision number for this document.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
signDate
Date this agreement was consummated among associated persons and/or organisations.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
status
Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
subType
Sub-classification of the inherited 'type' for this AuxiliaryAgreement.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
TargetingCIMDataObject
Data objects registered.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
type
Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
validityInterval
Date and time interval this agreement is valid (from going into effect to termination).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
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.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |