VendorShift

The operating shift for a vendor during which the vendor may transact against the merchant's account. It aggregates transactions and receipts during the shift and periodically debits a merchant account. The totals in vendor shift should always be the sum of totals aggregated in all cashier shifts that were open under the particular vendor shift.

Type

Class

URI

cim:VendorShift

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.

MerchantAccount

0..1

MerchantAccount

Merchant account this vendor shift periodically debits (based on aggregated transactions).

Vendor

0..1

Vendor

Vendor that opens and owns this vendor shift.

merchantDebitAmount

0..1

Money

The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).

posted

0..1

boolean

If true, merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes.

Receipts

0..*

Receipt

All receipts recorded during this vendor shift.

Transactions

0..*

Transaction

All transactions recorded during this vendor shift.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

activityInterval

0..1

DateTimeInterval

Interval for activity of this shift.

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.

receiptsGrandTotalBankable

0..1

Money

Total of amounts receipted during this shift that can be manually banked (cash and cheques for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = true.

receiptsGrandTotalNonBankable

0..1

Money

Total of amounts receipted during this shift that cannot be manually banked (card payments for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = false.

receiptsGrandTotalRounding

0..1

Money

Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt attributes: =sum(Receipt.receiptRounding).

transactionsGrandTotal

0..1

Money

Cumulative total of transacted amounts during this shift. Values are obtained from transaction: =sum('Transaction.transactionAmount'). It also has to be reconciled against transaction summary: =sum('TransactionSummary.transactionsTotal').

transactionsGrandTotalRounding

0..1

Money

Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from Transaction attributes: =sum(Transaction.transactionRounding).

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.


activityInterval

Interval for activity of this shift.

URI

cim:Shift.activityInterval

Cardinality

0..1

Type

DateTimeInterval

Inherited from

Shift

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

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

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

MerchantAccount

Merchant account this vendor shift periodically debits (based on aggregated transactions).

URI

cim:VendorShift.MerchantAccount

Cardinality

0..1

Type

MerchantAccount

merchantDebitAmount

The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).

URI

cim:VendorShift.merchantDebitAmount

Cardinality

0..1

Type

Money

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

posted

If true, merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes.

URI

cim:VendorShift.posted

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

Receipts

All receipts recorded during this vendor shift.

URI

cim:VendorShift.Receipts

Cardinality

0..*

Type

Receipt

receiptsGrandTotalBankable

Total of amounts receipted during this shift that can be manually banked (cash and cheques for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = true.

URI

cim:Shift.receiptsGrandTotalBankable

Cardinality

0..1

Type

Money

Inherited from

Shift

receiptsGrandTotalNonBankable

Total of amounts receipted during this shift that cannot be manually banked (card payments for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = false.

URI

cim:Shift.receiptsGrandTotalNonBankable

Cardinality

0..1

Type

Money

Inherited from

Shift

receiptsGrandTotalRounding

Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt attributes: =sum(Receipt.receiptRounding).

URI

cim:Shift.receiptsGrandTotalRounding

Cardinality

0..1

Type

Money

Inherited from

Shift

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

Transactions

All transactions recorded during this vendor shift.

URI

cim:VendorShift.Transactions

Cardinality

0..*

Type

Transaction

transactionsGrandTotal

Cumulative total of transacted amounts during this shift. Values are obtained from transaction: =sum('Transaction.transactionAmount'). It also has to be reconciled against transaction summary: =sum('TransactionSummary.transactionsTotal').

URI

cim:Shift.transactionsGrandTotal

Cardinality

0..1

Type

Money

Inherited from

Shift

transactionsGrandTotalRounding

Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from Transaction attributes: =sum(Transaction.transactionRounding).

URI

cim:Shift.transactionsGrandTotalRounding

Cardinality

0..1

Type

Money

Inherited from

Shift

Vendor

Vendor that opens and owns this vendor shift.

URI

cim:VendorShift.Vendor

Cardinality

0..1

Type

Vendor