Transaction

The record of details of payment for service or token sale.

Type

Class

URI

cim:Transaction

CIM standard (perspective)

IEC61968 (Enterprise)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

InstanceSet

1

InstanceSet

Dataset containing the data objects.

AuxiliaryAccount

0..1

AuxiliaryAccount

Auxiliary account for this payment transaction.

CashierShift

0..1

CashierShift

Cashier shift during which this transaction was recorded.

CustomerAccount

0..1

CustomerAccount

Customer account for this payment transaction.

Meter

0..1

Meter

Meter for this vending transaction.

PricingStructure

0..1

PricingStructure

Pricing structure applicable for this transaction.

Receipt

0..1

Receipt

The receipted payment for which this transaction has been recorded.

VendorShift

0..1

VendorShift

Vendor shift during which this transaction was recorded.

diverseReference

0..1

string

Formal reference for use with diverse payment (traffic fine for example).

donorReference

0..1

string

Reference to the entity that is the source of 'amount' (for example: customer for token purchase; or supplier for free issue token).

kind

0..1

TransactionKind

Kind of transaction.

line

0..1

LineDetail

Transaction amount, rounding, date and note for this transaction line.

receiverReference

0..1

string

Reference to the entity that is the recipient of 'amount' (for example, supplier for service charge payment; or tax receiver for VAT).

reversedId

0..1

string

(if 'kind' is transactionReversal) Reference to the original transaction that is being reversed by this transaction.

serviceUnitsEnergy

0..1

RealEnergy

Actual amount of service units that is being paid for.

serviceUnitsError

0..1

RealEnergy

Number of service units not reflected in 'serviceUnitsEnergy' due to process rounding or truncating errors.

UserAttributes

0..*

UserAttribute

All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.

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.

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.

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.

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.


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

AuxiliaryAccount

Auxiliary account for this payment transaction.

URI

cim:Transaction.AuxiliaryAccount

Cardinality

0..1

Type

AuxiliaryAccount

CashierShift

Cashier shift during which this transaction was recorded.

URI

cim:Transaction.CashierShift

Cardinality

0..1

Type

CashierShift

CustomerAccount

Customer account for this payment transaction.

URI

cim:Transaction.CustomerAccount

Cardinality

0..1

Type

CustomerAccount

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

diverseReference

Formal reference for use with diverse payment (traffic fine for example).

URI

cim:Transaction.diverseReference

Cardinality

0..1

Type

string

donorReference

Reference to the entity that is the source of 'amount' (for example: customer for token purchase; or supplier for free issue token).

URI

cim:Transaction.donorReference

Cardinality

0..1

Type

string

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

kind

Kind of transaction.

URI

cim:Transaction.kind

Cardinality

0..1

Type

TransactionKind

line

Transaction amount, rounding, date and note for this transaction line.

URI

cim:Transaction.line

Cardinality

0..1

Type

LineDetail

Meter

Meter for this vending transaction.

URI

cim:Transaction.Meter

Cardinality

0..1

Type

Meter

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

PricingStructure

Pricing structure applicable for this transaction.

URI

cim:Transaction.PricingStructure

Cardinality

0..1

Type

PricingStructure

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

Receipt

The receipted payment for which this transaction has been recorded.

URI

cim:Transaction.Receipt

Cardinality

0..1

Type

Receipt

receiverReference

Reference to the entity that is the recipient of 'amount' (for example, supplier for service charge payment; or tax receiver for VAT).

URI

cim:Transaction.receiverReference

Cardinality

0..1

Type

string

reversedId

(if 'kind' is transactionReversal) Reference to the original transaction that is being reversed by this transaction.

URI

cim:Transaction.reversedId

Cardinality

0..1

Type

string

serviceUnitsEnergy

Actual amount of service units that is being paid for.

URI

cim:Transaction.serviceUnitsEnergy

Cardinality

0..1

Type

RealEnergy

serviceUnitsError

Number of service units not reflected in 'serviceUnitsEnergy' due to process rounding or truncating errors.

URI

cim:Transaction.serviceUnitsError

Cardinality

0..1

Type

RealEnergy

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

UserAttributes

All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.

URI

cim:Transaction.UserAttributes

Cardinality

0..*

Type

UserAttribute

VendorShift

Vendor shift during which this transaction was recorded.

URI

cim:Transaction.VendorShift

Cardinality

0..1

Type

VendorShift