PassThroughBill

Pass Through Bill is used for: 1)Two sided charge transactions with or without ISO involvement 2) Specific direct charges or payments that are calculated outside or provided directly to settlements 3) Specific charge bill determinants that are externally supplied and used in charge calculations

Type

Class

URI

cim:PassThroughBill

CIM standard (perspective)

IEC62325 (Market)

Class hierarchy

Slots

Name Type Description Inherited from

ChargeProfiles

0..*
ChargeProfile

n/a

n/a

MarketStatementLineItem

0..1
MarketStatementLineItem

n/a

n/a

MktUserAttribute

0..*
MktUserAttribute

n/a

n/a

adjustedAmount

0..1
Money

n/a

n/a

amount

0..1
Money

The charge amount of the product/service.

n/a

billEnd

0..1
date

Bill period end date

n/a

billRunType

0..1
string

The settlement run type, for example: prelim, final, and rerun.

n/a

billStart

0..1
date

Bill period start date

n/a

billedTo

0..1
string

The company to which the PTB transaction is billed.

n/a

effectiveDate

0..1
date

The effective date of the transaction

n/a

isDisputed

0..1
boolean

Disputed transaction indicator

n/a

isProfiled

0..1
boolean

A flag indicating whether there is a profile data associated with the PTB.

n/a

paidTo

0..1
string

The company to which the PTB transaction is paid.

n/a

previousEnd

0..1
date

The previous bill period end date

n/a

previousStart

0..1
date

The previous bill period start date

n/a

price

0..1
Money

The price of product/service.

n/a

productCode

0..1
string

The product identifier for determining the charge type of the transaction.

n/a

providedBy

0..1
string

The company by which the PTB transaction service is provided.

n/a

quantity

0..1
FloatQuantity

The product quantity.

n/a

serviceEnd

0..1
date

The end date of service provided, if periodic.

n/a

serviceStart

0..1
date

The start date of service provided, if periodic.

n/a

soldTo

0..1
string

The company to which the PTB transaction is sold.

n/a

taxAmount

0..1
Money

The tax on services taken.

n/a

timeZone

0..1
string

The time zone code

n/a

tradeDate

0..1
date

The trade date

n/a

transactionDate

0..1
date

The date the transaction occurs.

n/a

transactionType

0..1
string

The type of transaction. For example, charge customer, bill customer, matching AR/AP, or bill determinant

n/a

ActivityRecord

0..*
ActivityRecord

The activity record for a document

Document

Approver

0..1
Approver

Approver of this document.

Document

Author

0..1
Author

Author of this document.

Document

ConfigurationEvents

0..*
ConfigurationEvent

All configuration events created for this document.

Document

Editor

0..1
Editor

Editor of this document.

Document

Issuer

0..1
Issuer

Issuer of this document.

Document

authorName

0..1
string

Name of the author of this document.

Document

comment

0..1
string

Free text comment.

Document

createdDateTime

0..1
date

Date and time that this document was created.

Document

docStatus

0..1
Status

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

Document

electronicAddress

0..1
ElectronicAddress

Electronic address.

Document

lastModifiedDateTime

0..1
date

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

Document

revisionNumber

0..1
string

Revision number for this document.

Document

status

0..1
Status

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

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 standards, practices, and existing IT systems...

Document

DiagramObjects

0..*
DiagramObject

The diagram objects that are associated with the domain object.

IdentifiedObject

InstanceSet

1
InstanceSet

Dataset containing the data objects.

IdentifiedObject

Names

0..*
Name

All names of this identified object.

IdentifiedObject

PropertiesCIMDataObject

0..1
ChangeSetMember

The single CIM data object in the appropriate dataset context.

IdentifiedObject

TargetingCIMDataObject

0..*
ChangeSetMember

Data objects registered.

IdentifiedObject

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

IdentifiedObject

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

IdentifiedObject

mRID

0..1
string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is...

IdentifiedObject

name

0..1
string

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

IdentifiedObject


ActivityRecord

The activity record for a document

URI

