ErpInvoice

A roll up of invoice line items. The whole invoice has a due date and amount to be paid, with information such as customer, banks etc. being obtained through associations. The invoice roll up is based on individual line items that each contain amounts and descriptions for specific services or products.

Type

Class

URI

cim:ErpInvoice

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.

CustomerAccount

0..1

CustomerAccount

n/a

amount

0..1

Money

Total amount due on this invoice based on line items and applicable adjustments.

billMediaKind

0..1

BillMediaKind

Kind of media by which the CustomerBillingInfo was delivered.

dueDate

0..1

date

Calculated date upon which the Invoice amount is due.

kind

0..1

ErpInvoiceKind

Kind of invoice (default is 'sales').

mailedDate

0..1

date

Date on which the customer billing statement/invoice was printed/mailed.

proForma

0..1

boolean

True if payment is to be paid by a Customer to accept a particular ErpQuote (with associated Design) and have work initiated, at which time an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus satisfies terms specificed in the ErpQuote.

referenceNumber

0..1

string

Number of an invoice to be reference by this invoice.

transactionDateTime

0..1

date

Date and time when the invoice is issued.

transferType

0..1

string

Type of invoice transfer.

ErpInvoiceLineItems

0..*

ErpInvoiceLineItem

n/a

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

amount

Total amount due on this invoice based on line items and applicable adjustments.

URI

cim:ErpInvoice.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

billMediaKind

Kind of media by which the CustomerBillingInfo was delivered.

URI

cim:ErpInvoice.billMediaKind

Cardinality

0..1

Type

BillMediaKind

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

CustomerAccount

URI

cim:ErpInvoice.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

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

dueDate

Calculated date upon which the Invoice amount is due.

URI

cim:ErpInvoice.dueDate

Cardinality

0..1

Type

date

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

ErpInvoiceLineItems

URI

cim:ErpInvoice.ErpInvoiceLineItems

Cardinality

0..*

Type

ErpInvoiceLineItem

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

kind

Kind of invoice (default is 'sales').

URI

cim:ErpInvoice.kind

Cardinality

0..1

Type

ErpInvoiceKind

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

mailedDate

Date on which the customer billing statement/invoice was printed/mailed.

URI

cim:ErpInvoice.mailedDate

Cardinality

0..1

Type

date

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

proForma

True if payment is to be paid by a Customer to accept a particular ErpQuote (with associated Design) and have work initiated, at which time an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus satisfies terms specificed in the ErpQuote.

URI

cim:ErpInvoice.proForma

Cardinality

0..1

Type

boolean

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

referenceNumber

Number of an invoice to be reference by this invoice.

URI

cim:ErpInvoice.referenceNumber

Cardinality

0..1

Type

string

revisionNumber

Revision number for this document.

URI

cim:Document.revisionNumber

Cardinality

0..1

Type

string

Inherited from

Document

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

title

Document title.

URI

cim:Document.title

Cardinality

0..1

Type

string

Inherited from

Document

transactionDateTime

Date and time when the invoice is issued.

URI

cim:ErpInvoice.transactionDateTime

Cardinality

0..1

Type

date

transferType

Type of invoice transfer.

URI

cim:ErpInvoice.transferType

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