Skip to content

Class: MarketStatement

_A statement is a roll up of statement line items. Each statement along with its line items provide the details of specific charges at any given time. Used by Billing and Settlement. _

__

URI: cim:MarketStatement

 classDiagram
    class MarketStatement
      Document <|-- MarketStatement

      MarketStatement : activity_record

          MarketStatement --> ActivityRecord : activity_record

      MarketStatement : alias_name

      MarketStatement : approver

          MarketStatement --> Approver : approver

      MarketStatement : author

          MarketStatement --> Author : author

      MarketStatement : author_name

      MarketStatement : comment

      MarketStatement : configuration_events

          MarketStatement --> ConfigurationEvent : configuration_events

      MarketStatement : created_date_time

      MarketStatement : description

      MarketStatement : diagram_objects

          MarketStatement --> DiagramObject : diagram_objects

      MarketStatement : doc_status

          MarketStatement --> Status : doc_status

      MarketStatement : editor

          MarketStatement --> Editor : editor

      MarketStatement : electronic_address

          MarketStatement --> ElectronicAddress : electronic_address

      MarketStatement : end

      MarketStatement : instance_set

          MarketStatement --> InstanceSet : instance_set

      MarketStatement : issuer

          MarketStatement --> Issuer : issuer

      MarketStatement : last_modified_date_time

      MarketStatement : m_rid

      MarketStatement : market_statement_line_item

          MarketStatement --> MarketStatementLineItem : market_statement_line_item

      MarketStatement : names

          MarketStatement --> Name : names

      MarketStatement : properties_cimdata_object

          MarketStatement --> ChangeSetMember : properties_cimdata_object

      MarketStatement : reference_number

      MarketStatement : revision_number

      MarketStatement : start

      MarketStatement : status

          MarketStatement --> Status : status

      MarketStatement : subject

      MarketStatement : targeting_cimdata_object

          MarketStatement --> ChangeSetMember : targeting_cimdata_object

      MarketStatement : title

      MarketStatement : trade_date

      MarketStatement : transaction_date

      MarketStatement : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