cim:Document.ActivityRecord

Cardinality

0..*

Type

ActivityRecord

Inherited from

Document

adjustedAmount

URI

cim:PassThroughBill.adjustedAmount

Cardinality

0..1

Type

Money

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

amount

The charge amount of the product/service.

URI

cim:PassThroughBill.amount

Cardinality

0..1

Type

Money

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

billedTo

The company to which the PTB transaction is billed.

URI

cim:PassThroughBill.billedTo

Cardinality

0..1

Type

string

billEnd

Bill period end date

URI

cim:PassThroughBill.billEnd

Cardinality

0..1

Type

date

billRunType

The settlement run type, for example: prelim, final, and rerun.

URI

cim:PassThroughBill.billRunType

Cardinality

0..1

Type

string

billStart

Bill period start date

URI

cim:PassThroughBill.billStart

Cardinality

0..1

Type

date

ChargeProfiles

URI

cim:PassThroughBill.ChargeProfiles

Cardinality

0..*

Type

ChargeProfile

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

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

effectiveDate

The effective date of the transaction

URI

cim:PassThroughBill.effectiveDate

Cardinality

0..1

Type

date

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

isDisputed

Disputed transaction indicator

URI

cim:PassThroughBill.isDisputed

Cardinality

0..1

Type

boolean

isProfiled

A flag indicating whether there is a profile data associated with the PTB.

URI

cim:PassThroughBill.isProfiled

Cardinality

0..1

Type

boolean

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

MarketStatementLineItem

URI

cim:PassThroughBill.MarketStatementLineItem

Cardinality

0..1

Type

MarketStatementLineItem

MktUserAttribute

URI

cim:PassThroughBill.MktUserAttribute

Cardinality

0..*

Type

MktUserAttribute

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

paidTo

The company to which the PTB transaction is paid.

URI

cim:PassThroughBill.paidTo

Cardinality

0..1

Type

string

previousEnd

The previous bill period end date

URI

cim:PassThroughBill.previousEnd

Cardinality

0..1

Type

date

previousStart

The previous bill period start date

URI

cim:PassThroughBill.previousStart

Cardinality

0..1

Type

date

price

The price of product/service.

URI

cim:PassThroughBill.price

Cardinality

0..1

Type

Money

productCode

The product identifier for determining the charge type of the transaction.

URI

cim:PassThroughBill.productCode

Cardinality

0..1

Type

string

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

providedBy

The company by which the PTB transaction service is provided.

URI

cim:PassThroughBill.providedBy

Cardinality

0..1

Type

string

quantity

The product quantity.

URI

cim:PassThroughBill.quantity

Cardinality

0..1

Type

FloatQuantity

revisionNumber

Revision number for this document.

URI

cim:Document.revisionNumber

Cardinality

0..1

Type

string

Inherited from

Document

serviceEnd

The end date of service provided, if periodic.

URI

cim:PassThroughBill.serviceEnd

Cardinality

0..1

Type

date

serviceStart

The start date of service provided, if periodic.

URI

cim:PassThroughBill.serviceStart

Cardinality

0..1

Type

date

soldTo

The company to which the PTB transaction is sold.

URI

cim:PassThroughBill.soldTo

Cardinality

0..1

Type

string

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

taxAmount

The tax on services taken.

URI

cim:PassThroughBill.taxAmount

Cardinality

0..1

Type

Money

timeZone

The time zone code

URI

cim:PassThroughBill.timeZone

Cardinality

0..1

Type

string

title

Document title.

URI

cim:Document.title

Cardinality

0..1

Type

string

Inherited from

Document

tradeDate

The trade date

URI

cim:PassThroughBill.tradeDate

Cardinality

0..1

Type

date

transactionDate

The date the transaction occurs.

URI

cim:PassThroughBill.transactionDate

Cardinality

0..1

Type

date

transactionType

The type of transaction. For example, charge customer, bill customer, matching AR/AP, or bill determinant

URI

cim:PassThroughBill.transactionType

Cardinality

0..1

Type

string

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