Class: Transaction
The record of details of payment for service or token sale.
URI: cim:Transaction
classDiagram
class Transaction
IdentifiedObject <|-- Transaction
Transaction : alias_name
Transaction : auxiliary_account
Transaction --> AuxiliaryAccount : auxiliary_account
Transaction : cashier_shift
Transaction --> CashierShift : cashier_shift
Transaction : customer_account
Transaction --> CustomerAccount : customer_account
Transaction : description
Transaction : diagram_objects
Transaction --> DiagramObject : diagram_objects
Transaction : diverse_reference
Transaction : donor_reference
Transaction : instance_set
Transaction --> InstanceSet : instance_set
Transaction : kind
Transaction --> TransactionKind : kind
Transaction : line
Transaction --> LineDetail : line
Transaction : m_rid
Transaction : meter
Transaction --> Meter : meter
Transaction : names
Transaction --> Name : names
Transaction : pricing_structure
Transaction --> PricingStructure : pricing_structure
Transaction : properties_cimdata_object
Transaction --> ChangeSetMember : properties_cimdata_object
Transaction : receipt
Transaction --> Receipt : receipt
Transaction : receiver_reference
Transaction : reversed_id
Transaction : service_units_energy
Transaction --> RealEnergy : service_units_energy
Transaction : service_units_error
Transaction --> RealEnergy : service_units_error
Transaction : targeting_cimdata_object
Transaction --> ChangeSetMember : targeting_cimdata_object
Transaction : user_attributes
Transaction --> UserAttribute : user_attributes
Transaction : vendor_shift
Transaction --> VendorShift : vendor_shift
Inheritance
- IdentifiedObject
- Transaction
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| diverse_reference | 0..1 String |
Formal reference for use with diverse payment (traffic fine for example) | direct |
| donor_reference | 0..1 String |
Reference to the entity that is the source of 'amount' (for example: customer... | direct |
| kind | 0..1 TransactionKind |
Kind of transaction | direct |
| line | 0..1 LineDetail |
Transaction amount, rounding, date and note for this transaction line | direct |
| receiver_reference | 0..1 String |
Reference to the entity that is the recipient of 'amount' (for example, suppl... | direct |
| reversed_id | 0..1 String |
(if 'kind' is transactionReversal) Reference to the original transaction that... | direct |
| service_units_energy | 0..1 RealEnergy |
Actual amount of service units that is being paid for | direct |
| service_units_error | 0..1 RealEnergy |
Number of service units not reflected in 'serviceUnitsEnergy' due to process ... | direct |
| meter | 0..1 Meter |
Meter for this vending transaction | direct |
| customer_account | 0..1 CustomerAccount |
Customer account for this payment transaction | direct |
| pricing_structure | 0..1 PricingStructure |
Pricing structure applicable for this transaction | direct |
| user_attributes | 0..* UserAttribute |
All snapshots of meter parameters recorded at the time of this transaction | direct |
| cashier_shift | 0..1 CashierShift |
Cashier shift during which this transaction was recorded | direct |
| receipt | 0..1 Receipt |
The receipted payment for which this transaction has been recorded | direct |
| vendor_shift | 0..1 VendorShift |
Vendor shift during which this transaction was recorded | direct |
| auxiliary_account | 0..1 AuxiliaryAccount |
Auxiliary account for this payment transaction | direct |
| alias_name | 0..1 String |
The aliasName is free text human readable name of the object alternative to I... | IdentifiedObject |
| description | 0..1 String |
The description is a free human readable text describing or naming the object | IdentifiedObject |
| m_rid | 0..1 String |
Master resource identifier issued by a model authority | IdentifiedObject |
| diagram_objects | 0..* DiagramObject |
The diagram objects that are associated with the domain object | IdentifiedObject |
| instance_set | 1..1 InstanceSet |
Dataset containing the data objects | IdentifiedObject |
| names | 0..* Name |
All names of this identified object | IdentifiedObject |
| properties_cimdata_object | 0..1 ChangeSetMember |
The single CIM data object in the appropriate dataset context | IdentifiedObject |
| targeting_cimdata_object | 0..* ChangeSetMember |
Data objects registered | IdentifiedObject |
Usages
| used by | used in | type | used |
|---|---|---|---|
| CustomerAccount | payment_transactions | range | Transaction |
| PricingStructure | transactions | range | Transaction |
| UserAttribute | transaction | range | Transaction |
| CashierShift | transactions | range | Transaction |
| Receipt | transactions | range | Transaction |
| VendorShift | transactions | range | Transaction |
| AuxiliaryAccount | payment_transactions | range | Transaction |
| Meter | vending_transactions | range | Transaction |
| MktUserAttribute | transaction | range | Transaction |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:Transaction |
| native | cim:Transaction |
LinkML Source
Direct
name: Transaction
description: The record of details of payment for service or token sale.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
diverse_reference:
name: diverse_reference
description: Formal reference for use with diverse payment (traffic fine for example).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.diverseReference
multivalued: false
domain_of:
- Transaction
range: string
required: false
donor_reference:
name: donor_reference
description: 'Reference to the entity that is the source of ''amount'' (for example:
customer for token purchase; or supplier for free issue token).'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.donorReference
multivalued: false
domain_of:
- Transaction
range: string
required: false
kind:
name: kind
description: Kind of transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.kind
multivalued: false
domain_of:
- Asset
- Customer
- BaseWork
- WorkTimeSchedule
- CustomerBillingInfo
- ErpInvoiceLineItem
- CatalogAssetType
- Design
- ConditionFactor
- LandProperty
- Seal
- Gate
- JumperAction
- RevisionHistory
- SwitchAction
- Fault
- ServiceCategory
- Transaction
- Procedure
- Medium
- Tender
- Cheque
- Charge
- ServiceRequest
- MeterMultiplier
- StructureSupport
- CutAction
- GroundAction
- ClampAction
- ProtectiveActionAdjustment
- RemedialActionScheme
- MeasurementCalculator
- ErpInvoice
- ServiceSupplier
- EnergyTypeReference
- CRROrgRole
- MarketInvoice
- MarketInvoiceLineItem
- EnvironmentalLocationType
- EnvironmentalDiscrete
- ServiceMultiplier
- AssetLocationHazard
- Analytic
- AssetGroup
- TagAction
- PinBranchGroup
- PinTerminal
- PinEquipment
- ClearanceAction
- PSREvent
- ShuntCompensatorAction
- EnergyConsumerAction
- EnergySourceAction
- Zone
- OilAnalysisMoistureAnalog
- AssetStringMeasurement
- InspectionAnalog
- AssetTemperaturePressureAnalog
- OilAnalysisFluidDiscrete
- InspectionDiscrete
- OilAnalysisPCBDiscrete
- OilAnalysisFluidAnalog
- OilAnalysisGasAnalog
- OilAnalysisPCBAnalog
- OilAnalysisParticleDiscrete
- OilAnalysisMetalsAnalog
- OilAnalysisParticleAnalog
- OilAnalysisPaperAnalog
- CompositeSwitchInfo
- Facility
- RiskScore
- FACTSDevice
- SimpleEndDeviceFunction
- UndergroundStructure
- RelativeDisplacement
- CloudCondition
- GeosphericAnalog
- HydrosphericAnalog
- AtmosphericAnalog
- SpaceAnalog
range: TransactionKind
required: false
line:
name: line
description: Transaction amount, rounding, date and note for this transaction
line.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.line
multivalued: false
domain_of:
- Transaction
- Receipt
range: LineDetail
required: false
receiver_reference:
name: receiver_reference
description: Reference to the entity that is the recipient of 'amount' (for example,
supplier for service charge payment; or tax receiver for VAT).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.receiverReference
multivalued: false
domain_of:
- Transaction
range: string
required: false
reversed_id:
name: reversed_id
description: (if 'kind' is transactionReversal) Reference to the original transaction
that is being reversed by this transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.reversedId
multivalued: false
domain_of:
- Transaction
range: string
required: false
service_units_energy:
name: service_units_energy
description: Actual amount of service units that is being paid for.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.serviceUnitsEnergy
multivalued: false
domain_of:
- Transaction
range: RealEnergy
required: false
service_units_error:
name: service_units_error
description: Number of service units not reflected in 'serviceUnitsEnergy' due
to process rounding or truncating errors.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.serviceUnitsError
multivalued: false
domain_of:
- Transaction
range: RealEnergy
required: false
meter:
name: meter
description: Meter for this vending transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.Meter
multivalued: false
domain_of:
- Transaction
- MeterReading
- MeterWorkTask
- MeterMultiplier
range: Meter
required: false
customer_account:
name: customer_account
description: Customer account for this payment transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.CustomerAccount
multivalued: false
domain_of:
- MeterReadSchedule
- CustomerAgreement
- CustomerBillingInfo
- WorkBillingInfo
- Transaction
- ErpInvoice
- AccountNotification
range: CustomerAccount
required: false
pricing_structure:
name: pricing_structure
description: Pricing structure applicable for this transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.PricingStructure
multivalued: false
domain_of:
- Transaction
range: PricingStructure
required: false
user_attributes:
name: user_attributes
description: 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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.UserAttributes
multivalued: true
domain_of:
- ErpInvoiceLineItem
- Transaction
- ErpLedgerEntry
range: UserAttribute
required: false
cashier_shift:
name: cashier_shift
description: Cashier shift during which this transaction was recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.CashierShift
multivalued: false
domain_of:
- Transaction
- Receipt
range: CashierShift
required: false
receipt:
name: receipt
description: The receipted payment for which this transaction has been recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.Receipt
multivalued: false
domain_of:
- Transaction
- Tender
range: Receipt
required: false
vendor_shift:
name: vendor_shift
description: Vendor shift during which this transaction was recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.VendorShift
multivalued: false
domain_of:
- Transaction
- Receipt
range: VendorShift
required: false
auxiliary_account:
name: auxiliary_account
description: Auxiliary account for this payment transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.AuxiliaryAccount
multivalued: false
domain_of:
- Transaction
range: AuxiliaryAccount
required: false
class_uri: cim:Transaction
Induced
name: Transaction
description: The record of details of payment for service or token sale.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
diverse_reference:
name: diverse_reference
description: Formal reference for use with diverse payment (traffic fine for example).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.diverseReference
multivalued: false
alias: diverse_reference
owner: Transaction
domain_of:
- Transaction
range: string
required: false
donor_reference:
name: donor_reference
description: 'Reference to the entity that is the source of ''amount'' (for example:
customer for token purchase; or supplier for free issue token).'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.donorReference
multivalued: false
alias: donor_reference
owner: Transaction
domain_of:
- Transaction
range: string
required: false
kind:
name: kind
description: Kind of transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.kind
multivalued: false
alias: kind
owner: Transaction
domain_of:
- Asset
- Customer
- BaseWork
- WorkTimeSchedule
- CustomerBillingInfo
- ErpInvoiceLineItem
- CatalogAssetType
- Design
- ConditionFactor
- LandProperty
- Seal
- Gate
- JumperAction
- RevisionHistory
- SwitchAction
- Fault
- ServiceCategory
- Transaction
- Procedure
- Medium
- Tender
- Cheque
- Charge
- ServiceRequest
- MeterMultiplier
- StructureSupport
- CutAction
- GroundAction
- ClampAction
- ProtectiveActionAdjustment
- RemedialActionScheme
- MeasurementCalculator
- ErpInvoice
- ServiceSupplier
- EnergyTypeReference
- CRROrgRole
- MarketInvoice
- MarketInvoiceLineItem
- EnvironmentalLocationType
- EnvironmentalDiscrete
- ServiceMultiplier
- AssetLocationHazard
- Analytic
- AssetGroup
- TagAction
- PinBranchGroup
- PinTerminal
- PinEquipment
- ClearanceAction
- PSREvent
- ShuntCompensatorAction
- EnergyConsumerAction
- EnergySourceAction
- Zone
- OilAnalysisMoistureAnalog
- AssetStringMeasurement
- InspectionAnalog
- AssetTemperaturePressureAnalog
- OilAnalysisFluidDiscrete
- InspectionDiscrete
- OilAnalysisPCBDiscrete
- OilAnalysisFluidAnalog
- OilAnalysisGasAnalog
- OilAnalysisPCBAnalog
- OilAnalysisParticleDiscrete
- OilAnalysisMetalsAnalog
- OilAnalysisParticleAnalog
- OilAnalysisPaperAnalog
- CompositeSwitchInfo
- Facility
- RiskScore
- FACTSDevice
- SimpleEndDeviceFunction
- UndergroundStructure
- RelativeDisplacement
- CloudCondition
- GeosphericAnalog
- HydrosphericAnalog
- AtmosphericAnalog
- SpaceAnalog
range: TransactionKind
required: false
line:
name: line
description: Transaction amount, rounding, date and note for this transaction
line.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.line
multivalued: false
alias: line
owner: Transaction
domain_of:
- Transaction
- Receipt
range: LineDetail
required: false
receiver_reference:
name: receiver_reference
description: Reference to the entity that is the recipient of 'amount' (for example,
supplier for service charge payment; or tax receiver for VAT).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.receiverReference
multivalued: false
alias: receiver_reference
owner: Transaction
domain_of:
- Transaction
range: string
required: false
reversed_id:
name: reversed_id
description: (if 'kind' is transactionReversal) Reference to the original transaction
that is being reversed by this transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.reversedId
multivalued: false
alias: reversed_id
owner: Transaction
domain_of:
- Transaction
range: string
required: false
service_units_energy:
name: service_units_energy
description: Actual amount of service units that is being paid for.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.serviceUnitsEnergy
multivalued: false
alias: service_units_energy
owner: Transaction
domain_of:
- Transaction
range: RealEnergy
required: false
service_units_error:
name: service_units_error
description: Number of service units not reflected in 'serviceUnitsEnergy' due
to process rounding or truncating errors.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.serviceUnitsError
multivalued: false
alias: service_units_error
owner: Transaction
domain_of:
- Transaction
range: RealEnergy
required: false
meter:
name: meter
description: Meter for this vending transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.Meter
multivalued: false
alias: meter
owner: Transaction
domain_of:
- Transaction
- MeterReading
- MeterWorkTask
- MeterMultiplier
range: Meter
required: false
customer_account:
name: customer_account
description: Customer account for this payment transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.CustomerAccount
multivalued: false
alias: customer_account
owner: Transaction
domain_of:
- MeterReadSchedule
- CustomerAgreement
- CustomerBillingInfo
- WorkBillingInfo
- Transaction
- ErpInvoice
- AccountNotification
range: CustomerAccount
required: false
pricing_structure:
name: pricing_structure
description: Pricing structure applicable for this transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.PricingStructure
multivalued: false
alias: pricing_structure
owner: Transaction
domain_of:
- Transaction
range: PricingStructure
required: false
user_attributes:
name: user_attributes
description: 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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Transaction.UserAttributes
multivalued: true
alias: user_attributes
owner: Transaction
domain_of:
- ErpInvoiceLineItem
- Transaction
- ErpLedgerEntry
range: UserAttribute
required: false
cashier_shift:
name: cashier_shift
description: Cashier shift during which this transaction was recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.CashierShift
multivalued: false
alias: cashier_shift
owner: Transaction
domain_of:
- Transaction
- Receipt
range: CashierShift
required: false
receipt:
name: receipt
description: The receipted payment for which this transaction has been recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.Receipt
multivalued: false
alias: receipt
owner: Transaction
domain_of:
- Transaction
- Tender
range: Receipt
required: false
vendor_shift:
name: vendor_shift
description: Vendor shift during which this transaction was recorded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.VendorShift
multivalued: false
alias: vendor_shift
owner: Transaction
domain_of:
- Transaction
- Receipt
range: VendorShift
required: false
auxiliary_account:
name: auxiliary_account
description: Auxiliary account for this payment transaction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Transaction.AuxiliaryAccount
multivalued: false
alias: auxiliary_account
owner: Transaction
domain_of:
- Transaction
range: AuxiliaryAccount
required: false
alias_name:
name: alias_name
description: "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.\r\nThe 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.\r\
\n\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.aliasName
multivalued: false
alias: alias_name
owner: Transaction
domain_of:
- IdentifiedObject
range: string
required: false
description:
name: description
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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.description
multivalued: false
alias: description
owner: Transaction
domain_of:
- IdentifiedObject
- NameType
- NameTypeAuthority
- DataSet
- SwitchingStepGroup
- AreaReserveSpec
range: string
required: false
m_rid:
name: m_rid
description: "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.\r\nFor 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."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.mRID
multivalued: false
alias: m_rid
owner: Transaction
domain_of:
- IdentifiedObject
- DataSet
range: string
required: false
diagram_objects:
name: diagram_objects
description: The diagram objects that are associated with the domain object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.DiagramObjects
multivalued: true
alias: diagram_objects
owner: Transaction
domain_of:
- IdentifiedObject
range: DiagramObject
required: false
instance_set:
name: instance_set
description: Dataset containing the data objects.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.InstanceSet
multivalued: false
alias: instance_set
owner: Transaction
domain_of:
- IdentifiedObject
range: InstanceSet
required: true
names:
name: names
description: All names of this identified object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.Names
multivalued: true
alias: names
owner: Transaction
domain_of:
- IdentifiedObject
- NameType
range: Name
required: false
properties_cimdata_object:
name: properties_cimdata_object
description: The single CIM data object in the appropriate dataset context.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
multivalued: false
alias: properties_cimdata_object
owner: Transaction
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
targeting_cimdata_object:
name: targeting_cimdata_object
description: Data objects registered.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
multivalued: true
alias: targeting_cimdata_object
owner: Transaction
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:Transaction