Skip to content

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

URI: cim:VendorShift

 classDiagram
    class VendorShift
      Shift <|-- VendorShift

      VendorShift : activity_interval

          VendorShift --> DateTimeInterval : activity_interval

      VendorShift : alias_name

      VendorShift : description

      VendorShift : diagram_objects

          VendorShift --> DiagramObject : diagram_objects

      VendorShift : instance_set

          VendorShift --> InstanceSet : instance_set

      VendorShift : m_rid

      VendorShift : merchant_account

          VendorShift --> MerchantAccount : merchant_account

      VendorShift : merchant_debit_amount

          VendorShift --> Money : merchant_debit_amount

      VendorShift : names

          VendorShift --> Name : names

      VendorShift : posted

      VendorShift : properties_cimdata_object

          VendorShift --> ChangeSetMember : properties_cimdata_object

      VendorShift : receipts

          VendorShift --> Receipt : receipts

      VendorShift : receipts_grand_total_bankable

          VendorShift --> Money : receipts_grand_total_bankable

      VendorShift : receipts_grand_total_non_bankable

          VendorShift --> Money : receipts_grand_total_non_bankable

      VendorShift : receipts_grand_total_rounding

          VendorShift --> Money : receipts_grand_total_rounding

      VendorShift : targeting_cimdata_object

          VendorShift --> ChangeSetMember : targeting_cimdata_object

      VendorShift : transactions

          VendorShift --> Transaction : transactions

      VendorShift : transactions_grand_total

          VendorShift --> Money : transactions_grand_total

      VendorShift : transactions_grand_total_rounding

          VendorShift --> Money : transactions_grand_total_rounding

      VendorShift : vendor

          VendorShift --> Vendor : vendor

Inheritance

Slots

