PricingStructure

Grouping of pricing components and prices used in the creation of customer charges and the eligibility criteria under which these terms may be offered to a customer. The reasons for grouping include state, customer classification, site characteristics, classification (i.e. fee price structure, deposit price structure, electric service price structure, etc.) and accounting requirements.

Type

Class

URI

cim:PricingStructure

CIM standard (perspective)

IEC61968 (Enterprise)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

ServiceCategory

1

ServiceCategory

Service category to which this pricing structure applies.

InstanceSet

1

InstanceSet

Dataset containing the data objects.

code

0..1

string

Unique user-allocated key for this pricing structure, used by company representatives to identify the correct price structure for allocating to a customer. For rate schedules it is often prefixed by a state code.

dailyCeilingUsage

0..1

integer

Absolute maximum valid non-demand usage quantity used in validating a customer's billed non-demand usage.

dailyEstimatedUsage

0..1

integer

Used in place of actual computed estimated average when history of usage is not available, and typically manually entered by customer accounting.

dailyFloorUsage

0..1

integer

Absolute minimum valid non-demand usage quantity used in validating a customer's billed non-demand usage.

revenueKind

0..1

RevenueKind

(accounting) Kind of revenue, often used to determine the grace period allowed, before collection actions are taken on a customer (grace periods vary between revenue classes).

taxExemption

0..1

boolean

True if this pricing structure is not taxable.

CustomerAgreements

0..*

CustomerAgreement

All customer agreements with this pricing structure.

Tariffs

0..*

Tariff

All tariffs used by this pricing structure.

Transactions

0..*

Transaction

All transactions applying this pricing structure.

UsagePoints

0..*

UsagePoint

All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.

Approver

0..1

Approver

Approver of this document.

Author

0..1

Author

Author of this document.

Editor

0..1

Editor

Editor of this document.

Issuer

0..1

Issuer

Issuer of this document.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

aliasName

0..1

string

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.

authorName

0..1

string

Name of the author of this document.

comment

0..1

string

Free text comment.

createdDateTime

0..1

date

Date and time that this document was created.

description

0..1

string

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.

docStatus

0..1

Status

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.

electronicAddress

0..1

ElectronicAddress

Electronic address.

lastModifiedDateTime

0..1

date

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

mRID

0..1

string

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.

name

0..1

string

The name is any free human readable and possibly non unique text naming the object.

revisionNumber

0..1

string

Revision number for this document.

status

0..1

Status

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

subject

0..1

string

Document subject.

title

0..1

string

Document title.

type

0..1

string

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.).

ActivityRecord

0..*

ActivityRecord

The activity record for a document

ConfigurationEvents

0..*

ConfigurationEvent

All configuration events created for this document.

DiagramObjects

0..*

DiagramObject

The diagram objects that are associated with the domain object.

Names

0..*

Name

All names of this identified object.

TargetingCIMDataObject

0..*

ChangeSetMember

Data objects registered.


ActivityRecord

The activity record for a document

URI

cim:Document.ActivityRecord

Cardinality

0..*

Type

ActivityRecord

Inherited from

Document

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

cim:IdentifiedObject.aliasName

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Approver

Approver of this document.

URI

cim:Document.Approver

Cardinality

0..1

Type

Approver

Inherited from

Document

Author

Author of this document.

URI

cim:Document.Author

Cardinality

0..1

Type

Author

Inherited from

Document

authorName

Name of the author of this document.

URI

cim:Document.authorName

Cardinality

0..1

Type

string

Inherited from

Document

code

Unique user-allocated key for this pricing structure, used by company representatives to identify the correct price structure for allocating to a customer. For rate schedules it is often prefixed by a state code.

URI

cim:PricingStructure.code

Cardinality

0..1

Type

string

comment

Free text comment.

URI

cim:Document.comment

Cardinality

0..1

Type

string

Inherited from

Document

ConfigurationEvents

All configuration events created for this document.

URI

cim:Document.ConfigurationEvents

Cardinality

0..*

Type

ConfigurationEvent

Inherited from

Document

createdDateTime

Date and time that this document was created.

URI

cim:Document.createdDateTime

Cardinality

0..1

Type

date

Inherited from

Document

CustomerAgreements

All customer agreements with this pricing structure.

URI

cim:PricingStructure.CustomerAgreements

Cardinality

0..*

Type

CustomerAgreement

dailyCeilingUsage

Absolute maximum valid non-demand usage quantity used in validating a customer's billed non-demand usage.

URI

cim:PricingStructure.dailyCeilingUsage

Cardinality

0..1

Type

integer

dailyEstimatedUsage

Used in place of actual computed estimated average when history of usage is not available, and typically manually entered by customer accounting.

URI

cim:PricingStructure.dailyEstimatedUsage

Cardinality

0..1

Type

integer

dailyFloorUsage

Absolute minimum valid non-demand usage quantity used in validating a customer's billed non-demand usage.

URI

cim:PricingStructure.dailyFloorUsage

Cardinality

0..1

Type

integer

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

cim:IdentifiedObject.description

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

DiagramObjects

The diagram objects that are associated with the domain object.

URI

cim:IdentifiedObject.DiagramObjects

Cardinality

0..*

Type

DiagramObject

Inherited from

IdentifiedObject

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

cim:Document.docStatus

Cardinality

0..1

Type

Status

Inherited from

Document

Editor

Editor of this document.

URI

cim:Document.Editor

Cardinality

0..1

Type

Editor

Inherited from

Document

electronicAddress

Electronic address.

URI

cim:Document.electronicAddress

Cardinality

0..1

Type

ElectronicAddress

Inherited from

Document

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

Issuer

Issuer of this document.

URI

cim:Document.Issuer

Cardinality

0..1

Type

Issuer

Inherited from

Document

lastModifiedDateTime

Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.

URI

cim:Document.lastModifiedDateTime

Cardinality

0..1

Type

date

Inherited from

Document

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

cim:IdentifiedObject.mRID

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

name

The name is any free human readable and possibly non unique text naming the object.

URI

cim:IdentifiedObject.name

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Names

All names of this identified object.

URI

cim:IdentifiedObject.Names

Cardinality

0..*

Type

Name

Inherited from

IdentifiedObject

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

revenueKind

(accounting) Kind of revenue, often used to determine the grace period allowed, before collection actions are taken on a customer (grace periods vary between revenue classes).

URI

cim:PricingStructure.revenueKind

Cardinality

0..1

Type

RevenueKind

revisionNumber

Revision number for this document.

URI

cim:Document.revisionNumber

Cardinality

0..1

Type

string

Inherited from

Document

ServiceCategory

Service category to which this pricing structure applies.

URI

cim:PricingStructure.ServiceCategory

Cardinality

1

Type

ServiceCategory

status

Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.

URI

cim:Document.status

Cardinality

0..1

Type

Status

Inherited from

Document

subject

Document subject.

URI

cim:Document.subject

Cardinality

0..1

Type

string

Inherited from

Document

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

Tariffs

All tariffs used by this pricing structure.

URI

cim:PricingStructure.Tariffs

Cardinality

0..*

Type

Tariff

taxExemption

True if this pricing structure is not taxable.

URI

cim:PricingStructure.taxExemption

Cardinality

0..1

Type

boolean

title

Document title.

URI

cim:Document.title

Cardinality

0..1

Type

string

Inherited from

Document

Transactions

All transactions applying this pricing structure.

URI

cim:PricingStructure.Transactions

Cardinality

0..*

Type

Transaction

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

cim:Document.type

Cardinality

0..1

Type

string

Inherited from

Document

UsagePoints

All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.

URI

cim:PricingStructure.UsagePoints

Cardinality

0..*

Type

UsagePoint