CustomerAgreement
Agreement between the customer and the service supplier to pay for service at a specific service location. It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.
Type |
Class |
|---|---|
URI |
|
CIM standard (perspective) |
IEC61968 (Enterprise) |
Slots
| Name | Cardinality | Type | Description |
|---|---|---|---|
1 |
Customer for this agreement. |
||
1 |
Customer account owning this agreement. |
||
1 |
Service supplier for this customer agreement. |
||
1 |
Dataset containing the data objects. |
||
0..1 |
Meter read schedule that applies to the customer agreement |
||
0..1 |
Service category for this agreement. |
||
0..1 |
n/a |
||
0..1 |
If true, the customer is a pre-pay customer for the specified service. |
||
0..1 |
Load management code. |
||
0..1 |
Final date and time the service will be billed to the previous customer. |
||
0..* |
All (non-service related) auxiliary agreements that refer to this customer agreement. |
||
0..* |
All demand response programs the customer is enrolled in through this customer agreement. |
||
0..* |
(could be deprecated in the future) All meter readings for this customer agreement. |
||
0..* |
All pricing structures applicable to this customer agreement. |
||
0..* |
All service locations regulated by this customer agreement. |
||
0..* |
All service delivery points regulated by this customer agreement. |
||
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 |
authorName
Name of the author of this document.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
AuxiliaryAgreements
All (non-service related) auxiliary agreements that refer to this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
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 |
CustomerAccount
Customer account owning this agreement.
URI |
|
|---|---|
Cardinality |
1 |
Type |
DemandResponsePrograms
All demand response programs the customer is enrolled in through this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
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 |
InstanceSet
Dataset containing the data objects.
URI |
|
|---|---|
Cardinality |
1 |
Type |
|
Inherited from |
isPrePay
If true, the customer is a pre-pay customer for the specified service.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
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 |
MeterReadings
(could be deprecated in the future) All meter readings for this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
MeterReadSchedule
Meter read schedule that applies to the customer agreement
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 |
PricingStructures
All pricing structures applicable to this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
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 |
ServiceCategory
Service category for this agreement.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
ServiceLocations
All service locations regulated by this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
ServiceSupplier
Service supplier for this customer agreement.
URI |
|
|---|---|
Cardinality |
1 |
Type |
shutOffDateTime
Final date and time the service will be billed to the previous customer.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
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 |
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 |
UsagePoints
All service delivery points regulated by this customer agreement.
URI |
|
|---|---|
Cardinality |
0..* |
Type |