Name Cardinality and Range Description Inheritance
merchant_debit_amount 0..1
Money		 The amount that is to be debited from the merchant account for this vendor sh... direct
posted 0..1
Boolean		 If true, merchantDebitAmount has been debited from MerchantAccount; typically... direct
receipts 0..*
Receipt		 All receipts recorded during this vendor shift direct
transactions 0..*
Transaction		 All transactions recorded during this vendor shift direct
merchant_account 0..1
MerchantAccount		 Merchant account this vendor shift periodically debits (based on aggregated t... direct
vendor 0..1
Vendor		 Vendor that opens and owns this vendor shift direct
activity_interval 0..1
DateTimeInterval		 Interval for activity of this shift Shift
receipts_grand_total_bankable 0..1
Money		 Total of amounts receipted during this shift that can be manually banked (cas... Shift
receipts_grand_total_non_bankable 0..1
Money		 Total of amounts receipted during this shift that cannot be manually banked (... Shift
receipts_grand_total_rounding 0..1
Money		 Cumulative amount in error due to process rounding not reflected in receiptsG... Shift
transactions_grand_total 0..1
Money		 Cumulative total of transacted amounts during this shift Shift
transactions_grand_total_rounding 0..1
Money		 Cumulative amount in error due to process rounding not reflected in transacti... Shift
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
Transaction vendor_shift range VendorShift
Receipt vendor_shift range VendorShift
MerchantAccount vendor_shifts range VendorShift
Vendor vendor_shifts range VendorShift

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: VendorShift
description: 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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Shift
attributes:
  merchant_debit_amount:
    name: merchant_debit_amount
    description: The amount that is to be debited from the merchant account for this
      vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.merchantDebitAmount
    multivalued: false
    domain_of:
    - VendorShift
    range: Money
    required: false
  posted:
    name: posted
    description: "If true, merchantDebitAmount has been debited from MerchantAccount;\
      \ typically happens at the end of VendorShift when it closes.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.posted
    multivalued: false
    domain_of:
    - VendorShift
    range: boolean
    required: false
  receipts:
    name: receipts
    description: All receipts recorded during this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:VendorShift.Receipts
    multivalued: true
    domain_of:
    - CashierShift
    - VendorShift
    range: Receipt
    required: false
  transactions:
    name: transactions
    description: All transactions recorded during this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:VendorShift.Transactions
    multivalued: true
    domain_of:
    - PricingStructure
    - CashierShift
    - Receipt
    - VendorShift
    range: Transaction
    required: false
  merchant_account:
    name: merchant_account
    description: Merchant account this vendor shift periodically debits (based on
      aggregated transactions).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.MerchantAccount
    multivalued: false
    domain_of:
    - VendorShift
    range: MerchantAccount
    required: false
  vendor:
    name: vendor
    description: Vendor that opens and owns this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.Vendor
    multivalued: false
    domain_of:
    - VendorShift
    range: Vendor
    required: false
class_uri: cim:VendorShift

Induced

name: VendorShift
description: 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.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Shift
attributes:
  merchant_debit_amount:
    name: merchant_debit_amount
    description: The amount that is to be debited from the merchant account for this
      vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.merchantDebitAmount
    multivalued: false
    alias: merchant_debit_amount
    owner: VendorShift
    domain_of:
    - VendorShift
    range: Money
    required: false
  posted:
    name: posted
    description: "If true, merchantDebitAmount has been debited from MerchantAccount;\
      \ typically happens at the end of VendorShift when it closes.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.posted
    multivalued: false
    alias: posted
    owner: VendorShift
    domain_of:
    - VendorShift
    range: boolean
    required: false
  receipts:
    name: receipts
    description: All receipts recorded during this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:VendorShift.Receipts
    multivalued: true
    alias: receipts
    owner: VendorShift
    domain_of:
    - CashierShift
    - VendorShift
    range: Receipt
    required: false
  transactions:
    name: transactions
    description: All transactions recorded during this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:VendorShift.Transactions
    multivalued: true
    alias: transactions
    owner: VendorShift
    domain_of:
    - PricingStructure
    - CashierShift
    - Receipt
    - VendorShift
    range: Transaction
    required: false
  merchant_account:
    name: merchant_account
    description: Merchant account this vendor shift periodically debits (based on
      aggregated transactions).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.MerchantAccount
    multivalued: false
    alias: merchant_account
    owner: VendorShift
    domain_of:
    - VendorShift
    range: MerchantAccount
    required: false
  vendor:
    name: vendor
    description: Vendor that opens and owns this vendor shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:VendorShift.Vendor
    multivalued: false
    alias: vendor
    owner: VendorShift
    domain_of:
    - VendorShift
    range: Vendor
    required: false
  activity_interval:
    name: activity_interval
    description: Interval for activity of this shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.activityInterval
    multivalued: false
    alias: activity_interval
    owner: VendorShift
    domain_of:
    - Shift
    range: DateTimeInterval
    required: false
  receipts_grand_total_bankable:
    name: receipts_grand_total_bankable
    description: "Total of amounts receipted during this shift that can be manually\
      \ banked (cash and cheques for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = true."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalBankable
    multivalued: false
    alias: receipts_grand_total_bankable
    owner: VendorShift
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_non_bankable:
    name: receipts_grand_total_non_bankable
    description: "Total of amounts receipted during this shift that cannot be manually\
      \ banked (card payments for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = false."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalNonBankable
    multivalued: false
    alias: receipts_grand_total_non_bankable
    owner: VendorShift
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_rounding:
    name: receipts_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in receiptsGrandTotal. Values are obtained from Receipt attributes:\r\n=sum(Receipt.receiptRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalRounding
    multivalued: false
    alias: receipts_grand_total_rounding
    owner: VendorShift
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total:
    name: transactions_grand_total
    description: "Cumulative total of transacted amounts during this shift. Values\
      \ are obtained from transaction:\r\n=sum('Transaction.transactionAmount'). It\
      \ also has to be reconciled against transaction summary:\r\n=sum('TransactionSummary.transactionsTotal')."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotal
    multivalued: false
    alias: transactions_grand_total
    owner: VendorShift
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total_rounding:
    name: transactions_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in transactionsGandTotal. Values are obtained from Transaction attributes:\r\
      \n=sum(Transaction.transactionRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotalRounding
    multivalued: false
    alias: transactions_grand_total_rounding
    owner: VendorShift
    domain_of:
    - Shift
    range: Money
    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: VendorShift
    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: VendorShift
    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: VendorShift
    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: VendorShift
    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: VendorShift
    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: VendorShift
    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: VendorShift
    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: VendorShift
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:VendorShift