end 0..1
date		 The end of a bill period direct
reference_number 0..1
String		 The version number of previous statement (in the case of true up) direct
start 0..1
date		 The start of a bill period direct
trade_date 0..1
date		 The date of which Settlement is run direct
transaction_date 0..1
date		 The date of which this statement is issued direct
market_statement_line_item 0..*
MarketStatementLineItem		 direct
author_name 0..1
String		 Name of the author of this document Document
comment 0..1
String		 Free text comment Document
created_date_time 0..1
date		 Date and time that this document was created Document
doc_status 0..1
Status		 Status of this document Document
electronic_address 0..1
ElectronicAddress		 Electronic address Document
last_modified_date_time 0..1
date		 Date and time this document was last modified Document
revision_number 0..1
String		 Revision number for this document Document
status 0..1
Status		 Status of subject matter (e Document
subject 0..1
String		 Document subject Document
title 0..1
String		 Document title Document
type 0..1
String		 Utility-specific classification of this document, according to its corporate ... Document
activity_record 0..*
ActivityRecord		 The activity record for a document Document
configuration_events 0..*
ConfigurationEvent		 All configuration events created for this document Document
author 0..1
Author		 Author of this document Document
editor 0..1
Editor		 Editor of this document Document
approver 0..1
Approver		 Approver of this document Document
issuer 0..1
Issuer		 Issuer of this document Document
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
MarketStatementLineItem market_statement range MarketStatement

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:MarketStatement
native cim:MarketStatement

LinkML Source

Direct

name: MarketStatement
description: "A statement is a roll up of statement line items. Each statement along\
  \ with its line items provide the details of specific charges at any given time.\
  \  Used by Billing and Settlement.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  end:
    name: end
    description: "The end of a bill period.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.end
    multivalued: false
    domain_of:
    - TimeInterval
    - DateInterval
    - DateTimeInterval
    - MonthDayInterval
    - Market
    - MarketStatement
    range: date
    required: false
  reference_number:
    name: reference_number
    description: "The version number of previous statement (in the case of true up).\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.referenceNumber
    multivalued: false
    domain_of:
    - ErpInvoice
    - MarketInvoice
    - MarketStatement
    - Regulation
    range: string
    required: false
  start:
    name: start
    description: "The start of a bill period.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.start
    multivalued: false
    domain_of:
    - TimeInterval
    - DateInterval
    - DateTimeInterval
    - MonthDayInterval
    - Market
    - MarketStatement
    range: date
    required: false
  trade_date:
    name: trade_date
    description: "The date of which Settlement is run.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.tradeDate
    multivalued: false
    domain_of:
    - Settlement
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  transaction_date:
    name: transaction_date
    description: "The date of which this statement is issued. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.transactionDate
    multivalued: false
    domain_of:
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  market_statement_line_item:
    name: market_statement_line_item
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.MarketStatementLineItem
    multivalued: true
    domain_of:
    - MktUserAttribute
    - PassThroughBill
    - MarketStatement
    range: MarketStatementLineItem
    required: false
class_uri: cim:MarketStatement

Induced

name: MarketStatement
description: "A statement is a roll up of statement line items. Each statement along\
  \ with its line items provide the details of specific charges at any given time.\
  \  Used by Billing and Settlement.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  end:
    name: end
    description: "The end of a bill period.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.end
    multivalued: false
    alias: end
    owner: MarketStatement
    domain_of:
    - TimeInterval
    - DateInterval
    - DateTimeInterval
    - MonthDayInterval
    - Market
    - MarketStatement
    range: date
    required: false
  reference_number:
    name: reference_number
    description: "The version number of previous statement (in the case of true up).\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.referenceNumber
    multivalued: false
    alias: reference_number
    owner: MarketStatement
    domain_of:
    - ErpInvoice
    - MarketInvoice
    - MarketStatement
    - Regulation
    range: string
    required: false
  start:
    name: start
    description: "The start of a bill period.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.start
    multivalued: false
    alias: start
    owner: MarketStatement
    domain_of:
    - TimeInterval
    - DateInterval
    - DateTimeInterval
    - MonthDayInterval
    - Market
    - MarketStatement
    range: date
    required: false
  trade_date:
    name: trade_date
    description: "The date of which Settlement is run.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.tradeDate
    multivalued: false
    alias: trade_date
    owner: MarketStatement
    domain_of:
    - Settlement
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  transaction_date:
    name: transaction_date
    description: "The date of which this statement is issued. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.transactionDate
    multivalued: false
    alias: transaction_date
    owner: MarketStatement
    domain_of:
    - PassThroughBill
    - MarketStatement
    range: date
    required: false
  market_statement_line_item:
    name: market_statement_line_item
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MarketStatement.MarketStatementLineItem
    multivalued: true
    alias: market_statement_line_item
    owner: MarketStatement
    domain_of:
    - MktUserAttribute
    - PassThroughBill
    - MarketStatement
    range: MarketStatementLineItem
    required: false
  author_name:
    name: author_name
    description: Name of the author of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.authorName
    multivalued: false
    alias: author_name
    owner: MarketStatement
    domain_of:
    - Document
    range: string
    required: false
  comment:
    name: comment
    description: Free text comment.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.comment
    multivalued: false
    alias: comment
    owner: MarketStatement
    domain_of:
    - NetworkModelProjectChangeVersion
    - Document
    - SwitchingPlanRequest
    - SwitchingOrder
    - TroubleOrder
    - ReadingQuality
    - TroubleTicket
    - OutageOrder
    range: string
    required: false
  created_date_time:
    name: created_date_time
    description: "Date and time that this document was created.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.createdDateTime
    multivalued: false
    alias: created_date_time
    owner: MarketStatement
    domain_of:
    - Document
    - ActivityRecord
    range: date
    required: false
  doc_status:
    name: doc_status
    description: "Status of this document. For status of subject matter this document\
      \ represents (e.g., Agreement, Work), use 'status' attribute.\r\nExample values\
      \ for 'docStatus.status' are draft, approved, cancelled, etc."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.docStatus
    multivalued: false
    alias: doc_status
    owner: MarketStatement
    domain_of:
    - Document
    range: Status
    required: false
  electronic_address:
    name: electronic_address
    description: Electronic address.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.electronicAddress
    multivalued: false
    alias: electronic_address
    owner: MarketStatement
    domain_of:
    - Asset
    - Document
    - Person
    - Organisation
    - Location
    - Cashier
    range: ElectronicAddress
    required: false
  last_modified_date_time:
    name: last_modified_date_time
    description: "Date and time this document was last modified. Documents may potentially\
      \ be modified many times during their lifetime.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.lastModifiedDateTime
    multivalued: false
    alias: last_modified_date_time
    owner: MarketStatement
    domain_of:
    - Document
    range: date
    required: false
  revision_number:
    name: revision_number
    description: Revision number for this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.revisionNumber
    multivalued: false
    alias: revision_number
    owner: MarketStatement
    domain_of:
    - Document
    - MajorChargeGroup
    range: string
    required: false
  status:
    name: status
    description: Status of subject matter (e.g., Agreement, Work) this document represents.
      For status of the document itself, use 'docStatus' attribute.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.status
    multivalued: false
    alias: status
    owner: MarketStatement
    domain_of:
    - Asset
    - Document
    - Customer
    - StreetAddress
    - Location
    - ErpQuoteLineItem
    - CostType
    - ErpJournalEntry
    - ErpRecLineItem
    - ErpPayableLineItem
    - ContractorItem
    - Capability
    - Craft
    - OldPerson
    - ErpPersonnel
    - LaborItem
    - DesignLocationCU
    - DesignLocation
    - ConditionFactor
    - MiscCostItem
    - CUGroup
    - WorkFlowStep
    - ErpTimeEntry
    - OverheadCost
    - PropertyUnit
    - CUMaterialItem
    - ErpIssueInventory
    - ErpReqLineItem
    - ErpRecDelvLineItem
    - Role
    - LandProperty
    - ErpSiteLevelData
    - Crew
    - ActivityRecord
    - ErpLedgerEntry
    - ErpLedBudLineItem
    - TransformerObservation
    - BushingInsulationPF
    - WindingInsulation
    - CULaborItem
    - CULaborCode
    - EndDeviceGroup
    - Hazard
    - CUWorkEquipmentItem
    - ShiftPattern
    - Route
    - Usage
    - CUContractorItem
    - CUAllowableAction
    - TypeAssetCatalogue
    - AssetModelCatalogue
    - Market
    - CRROrgRole
    - MarketScheduledEvent
    - MarketLedgerEntry
    - MarketPerson
    - MarketQualificationRequirement
    - ResourceGroup
    - ResourceAwardInstruction
    - ExPostResourceResults
    - MarketObjectStatus
    - TimePoint
    - ErpItemMaster
    - ScheduledEvent
    - ScheduledEventData
    - ErpInventory
    - ErpInventoryCount
    - RedLine
    - BusinessRole
    - BidTimeSeries
    range: Status
    required: false
  subject:
    name: subject
    description: Document subject.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.subject
    multivalued: false
    alias: subject
    owner: MarketStatement
    domain_of:
    - Document
    range: string
    required: false
  title:
    name: title
    description: Document title.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.title
    multivalued: false
    alias: title
    owner: MarketStatement
    domain_of:
    - Document
    range: string
    required: false
  type:
    name: type
    description: 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.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.type
    multivalued: false
    alias: type
    owner: MarketStatement
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  activity_record:
    name: activity_record
    description: The activity record for a document
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.ActivityRecord
    multivalued: true
    alias: activity_record
    owner: MarketStatement
    domain_of:
    - Document
    range: ActivityRecord
    required: false
  configuration_events:
    name: configuration_events
    description: All configuration events created for this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Document.ConfigurationEvents
    multivalued: true
    alias: configuration_events
    owner: MarketStatement
    domain_of:
    - Asset
    - Document
    - PersonRole
    - OrganisationRole
    - Location
    - UsagePoint
    - ServiceCategory
    range: ConfigurationEvent
    required: false
  author:
    name: author
    description: Author of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Author
    multivalued: false
    alias: author
    owner: MarketStatement
    domain_of:
    - Document
    - ActivityRecord
    range: Author
    required: false
  editor:
    name: editor
    description: Editor of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Editor
    multivalued: false
    alias: editor
    owner: MarketStatement
    domain_of:
    - Document
    range: Editor
    required: false
  approver:
    name: approver
    description: Approver of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Approver
    multivalued: false
    alias: approver
    owner: MarketStatement
    domain_of:
    - Document
    range: Approver
    required: false
  issuer:
    name: issuer
    description: Issuer of this document.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Document.Issuer
    multivalued: false
    alias: issuer
    owner: MarketStatement
    domain_of:
    - Document
    range: Issuer
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    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: MarketStatement
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MarketStatement