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 standard (perspective) |
IEC61968 (Enterprise) |
Slots
| Name | Type | Description | Inherited from |
|---|---|---|---|
0..1 |
Merchant account this vendor shift periodically debits (based on aggregated transactions). |
n/a |
|
0..* |
All receipts recorded during this vendor shift. |
n/a |
|
0..* |
All transactions recorded during this vendor shift. |
n/a |
|
0..1 |
Vendor that opens and owns this vendor shift. |
n/a |
|
0..1 |
The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the... |
n/a |
|
0..1 |
If true, merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes. |
n/a |
|
0..1 |
Interval for activity of this shift. |
||
0..1 |
Total of amounts receipted during this shift that can be manually banked (cash and cheques for example). Values are obtained... |
||
0..1 |
Total of amounts receipted during this shift that cannot be manually banked (card payments for example). Values are obtained... |
||
0..1 |
Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt... |
||
0..1 |
Cumulative total of transacted amounts during this shift. Values are obtained from... |
||
0..1 |
Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from... |
||
0..* |
The diagram objects that are associated with the domain object. |
||
Dataset containing the data objects. |
|||
0..* |
All names of this identified object. |
||
0..1 |
The single CIM data object in the appropriate dataset context. |
||
0..* |
Data objects registered. |
||
0..1 |
The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and... |
||
0..1 |
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to... |
||
0..1 |
Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is... |
||
0..1 |
The name is any free human readable and possibly non unique text naming the object. |
activityInterval
Interval for activity of this shift.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
DiagramObjects
The diagram objects that are associated with the domain object.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
InstanceSet
Dataset containing the data objects.
URI |
|
|---|---|
Cardinality |
1 |
Type |
|
Inherited from |
MerchantAccount
Merchant account this vendor shift periodically debits (based on aggregated transactions).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
merchantDebitAmount
The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
name
The name is any free human readable and possibly non unique text naming the object.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
Names
All names of this identified object.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
posted
If true, merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
PropertiesCIMDataObject
The single CIM data object in the appropriate dataset context.
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
Receipts
All receipts recorded during this vendor shift.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
receiptsGrandTotalRounding
Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt attributes: =sum(Receipt.receiptRounding).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
TargetingCIMDataObject
Data objects registered.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
Transactions
All transactions recorded during this vendor shift.
URI |
|
|---|---|
Cardinality |
0..* |
Type |
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 |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
transactionsGrandTotalRounding
Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from Transaction attributes: =sum(Transaction.transactionRounding).
URI |
|
|---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |