ARTS Logo

IXRetail Dictionary

Version 2.1 Build 01

Copyright 2000, IXRetail.

Retail Store Functions

Business Function

Subject Areas

Request For Comment Forecourt Fueling Point :: Forecourt Extensions :: Forecourt History :: Forecourt Pricing :: Forecourt Transaction :: Price Derivation Rules & Eligibilities :: Sales Tax View ::
Customer Relationship Management Customer Data Collection :: Customer Maintenance :: Employee Customer Management :: Gift Registry :: Loyalty Program Management :: Micro Marketing ::
Inventory Management Physical Inventory :: Retail Stock Ledger Maintenance ::
Item & Price Management Electronic Labeling :: Item Labeling :: Item Maintenance :: Price Derivation Rules Maintenance :: Service Item Maintenance :: Shelf Labeling ::
Merchandise Flow Management Direct Store Delivery :: Receiving :: Return to Vendor :: Stock Adjustment :: Transfer In Processing :: Transfer Out Processing ::
Ordering Direct Store Delivery Ordering :: Order Creation :: Replenishment Management ::
Point of Sale Processing POS Access Control :: POS Account Maintenance :: POS Payment Processing :: POS Price Derivation :: POS Sales & Returns Processing :: POS Sales Tax Processing :: POS Tender Processing :: POS Transaction Log Processing :: POS Void Processing :: Price Lookup ::
Store & Productivity Reporting Reporting Hierarchy Maintenance :: Sales Analysis :: Store Performance Reporting ::
Store Administration Accounting Period Close :: Accounting Period Open :: Financial Adjustments :: Party Maintenance :: Petty Cash Disbursements :: Petty Cash Receipts :: Store Access Control :: Store Calendar Maintenance :: Store Controls Maintenance :: Store Item Tax Maintenance :: Store Merchandise Location Maintenance :: Store Rules Maintenance ::
Tender Control External Authorization :: Media Balancing :: POS Loan/Pickup Processing :: Positive /Negative Authorization :: Tender Deposit ::
Workforce Management Employee Maintenance :: Employee Performance Management :: Time and Attendance :: Work Force Planning ::

Subject Areas

Forecourt Extensions

Blender :: BulkItem :: DevicePrice :: DriveOffTransaction :: Equipment :: Event :: ForecourtSettlementTransaction :: ForecourtTransaction :: FuelingPoint :: FuelingTransactionEvent :: FuelSalePriceModifier :: FuelSalesLineItem :: FuelSaleTaxModifier :: Location :: LogicalNozzle :: MissingVolumeEvent :: NozzleFuelingTransactionHistory :: NozzleHistory :: Operator :: PhysicalInventoryEvent :: PhysicalNozzle :: PrepayHistory :: ReportingPeriod :: RetailPriceModifier :: RetailStoreItem :: RetailTransaction :: RetailTransactionLineItem :: SaleReturnLineItem :: SaleReturnLineItemAddress :: SaleReturnTaxModifier :: SalesMeter :: SalesMeterReading :: StockItem :: StockItemLocation :: StockLedgerAccount :: StockMeter :: StockMeterReading :: TaxableGroup :: TaxGroupRule :: TestDelivery :: TimeGroupTimePeriod :: Transaction :: Workstation ::
Back to Top

Forecourt Fueling Point

Blender :: DevicePrice :: Equipment :: FuelingPoint :: Location :: LogicalNozzle :: PhysicalNozzle :: SalesMeter :: SalesMeterReading :: StockMeter :: StockMeterReading ::
Back to Top

Forecourt History

Blender :: ForecourtSettlementTransaction :: ForecourtTransaction :: FuelingPoint :: LogicalNozzle :: NozzleFuelingTransactionHistory :: NozzleHistory :: PhysicalInventoryEvent :: PrepayHistory :: ReportingPeriod :: SalesMeter :: SalesMeterReading :: StockMeter :: StockMeterReading ::
Back to Top

Forecourt Pricing

DevicePrice :: FuelingPoint :: LogicalNozzle :: TimeGroupTimePeriod ::
Back to Top

Forecourt Transaction

DriveOffTransaction :: ForecourtSettlementTransaction :: ForecourtTransaction :: FuelingPoint :: FuelingTransactionEvent :: FuelSalePriceModifier :: FuelSalesLineItem :: FuelSaleTaxModifier :: POSIdentity :: RetailTransaction :: RetailTransactionLineItem :: TestDelivery :: Transaction ::
Back to Top

Price Derivation Rules & Eligibilities

BrandPriceDerivationRuleEligbility :: CustomerAccountPriceDerivationRuleEligibility :: CustomerAffiliationPriceDerivationRuleEligibility :: EmployeeDiscountGroupPriceDerivationRuleEligibility :: ItemPriceDerivationRule :: ItemPriceDerivationRuleEligibility :: ManufacturerPriceDerivationRuleEligibility :: MerchandiseStructureLevel :: MerchandiseStructurePriceDerivationRuleEligibility :: MixAndMatchPriceDerivationItem :: MixAndMatchPriceDerivationRule :: MultiplePriceDerivationRuleEligibility :: PriceDerivationRuleMaintenance :: PriceLinePriceDerivationRuleEligibility :: SeasonPriceDerivationRuleEligibility :: SubseasonPriceDerivationRuleEligibility :: TimeGroupTimePeriod :: TotalPurchaseMarketBasketPriceDerivationRuleEligibility ::
Back to Top

Sales Tax View

FinancialTransactionJournalEntry :: RetailStoreItem :: RetailTransaction :: RetailTransactionLineItem :: SaleReturnLineItem :: SaleReturnTaxModifier :: StoreFinancialLedgerAccount :: TaxableGroup :: TaxExemptionModifier :: TaxGroupRule :: TaxLineItem :: TaxRate :: Transaction ::
Back to Top

Direct Store Delivery

AccessPassword :: Contact :: DiscrepancyToleranceRule :: FreightBill :: InventoryControlDocument :: InventoryControlDocumentAllowanceLineItem :: InventoryControlDocumentChargeLineItem :: InventoryControlDocumentFreightLineItem :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: InventoryControlDocumentMerchandiseLineItemModifier :: InventoryControlDocumentReference :: InventoryControlDocumentTaxLineItem :: Location :: OrderDocument :: PackingSlip :: PartyAddress :: ReceivingDocument :: RetailStoreItem :: ShipmentContainer :: ShipmentContainerMerchandiseLineItem :: StockItem :: StockLedgerAccount :: StoreFinancialLedgerAccount :: SupplierItem ::
Back to Top

Receiving

AccessPassword :: AdvancedShipNoticeDocument :: Contact :: DiscrepancyToleranceRule :: ExchangeRate :: FreightBill :: InventoryControlDocument :: InventoryControlDocumentAllowanceLineItem :: InventoryControlDocumentChargeLineItem :: InventoryControlDocumentFreightLineItem :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: InventoryControlDocumentMerchandiseLineItemModifier :: InventoryControlDocumentReference :: InventoryControlDocumentTaxLineItem :: Location :: OrderDocument :: PackingSlip :: ReceivingDocument :: RetailStoreItem :: ShipmentContainer :: ShipmentContainerMerchandiseLineItem :: StockItem :: StockLedgerAccount :: StoreFinancialLedgerAccount :: SupplierItem ::
Back to Top

Return to Vendor

AccessPassword :: Contact :: ExchangeRate :: FreightBill :: InventoryControlDocument :: InventoryControlDocumentAllowanceLineItem :: InventoryControlDocumentFreightLineItem :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: InventoryControlDocumentMerchandiseLineItemModifier :: InventoryControlDocumentReference :: InventoryControlDocumentTaxLineItem :: Location :: OrderDocument :: PartyAddress :: ReceivingDocument :: RequestForDebitCreditDocument :: RetailStoreItem :: ReturnAuthorizationRequest :: ReturnDocument :: StockItem ::
Back to Top

Stock Adjustment

AccessPassword :: InventoryAdjustmentDocument :: InventoryAdjustmentLineItem :: Location :: RetailStoreItem :: StockItem :: StockLedgerAccount ::
Back to Top

Transfer In Processing

AccessPassword :: DiscrepancyToleranceRule :: FreightBill :: InventoryAdjustmentLineItem :: InventoryControlDocument :: InventoryControlDocumentChargeLineItem :: InventoryControlDocumentFreightLineItem :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: InventoryControlDocumentMerchandiseLineItemModifier :: InventoryControlDocumentReference :: InventoryControlDocumentTaxLineItem :: Location :: PackingSlip :: PhysicalCountLineItem :: ReceivingDocument :: ReportingPeriod :: RetailStoreItem :: SaleReturnLineItem :: ShipmentContainer :: ShipmentContainerMerchandiseLineItem :: StockItem :: StockLedgerAccount :: StoreFinancialLedgerAccount :: StoreFinancialLedgerFiscalPeriodHistory :: TransferInDocument ::
Back to Top

Transfer Out Processing

AccessPassword :: DiscrepancyToleranceRule :: FreightBill :: InventoryAdjustmentLineItem :: InventoryControlDocument :: InventoryControlDocumentAllowanceLineItem :: InventoryControlDocumentChargeLineItem :: InventoryControlDocumentFreightLineItem :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: InventoryControlDocumentMerchandiseLineItemModifier :: InventoryControlDocumentReference :: InventoryControlDocumentTaxLineItem :: Location :: PackingSlip :: PhysicalCountLineItem :: RetailStoreItem :: SaleReturnLineItem :: ShipmentContainer :: ShipmentContainerMerchandiseLineItem :: StockItem :: StockLedgerAccount :: StoreFinancialLedgerAccount :: TransferOutDocument ::
Back to Top

Physical Inventory

AccessPassword :: AssociatedMerchandiseStructureLevel :: Event :: FiscalDay :: InventoryAdjustmentDocument :: InventoryAdjustmentLineItem :: Location :: PhysicalCountLineItem :: PhysicalInventoryEvent :: RetailStoreItem :: StockItem :: StockLedgerAccount ::
Back to Top

Retail Stock Ledger Maintenance

AccessPassword :: Deal :: DealSupplierItem :: DealSupplierItemCostBreak :: FiscalDay :: Location :: ReportingPeriod :: RetailStoreItem :: StockLedgerAccount :: StockLedgerAccountFiscalPeriodHistory :: SupplierItem ::
Back to Top

Electronic Labeling

AccessPassword :: ItemAlternateIdentity :: ItemElectronicLabel :: ItemLabel :: Location :: LocationEnvironmentClass :: RetailStoreItem :: StockItem :: StockItemConsumerProductLabel ::
Back to Top

Item Labeling

AccessPassword :: AssociatedMerchandiseStructureLevel :: ItemAlternateIdentity :: ItemLabel :: ItemMaintenanceEvent :: ItemTicket :: Location :: LocationEnvironmentClass :: RetailStoreItem :: SerializedUnit :: StockItem :: StockItemConsumerProductLabel ::
Back to Top

Item Maintenance

AccessPassword :: AgeRestrictionRule :: AlternativeItem :: AssociatedMerchandiseStructureLevel :: CommissionModifier :: CompetitorRetailItem :: DepositRule :: Employee :: Event :: InventoryControlDocumentLineItem :: ItemAlternateIdentity :: ItemCreation :: ItemDeletion :: ItemDescriptonUpdate :: ItemLot :: ItemMaintenanceEvent :: ItemPriceMaintenance :: Location :: MaintenanceEvent :: ManufacturerBrand :: ManufacturerCouponFamily :: ManufacturerItem :: MerchandiseStructureLevel :: MerchandiseStructureLevelSize :: PartyRole :: PermanentPriceChange :: PermanentPriceChangeItem :: POSIdentity :: PriceLine :: RetailStoreItem :: SaleReturnLineItem :: SerializedUnit :: StockItem :: StockItemConsumerProductLabel :: StoreFinancialLedgerAccount :: Subseason :: SupplierItem :: SupplierItemCatalogBaseCost :: SupplierItemCatalogBaseCostBreak :: SupplierItemStockItem :: SupplierPricePromotionZone :: TaxableGroup :: TemporaryPriceChange :: TemporaryPriceChangeItem ::
Back to Top

Price Derivation Rules Maintenance

AccessPassword :: AssociatedMerchandiseStructureLevel :: BrandPriceDerivationRuleEligbility :: Charity :: CustomerAccountPriceDerivationRuleEligibility :: CustomerAccountSpecialPrice :: CustomerAffiliation :: CustomerAffiliationPriceDerivationRuleEligibility :: CustomerLoyaltyAccount :: Employee :: EmployeeDiscountGroupPriceDerivationRuleEligibility :: EmployeeMembershipDiscountGroup :: Event :: ItemLoyaltyAccountEligibility :: ItemPriceDerivationRule :: ItemPriceDerivationRuleEligibility :: Location :: LocationEnvironmentClass :: ManufacturerPriceDerivationRuleEligibility :: MerchandiseStructureLevel :: MerchandiseStructurePriceDerivationRuleEligibility :: MixAndMatchPriceDerivationItem :: MixAndMatchPriceDerivationRule :: POSIdentity :: PriceDerivationRuleMaintenance :: RetailStoreItem :: StockItem :: StoreFinancialLedgerAccount :: Subseason :: SubseasonPriceDerivationRuleEligibility :: TotalPurchaseMarketBasketPriceDerivationRuleEligibility ::
Back to Top

Service Item Maintenance

AccessPassword :: AgeRestrictionRule :: AlternativeItem :: AssociatedMerchandiseStructureLevel :: CompetitorRetailItem :: DepositRule :: Employee :: Event :: ItemAlternateIdentity :: ItemCreation :: ItemDeletion :: ItemDescriptonUpdate :: ItemLot :: ItemMaintenanceEvent :: ItemPriceMaintenance :: Location :: MaintenanceEvent :: MerchandiseStructureLevel :: MerchandiseStructureLevelSize :: PartyRole :: PermanentPriceChange :: PermanentPriceChangeItem :: POSIdentity :: PriceLine :: RentalObject :: RentalService :: RentalUnit :: RetailStoreItem :: SaleReturnLineItem :: ServiceItem :: ServiceItemProvider :: Subseason :: TaxableGroup :: TemporaryPriceChange :: TemporaryPriceChangeItem ::
Back to Top

Shelf Labeling

AccessPassword :: ItemAlternateIdentity :: ItemLabel :: ItemShelfLabel :: Location :: LocationEnvironmentClass :: RetailStoreItem :: StockItem :: StockItemConsumerProductLabel ::
Back to Top

POS Access Control

AccessPassword :: ControlTransaction :: Employee :: GroupResourceAccess :: Location :: Operator :: OperatorGroup :: OperatorHistory :: OperatorResourceAccess :: POSLockTransaction :: POSUnlockTransaction :: ReportingPeriod :: SalariedEmployee :: Session :: SignOffTransaction :: SignOnTransaction :: StoreHistory :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication :: WorkstationTimeActivityHistory ::
Back to Top

POS Account Maintenance

AccessPassword ::
Back to Top

POS Payment Processing

AccessPassword :: CustomerConsumerChargeAccount :: CustomerInstallmentPaymentAccount :: CustomerLayawayAccount :: CustomerTradeAccount :: ExchangeRate :: KeyCustomer :: Operator :: PaymentOnAccountLineItem :: ReportingPeriod :: RetailTransactionLineItem :: Session :: StoreFinancialLedgerAccount :: StoreHistory :: ThirdPartyCustomerIdentification :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication ::
Back to Top

POS Price Derivation

CouponHandlingRule :: CustomerAccountPriceDerivationRuleEligibility :: CustomerAccountSpecialPrice :: CustomerAffiliation :: CustomerAffiliationPriceDerivationRuleEligibility :: CustomerLoyaltyAccount :: CustomerOccasion :: CustomerTradeAccount :: CustomerTypeSpecialPrice :: DepositRule :: EmployeeDiscountLineItem :: EmployeeMembershipDiscountGroup :: Event :: ItemPriceDerivationRule :: ItemPriceDerivationRuleEligibility :: Location :: ManufacturerPriceDerivationRuleEligibility :: MerchandiseStructurePriceDerivationRuleEligibility :: MixAndMatchPriceDerivationItem :: MixAndMatchPriceDerivationRule :: POSIdentity :: PriceLine :: PriceLinePriceDerivationRuleEligibility :: RentalService :: RetailPriceModifier :: RetailTransactionLineItem :: SaleReturnLineItem :: SeasonPriceDerivationRuleEligibility :: StockItem :: SubseasonPriceDerivationRuleEligibility :: ThirdPartyCustomerIdentification :: TotalPurchaseMarketBasketPriceDerivationRuleEligibility ::
Back to Top

POS Sales & Returns Processing

AccessPassword :: AccountReceivablePayableLineItem :: AgeRestrictionRule :: AlternativeItem :: AssociatedMerchandiseStructureLevel :: CommissionedEmployee :: CommissionModifier :: CustomerLoyaltyAccount :: DepositRedemptionLineItem :: DepositRule :: DiscountLineItem :: Employee :: EmployeeDiscountedSalesHistory :: GiftCertificateLineItem :: ItemAlternateIdentity :: ItemMaintenanceEvent :: ItemSalesProhibitionPeriodRule :: ItemSalesSummary :: ItemSellingPriceHistory :: LicenseSalesRestriction :: MerchandiseStructureLevelSalesRestriction :: MiscellaneousFeeLineItem :: Operator :: POSDepartmentHistory :: POSIdentity :: PromotionalLineItem :: RentalService :: RentalUnit :: ReportingPeriod :: RetailStoreItem :: RetailTransaction :: RetailTransactionLineItem :: RetailTransactionLineItemOverride :: SaleReturnLineItem :: SaleReturnLineItemAddress :: SaleReturnTaxModifier :: SerializedUnit :: ServiceItem :: ServiceItemProvider :: Session :: StockItem :: StoreFinancialLedgerAccount :: TaxableGroup :: TaxGroupRule :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication ::
Back to Top

POS Sales Tax Processing

AccessPassword :: Operator :: OperatorHistory :: OperatorTaxHistory :: POSDepartmentHistory :: POSDepartmentSalesTaxHistory :: ReportingPeriod :: RetailTransactionLineItem :: Session :: SessionTax :: StoreFinancialLedgerAccount :: StoreHistory :: StoreTaxHistory :: TaxableGroup :: TaxExemptionModifier :: TaxGroupRule :: TaxLineItem :: TillHistory :: TillTaxHistory :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication :: WorkstationTaxHistory ::
Back to Top

POS Tender Processing

AccessPassword :: CheckTenderLineItem :: CouponHandlingRule :: CouponTenderLineItem :: CreditDebitCardTenderLineItem :: CustomerAccountCard :: CustomerConsumerChargeAccount :: CustomerLoyaltyAccount :: CustomerLoyaltyAccountRedemption :: Employee :: ExchangeRate :: ForeignCurrencyTenderLineItem :: GiftCertificateTenderLineItem :: ItemTenderRestrictionRule :: ManufacturerCouponFamily :: Operator :: OperatorHistory :: OperatorTenderHistory :: ReportingPeriod :: RetailTransactionLineItem :: SaleReturnLineItem :: SendCheckTenderLineItem :: Session :: SessionTender :: StoreFinancialLedgerAccount :: StoreHistory :: StoreTenderHistory :: TenderChangeLineItem :: TenderLineItem :: TenderRepository :: TenderRepositoryTenderAccount :: ThirdPartyCustomerIdentification :: Till :: TillHistory :: TillSettlementTransaction :: Trade-In-KindTenderLineItem :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication :: WorkstationRuleTender :: WorkstationTenderHistory :: WorkstationTimeActivityHistory :: WorkstationTimeActivityTenderHistory ::
Back to Top

POS Transaction Log Processing

ControlTransaction :: Operator :: POSNoSaleTransaction :: ReportingPeriod :: Session :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication :: WorkstationTimeActivityHistory ::
Back to Top

POS Void Processing

AccessPassword :: AccountReceivablePayableLineItem :: CheckTenderLineItem :: ControlTransaction :: CouponHandlingRule :: CouponTenderLineItem :: CreditDebitCardTenderLineItem :: DepositRedemptionLineItem :: Employee :: GiftCertificateLineItem :: ManufacturerCouponFamily :: MiscellaneousFeeLineItem :: Operator :: PaymentOnAccountLineItem :: POSIdentity :: PostVoidTransaction :: ReportingPeriod :: RetailTransaction :: RetailTransactionLineItem :: SaleReturnLineItem :: SaleReturnTaxModifier :: SendCheckTenderLineItem :: Session :: StoreHistory :: TaxableGroup :: TaxGroupRule :: TenderControlTransaction :: TenderControlTransactionTenderLineItem :: TenderLineItem :: Trade-In-KindTenderLineItem :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication ::
Back to Top

Price Lookup

AccessPassword :: AlternativeItem :: AssociatedMerchandiseStructureLevel :: BrandPriceDerivationRuleEligbility :: Charity :: CouponHandlingRule :: CustomerTypeSpecialPrice :: POSIdentity :: ServiceItem :: TemporaryPriceChange :: TemporaryPriceChangeItem ::
Back to Top

External Authorization

Contact :: PartyAddress ::
Back to Top

Media Balancing

AccessPassword :: CheckTenderLineItem :: ControlTransaction :: FiscalDay :: Operator :: ReportingPeriod :: StoreHistory :: StoreSafe :: StoreSafeHistory :: StoreSafeSettlementTransaction :: StoreSafeTender :: StoreSafeTenderHistory :: StoreTenderHistory :: TenderRepository :: Till :: TillHistory :: TillSettlementTransaction :: Workstation :: WorkstationHistory :: WorkstationTenderHistory :: WorkstationTimeActivityHistory :: WorkstationTimeActivityTenderHistory ::
Back to Top

POS Loan/Pickup Processing

AccessPassword :: Event :: FinancialAccountingTransaction :: FiscalDay :: Location :: Operator :: ReportingPeriod :: SafeTransferTransaction :: Session :: StoreFinancialLedgerAccount :: StoreHistory :: StoreSafe :: StoreSafeHistory :: StoreSafeSettlementTransaction :: StoreSafeTender :: StoreSafeTenderHistory :: StoreTenderHistory :: TenderControlTransaction :: TenderControlTransactionTenderLineItem :: TenderLoanTransaction :: TenderPickupTransaction :: TenderRepository :: TenderRepositoryTenderAccount :: Till :: TillHistory :: TillSettlementTransaction :: Transaction :: Workstation :: WorkstationHistory :: WorkstationRule :: WorkstationRuleApplication :: WorkstationTenderHistory :: WorkstationTimeActivityHistory :: WorkstationTimeActivityTenderHistory ::
Back to Top

Positive /Negative Authorization

AccessPassword :: ReportingPeriod :: StoreHistory :: TenderAccountApprovalReference ::
Back to Top

Tender Deposit

ControlTransaction :: ExternalDepository :: ExternalDepositoryHistory :: ExternalDepositorySettlementTransaction :: ExternalDepositoryTender :: ExternalDepositoryTenderHistory :: ReportingPeriod :: StoreFinancialLedgerAccount :: StoreHistory :: StoreSafe :: StoreSafeHistory :: StoreSafeSettlementTransaction :: StoreSafeTender :: StoreSafeTenderHistory :: StoreTenderHistory :: TenderControlTransaction :: TenderControlTransactionTenderLineItem :: TenderRepository :: TenderRepositoryTenderAccount :: Transaction ::
Back to Top

Accounting Period Close

ControlTransaction :: PeriodCloseTransaction :: ReportingPeriod :: StoreFinancialLedgerAccount :: StoreFinancialLedgerFiscalPeriodHistory ::
Back to Top

Accounting Period Open

ControlTransaction :: PeriodCloseTransaction :: StoreFinancialLedgerAccount ::
Back to Top

Financial Adjustments

FinancialAccountingTransaction :: FinancialTransactionJournalEntry :: FiscalDay :: InventoryControlDocument :: StoreFinancialLedgerAccount :: Transaction ::
Back to Top

Party Maintenance

CommercialEnterprise :: Contact :: Employee :: NonProfitEnterprise :: NonStandardAddress :: Organization :: OrganizationalAffiliation :: OrganizationalStructure :: PartyAddress :: PartyRole :: PartyRoleStatus :: PartyRoleTypeState :: Person :: PersonOrganizationAffiliation :: PhysicalLocation :: PhysicalLocationAddress :: StandardizedAddress :: StandardizedDomesticAddress :: StandardizedForeignAddress :: TaxExemptOrganization :: Telephone ::
Back to Top

Petty Cash Disbursements

DisbursementTransaction :: FinancialAccountingTransaction :: StoreFinancialLedgerAccount ::
Back to Top

Petty Cash Receipts

DisbursementTransaction :: FinancialAccountingTransaction :: FundsReceiptTransaction :: MiscellaneousFeeLineItem :: RetailTransactionLineItem :: StoreFinancialLedgerAccount ::
Back to Top

Store Access Control

Location :: LocationEnvironmentClass ::
Back to Top

Store Calendar Maintenance

AccessPassword :: Event :: FiscalDay :: FiscalMonth :: FiscalQuarter :: FiscalWeek :: Location :: PhysicalInventoryEvent :: ReportingPeriod :: RetailStoreLocationEvent :: Season :: Subseason ::
Back to Top

Store Controls Maintenance

AccessPassword :: ControlTransaction :: Denomination :: Operator :: PartyRole :: ReportingPeriod :: RetailStoreItem :: RetailStorePOSDepartment :: StoreFinancialLedgerAccount :: StoreHistory :: StoreSafe :: StoreSafeTender :: TemporaryPriceChange :: TemporaryPriceChangeItem :: TenderRepository :: TenderRepositoryTenderAccount :: Till :: TillHistory :: TillSettlementTransaction :: Transaction :: Workstation ::
Back to Top

Store Item Tax Maintenance

AccessPassword :: StockItem :: StoreFinancialLedgerAccount :: TaxableGroup :: TaxGroupRule ::
Back to Top

Store Merchandise Location Maintenance

AccessPassword :: Location :: LocationEnvironmentClass :: RetailStoreItem :: StockItem ::
Back to Top

Store Rules Maintenance

AccessPassword :: AgeRestrictionRule :: CouponHandlingRule :: DepositRule :: DiscrepancyToleranceRule :: Event :: ExchangeRate :: ItemSalesProhibitionPeriodRule :: ItemTenderRestrictionRule :: LicenseSalesRestriction :: MerchandiseStructureLevel :: MerchandiseStructureLevelSalesRestriction :: StockItem :: SupplierItemReceivingUnit :: SupplierItemReceivingUnitConversionRule :: Workstation :: WorkstationResource :: WorkstationRule :: WorkstationRuleApplication :: WorkstationRuleTender ::
Back to Top

Reporting Hierarchy Maintenance

AssociatedMerchandiseStructureLevel :: MerchandiseStructureLevel :: RelatedItemAssociation ::
Back to Top

Sales Analysis

MerchandiseHierarchySalesPlan :: MerchandiseHierarchySalesSummary :: MerchandiseStructureLevel :: RelatedItemAssociation :: RelatedItemAssociationSalesSummary :: ReportingPeriod ::
Back to Top

Store Performance Reporting

AccessPassword :: AssociatedMerchandiseStructureLevel ::
Back to Top

Direct Store Delivery Ordering

AccessPassword :: Contact ::
Back to Top

Order Creation

AccessPassword :: Contact :: CustomerOccasion :: Deal :: DealSupplierItem :: DealSupplierItemCostBreak :: FreightBill :: InventoryControlDocument :: InventoryControlDocumentLineItem :: InventoryControlDocumentMerchandiseLineItem :: ManufacturerBrand :: ManufacturerCouponFamily :: ManufacturerItem :: MerchandiseStructureLevel :: OrderDocument :: PartyAddress :: PartyRole :: PriceLine :: ShipmentContainer :: ShipmentContainerMerchandiseLineItem :: StockItem :: Subseason :: SupplierItem :: SupplierItemCatalogBaseCost :: SupplierItemCatalogBaseCostBreak :: SupplierItemStockItem :: SupplierPricePromotionZone :: TaxableGroup ::
Back to Top

Replenishment Management

AccessPassword :: Contact :: InventoryControlDocument :: OrderDocument :: PartyAddress :: PartyRole :: StockItem :: SupplierItem ::
Back to Top

Employee Maintenance

Employee :: EmployeeAssignment :: EmployeeRetailStoreAssignment :: HourlyEmployee :: PartyAddress :: PartyRole :: Person :: SalariedEmployee :: StoreFinancialLedgerAccount ::
Back to Top

Employee Performance Management

AccessPassword :: Contractor :: Employee :: EmployeeAssignment :: EmployeeRetailStoreAssignment :: HourlyEmployee :: PartyRole :: SalariedEmployee :: StoreFinancialLedgerAccount ::
Back to Top

Time and Attendance

AccessPassword :: Contractor :: Employee :: Event :: HourlyEmployee :: Location :: ReportingPeriod :: SalariedEmployee ::
Back to Top

Work Force Planning

AccessPassword :: AgeRestrictionRule :: CommissionedEmployee :: Contractor :: Employee :: EmployeeAssignment :: EmployeeRetailStoreAssignment :: HourlyEmployee :: Location :: PositionAllocation :: PositionWorkSchedule :: SalariedEmployee ::
Back to Top

Customer Data Collection

AccessPassword :: Charity :: CustomerConsumerChargeAccount :: CustomerInformationLineItem :: CustomerInformationLineModifier :: PartyRole :: Prospect :: RetailTransactionLineItem :: Shopper :: SurveyQuestion :: TaxExemptOrganization ::
Back to Top

Customer Maintenance

AccessPassword :: CustomerAccountCard :: CustomerAffiliation :: CustomerAssetAssociation :: CustomerDemographicRole :: CustomerOccasion :: CustomerRelationship :: CustomerTradeAccount :: CustomerTypeSpecialPrice :: EmailAddress :: ExCustomer :: KeyCustomer :: KeyCustomerClient :: PartyAddress :: PartyRole :: Prospect :: RetailStoreClient :: RetailStoreItem :: Shopper :: StoreFinancialLedgerAccount :: ThirdPartyCustomerIdentification ::
Back to Top

Employee Customer Management

AccessPassword :: Contact :: CustomerCorrespondence :: Employee :: KeyCustomer :: PartyAddress :: Person :: PersonOrganizationAffiliation :: RetailStoreClient ::
Back to Top

Gift Registry

CustomerGiftRegistration :: CustomerOccasion :: CustomerPreference :: GiftRegisteredItem :: GiftRegistryLineItem :: KeyCustomer :: KeyCustomerClient :: Location :: OccasionRecommendation :: PartyAddress :: Person :: POSIdentity :: RegisteredItemClass :: RetailStoreItem :: SaleReturnLineItem :: StockItem ::
Back to Top

Loyalty Program Management

AccessPassword :: CustomerAssetAssociation :: CustomerConsumerChargeAccount :: CustomerCorrespondence :: CustomerLoyaltyAccount :: CustomerLoyaltyAccountRedemption :: CustomerPreference :: CustomerTradeAccount :: KeyCustomer :: KeyCustomerClient :: LoyaltyAccountAgreement :: LoyaltyAccountTerm :: PartyAddress :: Person :: PersonOrganizationAffiliation :: RetailStoreClient :: Shopper ::
Back to Top

Micro Marketing

CustomerAssetAssociation :: CustomerCorrespondence :: CustomerDemographicRole :: CustomerOccasion :: CustomerPreference :: CustomerSurveyResponse :: KeyCustomer :: KeyCustomerClient :: PartyAddress :: Person :: PersonOrganizationAffiliation :: SurveyQuestion ::
Back to Top

Entities

AccessPassword

A secret term used by an operator to obtain access to a workstation.

Tag

Type

Definition

AccessPassword Password The password which permits the OPERATOR to specific RESOURCES and workstations within the RETAIL STORE.

Back to Top

AccountReceivablePayableLineItem

A line item component of a RETAIL TRANSACTION that records the dollar amount to be debited or credited to a customer account. This line reflects a transaction specific to the creation of a current asset or liability to be settled at some future point in time through an exchange of tender.

Tag

Type

Definition

AccountCode Code4 Identifies how the account payable/receivable should be recorded in the financial journal.
AccountPayableReceivableCustomerAccountID Identity Identifies a customer account that is being debited or credited by the account payable/receivable line item. \
AccountPayableReceivableFlag Flag Flag that determines whether this line item is a payable or a receivable.
Amount Money The monetary amount of the account payable/receivable line item.

Back to Top

Address

A mail location for a party (i.e. a customer, supplier, etc.)

Tag

Type

Definition

AddressID Identity A unique identifier for a location and mail address.

Back to Top

AddressType

Describes a valid address usage for an ADDRESS entity type. Valid uses include billing, shipping, legal, etc.

Tag

Type

Definition

AddressTypeCode Code2 Defines a standard type of address usage.
Description DescriptionShort Description of address type.
Name Name Business name for an address type.

Back to Top

AdvancedShipNoticeDocument

An electronic document sent to a store by a supplier that defines the shipment date, expected delivery date, carrier, shipped items, and ORDER DOCUMENT reference. It is sent out in advance of the shipment to enable the retailer to plan workload and receipt processing.
Back to Top

AgeRestrictionRule

Defines a rule that restricts the sale of an item to customers that must be a minimum age and by the employee that must be a minimum age.

Tag

Type

Definition

Description DescriptionShort A description of the type of age restriction that applies to this ITEM
MinimumCustomerAge QuantityYrsCount The minimum age under which the customer is prohibited from purchasing the ITEM.
MinimumEmployeeAge QuantityYrsCount The minimum age under which the employee is prohibited from selling the ITEM.

Back to Top

AlternativeItem

A cross reference of items that may be substituted or offered in place of another item.

Tag

Type

Definition

SubstitutionReasonDesc DescriptionShort A narrative describing the circumstances under which one item can be substituted for another. For instance, one item may be offered as an alternative in a gift registry scenario, but not in a clearance or promotional scenario.

Back to Top

AssociatedMerchandiseStructureLevel

An association between two MERCHANDISE STRUCTURE LEVELs that establishes one as the higher and one as the lower level for summarizing item sales information.
Back to Top

Blender

A connection between a LOGICAL NOZZLE and one or more LOCATIONs each containing a single BULK ITEM which are blended by the LOGICAL NOZZLE when performing a FUELLING TRANSACTION

Tag

Type

Definition

BlendPercentage Percent The percentage of the final blend that the given BULK ITEM constitutes.

Back to Top

Brand

The selling and promotional name used to identify a product for advertising and name recognition purposes.

Tag

Type

Definition

BrandName Name A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer. The brand can include private label ITEMs.
Description DescriptionShort The description of a class of ITEMs produced by a product of a single supplier or manufacturer.

Back to Top

BrandPriceDerivationRuleEligbility

Defines an association between a BRAND and PRICE DERIVATION RULE and the conditions that govern the application of the associated rule to an item belonging to the specified BRAND at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise ( in which case it impacts the stock ledger) or an expense ( in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule is applied within a sales transaction.
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied
ExpirationDateTimestamp TimeStampExpiration The time and date this rule no longer valid

Back to Top

BulkItem

A subType of STOCK ITEM denoting stock that is purchased in bulk and sold in measured smaller amounts.
Back to Top

BusinessDay

A calendar date that corresponds to a FISCAL DAY and has financial transactions attributed to it.

Tag

Type

Definition

BusinessDayDate DateCalendar The calendar date equivalent of the associated fiscal day, fiscal week and fiscal year.

Back to Top

Carrier

An external party that transports merchandise and/or supply items from their source to the retail store and from the retail store back to their source

Tag

Type

Definition

CarrierID Identity The carrier presenting the bill of lading.
DUNSNumber IdentityDunsIdentifier The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the retail community and credit worthiness.
Name Name The legal name of the transportation company referenced by the CARRIER-ID.

Back to Top

CensusGeographicCoding

Standardized national, state, and local codes created by a governmental census agency for the identification of geographic areas.
Back to Top

Charity

An organization that has been designated as a charitable organization for tax purposes.

Tag

Type

Definition

CharitableRegistrationNumber TaxIdentityNumber An ID assigned by a tax authority for charitable organizations.

Back to Top

CheckTenderLineItem

A type of TENDER LINE ITEM that records the specifics about a check received from a customer in settling a transaction.

Tag

Type

Definition

AdjudicationCode Code4 A code to denote that approval has been received from the authorization center.
BankID Identity The unique identifier of the bank or third party authorization center.
CheckAccountNumber Identity The check account number of CUSTOMERs whose checks have been previously honored or rejected. Retaining a check history by CUSTOMER provides the RETAIL STORE with a means of tender authorization.
CheckSequenceNumber LineNumber A unique sequence number relating to a particular check authorization.
CustomerBirthDate DateCalendarDay The customer's date of birth captured as part of the personal data required to verify their identity and authorize their use of a check to pay for a purchase.
PersonalIDNumber Identity The personal identification number that must be keyed by an individual at the point of sale when paying by personal check.
PersonalIDRequiredTypeCode Code2 Identifies the type of personal identification required to authorize tender. Examples include driver's license, a second credit card, social security card, etc.

Back to Top

Color

This entity type serves as a standard store reference for APPAREL ITEM color. Certain apparel retailers will record data at this level, specifically for replenishment.

Tag

Type

Definition

ColorCode Code4 A code to identify the color. The assumption is that the retailer will adopt the standards as designated by the NRF, created to facilitate the exchange of data between vendors and retailers
Description DescriptionShort A full description of the individual color, designated by the respective code and name.
Name Name The individual names of the associated colors that are encompassed by the respective color code. For example, color code 201 may include both chocolate and kola nut.

Back to Top

CommercialEnterprise

An organization that is not exempt from sales taxes
Back to Top

CommissionedEmployee

An employee who receives a percentage or fee that is based on some type of sales metric.
Back to Top

CommissionModifier

A modifier that captures earned commissions by an employee involved in serving the customer purchasing the merchandise or service item identified in the SALE/RETURN LINE ITEM.

Tag

Type

Definition

AmountPercentFlag Flag Directs the commission calculator to use a flat commission-modifier-amount or the commission-modifier-percent to calculate the commission to be credited to the commissionable employee.
CommissionModifierSequenceNumber LineNumber A sequential counter used to uniquely identify an instance of a COMMISSION MODIFIER.
ModifierAmount Money Defines the flat amount of commission earned on the sale of this item
ModifierPercent Percent Defines the percentage applied to the sold-at retail amount to arrive at the commission for an item or service sold in the SALE/RETURN LINE ITEM.

Back to Top

Competitor

A retailer with a product range and customer base similar to those for the store.

Tag

Type

Definition

CloseDate DateCalendar The date the date the competitor closed
CompetitorID Identity The unique identifier assigned to a competitor by the store.
Name Name The name of retailer competing in the same sector within the same locality
OpenDate DateCalendar The date the competitor opened.
StatusCode Code2Status The current status of the competitor.

Back to Top

CompetitorRetailItem

A RETAIL ITEM which is stocked by a COMPETITOR and is perceived by the customer to have no discernible difference in terms of form, fit or function -- but may be sold at a different retail price.

Tag

Type

Definition

LocalAdvertisingFlag Flag A flag that indicates whether or not the competitor is advertising the item in local media.
OnPromotionFlag Flag Flag that indicates that the item offered by a competitor is being promoted (i.e. offered at a lower price).
PriceEffectiveDate DateCalendar The effective date of the competitor retail sale unit price.
PriceExpirationDate DateCalendar The expiration date of the competitor retail sale unit price.
PromotionStoreCouponFlag Flag A flag to indicate whether or not the competitor is promoting the item using in-store coupons.
SaleUnitPriceAmount MoneyShortRetail The retail sale unit price that a competitor has assigned to the item.

Back to Top

Contact

An individual person who has been designated by a PARTY organization for a specific PARTY ROLE and may be contacted by the store during the normal course of business.

Tag

Type

Definition

FunctionCode Code2 A code to identify the major duty or responsibility of the contact. These codes relate to the UCC data element 366.

Back to Top

ContactType

Defines valid types of contacts for a store. Contact types refer to the role played by a contact when interacting with a store.

Tag

Type

Definition

ContactTypeCode Code2 A code used to categorize different kinds of contact.
Description DescriptionShort The business description for this type of contact
Name Name The business name for this type of contact.
RoleCode Code2 The role played by this type of contact (e.g., pays invoices, approves RTV's, etc.)

Back to Top

ContainerType

A valid UCC type of container which may be used to transport shipping units between a supplier and a store, a store and a store, etc.

Tag

Type

Definition

Description Name A description of the container type.
UCCPackagingFormCode Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element list..
UCCPackagingMaterialCode Code4External A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This code uses the UCC 103 packaging code date element value list for packaging materials.

Back to Top

Contractor

A person who is not an employee but provides services to the retail enterprise.

Tag

Type

Definition

ContractorID Identity An alternate ID assigned to a CONTRACTOR.

Back to Top

ControlTransaction

A type of TRANSACTION that records non-financial activity that tracks changes in the status of a point of sale terminal, terminal access by retail store employees and their supervisors and other activities and events related to the administration and management of the point of sale system.

Tag

Type

Definition

TypeCode Code4 A code that describes the type of control transaction, i.e. period close, etc.

Back to Top

CoordinateType

A system of identifying physical locations.

Tag

Type

Definition

CoordinateTypeCode Code2 A categorization of co-ordinate systems.
Description DescriptionNarrative A description of a category of co-ordinate systems.

Back to Top

CouponHandlingRule

A rule that states how a particular coupon should be processed. For example, store coupons are normally taken as a markdown against the purchased ITEM, whereas manufacturer coupons are redeemed in full.

Tag

Type

Definition

CouponTypeCode Code2 A code to denote the type of coupon, e.g. raincheck, manufacturer coupon, electronic coupon.
CouponValueAccountingDispositionCode Code4 The disposition code for the coupon, e.g. store coupons are charged as an expense or markdown.
Description DescriptionShort A description of the coupon, e.g. money off a particular ITEM.

Back to Top

CouponTenderLineItem

A type of TENDER LINE ITEM that records the redemption of a store or manufacturer's coupon in a RETAIL TRANSACTION.

Tag

Type

Definition

ExpirationDate ProductCodeExpiry The date a coupon may no longer be used as part of the settlement of a sale transaction. It is normally found in the UCC/EAN-128 coupon extended code. In this code, the expiration code is only four digits and contains only month and year. The day is always the last day of the month.
KeyEnteredFlag Flag A flag to denote whether the coupon is key entered or scanned, i.e. 0=no (scanned), 1=yes (key entered)
PromotionCode Code6 Identifies a promotion associated with the coupon. Promotion codes are used by manufacturers and suppliers to analyze the impact their promotion is having on sales across a geographic area and over a specified promotional period of time.
ScanCode PostalCode The barcode on a store or manufacturer coupon. The coupon scan code comprises two parts: the first is a fixed 12 character code that contains the manufacturer identification, family code, and coupon value, the second is based on Code 128 and comprises up to 20 characters. This supplementary code comprises the manufacturer's number system character, the offer code, and end of offer code. The supplementary was introduced as a guideline in 1997.

Back to Top

CreditDebitCardTenderLineItem

A type of TENDER LINE ITEM that records the specifics about a credit or debit card used to settle a transaction.

Tag

Type

Definition

AccountNumber Name The account number appearing on a debit/credit card and identifying the card issuer's customer account to be charged or credited for the transaction.
AdjudicationCode Code6 A code indicating the result of a request to authorize the use of tender to settle a transaction.
AuthorizationMethodCode Code4 Identifies the method used to authorize tender. Examples include by electronic query, by sales employee visual inspection of customer card and id.
CardNumberSwipedOrKeyedCode Code2 A code that indicates whether the credit or debit card account number was read using a magnetic stripe reader (i.e. swiped) or keyed.
CustomerSignatureImage Code2Status Digitized image of the customer's signature.
MediaIssuerID Identity The identifying number of the bank, credit union, financial services firm or other third party issuing the debit/credit card used in the transaction.
PersonalIDReferenceNumber Identity The identifying number of the driver license or other personal id provided by the customer to verify his/her identity at the point of sale.
PersonalIDRequiredTypeCode Code2 Identifies the type of personal identification required to authorize tender. Examples include driver's license, a second credit card, social security card, etc.
Track2CreditCardBitMap BitMap Defines the bit pattern used on track 2 of the magnetic strip on the back of a credit card.

Back to Top

Currency

Specifies the national designation and quantitative value of monetary media used as tender in the processing of this TENDER LINE ITEM.

Tag

Type

Definition

CurrencyID Identity The unique identifier of the CURRENCY.
Description DescriptionShort A description of the currency, i.e. pounds sterling, US dollars, Canadian dollars, etc.
IssuingCountryCode Code4 Identification of the country issuing the currency. This code relates to the UCC data element 100, Currency Code,
Symbol Name National symbol for the main unit of currency, e.g. £, $, etc

Back to Top

Customer

A person or individual who purchases, may purchase, or did purchase goods and or services from a retail store.

Tag

Type

Definition

AnnualIncomeAmount Money A customer's annual salary or income.
CustomerID Identity A unique identifier for a customer.
HighestEducationLevelName Name A name or label that describes a CUSTOMER's highest level of education. For instance, primary school, post-secondary, graduate, etc.
LifecycleType Name A categorization of CUSTOMERs based on the type of relationship that customer has with the retail enterprise.
MaritalStatusCode Code2Status A code that describes a CUSTOMER's current marital status. For instance, married, single, etc.
ReligiousAffiliationName Name A name or label that describes a CUSTOMER's religious preference.

Back to Top

CustomerAccount

A charge account or other accounting relationship a customer has with the store or enterprise. An account exists to allow the store to record a series of transactions with the same customer and keep an ongoing record of monies owed by the customer and monies due to the customer.

Tag

Type

Definition

CumulativeFrequentShopperPointsCount Quantity A counter that accumulates frequent shopper points earned by a customer over a period of time and which may entitle a customer to a free gift or additional price reductions on selected items.
CustomerAccountID Identity A unique identifier for a customer account. Generally assigned by the home office.
CustomerIdentityRequiredFlag Flag Flag that if set to true requires the customer to provide proof of his/her identity to verify that he/she may use the CUSTOMER ACCOUNT.
CustomerIdentityTypeCode Code2 Determines the type of customer identification proof required. Examples include drivers license, store charge card, trade association identification card, etc.
TypeCode Code2 Determines what kind of customer account this is. Examples include a trade account, a school account, a not-for-profit, regular customer, etc.

Back to Top

CustomerAccountCard

An card or other device used in association with and account.

Tag

Type

Definition

CustomerAccountCardItemNumber Number A sequential number assigned to one of potentially many CUSTOMER ACCOUNT CARDs.
ExpirationDate DateCalendar A date that a specific CUSTOMER ACCOUNT CARD is no longer valid.

Back to Top

CustomerAccountPriceDerivationRuleEligibility

This entity associates a customer account to a price derivation rule.This entity exists to provide a linkage to special accounts for tradesmen who may purchase supplies at a discount not offered to regular customers. It may also establish associations between price derivation rules and other kinds of accounts as determined by a retailer.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense (in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
EffectiveDateTimestamp TimeStampEffective The time and date when the CUSTOMER ACCOUNT PRICE DERIVATION RULE becomes effective.
ExpirationDateTimestamp TimeStampExpiration The time and date when the CUSTOMER ACCOUNT PRICE DERIVATION RULE expires.

Back to Top

CustomerAccountSpecialPrice

A pre-arranged price (not discount percentage) for a specific customer account.

Tag

Type

Definition

ItemCurrentSaleUnitSpecialPriceAmount MoneyShortRetail The current retail price per sale unit of the item. This monetary amount is used as the basis for deriving retail price at the point of sale.
ItemSpecialPriceDiscountFlag Flag A flag that determines whether or not the customer account special price is eligible for discounts.

Back to Top

CustomerAffiliation

Associates a customer with a customer group.

Tag

Type

Definition

IdentityVerifyRequiredFlag Flag A flag to denote whether the CUSTOMER's identity has been verified as belonging to the CUSTOMER AFFILIATION scheme.

Back to Top

CustomerAffiliationPriceDerivationRuleEligibility

This entity associates a price derivation rule with a customer group affiliation and, by its presence, defines a customer affiliation condition for triggering the application of the rule at the point of sale. This entity provides the linkages required to provide senior citizens discounts, credit union member discounts, etc.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense (in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
EffectiveDateTimestamp TimeStampEffective The time when the CUSTOMER AFFILIATION PRICE DERIVATION RULE is effective.
ExpirationDateTimestamp TimeStampExpiration The time when the CUSTOMER AFFILIATION PRICE DERIVATION RULE can no longer be applied to a TRANSACTION.

Back to Top

CustomerAsset

A customer's asset of interest to a retailer. This item may be maintained or enhanced using products and services provided by the retailer

Tag

Type

Definition

CustomerAssetID Identity A unique, automatically assigned identifier for an asset or other item of interest that belongs to or is related to a customer.
Description DescriptionNarrative A narrative that describes this asset or other item belonging to a CUSTOMER.

Back to Top

CustomerAssetAssociation

A cross reference of customers to assets they own or possess.

Tag

Type

Definition

OwnedSinceDate DateCalendar A self-reported original ownership/lease/acquisition date for a CUSTOMER ASSET.
VerifiedDate DateCalendar The date that an asset is verified as being in the possession of a CUSTOMER.

Back to Top

CustomerConsumerChargeAccount

A type of CUSTOMER ACCOUNT that allows a customer to make purchases on credit. This type of account is a \"house\" charge account and usually requires the customer to use a charge card to settle a transaction.
Back to Top

CustomerCorrespondence

An e-mail, letter, telegram, or other written communication from a CUSTOMER.

Tag

Type

Definition

CreatedDate DateCalendar The date and time that a CUSTOMER's letter, fax, or e-mail was created.
CustomerCorrespondenceReceivedDate DateCalendar The date and time that a CUSTOMER's letter, fax, e-mail, or phone call is taken or received at a retail store or other facility.
SendDate DateCalendar The date and time that a CUSTOMER's letter, fax, e-mail, or phone call was sent by the customer.
SummaryDescription DescriptionNarrative A brief interpretation summarizing the main points of the correspondence.

Back to Top

CustomerDemographicRole

A specific customer's assignment to the most fitting demographic role.

Tag

Type

Definition

CustomerDemographicRoleEffectiveDate DateCalendar The date that a CUSTOMER is first assigned to a demographic role.

Back to Top

CustomerGiftRegistration

A specific CUSTOMER's registration for an occasion.

Tag

Type

Definition

Date DateCalendar The date that a CUSTOMER GIFT RESTRATION is created.

Back to Top

CustomerGroup

A group of customers based on specific demographic and marketing attributes and properties. Examples include over 65 year old customers, students, unions, and other associations.

Tag

Type

Definition

CustomerGroupID Identity A unique identification number assigned to a customer group
Description DescriptionShort The text description applied to a customer group.
Name Name The business name applied to a customer group.

Back to Top

CustomerInformationLineItem

A retail transaction line item component that captures different kinds of customer information required to fulfill a retail transaction. Examples include customer address, customer account, delivery directions, special handling instructions and so on.

Tag

Type

Definition

TypeCode Code2 Defines the type of customer information captured in this line item instance. Valid examples include: Customer Name, Customer Address, Delivery Address, Customer Account, and Special Handling Instruction

Back to Top

CustomerInformationLineModifier

Provides a specific data element level description and value for customer information line item. This modifier provides a flexible, dictionary driven method for specifying the kind of data captured about a customer.

Tag

Type

Definition

CustomerInformationModifierSequenceNumber LineNumber A sequential number designed to uniquely identify each modifier for a CUSTOMER INFORMATION LINE item.
DataElementFormatCode Code2 Defines how the value of a data element is to be internally represented. Valid examples include TEXT, MONEY, LOGICAL (yes/no), COUNT (integer), FLOAT.
DataElementID Identity A dictionary data element identity assigned by each retailer for the type of data they want to collect as part of their CUSTOMER INFORMATION LINE.
DataElementValue Money The value entered for a data element in a CUSTOMER INFORMATION LINE MODIFIER.

Back to Top

CustomerInstallmentPaymentAccount

A type of CUSTOMER ACCOUNT established to track installment payments made against a sale transaction. This type of account is generally established to support big ticket sales.
Back to Top

CustomerLayawayAccount

A type of CUSTOMER ACCOUNT established to record layaway payments made against merchandise set aside for a customer. The merchandise is retained at the store until the transaction is settled.
Back to Top

CustomerLoyaltyAccount

A type of CUSTOMER ACCOUNT established purely for the purposes of tracking a customer's activity over a period of time and based on the volume of NET sales to provide an award to the customer in the form of a gift or special discount.

Tag

Type

Definition

CumulativeNetSalesAmount Money The net sales (gross sales less returns) accumulated for the CUSTOMER PROMOTIONAL ACCOUNT. Note the accumulation is for the period bounded by the effective date and the expiration date for this promotional account.
EffectiveDate DateCalendar The date this CUSTOMER PROMOTIONAL ACCOUNT becomes active for accumulating sales and other activity.
ExpirationDate DateCalendar The date this CUSTOMER PROMOTIONAL ACCOUNT expires making him/her ineligible for special awards and/or price reductions.

Back to Top

CustomerLoyaltyAccountRedemption

A member's use of promotional account (points/dollars/miles) for a reward.
Back to Top

CustomerOccasion

An event celebrated or observed by a customer.

Tag

Type

Definition

CustomerOccasionDate DateCalendar The start date of a an event or other occasion that a customer celebrates.

Back to Top

CustomerOccasionType

A categorization of CUSTOMER OCCASIONs.

Tag

Type

Definition

CustomerOccasionTypeName Name A short label for a group of CUSTOMER OCCASIONs. For instance, this could be a wedding, a high school graduation, a birthday, a golden wedding anniversary, etc.
Description DescriptionNarrative A description of a categorization of celebrated events or occasions.

Back to Top

CustomerPreference

A description of a KEY CUSTOMER's merchandise preferences for classes of items or general categories..

Tag

Type

Definition

Description DescriptionNarrative A description of customers likes or dislikes of classes of items, colors, sizes, materials, etc.

Back to Top

CustomerRelationship

A grouping of customers who tend to jointly make purchasing decisions.
Back to Top

CustomerRelationshipType

A categorization of CUSTOMER RELATIONSHIPS.

Tag

Type

Definition

CustomerRelationshipTypeName Name The name or code assigned to a type of CUSTOMER RELATIONSHIP.
Description DescriptionNarrative A description of a categorization of customer relationships.

Back to Top

CustomerSurvey

A collection of questions or other inquiries for soliciting responses from customers (shoppers too?).
Back to Top

CustomerSurveyResponse

A specific customer's survey responses
Back to Top

CustomerTradeAccount

A type of CUSTOMER ACCOUNT established for builders, plumbers, electricians and other trade businesses that purchase merchandise, usually at a preferential discount, from the store.

Tag

Type

Definition

DiscountMonetaryAmount Money The monetary amount of discount provided to a specific CUSTOMER TRADE ACCOUNT.
DiscountPercent Percent The percentage of the base retail price discount provided to a specific CUSTOMER TRADE ACCOUNT.

Back to Top

CustomerTypeSpecialPrice

A special price (not discount or derivation) set for an ITEM for purchase by a specific customer group.

Tag

Type

Definition

ItemCurrentSaleUnitSpecialPriceAmount MoneyShortRetail The current special price per sale unit of the item. This monetary amount is available to only specific CUSTOMER GROUPs..
ItemSpecialPriceDiscountFlag Flag A flag that determines whether or not the customer type special price is eligible for discounts.

Back to Top

Deal

A deal refers to a special offer from a supplier to the store. The deal generally provides allowances, discounts, special favorable terms of payment or other incentives to motivate the store to buy more products or services from a supplier.

Tag

Type

Definition

DealCode Identity A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the SUPPLIER may offer an additional 2% discount off the cost price, or increase the case units by 10% for the same cost price. Normally DEALs last for finite periods.
Description DescriptionShort A brief text description of the DEAL.
EffectiveDate DateCalendar The start date upon which an ITEM can be ordered under the terms of a given deal.
ExpirationDate DateCalendar The end date upon which an ITEM can be ordered under the terms of a given deal.
Name Name The business name for the deal.

Back to Top

DealSupplierItem

This entity identifies a specific SUPPLIER ITEM that is offered as part of a deal to the store and defines how the deal cost is to be handled.

Tag

Type

Definition

CostChangeAmount MoneyShortCost The difference between the standard and DEAL cost prices or the DEAL cost intended to replace the standard catalog cost for the item.
CostChangePercent Percent The percentage difference between the standard and DEAL cost prices or the DEAL cost intended to replace the standard catalog cost for the item.
CostChangeReplaceOrModifyCode Code2 A code that determines how the deal-supplier-cost-change-amount is to be applied -- i.e. it is to replace or modify the catalog cost.

Back to Top

DealSupplierItemCostBreak

This entity establishes deal-related cost breaks offered to a store. Cost breaks represent stepped cost reductions based on the number of units acquired by the store.

Tag

Type

Definition

ChangeAmount Money The additional allowance amount which is applied when the SUPPLIER's breakpoint is attained.
ChangePercent Percent The additional allowance percentage that is applied when the SUPPLIER's breakpoint is attained.
SupplierItemUnitDealThresholdCount Quantity A count associated with an item that triggers a cost reduction as part of a DEAL.

Back to Top

DemographicRole

An industry or proprietary categorization of a person or organization based on his/her/its purchasing behaviors, age, desires, geographic location, job type, etc.

Tag

Type

Definition

DemographicRoleName Name A label or title given to a group of people or organizations that represents their assignment to a class of buyers.
Description DescriptionNarrative A description of a grouping of customers based on their lifestyles, purchasing trends, income ranges, etc.

Back to Top

Denomination

Specifies the quantitative value of the referenced CURRENCY media.

Tag

Type

Definition

DenominationID Identity An identifier which uniquely identifies the quantitative value of a specific currency, e.g. $100, £50, etc.
Description Name A description of the quantitative value of a specific currency.

Back to Top

DepositRedemption

A DEPOSIT is a monetary amount that is paid to secure an ITEM. The DEPOSIT can be redeemed against the eventual purchase or returned to the CUSTOMER when the ITEM is returned, e.g. bottle or can. DEPOSITs/REDEMPTIONs are very prevalent in Northern European grocery where a DEPOSIT is paid for the container at the time of purchase and a REDEMPTION payment made when returned at a future visit.

Tag

Type

Definition

DepositRedemptionTypeCode Code2 Defines the type of deposit or redemption. In addition to distinguishing between deposits (i.e. deposits on bottles, etc.) and redemptions, this code allows the store to establish different categories of deposits and redemptions.

Back to Top

DepositRedemptionLineItem

A line item component of a RETAIL TRANSACTION that records the dollar amount to be debited or credited to a deposit receivable or payable account and added to or subtracted from the balance due total of the transaction

Tag

Type

Definition

Amount Money The monetary amount of a deposit or redemption.
UnitCount Quantity The number of containers, bottles, racks, cases, etc. involved in the deposit or redemption. For example a redemption of $5.00 for 100 aluminum cans - 100 here is the unit count
UnitOfMeasureCode Code2 The unit of measures applied for counting the number of units involved in a deposit or redemption. Examples include cans, cases, racks, bottles, etc

Back to Top

DepositRule

An association of a STOCK ITEM and a RETURN AGENT that defines the rules governing the deposit payment that must be paid by the customer at the time the item is purchased and the refund that must be made to the customer upon return of the item package or container. This rule is most often related to bottles, aluminum cans, crates and other containers which must be returned for reuse or recycling.

Tag

Type

Definition

DepositPaidOnUnitOfMeasureCode Code2 The unit of measure (e.g. each bottle, each case, each rack, etc.) that the customer pays a deposit on at the time of a sale.
DepositPaidPerUnitOfMeasureAmount Money Th deposit amount paid for each deposit-paid-on-unit-of-measure-code by the consumer at the time an item is purchased.

Back to Top

DevicePrice

The current mapping between the system ItemPrice and a FuelingPoint device specific identifier used to identify aretail unit price.

Tag

Type

Definition

DevicePriceID Identity The devicePriceID used by the FuelingPoint to identifiy the retail price.

Back to Top

DisbursementFundsReceiptReason

The reason why a petty cash disbursement has been made or funds receipt received.

Tag

Type

Definition

Description DescriptionShort A textual description of the reason for the DISBURSEMENT or FUNDS RECEIPT
DisbursementReceiptReasonCode Code2 The reason code for the DISBURSEMENT or the FUNDS RECEIPT.

Back to Top

DisbursementTransaction

A type of FINANCIAL ACCOUNTING TRANSACTION that records disbursement (with an offsetting miscellaneous expense).

Tag

Type

Definition

FundDisbursementAmount Money The monetary amount of the disbursement transaction.
PettyCashPartyId Identity Identifies the party receiving the petty cash.
PettyCashReceiptRequiredFlag Flag A flag that when true indicates that the recipient of a petty cash payment must provide a written receipt as evidence that the transaction was valid.

Back to Top

Discount

A reduction in the selling price that is normally charged as an expense to the RETAIL STORE's general ledger. Can be applied by transaction line item or to the whole transaction.

Tag

Type

Definition

Description DescriptionShort A text description of the standard discount types represented in the DISCOUNT entity collection
DiscountTypeCode Code2 The type code used as a look up key for the standard discount types represented in the DISCOUNT entity collectio
Name Name The name of the standard discount types represented in the DISCOUNT entity collection

Back to Top

DiscountLineItem

A line item component of a RETAIL that records the granting of a reduction of price on items and/or services purchased by a customer and treats that price reduction as an expense item for accounting purposes

Tag

Type

Definition

Amount Money The monetary value for the discount line item.

Back to Top

DiscrepancyToleranceRule

A rule that defines permissible variance between the total inventory control document cost (based on the supplier's cost) and the store's receiving total (based on the store's record of supplier item cost). Any variance that exceeds the discrepancy threshold will trigger an invoice or item-level reconciliation.

Tag

Type

Definition

Amount Money The monetary value, weight or quantity that establishes the tolerance threshold that when reached will exceed the tolerance for the SUPPLIER and require special approval or remedial action.
DiscrepancyRuleID Identity A specific rule which defines the nature and amount of the cost, weight or quantity discrepancy. Rules can apply to the entire bill or individual lines and be measured in amount or percentage terms.
MessageText DescriptionNarrative Message to detail the reason for the difference between the billed and ITEM cost amounts, weights or counts.
Percent Percent The monetary value, weight or quantity percent variance between what is ordered and what is received that establishes the tolerance threshold that when reached will exceed the tolerance for the SUPPLIER and require special approval or remedial action.
TypeCode Code2 Determines whether the discrepancy rule applies to cost (in monetary units), weight or quantity (i.e. item count).

Back to Top

DriveOffTransaction

A type of TRANSATION that records the clearing of a FUELLING TRANSACTION without accepting payment because the customer simply drove off wthout paying. Operator may record some details about the vehicle that has driven o

Tag

Type

Definition

VehicleColor Name The color of the vehicle that did the drive-off
VehicleManufacturer Name The make of the vehicle that did the drive-off
VehicleModel Name The model of the vehicle that did the drive-off
VehicleRegistrationNumber Name The registration nujmber of the vehicle that did the drive-off

Back to Top

EmailAddress

An electronic mail address.

Tag

Type

Definition

EmailAddressID Email address An electronic address for sending messages..

Back to Top

Employee

An individual that works for a retail store, accepts direction from the retail store management and satisfies the statutory criteria requiring that payroll taxes and benefit contributions be paid by the retailer

Tag

Type

Definition

EmployeeCompensationTypeCode Code
EmployeeID Identity A unique, non-significant number used to identify a store employee.
Name Name The full name of the EMPLOYEE.
SocialSecurityNumber IdentitySocSecurityNumber The social security number of the EMPLOYEE.
StatusCode Code2Status The status code regarding the EMPLOYEE, i.e. active or inactive.

Back to Top

EmployeeAssignment

An employee's assignment to a specific position, at one point in time.

Tag

Type

Definition

EffectiveDate DateCalendar The date that an EMPLOYEE ASSIGMENT is first valid.
ExpirationDate DateCalendar The date that an employee's assignment is no longer valid.
StatusCode Code2Status A code that represents the current state of an EMPLOYEE ASSIGNEMENT.

Back to Top

EmployeeCommissionPlan

A plan for compensating employees for sales they make to customers.

Tag

Type

Definition

Description DescriptionShort A textual description of the type of employee's commission plan
EmployeeCommissionPlanID Code4 A unique reference number for an employee's commission plan. This may be the employee's payroll number.

Back to Top

EmployeeDiscountedSalesHistory

A collection of accumulators for each employee who purchases merchandise, at a discount, from the store.

Tag

Type

Definition

LineItemCount QuantityTransactionCount The total number of ITEMs discounted as part of EMPLOYEE purchases in each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of discount granted to EMPLOYEEs for miscellaneous fees in each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales resulting from EMPLOYEE purchases in each REPORTING PERIOD.
RefundTotalAmount Money The total number of refunds made for ITEMs originally purchased as part of an EMPLOYEE discount scheme in each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of refunds made for ITEMs originally purchased as part of an EMPLOYEE discount scheme in each REPORTING PERIOD.
TotalAmount Money The total monetary amount of discount granted in EMPLOYEE purchases in each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees discounted for EMPLOYLEEs in each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds made for ITEMs originally purchased as part of an EMPLOYEE discount scheme in each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns of ITEMs originally purchased as part of an EMPLOYEE discount scheme in each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions involving EMPLOYEE purchases in a given REPORTING PERIOD.

Back to Top

EmployeeDiscountGroup

A group of EMPLOYEEs who share the same employee discount privilege.

Tag

Type

Definition

EmployeeDiscountGroupID Identity The identifier for a specific EMPLOYEE DISCOUNT GROUP.
Name Name The name given to a specific EMPLOYEE DISCOUNT GROUP, e.g. store management, part-time employees, etc.

Back to Top

EmployeeDiscountGroupPriceDerivationRuleEligibility

Establishes the association between an employee Discount Group and a PRICE DERIVATION RULE. The association indicates that the employee group is eligible for a price reduction.

Tag

Type

Definition

ApplyAfterAllMarkdownsFlag Flag A flag to denote whether the EMPLOYEE DISCOUNT is applied after all the ITEM markdowns have been applied.
ConcurrenceDispositionCode Code2 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
CostPlusFlag Flag A flag to denote whether the price of the ITEM to the EMPLOYEE is calculated by adding a dollar amount or percent to the cost price.
Description DescriptionShort Describes the derivation rule for the employee group price discount.
EffectiveDateTimestamp TimeStampEffective The date and time when the EMPLOYEE DISCOUNT DERIVATION RULE becomes effective.
EligibilityDescription DescriptionShort Describes this employee-group discount eligibility rule.
ExpirationDateTimestamp TimeStampExpiration The date and time when the EMPLOYEE DISCOUNT DERIVATION RULE expires.

Back to Top

EmployeeDiscountLineItem

A special kind of retail line item set up to record and keep track of employee discounts taken in a transaction.

Tag

Type

Definition

Amount Money The discount amount granted to an EMPLOYEE when making a purchase. The item sales are typically held separately in order to assess whether the EMPLOYEE is abusing the privilege.

Back to Top

EmployeeMembershipDiscountGroup

An association between an employee and an employee discount group which makes the employee eligible for the price reductions available to the discount group.

Tag

Type

Definition

Description DescriptionShort Description associated with this employee discount group.
IdentityVerifyRequiredFlag Flag A flag to denote whether the identity of the EMPLOYEE has been verified.

Back to Top

EmployeeRetailStoreAssignment

An associative entity that links EMPLOYEE and RETAIL STORE. The assumption here is that a RETAIL STORE has many EMPLOYEEs and EMPLOYEEs can operate in many different RETAIL STOREs.

Tag

Type

Definition

EffectiveDate DateCalendar The date on which an individual assignment in a store becomes effective.
ExpirationDate DateCalendar The date on which an individual assignment in a store expires.
StatusCode Code2Status A code to signify the status of a specific assignment.

Back to Top

EnvironmentClass

A category of environmental properties, such as humidity, lighting, and temperatures.

Tag

Type

Definition

Description DescriptionNarrative A descriptive narrative of the environmental class.
EnvironmentClassCode Code6 A code that identifies a class environmental properties of a location. For instance, this might describe humidity, temperature, or lighting restrictions or requirements

Back to Top

Equipment

A device used as an as interface to any store business function. It comes in a number of sub-types.

Tag

Type

Definition

DeviceAddress Name The device address in the system
EquipmentID Identity A unique identifier for the piece of hardware.
EquipmentTypeCode Code A 2 character code denoting what kind of hardware device it is.
FixedAssetNumber Name The fixed asset number for the piece of hardware
ManufacturerName Name The name of the hardware manufacturer
ModelNumber Name The model number of the hardware

Back to Top

Event

Something that happens, takes place or has been planned represented by the designation of time, place and purpose. Events are normally associated with business processes like markdowns, physical inventory, special promotional displays and advertising, etc.

Tag

Type

Definition

ActualEndDateTimestamp TimeStampExpiration Defines the actual time and date when the event terminates.
ActualStartDateTimestamp TimeStampEffective Defines the actual start date and time for an event.
Description DescriptionShort Describes the event.
EventID Identity A unique, automatically assigned identifier for each EVENT instance.
Name Name The business name of the event.
OwnerName Name Identifies who in the retailer organization owns and is responsible for the EVENT.
PlanEndDateTimestamp TimeStampExpiration Defines the planned time and date when the event terminates
PlanStartDateTimestamp TimeStampEffective Defines the planned starting time and date for an event.
StatusCode Code2Status The current status code of the event -- e.g. active, pending, deferred, canceled, etc.
StoreOrHomeOfficeControlCode Code2 A code to indicate whether the event is controlled by the store or by the home office.
TypeCode Code4 Identifies the category for the event. Examples include holiday promotion, physical inventory count, Presidents Day, Back to School Sale, Register Roulette, etc.

Back to Top

ExchangeRate

Expresses the quantitative conversion factor between two kinds of CURRENCY, one which must be the store's home currency.

Tag

Type

Definition

ExchangeRateEffectiveDate DateCalendar The date on which a specific exchange rate becomes effective.
ExchangeRateExpirationDate DateCalendar Date on which the exchange rate expires and is no longer valid.
MinimumCurrencyAmount Money The minimum monetary amount the store will either purchase or sell foreign tender.
ServiceFeeAmount Money The add-on fee, in local currency amounts, imposed on the exchange
ToBuyAmount Money The buying rate of the tender type, based on the store's local currency.
ToSellAmount Money The selling rate of the tender type, based on the store's local currency

Back to Top

ExCustomer

An individual, collection of individuals, company, or public institution that does not currently purchase merchandise or services from the retailer, but who was at one time a customer. An Ex-customer has an inactive relationship with the retaile
Back to Top

ExternalDepository

A bank or other institution that accepts periodic deposits of TENDER from the retail store.

Tag

Type

Definition

Description DescriptionShort Business description of the external depository
Name Name The business name of the external repository.

Back to Top

ExternalDepositoryHistory

A record of the TRANSACTIONs that lists the deposit of TENDER in the EXTERNAL DEPOSITORY by the store.
Back to Top

ExternalDepositoryParty

A type of party related to an EXTERNAL DEPOSITORY.

Tag

Type

Definition

ExternalDepositoryPartyID Identity A unique identifier for an External Depository Party. The identifiers are only unique within this type of PARTY.

Back to Top

ExternalDepositorySettlementTransaction

A transaction that records the closing balances for the EXTERNAL REPOSITORY HISTORY. This is associated with the cash count of the deposit made to an external repository.
Back to Top

ExternalDepositoryTender

A collection of tender totals deposited in a bank or other institution that accepts periodic deposits of TENDER from the retail store.

Tag

Type

Definition

OpenBalanceTotalAmount Money The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at the start of the current deposit..
OverTenderDiscrepancyAmount Money The overage, expressed as an amount, between the actual and recorded tender deposited in the EXTERNAL DEPOSITORY.
TenderDepositDateTimestamp TimeStampAudit The timestamp when tender is deposited in the EXTERNAL DEPOSITORY.
TenderDepositTotalAmount Money The total amount of tender deposited in the EXTERNAL DEPOSITORY.
TenderReceiptTotalAmount Money The total amount of money received from the EXTERNAL DEPOSITORY.
TotalTenderDepositCount QuantityTransactionCount The total number of TENDER deposits made in the EXTERNAL DEPOSITORY.
TotalTenderReceiptCount QuantityTransactionCount The total number of receipts to the STORE from the EXTERNAL DEPOSITORY.
UnderTenderDiscrepancyAmount Money The shortage, expressed as an amount, between the actual and recorded tender deposited in the EXTERNAL DEPOSITORY.

Back to Top

ExternalDepositoryTenderHistory

An accumulator for various tender amounts and units held and transferred to an EXTERNAL REPOSITORY. These totals cover an accumulation period bounded by the EXTERNAL REPOSITORY SETTLEMENT TRANSACTION.

Tag

Type

Definition

DepositDateTimestamp TimeStampAudit The timestamp when tender is deposited in the EXTERNAL DEPOSITORY for each accumulation period.
DepositTotalAmount Money The total amount of tender deposited in the EXTERNAL DEPOSITORY for each accumulation period..
OpenBalanceTotalAmount Money The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at the start of the accumulation period.
OverTenderDiscrepancyAmount Money The overage, expressed as an amount, between the actual and recorded tender deposited in the EXTERNAL DEPOSITORY for each accumulation period.
ReceiptTotalAmount Money The total amount of money received from the EXTERNAL DEPOSITORY in each accumulation period.
TotalTenderDepositCount QuantityTransactionCount The total number of TENDER deposits made in the EXTERNAL DEPOSITORY for each accumulation period.
TotalTenderReceiptCount QuantityTransactionCount The total number of receipts to the STORE from the EXTERNAL DEPOSITORY in each accumulation period.
UnderTenderDiscrepancyAmount Money The shortage, expressed as an amount, between the actual and recorded tender deposited in the EXTERNAL DEPOSITORY for each accumulation period.

Back to Top

Facility

A distribution center, warehouse or store which ships merchandise to and accepts returned merchandise from the retail store.

Tag

Type

Definition

FacilityID Identity The unique reference for the facility that originated the supply. This facility is a generic term that will normally apply to a warehouse or distribution center.
Name Name The name by which the FACILITY is known.

Back to Top

FinancialAccountingTransaction

A type of TRANSACTION that records financial activity that does not directly involve the sale or exchange of merchandise nor changes to customer accounts but captures the movement of inventory, tender, income and expenses as debits and credits within the retail store.

Tag

Type

Definition

TypeCode Code2 A code to denote the type of FINANCIAL ACCOUNTING TRANSACTION, e.g. tender loan or pickup.

Back to Top

FinancialTransactionJournalEntry

An entry in a journal of transaction details for posting to a STORE FINANCIAL LEDGER ACCOUNT and/or the STOCK LEDGER

Tag

Type

Definition

Amount Money The monetary value of the FINANCIAL TRANSACTION JOURNAL ENTRY.
DateTimestamp TimeStampAudit The time at which the FINANCIAL TRANSACTION JOURNAL ENTRY is made.
DebitCreditCode Code2 A code to denote whether the value of the FINANCIAL TRANSACTION JOURNAL ENTRY is debited or credited to the FINANCIAL LEDGER.
FinancialTransactionJournalEntryID Identity The unique reference of the FINANCIAL TRANSACTION JOURNAL ENTRY.
FinancialTransactionJournalEntrySequenceNumber LineNumber The sequence number of the FINANCIAL TRANSACTION JOURNAL ENTRY.
StatusCode Code2Status Defines the current status of the FINANCIAL TRANSACTION JOURNAL ENTRY. Examples include pending, booked, etc.

Back to Top

FiscalDay

An accounting period representing one day. This is regarded as the shortest time period for which accounting records are kept.

Tag

Type

Definition

CalendarDateTime TimeStampEffective A specific date and time within the FISCAL DAY.
FiscalDayNumber DateFiscalDay The week day part of a fiscal date numbered 1 (Sun) through 7 (Sat)

Back to Top

FiscalMonth

An accounting period of one month. The month can comprise 4 or 5 weeks depending on whether the retailer divides the FISCAL YEAR into 12 or 13 months. This time period is bounded by a beginning and ending time and date for accounting purposes.

Tag

Type

Definition

FiscalMonth DateFiscalMonth A fiscal (financial) month.

Back to Top

FiscalQuarter

An accounting period of three months against which revenues and expenses are attributed. This time period is bounded by a beginning and ending time and date.

Tag

Type

Definition

FiscalQuarterID DateFiscalQuarter The identifier which uniquely specifies a FISCAL QUARTER within a specific FISCAL YEAR.
FiscalQuarterNumberOfWeeksCount QuantityMonthCount The number of weeks within the FISCAL QUARTER. Most retailers use a 13 week quarter, but some apparel retailers use 12 week quarters.

Back to Top

FiscalWeek

An accounting period of seven days against which revenues and expenses are attributed. This time period is bounded by a beginning and ending time and date.

Tag

Type

Definition

Description DescriptionShort A text description applied to a fiscal week.
FiscalWeekNumber DateFiscalWeek The relative week with in a fiscal year expressed as an integer count.

Back to Top

FiscalYear

An accounting period of one year. This time period can be divided into 12 or 13 months( denoted as 4,4,4 or 5,4,4 respectively). It is bounded by a beginning and ending time and date for accounting purposes.

Tag

Type

Definition

BeginningDate DateCalendar The start date of the FISCAL YEAR.
CalendarYear DateCalendarYear The calendar year which spans 52 weeks starting at the first FISCAL WEEK in the new year.
FiscalYear DateCalendarYear An identifier that uniquely identifies a particular FISCAL YEAR in CCYY format.
NumberOfMonthsCount QuantityMonthCount The number of fiscal months in a FISCAL YEAR. Most retailers will operate 12 FISCAL MONTHS, although some will operate 13.

Back to Top

ForecourtSettlementTransaction

A special kind of forecourt transaction, that causes the system to do the following: 1. Perform an automatic PhysicalInventory of the tank Locations via TankGauge equipment 2. Take a set of StockMeter and/or Sales/Meter Readings 3. Close-o
Back to Top

ForecourtTransaction

A type of TRANSATION that records the clearing of FUELLING TRANSACTIONs without accepting money for them by an operator at a workstation.

Tag

Type

Definition

ForecourtTransactionType Code2 A code to denote the type of ForecourtTransaction , eg DriveOff, TestDelivery

Back to Top

ForeignCurrencyTenderLineItem

A type of TENDER LINE ITEM used to record the collection of cash in a foreign currency (i.e. a currency that is different from the store's host country currency).

Tag

Type

Definition

Amount Money A tender line item identifying the foreign currency tendered by the CUSTOMER as payment.

Back to Top

FreightBill

A carrier-originated document that lists the number of containers (e.g. pallets, cartons, etc.) that were delivered to the store. The freight bill does not reference the inner contents of a shipment. \

Tag

Type

Definition

CarrierWeightRestrictionCode Code2 A code to denote the maximum weight of each carton that can be handled by the carrier.
FreightBillID Identity The carrier-assigned shipping document number
SerialFormID String An identifier for this document, usually preprinted on the form stock prior to being filled out.
ShippedCartonCount Quantity The number of cartons listed on the FREIGHT BILL.
SpecialHandlingCode Code2 A code that specifies special handling instructions.
SpecialHandlingMessage DescriptionNarrative Free form additional description of special handling conditions if special handling code inadequate.
Status Code2Status The status of the receiving event: scheduled, initiated, completed, processed, reviewed, modified.
StoreCartonCount Quantity The number of cartons as established by the store.
StoreReceiptTime TimeStampAudit The time and date when the freight is received at the store.

Back to Top

FuelingPoint

A device used to deliver fuel.

Tag

Type

Definition

FuelingPointID Identity A unique identifier for the FuelingPoint at a particular retail store
ProtocolVersionCode Code2 The version of the protocol this FuellingPoint uses.
WeightsAndMeasuresSecurityCode Code2 A security code in the FuellingPoint as reported to Weights & Measures
WeightsAndMeasuresSoftwareDate DateCalendar The date of the software version in the FuellingPoint as reported to Weights & Measures
WeightsAndMeasuresSoftwareVersion Name The software version in the FuellingPoint as reported to Weights & Measures

Back to Top

FuelingTransactionEvent

An auditing event, recording a particular LOGICAL NOZZLE completing a delivery of fuel.

Tag

Type

Definition

FuelingTransactionID Identity A unique identifier for the fuelling transaction
TimeStamp Datetime The date & time of the completion of the fuelling transaction
TotalPrice Number The total price charged by the FUELLING POINT for the fuel delivered in the FUELLING TRANSACTION.
TotalPriceIncludesSalesTax Flag A flag denoting the inclusion (or non-inclusion) of the reported sales tax in the total price figure.
TotalSalesTax MoneyShortRetail The sales tax charged by the FUELLING POINT for the fuel delivered in the FUELLING TRANSACTION.
TypeCode Code2 A two charcter code denoting the type of FuelingTransactionEvent being recorded. Possible values include PostPay: Where the FuelingTransaction is yet to be sold by a FuelSalesLineItem in a RetailTransaction PrePayCompletion: Where money has been collected for the FuelingTransaction in a previous FuelSalesLineItem and there is no refund required. PrePayRefund: Where too much money was collected for the FuelingTransaction in a previous FuelSalesLineItem, and a further FuelSalesLineItem in a RetailTransaction is required to deal with the
UnitPrice Number The price per volume unit charged by the FUELLING POINT for the fuel delivered in the FUELLING TRANSACTION
Volume Number The volume of fuel delivered in the fuelling transaction.

Back to Top

FuelSalePriceModifier

A line item modifier that reflects a modification of the retail selling price of a particular FuelingTransaction

Tag

Type

Definition

Amount Money The flat amount to be applied to the unit retail to arrive at the modified selling price.
DerivationRuleID Identity Identifies the rule fired off to create and apply this retail price modifier. Note that this attribute may be replaced by a foreign key reference as the retail price derivation rules view is further developed. The intent here is to provide an audit trail that shows HOW a retail selling price is derived from the look up price read from the ITEM UNIT RETAIL AND COST entity.
Percent Percent The percent of the look up retail price to be applied to the unit retail to arrive at the modified selling price.
ReasonCode Code2 A code that describes why the price modifier is applied to the line item.
RetailPriceModifierSequenceNumber LineNumber The sequence number to signify a particular instance of a PRICE LINE MODIFIER.
StockLedgerAccounting-DispositionCode Code4 A code that determines how the price change reflected in this modifier is to be treated for stock ledger accounting purposes. This code allows price change modifiers to be treated as discounts (expenses below the gross margin line) OR as markdowns (treated as changes to the inventory value which alter the stock ledger's cumulative markon for the item).

Back to Top

FuelSalesLineItem

A line item component of a RETAIL TRANSACTION that records the collection of money in return for the fuel dispensed by a FUELLING TRANSACTION.

Tag

Type

Definition

FuelSaleStatusCode Code2 A status code denoting the mode of the Fuel Sale. Possible values are: Prepay: Where the FuelSaleLineItem happens before the FuellingTransaction PostPay: Where the FuelSaleLineItem happens after the Fuelling Transaction PrepayRefund: Where the FuelSaleLineItem happens after a Prepay FuelSaleLineItem and the matching FuellingTransaction did not use all of the

Back to Top

FuelSaleTaxModifier

A modifier to record tax or tax exemption to the sale of a particular FuelingTransaction.

Tag

Type

Definition

ExemptAmount Money The monetary value of the tax exemption for a given tax authority for a SALE/RETURN LINE ITEM. This amount will be subtracted from the sale-return-tax-amount (and nearly always result in a zero tax due amount) to reflect the tax exemption of a line item.
ExemptionReasonCode Code2 Defines the basis for exempting a SALE/RETURN LINE ITEM from tax.
TaxAmount Money The monetary value of the tax for a given tax authority for a SALE/RETURN LINE ITEM.
TaxModifierSequenceNumber LineNumber A sequence number to identify each tax modifier associated with a SALE RETURN LINE ITEM.

Back to Top

FundsReceiptTransaction

A type of FINANCIAL ACCOUNTING TRANSACTION that records a cash receipt (with an offsetting miscellaneous income).

Tag

Type

Definition

FundReceiptMonetaryAmount Money The monetary amount of the receipt transaction.
FundsReceiptPartyID Identity The identifier for the party who submitted the FUNDS RECEIPT.

Back to Top

GiftCertificate

A certificate with a face monetary value issued by a store for subsequent exchange for merchandise. A GIFT CERTIFICATE when sold to a customer represents a current liability that is carried until the GIFT CERTIFICATE is redeemed or until it is aged to the point where the store declares it invalid/expired.

Tag

Type

Definition

DonorAddress Address The address where the GIFT CERTIFICATE donor resides.
DonorCity City The city where the GIFT CERTIFICATE donor resides.
DonorName Name The name of the GIFT CERTIFICATE donor.
DonorPostalCode PostalCode The postal or zip code component of the address where the GIFT CERTIFICATE donor resides.
DonorState State The state in which the GIFT CERTIFICATE donor resides.
DonorTelephoneAreaCode PhoneNumberAreaCode The telephone area code of the GIFT CERTIFICATE donor.
DonorTelephoneCountryCode PhoneNumberCountryCode The telephone country code of the GIFT CERTIFICATE donor.
DonorTelephoneLocalNumber PhoneNumberLocal The telephone local number of the GIFT CERTIFICATE donor.
ExpirationDate DateCalendar The expiration date when the GIFT CERTIFICATE can no longer be tendered.
FaceValueAmount Money The monetary value printed or embossed on the GIFT CERTIFICATE.
GiftCertificateSerialNumber Name The serial number that uniquely identifies a GIFT CERTIFICATE.
IssueDateTimestamp TimeStampEffective The time and date when the gift certificate was issued by the RETAIL STORE to the CUSTOMER.
IssueTypeCode Code2 A code to denote how GIFT CERTIFICATEs are issued by the RETAIL STORE, e.g. embossed or printed at the point of sale.
IssuingStoreNumber Identity A unique store number reference to identify the RETAIL STORE that issued the GIFT CERTIFICATE.
UnspentBalanceAmount Money The monetary value of the unspent amount outstanding on a specific GIFT CERTIFICATE.

Back to Top

GiftCertificateClass

Defines a class of gift certificates and establishes the business rules governing their issuance and redemption.

Tag

Type

Definition

BusinessAffiliateName Name Identifies the business affiliate (i.e. a mall, another peer store, a union, etc.) on whose behalf this type of gift certificate is set up.
FormID Identity Identifies the format and type of paper used to print this type of gift certificate.
GiftCertificateTypeCode Code2 Identifies a gift certificate type.
RedemptionPeriodDayCount QuantityDayCount Defines the number of days this gift certificate remains outstanding and redeemable.
TypeDescription DescriptionShort Describes a gift certificate type
UnspentBalanceDispositionCode Code4 Defines how the unspent balance for a gift certificate is to be handled. Options are to pay the balance back to the customer as cash, issue a 2nd gift certificate for the remaining balance, etc.

Back to Top

GiftCertificateLineItem

A type of RETAIL TRANSACTION LINE ITEM that records the sale of redeemable form of tender for a predetermined monetary value of sellable merchandise in the store. Creates a liability for the retailer in the amount denoted on the face value of the certificate.

Tag

Type

Definition

ScannedOrKeyedCode Code2 A code that indicates whether the serial number for the gift certificate was keyed or scanned.

Back to Top

GiftCertificateTenderLineItem

A type of TENDER LINE ITEM that records the specifics about a GIFT CERTIFICATE redeemed as part of settling a transaction.
Back to Top

GiftRegisteredItem

A customer's selection of an item for inclusion in his or her gift registry.

Tag

Type

Definition

DesiredQuantity QuantityShortCount The quantity of ITEMs that are asked for in the GIFT REGISTRATION.

Back to Top

GiftRegistryLineItem

A linkage of ITEMs that have been registered for and items that have been purchased.

Tag

Type

Definition

Quantity Quantity The number of items purchased for the GIFT REGRISTRATION on this line item.

Back to Top

GroupResourceAccess

GROUP RESOURCE ACCESS defines a specific Group's access privileges to a given RESOURCE.

Tag

Type

Definition

GroupReadAccessLevelFlag Code2 A flag to indicate whether read access is granted to the referenced GROUP for the corresponding RESOURCE identified in this record.
GroupWriteAccessLevelFlag Code2 A flag to signify whether write access is granted to the referenced GROUP for the corresponding RESOURCE identified in this record.

Back to Top

HourlyEmployee

An employee that is compensated based on hours worked.
Back to Top

InventoryAdjustmentDocument

A document that captures an increment or decrement to an item's unit on hand count and/or financial valuation.

Tag

Type

Definition

InventoryAdjustmentDocumentID Identity A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments between actual and notified amounts.

Back to Top

InventoryAdjustmentLineItem

The detail line item on the INVENTORY ADJUSTMENT DOCUMENT which applies an increment or decrement to the ITEM's unit on hand and /or the financial valuation.

Tag

Type

Definition

InventoryAdjustmentLineNumber LineNumber The line number for a specific line item adjustment.
ReasonCode Code2 The reason code for the line item adjustment.

Back to Top

InventoryCondition

A reference entity type that defines permissible inventory conditions (e.g. damaged, shorted, etc.). An inventory condition applies to inbound, stored and outbound merchandise and is important in establishing the value of that merchandise.

Tag

Type

Definition

InboundDescription DescriptionShort A textual description of the condition of the shipment.
InventoryConditionCode Code4 A code which uniquely identifies the condition for inventory being received, stored or shipped out by a retail store. These codes will signify good, broken, damaged, wrong, partial shipment, overage, etc. This code relates to the UCC code, Receiving Condition Code, data element 412. \

Back to Top

InventoryControlDocument

A written or printed paper, or digital equivalent, that evidences an exchange in the ownership of merchandise or supply STOCK ITEMs.

Tag

Type

Definition

ActualDeliveryDate DateCalendar The actual delivery date of the shipment, to which this particular inventory control document relates.
CompleteDateTimestamp TimeStampAudit The time and date when the processing of the inventory control document was completed.
ContractReferenceNumber Identity The contract against which the delivery has been made.
CreateDateTimestamp TimeStampAudit The time and date when the inventory control document was originally created.
DeferredPaymentDate DateCalendar The deferred payment date on which the RETIL STORE has to make its payment. Deferred payments are an inducement to retailers to accept certain stock.
DocumentTypeCode Code2 This code identifies the type of INVENTORY CONTROL DOCUMENT.
ExpectedDeliveryDate DateCalendar The expected delivery date of the shipment, to which this particular inventory control document relates.
FreightChargeDispositionCode Code4 A code that assigns responsibility for payment of the freight and insurance charges for this inventory control document to the store or other party in the transaction.
FromPartyID Identity The party that originated the inventory control document.
InventoryControlDocumentID Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
LastUpdateDate DateCalendar The date when the inventory control document was last updated by the store.
OriginatorID Identity Identifies the point of origin for this inventory control document. An originator may be a program (for automatically generated documents) or a person.
ReceivedDifferenceCode Code2 A code to indicate the reason for the difference between the quantity ordered and quantity shipped. This code relates to the UCC code, Shipment/Order Status Code, data element 368.
SerialFormID String An idenfier for this document, usually preprinted on the form stock prior to being filled out.
SupplierActualShipDate DateCalendar The actual ship date of the shipment, to which this particular inventory control document relates. The actual date of the to which this particular inventory control document relates, is expected to be shipped from the originating company or store.
SupplierExpectedShipDate DateCalendar The expected arrival date of the shipment, to which this particular inventory control document relates.
TermsAndConditionsCode Code4 This code denotes the relevant terms and conditions pertaining to this particular inventory control document, eg the supplier must be notified of any shortages within three days.
ToPartyID Identity The name and address of the party to whom the inventory control is directed for the purposes of receiving, transferring or ordering of merchandise.
UnitDiscrepancyCount Quantity The discrepancy count between the units recorded on the INVENTORY CONTROL DOCUMENT and the actual units counted.

Back to Top

InventoryControlDocumentAllowanceLineItem

A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records allowances applicable to the whole INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

Amount Money The monetary allowance made by the supplier against a specific line on the INVENTORY CONTROL DOCUMENT.
ReasonCode Code2 The reason code for applying the allowance.
RetailerSerialFormID String An idenfier for this document, usually preprinted on the form stock prior to being filled out.
SupplierAllowanceNumber Identity The number assigned by the supplier referencing an allowance, promotion or deal.
TypeCode Code2 This code defines the type of allowance. For ARTS purposes the UCC-defined codes, data elements 150 and 340, are used as the basis for the domain of this attribute.

Back to Top

InventoryControlDocumentChargeLineItem

A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records charges applicable to the whole INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

Amount Money The monetary charge levied against a specific line on the INVENTORY CONTROL DOCUMENT.
ReasonCode Code2 The reason code for the levy of this charge, eg price labeling the merchandise prior to shipment.
SupplierChargeNumber Identity The number assigned by the supplier referencing the charge.
TypeCode Code2 This code defines the type of charge. For ARTS purposes the UCC-defined codes, as per data elements 150 and 340, are used as the basis for the domain of this attribute.

Back to Top

InventoryControlDocumentFreightLineItem

A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records the type and amount of freight cost incurred on an INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

CostAmount Money The freight charges.
CostCode Code2 A code to signify whether the freight cost is met by the retailer or supplier.

Back to Top

InventoryControlDocumentLineItem

A detail line on an INVENTORY CONTROL DOCUMENT that identifies the STOCK ITEM, and unit of measure exchanged, or the freight, charges, taxes, and allowances applicable to a particular inventory control event and action.

Tag

Type

Definition

DocumentLineItemID Identity The INVENTORY CONTROL DOCUMENT LINE ID identifies the ID for a specific line number within the INVENTORY CONTROL DOCUMENT.
DocumentTypeCode Code2 The DOCUMENT LINE ITEM CODE TYPE CODE specifies the item type.
InventoryControlDocumentLineNumber LineNumber The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the INVENTORY CONTROL DOCUMENT.

Back to Top

InventoryControlDocumentMerchandiseLineItem

A type of INVENTORY CONTROL DOCUMENT LINE ITEM that identifies and records the number of retail and ship units and unit cost for a STOCK ITEM being received, returned, transferred or shipped on an INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

ChangeReasonCode Code2 A code that defines the reason for the difference between the quantity ordered and quantity shipped for a line item.This code relates to the UCC code, Line Item Change Reason Code, data element 892.
CostPerUnitTypeCode Code2 Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types include: SALE UNIT, PACK UNIT and SHIP UNIT. A single SUPPLIER ITEM may in effect have 1 to three SUPPLIER ITEM BASE COST entities associated with it.
DamagedUnitCount Quantity A count of the damaged item units (in the item-cost-per-unit-type) received or shipped in this document line item. This count when subtracted from the document-line-item-unit-count yields the number received or shipped in good condition.
DocPreticketedFlag Flag A flag indicating whether this line item has been preticketed by the SUPPLIER.
PrepricedFlag Flag A flag indicating whether or not the item is prepriced by the manufacturer.
UnitBaseCostAmount Money The cost of the merchandise by itself exclusive of shipping and handling, duties and import fees, insurance, taxes and other logistic expenses that a store incurs to bring the item into the store.
UnitCount Quantity A count of all item units (in the item-cost-per-unit-type) received or shipped in this document line item.
UnitNetCostAmount Money The cost of the merchandise by itself plus shipping and handling, duties and import fees, insurance, taxes and other logistic expenses that a store incurs to bring the item into the store; and less any discounts or allowances allocated to the line item (hence the term NET).
UnitsShippedCount Quantity The count of units shipped versus the receiving count. This is subtracted from the document-line-item-unit-count to yield an over/under variance between what a supplier said was shipped and what was counted and received at by the store's staff.

Back to Top

InventoryControlDocumentMerchandiseLineItemModifier

A modifier that applies an allowance or a charge to a single line item on an INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

AccountingDispositionCode Code4 The code to denote as to how the amendment resulting from the INVENTORY DOCUMENT MERCHANDISE LINE ITEM MODIFIER will be accounted for within the STOCK LEDGER.
AllowanceOrChargeCode Code2 A code to denote whether a charge or allowance is applied to a specific merchandise control document line.
InventoryControlDocumentLineModifierNumber LineNumber A reference number against which a specific instance of a modifier is applied.
MonetaryAmount Money The monetary amount amendment resulting from the INVENTORY DOCUMENT MERCHANDISE LINE ITEM MODIFIER.
Percent Percent The percent amendment resulting from the INVENTORY DOCUMENT MERCHANDISE LINE ITEM MODIFIER.
ReasonCode Code2 The code which denotes the reason for the change made to a specific INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM.

Back to Top

InventoryControlDocumentReference

Defines instances where one inventory control document refers to one or more other inventory control documents.
Back to Top

InventoryControlDocumentTaxLineItem

A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records sales, use and value added taxes applicable to the whole INVENTORY CONTROL DOCUMENT.

Tag

Type

Definition

TaxRateCode Code4 A code which refers to the tax rate to be applied to the specific line item on the INVENTORY CONTROL DOCUMENT.
TaxTypeCode Code2 A code to denote the tax type that refers to the line item on the INVENTORY CONTROL DOCUMENT, eg VAT.

Back to Top

InventoryTransactionJournalEntry

A list of inventory retail-selling-unit receipts and issues that is applied to an ITEM - LOCATION STOCK LEDGER ACCOUNT stock-on-hand and is directly traceable to an inventory control event, inventory control document and document line item.

Tag

Type

Definition

AccountingDate DateCalendar The accounting date within which the INVENTORY TRANSACTION JOURNAL ENTRY is recorded.
DateTimestamp TimeStampAudit The time and date when the INVENTORY TRANSACTION JOURNAL ENTRY is recorded.
InventoryTransactionJournalID Identity A unique identifier for the INVENTORY TRANSACTION JOURNAL.
RetailUnitAllowanceAmount Money The allowance permitted between the actual count and the inventory on hand unit amount.
RetailUnitCount Quantity The actual number of units of a specific ITEM.
RetailUnitCurrentSellingPriceAmount Money The actual monetary amount charged to the customer in exchange for ITEMs.
RetailUnitMarkdownAmount Money The monetary amount of the markdown applied to the retail price.
StockLedgerActionCode Code4 Defines the action taken against a specific stock ledger item location by the source transaction

Back to Top

Item

An ITEM is the lowest level for which inventory and sales records are retained within the retail store. It is analogous to the SKU ( Stock Keeping Unit).

Tag

Type

Definition

AuthorizedForSaleFlag Flag A flag to indicate that the RETAIL STORE is authorized to stock this particular ITEM.
Description DescriptionShort The textural description of the ITEM and its characteristics.
DiscountFlag Flag A flag to indicate whether this ITEM can be discounted.
ItemID Identity The retailer's SKU or unique item identifier for items sold or returned.
KitSetCode Code2 This code signifies this ITEM is provided as a kit which has to made up either by the customer or by the store at an additional cost.
Name Name The name by which the ITEM is known.
OrderCollectionCode Code2 A code to signify that this ITEM is ordered as part of a collection of ITEMs.
PriceAuditFlag Flag A flag to denote whether this ITEM was validated (scanned) during verification of the ITEM table.
SubstituteIdentifiedFlag Flag An ITEM for which there is a substitute available for sale within the RETAIL STORE.
TaxExemptCode Code2 A code to denote the tax exemption status from sales and use tax. The codes refer to the UCC code, Tax Exempt Code, defined in data element 441.
TypeCode Code4 This code indicates whether the item is a STOCK ITEM or SERVICE ITEM.
UsageCode Code2 This code defines how this item may be used within a store. Usage is a function of how an item may be consumed or disposed of by the store.

Back to Top

ItemAlternateIdentity

Defines an alternative identifier for a STOCK ITEM entity type instance. The alternative identifier is assigned by the retail store.

Tag

Type

Definition

CaseCodePackCount Quantity The number of units in the case for the alternate ITEM.
Description DescriptionShort The textual description for the alternate ITEM.
RetailItemAlternateID Identity An alternate identifying number or code for an item.
UsageCode Code2 A code that defines how this ITEM ALTERNATE IDENTITY is to be used.

Back to Top

ItemCollection

An optional relationship between an item and its components and affiliates where the components consist of other ITEMs. Note that this data structure is intended to support one and only one level of decomposition and/or affiliation between an ITEM parent and its ITEM children.

Tag

Type

Definition

BlendPercent Percent The percentage of the parent item that comes from the child item.
ItemCollectionID Identity A unique identifier given to a specific ITEM COLLECTION.
PerAssemblyCount Quantity The number of individual constituent ITEMs within the ITEM COLLECTION.
TypeCode Code2 A code to denote the type of ITEM COLLECTION.

Back to Top

ItemCreation

A type of ITEM - MAINTENANCE EVENT that creates a new ITEM entity and related supporting attributive entities.
Back to Top

ItemDeletion

A type of ITEM - MAINTENANCE EVENT that deletes an ITEM entity and its associated supporting attributive entities.
Back to Top

ItemDescriptonUpdate

A type of ITEM - MAINTENANCE EVENT that updates the non-retail price descriptive data for an ITEM and its attributive entities.
Back to Top

ItemElectronicLabel

A type of ITEM LABEL that defines the properties of the electronic shelf labels used to present the current retail price to customers. Electronic labels are small liquid crystal screens, attached to the front of the display shelf or unit,which convey the current selling price and other information regarding the RETAIL ITEM to the CUSTOMER or EMPLOYEE. These labels are electronically linked to the store processor. In this way any amendments to the ITEM can be transmitted to the shelf label at the same time they take effect. This facility ensures that ITEM details and prices on the shelf and store processor are synchronized.
Back to Top

ItemLabel

A means of conveying information about a RETAIL ITEM to the CUSTOMER and/or EMPLOYEE. This information is available on or adjacent to the ITEM. It may be in the form of an item tag or paper or electronic shelf label

Tag

Type

Definition

LabelID Identity A unique identifier for a specific ITEM LABEL.
TypeCode Code2 Identifies the type of label to be created for the associated item maintenance event.

Back to Top

ItemLot

A batch or group of items. The idenfication of this grouping normally comes from the MANUFACTURER and normally applies to ITEMs that are dependent on matching of colours or detailed tracking requirements.

Tag

Type

Definition

ItemLotID Identity An identifier for a LOT of specific ITEMs.

Back to Top

ItemLoyaltyAccountEligibility

A specific item's eligibility for loyalty account point accrual.
Back to Top

ItemMaintenanceEvent

An association between an ITEM and a MAINTENANCE EVENT that updates information about that item.

Tag

Type

Definition

FunctionCode Code2 Defines the maintenance action taken by this ITEM - MAINTENANCE EVENT against an ITEM.

Back to Top

ItemPrice

A sparse array allowing combinations of Time, Forecourt Service Level, Price Level and FuellingPoint affect the current retail price of an ITEM. The available set of valid prices for all ITEMs dispensed by a FUELLING POINT are downloaded into the FU

Tag

Type

Definition

EffectiveDate DateCalendar The calendar day this ItemPrice becomes active
ExpirationDate DateCalendar The calendar day this ItemPrice becomes inactive
ItemPriceID Identity A unique identifier for the ItemPrice.
Name Name A descriptive short name that people use to identify the ItemPrice
RetailPrice MoneyShortRetail
StatusCode Code2Status The current status of the ItemPrice entry. Possible values include Active, InActive and Pending.

Back to Top

ItemPriceDerivationRule

A type of PRICE DERIVATION RULE that modifies the retail sale unit price amount for an item as read from the PLU and results in a new retail sale unit price that is presented to the customer and/or used as the new base for compounding price changes. This rule affects prices of items that triggered the eligibilit

Tag

Type

Definition

PricePoint Money A reduction expressed as a price.
ReductionAmount Money A reduction expressed as a flat amoung
ReductionPercent Percent A reduction expressed as a percent.
ReductionTypeCode Code4 A code that indicates the category of price reduction

Back to Top

ItemPriceDerivationRuleEligibility

Defines an association between an ITEM and a PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense (in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied
ExpirationDateTimestamp TimeStampExpiration The time and day this rule is no longer valid.
IntervalAmount Money An interval monetary armount for which this price derivation rulle eligible.
IntervalQuantity Quantity An interval quantiy for which this price derivation rulle eligible.
LimitAmount Money The maximum monetary amount within a merchanidise structure level for which this price deriviation rule is eligible.
LimitQuantity Quantity The maximum number of items within a merchanidise structure level for which this price deriviation rule is eligible.
ThresholdAmount Money A monetary amount within a single merchandise structure level required to be purchased to trigger this price derivation rule.
ThresholdQuantity Quantity A quanity of items within a single merchandise structure level required to be purchased to trigger this price derivation rule.
ThresholdTypeCode Code4 A code for the type of threshold wich applies to a price derivation rule eligibility.

Back to Top

ItemPriceMaintenance

A type of ITEM MAINTENANCE EVENT that updates the current retail price of an item or creates, updates or deletes a PRICE DERIVATION RULE.

Tag

Type

Definition

TypeCode Code2 A code to denote how the permanent price is actioned, ie global or individual ITEM amendment.

Back to Top

ItemSalesProhibitionPeriodRule

A rule that identifies specific days of the week and/or special dates and time periods during which the sale of an ITEM is prohibited.

Tag

Type

Definition

EndDayOfWeekCode DateFiscalDay A code to denote the end date in the week for the item sales restriction.
EndTime Time A code to denote the end time on a specified day for the item sales restriction.
StartDayOfWeekCode DateFiscalDay A code to denote the start date in the week for the item sales restriction.
StartTime Time A code to denote the start time on a specified day for the item sales restriction.

Back to Top

ItemSalesSummary

Sales accumulations for RETAIL ITEMS by different FISCAL PERIODs.

Tag

Type

Definition

TotalEmployeeDiscountAmount Money The total monetary value of ITEMs sold with an employee discount in the REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of items sold with an employee discount in the REPORTING PERIOD.
TotalItemAmount Money The total monetary amount of ITEMs sold within the REPORTING PERIOD.
TotalItemCount QuantityTransactionCount The total number of ITEMs sold within the REPORTING PERIOD.
TotalMarkdownAmount Money The total value of ITEM markdowns sold within the REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of items marked down within the REPORTING PERIOD.
TotalMiscellaneousDiscountAmount Money The total monetary value of ITEM miscellaneous discounts in the REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of items sold with a miscellaneous discount in the REPORTING PERIOD.
TotalReturnAmount Money The monetary value of ITEMs' returns within the REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of ITEM returns within the REPORTING PERIOD.
TotalVoidAmount Money The total monetary value of voided of items sold within the REPORTING PERIOD.
TotalVoidCount QuantityTransactionCount The total number of items voided within the REPORTING PERIOD.

Back to Top

ItemSellingPriceHistory

The historical archive of the retail-selling unit price at which a given ITEM was actually sold at POS, net of markdowns, markups and other price changes that modify the cumulative markon for an item.

Tag

Type

Definition

EffectiveDateTimestamp TimeStampEffective The date and date on which a specific price change became effective.
EndDateTimestamp TimeStampExpiration The date and time when an ITEM price no longer applied.
ItemRetailPriceSequenceNumber LineNumber The reference number that applies to each occurrence of a price change.
UnitRetailPriceAmount MoneyShortRetail The historical unit retail price of an item associated with an event.

Back to Top

ItemShelfLabel

A type of ITEM LABEL that provides a means of conveying information about a RETAIL ITEM to the CUSTOMER and/or EMPLOYEE. The label is sited adjacent to the item, usually in front of the merchandise where it can easily be seen by the customer.
Back to Top

ItemTenderRestrictionGroup

A collection of ITEMs which share a common restriction on the kind of tender that may be used to pay for them at a store.

Tag

Type

Definition

Description DescriptionShort The description of a group of TENDER RESTRICTIONs which apply to specific ITEMs.
ItemTenderRestrictionGroupCode Code2 A code to denote a specific group of ITEM TENDER RESTRICTIONs.
Name Name The name of a specific group of TENDER RESTRICTIONs which apply to specific ITEMs, eg WICs cannot be used to purchase tobacco or alcohol ITEMs.

Back to Top

ItemTenderRestrictionRule

An association between ITEM TENDER RESTRICTION GROUP and TENDER which constrains the use of a specific type of tender in the settlement of a sale for a specific ITEM.

Tag

Type

Definition

Description DescriptionShort A description of the rule that prohibits the purchase of specific ITEMs with certain tender types.
EffectiveDate DateCalendar The date on which the ITEM TENDER RESTRICTION becomes effective.
ExpirationDate DateCalendar the date on which the tender restriction on specific STOCK ITEM expires.
Name Name The rule that prohibits the purchase of certain ITEMs by certain tender types.
StatusCode Code2Status A code to indicate whether the restriction rule applies to a certain ITEM or not.

Back to Top

ItemTicket

A type of ITEM LABEL that provides a means of conveying information about a RETAIL ITEM to the CUSTOMER or EMPLOYEE.The ITEM TICKET typically takes the form of either as an adhesive ticket or hanging tag.
Back to Top

Job

Defines the functions, duties, responsibilities and authority delegated to one or more positions within the retail enterprise.

Tag

Type

Definition

Description DescriptionNarrative A narrative that describes the functions and responsibilities of a JOB.
JobCode Code6 A unique identifier for a JOB or funcation.
Name Name A name or label that describes a JOB.

Back to Top

KeyCustomer

An individual, collection of individuals, company, or public institution that may purchase (and return goods) and services from a retailer and that has a persistent relationship with that retailer. A persistent relationship is one that exists apart from and transcends specific purchase and return transactions. A persistent relationship is evidenced by some kind of an account with the retai
Back to Top

KeyCustomerClient

Represents the \"super customer\" relationship between a KEY CUSTOMER and any other CUSTOMER. This relationship may be that of a personal shopper, a mechanic that purchase parts on behalf of his/her customer, or any other agent type relationship.

Tag

Type

Definition

TypeCode String A grouping of clients based on the relationship between the key customer and the client.

Back to Top

LicenseSalesRestriction

A restriction or limitation on the sales of a class of items based on the purchaser's profession, license, or other certification.

Tag

Type

Definition

Description String A narrative that describes the restriction of sales to those holding a license or certification.

Back to Top

Location

A floor and an area on a floor inside a RETAIL STORE that is explicitly identified for tracking inventory, sales activity and other business activities that are important to measuring a store's performance

Tag

Type

Definition

FunctionCode Code6 A code that describes what business activities and functions are performed in a specific location. Activities may include: ADMIN - Administration functions (no stock or customer services are handled here) DISPLY - Merchandise display (stock is presented to the customer for sale) CUSTSVC - Customer service - Customer merchandise may be picked up, returned, etc. RETADJ - Returns and adjustments - where a customer may return merchandise for a credit or refund. Where customers may request price adjustments (e.g. when they bought a sale item just before it went on special) STOCKPT - Stock Point - Out of customer sight location where merchandise is stored, counted and tracked at a physical and financial level. This could be the \"back room\" (like you see in shoe stores) or it could be a receiving dock, etc. RECV - Receiving or merchandise intake location where merchandise is physically unloaded and accepted by the retail store into its inventory (or at least acknowledged). And lots more depending on the retailer. These codes should indicate which locations involve merchandise sales and tracking. Based on the examples above DISPLY, STOCKPT, CUSTSVC, RECV and RETADJ all represent types of locations that involve the storage, sale or return of merchandise. There are many additional functions and codes that might be assigned depending on the retailer. As Internet sales open up, the concept of location changes. Instead of physical locations, merchandise tracking may be by URL and HTML name. The goal is still to understand WHERE merchandise is moving and where the ownership gets transferred from one party to
LevelNumber Number A retailer-defined code that defines the relative position a location has within a hierarchy of locations. This is for modeling traditional retail stores. It allows a retailer to assign locations to specific levels. For example: Level Level Descrption 01 Store Building 03 Floor 05 Area 07 Department 09 Fixture Address 11 POS Device
LocationID Identity A unique identifier for a specific LOCATION within the RETAIL STORE.
Name Name The name designated to identify the LOCATION, eg first floor sales area.
SecurityClassCode Code6 Defines the level of security required for a specific location. This is to accommodate secured merchandise like prescription drugs, guns and ammunition, upper end sound and video equipment, etc.
SquareFeetCount Quantity The number of square feet within this LOCATION.

Back to Top

LocationEnvironmentClass

A cross reference of LOCATIONS to the class of environmental propertiesfor that location. For instance, this might describe humidity, temperature, or lighting restrictions or requirements
Back to Top

LocationLevel

A group of locations at the same hierarchical level.

Tag

Type

Definition

Description DescriptionNarrative A narrative that describes a location level.
LocationLevelID Identity A unique identifier for a specific location level.
StockLedgerControlFlag Flag A flag that indicates whether or not a LOCATION LEVEL will be used to track stock ledger items. If a LOCATION LEVEL has a stock-ledger-control-flag of 'N', no lower levels can have a stock-ledger-control-flag of 'Y

Back to Top

LogicalNozzle

A collection of PHYSICAL NOZZLES which blend and dispense BULK ITEMs during a FUELLING TRANSACTION. The logical nozzle measures the volume of fuel dispensed, and may calculate the total value of the FUELLING TRANSACTION. The logical nozzle may also c

Tag

Type

Definition

LogicalNozzleID Identity A unique identifier for the logical nozzle

Back to Top

LoyaltyAccountAgreement

An agreement between the loyalty account member and the enterprise.
Back to Top

LoyaltyAccountTerm

Terms and conditions associated with a promotional program.

Tag

Type

Definition

Description DescriptionNarrative
LoyaltyProgramTermID Identity

Back to Top

LoyaltyAward

The identification of a reward that the customer receives for satisfying the requirements of a promotion. Examples include premium gifts given when a customer has purchased $N worth of merchandise over a promotional period.

Tag

Type

Definition

LoyaltyAwardID <unknown>
TypeCode Code2 Indicates the type of promotional award given. For example the award may be an item, a gift certificate, as savings bond, etc.

Back to Top

LoyaltyProgram

A membership-based customer incentive initiative.

Tag

Type

Definition

Description DescriptionNarrative Text that describes a loyalty program.
EffectiveDate DateCalendar The date that a loyalty program becomes available.
EndDate DateCalendar The date that a loyalty program is no longer available.
LoyaltyProgramID Identity A artificial, unique identifier for a loyalty program.
Name Name A name or tradename for a loyalty program.

Back to Top

MaintenanceEvent

A type of EVENT which represents a collection of changes to ITEM details that are managed together. These changes may reflect a promotional activity, a set of price changes, item additions and deletions, or general maintenance of item data.

Tag

Type

Definition

AppliedTimestamp TimeStampAudit The date and time the maintenance event's associated adds, changes and deletes are applied to the store database.
CreateDateTimestamp TimeStampAudit The date and time this maintenance event was created.
Description DescriptionShort Describes the maintenance event in business terms.
EffectiveDateTimestamp TimeStampEffective The date and time the maintenance event is to become effective (and is to be applied)
ExpirationDateTimestamp TimeStampExpiration The date and time the maintenance event is to expire (and be removed).
Name Name Assigns a name to the maintenance event.
OriginTypeCode Code4 The origin for this maintenance event. Examples of origins include: home office, store, etc.
ReasonCode Code4 Establishes a reason for the maintenance event. Reason codes will be determined by each retailer.
StatusCode Code2Status The current status of the maintenance event. Valid status conditions include pending, applied, canceled, expired, etc.
TypeCode Code2 Categorizes the maintenance event based on its intended purpose and subject. Examples include ITEM maintenance, selling rules maintenance, tender authorization maintenance and a whole host of different aspects of the retail store data model that may be maintained from the home office. \

Back to Top

Manufacturer

The external party that manufactures the ITEM.

Tag

Type

Definition

ManufacturerID Identity A unique identifier to denote the ITEM MANUFACTURER.
Name Name The name of the MANUFACTURER's organization.

Back to Top

ManufacturerBrand

An associative (many-to-many) entity that links MANUFACTURER and BRAND. Brands, such as private label merchandise, can be produced by different MANUFACTURERs and a MANUFACTURER can produce different BRANDs
Back to Top

ManufacturerCouponFamily

Code assigned by the manufacturer to classify product for promotion purposes. In the ARTS model it is used to validate manufacturers coupons.

Tag

Type

Definition

Description DescriptionShort The description for a coupon family code for the manufacturer item.
ManufacturerFamilyCode ProductCodeFamily The UPC designated three digit coupon family code for the manufacturer item.

Back to Top

ManufacturerItem

A stock item identified by and described by its manufacturer

Tag

Type

Definition

CouponFamilyCode ProductCodeFamily A code that validates the consumer has purchased a couponed product. This code represents a category of products with the same color, favor, size or particular BRAND.
Description DescriptionShort The business description for the manufacturer item.
ManufacturerUPCItemID ProductCodeGlobal The UPC number assigned to the item by the manufacturer to uniquely identify the item.
Name Name The business name of the manufacturer item.

Back to Top

ManufacturerPriceDerivationRuleEligibility

Defines an association between a MANUFACTURER and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of the merchandise ( in which case it impacts the stock ledger) or an expense ( in which case it impacts the store financial ledger). in certain instances where the manufacturer has agreed to compensate the retailer for part or the entire price markdown then it is probable that the store will take the revaluation as an expense which will be credited at a subsequent time.
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as a result of the application of the PRICE DERIVATION RULE will be handled where more than one rule is applied within a sales transaction.
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied.
ExpirationDateTimestamp TimeStampExpiration The time and date this rule is no longer valid.

Back to Top

MerchandiseHierarchyLevel

Establishes the levels of the merchandise hierarchy structure for rolling up sales units and financial amounts for ITEMs.

Tag

Type

Definition

Description DescriptionShort The retailer-specific description associated with an ARTS standard merchandise-hierarchy-level-code. This attribute allows retailers to assign any description they choose to each level.
MerchandiseHierarchyLevelCode Code4 Identifies a hierarchy level within a summarization tree structure for merchandise sales analysis and merchandise classification. The values for this attribute will be standardized within the ARTS Data Model.

Back to Top

MerchandiseHierarchySalesPlan

Budgeted sales for MERCHANDISE HIERARCHY points by different FISCAL PERIODs.

Tag

Type

Definition

SalesBudgetNetSalesRetailAmount Money The net sales amount which has been budgeted for the RETAIL STORE. This budget is normally set at certain merchandise hierarchical levels to enable the RETAIL STORE to better identify the sales contribution of the various merchandise groups.

Back to Top

MerchandiseHierarchySalesSummary

Sales accumulations for MERCHANDISE HIERARCHY points by different FISCAL PERIODs.

Tag

Type

Definition

CumulativeItemDaysOnPromotionCount QuantityTransactionCount The cumulative number of days where item promotions are run. These days are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemDiscountAmount Money The cumulative monetary value of miscellaneous item discounts recorded by the RETAIL STORE. These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemDiscountTransactionCount QuantityTransactionCount The cumulative number of item discounts which have been applied at the transaction level. These discounts will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD. \
CumulativeItemDiscountUnitCount QuantityTransactionCount The cumulative number of miscellaneous item discounts recorded by the RETAIL STORE. These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemEmployeeDiscountAmount Money The cumulative monetary value of employee item discounts recorded by the RETAIL STORE. These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemEmployeeDiscountTransactionCount QuantityTransactionCount The cumulative number of item employee discounts which have been applied at the transaction level. These discounts will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemEmployeeDiscountUnitCount QuantityTransactionCount The cumulative number of employee item discounts recorded by the RETAIL STORE. These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemGrossSales Money The cumulative gross item sales recorded by the RETAIL STORE. These sales are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemGrossSalesExVATAmount Money The cumulative monetary amount of gross sales excluding VAT recorded by the RETAIL STORE. These markdowns will be recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemPromotionalPriceMarkdownAmount Money The cumulative monetary value of markdowns recorded by the RETAIL STORE. These markdowns are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemPromotionalPriceMarkdownTransactionCount QuantityTransactionCount The cumulative number of transactions which have been marked down by the RETAIL STORE. These markdowns are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemPromotionalPriceMarkdownUnitCount QuantityTransactionCount The cumulative number of markdowns recorded by the RETAIL STORE. These markdowns are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemReturnAmount Money The cumulative monetary value of item returns for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.
CumulativeItemReturnUnitCount QuantityTransactionCount The cumulative number of item returns for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD. \
CumulativeItemSalesTransactionCounts QuantityTransactionCount The cumulative number of transactions involving item sales. The item sales are recorded at the various MERCHANDISE HIERARCHY levels for each REPORTING PERIOD.
CumulativeItemSalesUnitCount QuantityTransactionCount The cumulative number of ITEMs sold by the RETAIL STORE. The ITEMs are recorded at the various merchandise hierarchy for each REPORTING PERIOD.
CumulativeItemStoreCouponAmount Money The cumulative monetary value of item store coupons received by the RETAIL STORE. These coupons are recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
CumulativeItemStoreCouponTransactionCount QuantityTransactionCount The cumulative number of item store coupons received by the RETAIL STORE. These coupons are recorded at the various hierarchy levels for each REPORTING PERIOD.
CumulativeItemStoreCouponUnitCount QuantityTransactionCount The cumulative number of item store coupons received by the RETAIL STORE. These coupons are recorded at the various hierarchy levels for each REPORTING PERIOD.
CumulativeItemStoreRefundAmount Money The cumulative monetary value of item refunds for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.
CumulativeItemStoreRefundTransactionCount QuantityTransactionCount The cumulative number of transaction refunds for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.
CumulativeItemStoreRefundUnitCount QuantityTransactionCount The cumulative number of item refunds for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.
CumulativeTransactionCount QuantityTransactionCount The cumulative number of transactions for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.
CumulatveItemReturnTransactionCount QuantityTransactionCount The cumulative number of item returns for the RETAIL STORE, recorded at the various merchandise hierarchy levels, for each REPORTING PERIOD.

Back to Top

MerchandiseStructureLevel

An aggregation level for rolling ITEM sales and units for reporting purposes and for mapping item-level activity into the retailer's merchandise structure defined as a set of MERCHANDISE HIERARCHY LEVELs

Tag

Type

Definition

Description DescriptionShort A brief text description of the merchandise structure.
MerchandiseStructureID Identity Unique identifier for a merchandise structure.
Name Name The business name for the merchandise structure.

Back to Top

MerchandiseStructureLevelSalesRestriction

A restriction that limits a particular level's eligibility for sale.
Back to Top

MerchandiseStructureLevelSize

A cross reference of SIZEs that are available for a specific MERCHANDISE STRUCTURE LEVEL, specifically the department level.
Back to Top

MerchandiseStructurePriceDerivationRuleEligibility

Defines an association between a MERCHANDISE STRUCTURE LEVEL and PRICE DERIVATION RULE and the conditions which govern the application of the associate rule to an item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense (in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
EffectiveDateTimestamp TimeStampEffective The time and date when the MERCHANDISE STRUCTURE DERIVATION RULE becomes effective.
ExpirationDateTimestamp TimeStampExpiration The time and date when the MERCHANDISE STRUCTURE DERIVATION RULE no longer applies.
IntervalAmount Money An interval monetary armount for which this price derivation rulle eligible.
IntervalQuantity Quantity An interval quantiy for which this price derivation rulle eligible.
LimitAmount Money The maximum monetary amount within a merchanidise structure level for which this price deriviation rule is eligible.
LimitQuantity Quantity The maximum number of items within a merchanidise structure level for which this price deriviation rule is eligible.
ThresholdAmount Money A monetary amount within a single merchandise structure level required to be purchased to trigger this price derivation rule.
ThresholdQuantity Quantity A quanity of items within a single merchandise structure level required to be purchased to trigger this price derivation rule.
ThresholdTypeCode Code4 A code for the type of threshold wich applies to a price derivation rule eligibility.

Back to Top

MiscellaneousFee

A fee paid by the CUSTOMER for a service, normally associated with the purchase of a STOCK ITEM. An example would be delivery charge, gift wrapping service, etc.

Tag

Type

Definition

CustomerPaysForDispositionFlag Code4 Flag that determines whether the customer is charged for this misc. fee or the store absorbs it as an expense.
Description DescriptionShort Describes this miscellaneous fee
MiscellaneousFeeTypeCode Code2 A code to denote the type of miscellaneous fee, eg delivery, gift wrapping, etc

Back to Top

MiscellaneousFeeLineItem

A line item component of a RETAIL TRANSACTION that records a fee added to the transaction net total and reflects a non-item income or reimbursable expense to the retailer.

Tag

Type

Definition

Amount Money The amount of the miscellaneous fee to be booked.

Back to Top

MissingVolumeEvent

An audit event recording the fact that the comparison of two STOCK METER READINGs has raised the possibility of one or more FUELLING TRANSACTIONs having been performed without being recorded by the system.

Tag

Type

Definition

DetectionReasonCode String A 2 character code denoting the reason the comparison was performed.
MissingVolume Number The value of the missing volume detected in the comparison

Back to Top

MixAndMatchPriceDerivationItem

Specifies matching items that may be used to trigger a MIX AND MATCH PRICE DERIVATION RULE. In situations like Buy item A and get items B, C or D at 50% off, items B, C and D would be the matching items. Item A would be the trigger item scanned in at the point of sale.

Tag

Type

Definition

ReductionMonetaryAmount Money The monetary amount of the markdown each time this rule is applied.
ReductionPercent Percent The percentage markdown each time this rule is applied.
ReductionPricePoint Money A reduction expressed as a price.
ReductionTypeCode Code4 A code that indicates the category of price reduction.

Back to Top

MixAndMatchPriceDerivationRule

A type of PRICE DERIVATION RULE that defines combinations of items and item counts that when purchased together result in a price revision (generally a reduction). A mix and match price derivation rule affects prices of items OTHER than those that triggered the eligibilit

Tag

Type

Definition

MixAndMatchLimitCount Quantity The maximum number of mix and matched items that may be purchased along with the item that triggered the price derivation rule. For example a break maker may be sold with an offer to acquire any 3 of 24 varieties of bread mix for half price. The 3 varieties represent the mix-and-match-limit-count.

Back to Top

MultiplePriceDerivationRuleEligibility


Back to Top

MultipleUnitThreshold

This defines a threshold associated with a MULTIPLE UNIT PRICE CHANGE. When the threshold-unit-count is reached in a retail transaction, this price derivation rule is triggered resulting in a new sell price. This price derivation rule is usually associated with price reductions for promotions.

Tag

Type

Definition

MonetaryValueAmount Money The monetary value of retail sale units of this item that earn the price reduction specified in this MULTIPLE UNIT THRESHOLD entity instance.
PriceReductionMonetaryAmount Money The monetary amount price reduction to be applied through this MULTIPLE UNIT THRESHOLD price derivation rule.
PriceReductionPercent Percent The percent of the base retail price reduction to be applied through this MULTIPLE UNIT THRESHOLD price derivation rule.
ThresholdLevelID Identity The identifier for a specific MULTIPLE UNIT THRESHOLD.
UnitCount Quantity The number of retail sale units of this item that earn the price reduction specified in this MULTIPLE UNIT THRESHOLD entity instance.

Back to Top

NonProfitEnterprise

An organization that has been designated as non-profit or not-for-profit for tax purposes.

Tag

Type

Definition

RegistrationNumber DescriptionShort A tax or other government identifier that is assigned to non-profit organization.

Back to Top

NonStandardAddress

An address that is not covered by address postal standards.

Tag

Type

Definition

AddressLine1Name Address A generic holder of non-standardized address infomration.
AddressLine2Name Address A generic holder of non-standardized address infomration.
CountryName Name The name of a country or territory.
PostalCode PostalCode A code assigned by the postal authority and used for mail delivery.
TerritoryName Name A state, provice, or other region within a country.
UnitName Name An appartment, suite, office or other location's ID.

Back to Top

NozzleFuelingTransactionHistory

The total number, volume and monetary value of all FuelingTransactions performed on a particular LogicalNozzle during a particular ReportingPeriod. Totals are separated by Prepay and Postpay FuelingTransactio

Tag

Type

Definition

PostPayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions performed at the LogicalNozzle during the ReportingPeriod
PostpayFuelingTransactionCount Quantity The number of FuellingTransactions performed at the LogicalNozzle during the ReportingPeriod
PostpayFuelingTransactionVolume Quantity The total volume of FuellingTransactions performed at the LogicalNozzle during the ReportingPeriod
PrepayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the ReportingPeriod
PrepayFuelingTransactionCount Quantity The count of fueling transactions prepaid at the logical nozzle during the reporting period.
PrepayFuelingTransactionVolume Quantity The total volume of fueling transactions prepaid at the logical nozzle during the reporting period.

Back to Top

NozzleHistory

The total number, volume and monetary value of all FuelingTransactions performed on a particular LogicalNozzle during a time period bounded by two consecutive ForecourtSettlementTransactions Totals are separated by Prepay and Postpay FuelingTransact

Tag

Type

Definition

PostpayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions performed at the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction
PostpayFuelingTransactionCount Quantity The number of PostpayFuelingTransactions performed on the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction
PostpayFuelingTransactionVolume Quantity The number of Postpay FuelingTransactions performed on the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction
PrepayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction
PrepayFuelingTransactionCount Quantity The number of PrePayFuelingTransactions performed on the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction
PrepayFuelingTransactionVolume Quantity The number of Prepay FuelingTransactions performed on the LogicalNozzle during the period of time covered by the ForecourtSettlementTransaction

Back to Top

OccasionRecommendation

A cross reference of items that are recommended to CUSTOMERs for inclusion in their GIFT REGISTRY, based on the type of occasion being celebrated or observed.
Back to Top

Operator

An employee or any other authorized individual who may enter transactions into the store's workstations. The OPERATOR is accountable for the tender collected and dispensed while assigned to a WORKSTATION.

Tag

Type

Definition

AccessPassword Password A security password entered by an operator and used to verify his/her identity when signing on to a WORKSTATION.
OperatorID Identity A unique, automatically assigned number used to identify a workstation OPERATOR.

Back to Top

OperatorGroup

EMPLOYEE GROUP assigns an EMPLOYEE to a specific work GROUP. There is no limitation as to the number of work GROUPs a given EMPLOYEE may be assigned to, nor to the limit of EMPLOYEEs assigned to a specific GROUP
Back to Top

OperatorHistory

A collection of monetary and operational totals used to track the activity volume of an operator during a reporting period.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount of container discounts collected by OPERATOR for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts actioned by OPERATOR for each REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary amount of negative gross sales recorded by OPERATOR for each REPORTING PERIOD. This total only includes returns made to the RETAIL STORE.
GrossPositiveTotalAmount Money The total monetary amount of positive gross sales recorded by OPERATOR for each REPORTING PERIOD. Positive gross sales exclude returns.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax recorded by OPERATOR for each REPORTING PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliations for an OPERATOR for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount MoneyShortCost The total monetary amount of layaway payments collected by OPERATOR for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by OPERATOR for each REPORTING PERIOD.
LockTime QuantityShortCountSeconds The time expressed in minutes when the WORKSTATION is locked even though the OPERATOR has signed on for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by OPERATOR for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts recorded by OPERATOR for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by OPERATOR for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by OPERATOR for each REPORTING PERIOD.
NoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded by OPERATOR for each REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by OPERATOR for each REPORTING PERIOD.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash disbursements by OPERATOR for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of post transaction voids by OPERATOR for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by OPERATOR for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds made by OPERATOR for each REPORTING PERIOD.
ResumedTotalAmount Money The total monetary amount of TRANSACTIONs resumed by OPERATOR for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns made by OPERATOR for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by OPERATOR for each REPORTING PERIOD.
SuspendedTotalAmount Money The total number of TRANSACTIONs suspended by OPERATOR for each REPORTING PERIOD.
SuspendedTransactionCount QuantityTransactionCount The total monetary amount of TRANSACTIONs suspended by OPERATOR for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount recorded by OPERATOR for each REPORTING PERIOD.
TaxTotalAmount Money The total tax amount recorded by OPERATOR for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary amount of tender loans by OPERATOR for each REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by OPERATOR for each REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by OPERATOR for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of line item employee discounts recorded by OPERATOR for each REPORTING PERIOD.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by operator where no sales are being recorded for each REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaways payments collected by OPERATOR for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by OPERATOR for each REPORTING PERIOD.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by the OPERATOR for each REPORTING PERIOD.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by OPERATOR for each REPORTING PERIOD.
TotalLineItemOpenDepartmentPercentage Percent The percentage of ITEMs recorded through an open department compared to the total ITEMs by OPERATOR for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides made by OPERATOR for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by OPERATOR for each REPORTING PERIOD.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by the OPERATOR for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids made by OPERATOR for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of item markdowns actioned by OPERATOR for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discounts actioned by OPERATOR for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fee item sales recorded by OPERATOR for each REPORTING PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account received by OPERATOR for each REPORTING PERIOD.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of item refunds actioned by OPERATOR for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of item returns received by OPERATOR for each REPORTING PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying ITEMs by OPERATOR for each REPORTING PERIOD.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales recorded by OPERATOR for each REPORTING PERIOD.
TotalSendCheckAmount Money The total monetary amount of send checks recorded by OPERATOR for each REPORTING PERIOD.
TotalSendCheckCount QuantityTransactionCount The total number of send checks recorded by OPERATOR for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of sign-on made by OPERATOR for each REPORTING PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of sign-offs made by OPERATOR for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by OPERATOR for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by OPERATOR for each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans recorded against the workstation OPERATOR for each REPORTING PERIOD.
TotalTenderOverAmount Money The total monetary amount of tender overages recorded against the workstation OPERATOR for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups recorded against the workstation OPERATOR for each REPORTING PERIOD.
TotalTenderUnderAmount Money The total monetary amount of tender shortages recorded by OPERATOR for each REPORTING PERIOD.
TotalTranactionVoidCount QuantityTransactionCount The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by OPERATOR for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items recorded by OPERATOR for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
WorkstationResumedTransactionCount QuantityTransactionCount The total number of resumed transactions recorded by OPERATOR for each REPORTING PERIOD.

Back to Top

OperatorResourceAccess

This entity defines the rules which permits an OPERATOR to gain access to a specific RESOURCE within the RETAIL STORE.

Tag

Type

Definition

ReadAccessLevelCode Code2AccessControl An indicator to signify that read access is granted to the referenced OPERATOR for the corresponding resource identified in this record. Read access limitation may be set by, for example, no access, group access, user access, etc.
WriteAccessLevelCode Code2AccessControl An indicator to signify that write access is granted to the referenced OPERATOR for the corresponding resource identified in this record. Write access limitation may be set by, for example, no access, group access, user access, etc.

Back to Top

OperatorTaxHistory

A collection of tax totals for a tax authority by operator for a reporting period.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total monetary amount of taxable sales recorded by OPERATOR for each REPORTING PERIOD.
TaxCollectedTotalAmount Money The total monetary amount of tax recorded by OPERATOR for each REPORTING PERIOD.
TaxExemptSaleTotalAmount Money The total monetary amount of tax exempt sales recorded by OPERATOR for each REPORTING PERIOD.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt sales recorded by OPERATOR for each REPORTING PERIOD.

Back to Top

OperatorTenderHistory

A collection of tender type accumulators by operator for a reporting period. This entity is used to support employee tender accountability.

Tag

Type

Definition

DepositTotalAmount Money The total monetary value of tender media deposited in the EXTERNAL DEPOSITORY by OPERATOR for each REPORTING PERIOD.
LoanMediaTotalAmount Money The total monetary amount of tender media units loaned by operator for each REPORTING PERIOD.
OverTotalAmount Money The total monetary value of tender overages recorded by OPERATOR for each REPORTING PERIOD.
PickupMediaTotalAmount Money The total monetary amount of tender media units picked up by operator for each REPORTING PERIOD.
ShortTotalAmount Money The total monetary value of tender shortages recorded for that OPERATOR for each REPORTING PERIOD.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The open balance of the number of tender media units for that OPERATOR for each REPORTING PERIOD.
TotalTenderDepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited in the EXTERNAL DEPOSITORY by OPERATOR for each REPORTING PERIOD.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender media units loaned by operator for each REPORTING PERIOD.
TotalTenderMediaCount QuantityTransactionCount The total number of tender media units counted by operator for each REPORTING PERIOD.
TotalTenderMediaOverCount QuantityTransactionCount The total tender overage recorded against an operator for each REPORTING PERIOD.
TotalTenderMediaShortCount QuantityTransactionCount The total monetary value of tender shortages recorded for that OPERATOR for each REPORTING PERIOD.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender media units picked up by operator for each REPORTING PERIOD.

Back to Top

OrderDocument

A type of INVENTORY CONTROL DOCUMENT that is a record of agreement made with a supplier that includes a detailed list of retail items, cost discount terms, method of shipping, delivery dates, delivery location and other pertinent terms and conditions governing the acquisition.

Tag

Type

Definition

BuyerID Identity The BUYER_ID specifies the corporate buyer responsible for the purchase of merchandise specified in the order document.
OrderEventTypeCode Code2 A code that characterizes an order based on the event causing its creation. Examples include orders generated on a regular basis, orders generated as part of a promotion and orders generated for a season.
OrderTypeCode Code2 A code to denote the type of purchase order, eg close out, consignment, etc. This code relates to the UCC Purchase Order Type Code, Data Element 92.

Back to Top

Organization

A company, association, institution, or other enterprise of interest to a retail store or retail enterprise.

Tag

Type

Definition

FederalTaxID DescriptionShort A tax or other number assigned by a federal government that is unique to all ORGANIZATIONs within that federal government's jurisdiction.
LegalStatusCode Code2Status A code that indicates the ORGANIZATION's legal or tax status. For example, this may be Commercial Corporation, Not-for-profit, Non-profit, Academic, Government, etc.
Name Name An ORGANIZATION's legal trade name.
StateTaxID DescriptionShort A tax or other number assigned by a state government that is unique to all ORGANIZATIONs within that state government's jurisdiction.
TaxID DescriptionShort A tax or other number assigned by a governing body that is unique to all ORGANIZATIONs within that governing body's jurisdiction.

Back to Top

OrganizationalAffiliation

A non-hierarchical affiliation of organizations.
Back to Top

OrganizationalStructure

The hierarchical reporting or ownership relationship within an organization
Back to Top

PackingSlip

A document that identifies the merchandise items a supplier claims to be shipping to the store against one or more purchase orders.

Tag

Type

Definition

PackingSlipID Identity the unique identifier for the packing slip, typically the reference number.
SupplierOrderFulfilledDate DateCalendar The date on which the order is fulfilled by the SUPPLIER.
SupplierOrderShipmentOutboundDate DateCalendar The date on which the fulfilled order is shipped from the SUPPLIER to the RETAIL STORE.

Back to Top

Party

An individual or firm that exchanges information and/or goods and services with the store.

Tag

Type

Definition

OrganizationTypeCode Code2 Describes the type of organization from the legal aspect, ie company which is either private, public, limited liability, etc.
PartyID Identity A unique, automatically assigned identity for a PARTY.
PartyTypeCode Code2 Defines the type of party a store is dealing with (e.g. a supplier, carrier, customer, etc.)

Back to Top

PartyAddress

A specific party's address.

Tag

Type

Definition

EffectiveDate DateCalendar The date that a PARTY's address is valid for that PARTY.
ExpirationDate DateCalendar The date that a PARTY's address is no longer valid for that PARTY.
StatusCode Code2Status An indicator of the address's currency. For instance, this address may be valid, invalid, temporary, etc.

Back to Top

PartyRole

A type of relationship that a person or organization has with the enterprise.

Tag

Type

Definition

EffectiveDate DateCalendar The date that this role is valid.
ExpirationDate DateCalendar The date that this role is no longer valid.

Back to Top

PartyRoleStatus

The current state of a PARTY ROLE.
Back to Top

PartyRoleType

A categorization of PARTY ROLEs.

Tag

Type

Definition

Description DescriptionNarrative A narrative that describes this group of party roles.
Name Name A name or label for a group of party roles.
PartyRoleTypeCode Code6 A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.

Back to Top

PartyRoleTypeState

This dependent entity defines ALL valid states that a specific PARTY ROLE TYPE may assume.

Tag

Type

Definition

Description DescriptionNarrative A narrative that describes the status of a PARTY ROLE.
Name Name A name or label for a status of a PARTY ROLE>
PartyRoleStateCode Code6 A unique code that will identify a group of party roles.

Back to Top

PaymentOnAccountLineItem

A detail line item recording a payment for a product or service purchased on an installment account basis. These line items are different from those charged to a house account. In this case the account normally has to be completely paid off within a specific time period. The account exists only until the installment sale is completely extinguished.

Tag

Type

Definition

PaymentAgainstReceivableAccountCode Code4 A code to denote the type of payment on account, eg layaway, house, etc.
PaymentAgainstReceivableAmount Money The monetary payment on account received from the CUSTOMER.
PaymentAgainstReceivableCustomerAccountID Identity The unique identifier for the customer account .
PaymentReceivableFlag Flag A flag to denote that payment is outstanding on the account.

Back to Top

PeriodCloseTransaction

A transaction that declares the end of an accounting period. The smallest accounting period fiscal day, which is aggregated by the fiscal calendar structure.
Back to Top

PermanentPriceChange

A price change that modifies the inventory value for the ITEMs included in the EVENT. This price change normally only has a start date.

Tag

Type

Definition

SaleUnitAmount MoneyShortRetail The amount (either monetary or percent) to be used to change or replace the current selling price for a sale unit of the item.
SaleUnitAmountTypeCode Code2 A code to define how the temporary-price-change-sale-unit-amount is to be interpreted. Valid values include: PCT percent of current retail price to be added to or subtracted from the current retail to arrive at a selling price; AMT, flat monetary amount to be added to or subtracted from the current retail to arrive at a selling price; and AMTREPL, a retail sale unit price amount that is to replace the current selling pr

Back to Top

PermanentPriceChangeItem

This association between a PERMANENT PRICE CHANGE and ITEM establishes the application of a new permanent price (or percentage or monetary increase or decrease) for an item. A PERMANENT PRICE CHANGE is posted to an ITEM and is not contingent on conditions or events that occur at the point of sale.
Back to Top

Person

A individual of interest to the retail store or retail enterprise.

Tag

Type

Definition

BirthDate DateCalendar A person's date of birth.
FirstName Name A person's first or given name.
GenderType Code2 A code for specifying a person's gender.
LastName Name A person's family name.
MiddleInitial NameMiddleInitial The first letter of a person's middle name.
Salutation Name The courtesy title belonging to a person. For instance, Mr. Ms., Miss, Dr. etc.

Back to Top

PersonOrgAffiliationType

A categorization of relationships between a PERSON and an ORGANIZATION.

Tag

Type

Definition

Description DescriptionNarrative A narrative for a group of affiliations of people and organizations.
PersonOrganizationAffilationTypeName String A name or label for a group of affiliations of people and organizations. For instance, this might be 'employment'.

Back to Top

PersonOrganizationAffiliation

A relationship between a person and an organization that is of interest to the retailer.

Tag

Type

Definition

Effective Date DateCalendar The start date of a PERSON's affiliation with an organization.

Back to Top

PhysicalCountDocument

The document on which the actual ITEM counts are recorded on the day of the Physical Inventory. This is raw/ unedited data captured during the Inventory.

Tag

Type

Definition

PhysicalCountDocumentID Identity The identifier for the physical count document on which the actual item counts are recorded.

Back to Top

PhysicalCountLineItem

The line detail which records the number of units counted during the Physical Inventory. This is raw/ unedited data captured and will compared to the book stock to determine the actual unit and financial discrepancy for that ITEM.

Tag

Type

Definition

PhysicalItemCountLineNumber Identity The physical count line item.

Back to Top

PhysicalInventoryEvent

An EVENT at which time the physical inventory occurs.
Back to Top

PhysicalLocation

A location of interest due to delivery or other service provision.

Tag

Type

Definition

PhysicalLocationCode Code6 A code that identifies a specific physical location.

Back to Top

PhysicalLocationAddress

A physical location's use of an address.
Back to Top

PhysicalNozzle

A physical nozzle which dispenses fuel during a FUELLING TRANSACTION. The physical nozzle does not measure any fuel dispensed, but can be addressed, and enabled or disabled during a FUELLING TRANSACTION

Tag

Type

Definition

PhysicalNozzleID Identity A unique identifier for a physical nozzle.

Back to Top

POSDepartment

A grouping of items with similar point of sale control and processing attributes. This entity type may also be used to control sales that are not properly identified at the item-level. As modeled this entity is an enterprise level entity that is cross referenced to a store via the RETAIL STORE POS DEPARTMENT associative entit

Tag

Type

Definition

Name Name The title or label given to a point-of-sale department.
POSDepartmentID Identity The point-of-sale department number.

Back to Top

POSDepartmentHistory

A collection of monetary and operational totals used to track the activity volume for a POS DEPARTMENT during a reporting period.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount of container deposits by POS department for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by POS department for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids by POS department for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of markdowns by POS department for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by POS department for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees by POS department for each REPORTING PERIOD.
NetItemSalesTotalAmount Money The total monetary amount of net item sales by POS department for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of items cancelled by a post transaction void by POS department for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of redeemed container deposits by POS department for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds by POS department for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns by POS department for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of lines purchased in part or in full by store coupons by POS department for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total monetary amount of tax exempt item sales by POS department for each REPORTING PERIOD.
TaxTotalAmount Money The total monetary amount of tax item sales by POS department for each REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits by POS department for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee discounted items by POS department for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of keyed item sales by POS department for each REPORTING PERIOD.
TotalLineItemKeyedPercentage Percent The number of items keyed as a percentage of total items sold by POS department for each REPORTING PERIOD.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The total number of items sold by a POS department for each REPORTING PERIOD.
TotalLineItemOpenDepartmentPercentage Percent The number of items sold through a department key as a percentage of total items sold by POS department for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by POS department for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of scanned item sales by POS department for each REPORTING PERIOD.
TotalLineItemScannedPercentage Percent The number of items scanned as a percentage of total items sold by POS department for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids by POS department for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of markdowns by POS department for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discounted items by POS department for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees by POS department for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of items cancelled by a post transaction void by POS department for each REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount he total number of redeemed container deposits by POS department for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by POS department for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by POS department for each REPORTING PERIOD.
TotalSaleLineItemCount QuantityTransactionCount The total number of item sales by POS department for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount he total number of lines purchased in part or in full by store coupons by POS department for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt item sales by POS department for each REPORTING PERIOD.
TotalTranactionVoidCount QuantityTransactionCount The total number of items cancelled by transaction void by POS department for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed item sales by POS department for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary amount of items cancelled by transaction void by POS department for each REPORTING PERIOD.

Back to Top

POSDepartmentSalesTaxHistory

A collection of tax totals for a tax authority for a POS DEPARTMENT for a reporting period.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total amount of taxable sales by POS department for each REPORTING PERIOD.
TaxCollectedTotalAmount Money The total amount of tax collected by POS department for each REPORTING PERIOD.
TaxExemptSaleTotalAmount Money The total amount of tax exempt sales by POS department for each REPORTING PERIOD.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt sales by POS department for each REPORTING PERIOD.

Back to Top

POSIdentity

Identifies the point of sale scan code or keyed identifying number used to refer to a specific ITEM by reference to its retail-item-id. The POS IDENTITY is used to lookup price, description and other information required at the time an item's sale or return is recorded.

Tag

Type

Definition

AllowCouponMultiplyFlag Flag A flag that enables or disables multiple coupon promotions. Used to enable or disable double or triple coupon promotions.
AllowFoodStampFlag Flag A flag to indicate whether food stamps can be tendered for this ITEM.
CouponEndOfOfferDate ProductCodeExpiry The end of offer date encoded in the supplementary part of the coupon code. This code provides the month and year ( eg 0697 denotes the expiration date for that particular coupon as June 30, 1997)
CouponRestrictedFlag Flag A flag to indicate whether a coupon can be redeemed for this ITEM.
CouponValueCode ProductCodeValue A two digit value code that designates the redemption value of a coupon in monetary units. The code follows the family code on the UPC/EAN coupon code. The code in some instances is a direct representation of the face value (eg code number 10 represents a 10 cent coupon value) and some which are not (eg code number 83 represents $2.25coupon value).
CurrentSaleUnitPOSRetailPriceAmount MoneyShortRetail The current retail price per sale unit of the item. This monetary amount is used as the basis for deriving retail price at the point of sale.
CustomerAccountDiscountAllowedFlag Flag A flag that enables or disables price derivation rule applicability to a particular customer account for the ITEM.
CustomerAffiliationDiscountAllowedFlag Flag A flag that enables or disables price derivation rule applicability to a customer group affiliation for the ITEM.
Description DescriptionShort The abbreviated text description of an item printed on the customer receipt.
ElectronicCouponFlag Flag A flag to denote whether an electronic coupon is available for this ITEM. The value is automatically applied to the purchase, no media is exchanged.
EmployeeDiscountAllowedFlag Flag A flag that enables or disables price derivation rule applicability to a particular employee for the ITEM.
FrequentShopperPointsCount Quantity The number of frequent buyer points awarded for purchase of this ITEM.
FrequentShopperPointsEligibleFlag Flag A flag to denote whether this ITEM is eligible for frequent shopper benefits as part of a customer loyalty scheme
GiveawayFlag Flag A flag to denote whether this ITEM can be given away free as part of a promotion, provided the CUSTOMER fully meets the conditions of that promotion.
MarketBasketDiscountAllowedFlag Flag A flag that enables or disables price derivation rule applicability to a market basket for the ITEM.
MaximumSaleUnitCount QuantityShortCount Defines the maximum number of retail sale units that may be purchased in a single sales transaction. Typically this is used for special promotions or \"rationed\" merchandise (e.g. Nintendo 64 in Christmas 1995).
MinimumSaleUnitCount QuantityShortCount For items, the minimum number of selling units (e.g. square yards, linear feet, pounds, liters, etc.) that must be purchased for a specific item. This selling rule qualifies the item at point of sale.
POSItemID Identity POS item id is a token identifier to facilitate price lookup and does not contain any descriptive information
PriceEntryRequiredFlag Flag A flag to denote that the RETAIL PRICE has to manually entered when this ITEM is purchased by a CUSTOMER.
ProhibitRepeatKeyFlag Flag A flag to prohibit the use of the repeat key when selling this ITEM. This flag forces the operator to scan or separately enter each instance of a ITEM rather than use a repeat key to ensure inventory integrity and avoid arithmetic errors.
ProhibitReturnFlag Flag A flag to indicate whether this ITEM can be returned or not, unless faulty. This normally applies to freezer or chilled products.
QuantityKeyProhibitFlag Flag A flag to denote that the quantity key cannot be used with the sale of this ITEM.
VisualVerifyPriceFlag Flag A flag to denote whether the operator must verify the price in the ITEM with the price derived from the price look up table.
WeightEntryRequiredFlag Flag A flag to indicate that the weight of this ITEM has to be entered into the system to derive the selling price.
WICFlag Flag A flag to indicate it this ITEM is allowed in WIC transaction.

Back to Top

Position

A job or role that employees fill.

Tag

Type

Definition

AccessLevelCode Code6 A code that indicates what access privileges are granted to a position.
CommissionFlag Flag An indicatory of whether or not this position is eligible for commission.
Description DescriptionNarrative A narrative that describes the POSTION or job.
PayrollTypeCode Code6 A code indicating how this position is paid.
PositionID Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR function.
ShareFlag Flag An indicator for whether or not this position is eligible for job sharing.
Title Name A job title associated with a POSITION.

Back to Top

PositionAllocation

The allotment of POSITIONs that have been approved for a specific RETAIL STORE.

Tag

Type

Definition

EffectiveDate DateCalendar The starting date for an allotment of positions to a retail store.
ExpirationDate DateCalendar The ending date for an allotment of positions to a retail store.
LocationID Identity A unique identifier for a specific LOCATION within the RETAIL STORE.
RetailStoreID Identity A unique identifier for a specific RETAIL STORE within the organization. Typically, STOREs are given a unique reference number.

Back to Top

PositionHierarchy

The reporting structure of POSTIONs.

Tag

Type

Definition

EffectiveDate DateCalendar The valid start date for a position's reporting structure
ExpirationDate DateCalendar The date that a position's reporting structure is no longer valid.

Back to Top

PositionWorkSchedule

A shift schedule for a position

Tag

Type

Definition

FinishTime Time The ending time for this schedule.
Hours Number Total hours for this schedule.
PositionWorkScheduleWeekDay Name The name of the day that this schedule is for.
StartTime Time The beginning time for this schedule.

Back to Top

POSLockTransaction

A non sales POS transaction which secures the WORKSTATION while an EMPLOYEE is absent from the WORKSTATION. The WORKSTATION cannot be operated unless the EMPLOYEE enters the relevant ACCESS CODE. It is different from SIGN OFF in that the WORKSTATION is not disassociated from the EMPLOYEE.
Back to Top

POSNoSaleTransaction

A non salesTRANSACTION that conducts no business, but causes the till drawer to open. The WORKSTATION accumulates the number of times by EMPLOYEE this facility is used
Back to Top

PostVoidTransaction

A non sales transaction that cancels a prior SALES/ RETURN TRANSACTION. The workstation will normally record each individual instance of this TRANSACTION by EMPLOYEE.
Back to Top

POSUnlockTransaction

A type of CONTROL TRANSACTION that changes the state of a WORKSTATION from an inaccessible (locked) state to an accessible (unlocked) state for entering transactions.
Back to Top

PreferenceType

A grouping of preferences. For instance, clothing style -related preferences may be grouped together under a type.

Tag

Type

Definition

Description DescriptionNarrative A narrative that describes the group of preferences.
PreferenceTypeCode Code2 A unique code for a group of preferences. For instance, all the types of material (clothing) preferences may be grouped together.

Back to Top

PrepayHistory

The total number and monetary value of all Prepay and PrepayRefund FuelSaleLineItems that were sold to a FuelingPoint during a ReportingPeriod.

Tag

Type

Definition

PrepayFuelingRefundAmount Money The total monetary value of prepay refund FuellingTransactions performed at the FuellingPoint during the ReportingPeriod
PrepayFuelingRefundCount Quantity The number of prepay refund FuellingTransactions performed at the FuellingPoint during the ReportingPeriod
PrepayFuelingTransactionCount Quantity The number of prepay FuellingTransactions performed at the FuellingPoint during the ReportingPeriod
PrepayFuelingTransactionTotalAmount Money The total monetary amount of prepay FuellingTransactions performed at the FuellingPoint during the ReportingPeriod

Back to Top

PriceDerivationRule

The specification of a method to be used to transform the current sell unit retail amount to the retail price actually paid by a customer at the point of sale.

Tag

Type

Definition

Description DescriptionShort Business description for this price derivation rule.
EffectiveDate DateCalendar The date this price derivation rule may be applied to a transaction.
ExpirationDate DateCalendar The date this derivation rule may no longer be applied to a transaction.
Name Name Price derivation rule name
PriceDerivationRuleID Identity A identifier for a specific price derivation rule.
StatusCode Code2Status Defines the current status for the price derivation rule. Examples of valid codes include: Pending, Active, Canceled, Inactive
TransactionControlBreakCode Code2 This is a special code that determines when, during the entry of a sale transaction, this rule will be applied. For example a price change rule may be applied on a line item by line item basis (which is DETAIL TIME), a price change rule may be triggered after a transaction is totaled -- but before tax and tender entry (i.e. MERCHANDISE SUBTOTAL TIME).
TypeCode Code2 Defines the type of price derivation rule.

Back to Top

PriceDerivationRuleEligibility

Tag

Type

Definition

PriceDerivationRuleEligibilityID Identity A unique identifier for a Price Derivation Rule Eligibility.
TypeCode Code4 A code that indicates the type of Price Derivation Rule Eligibility.

Back to Top

PriceDerivationRuleMaintenance

A type of ITEM PRICE MAINTENANCE that results in the creation, update or deletion of a PRICE DERIVATION RULE and its associated entities.

Tag

Type

Definition

MaintenanceFunctionCode Code4 Defines the maintenance function to be performed. Valid values include creation, update or deletion of a price derivation rule.

Back to Top

PriceLevel

A collection of price levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are \"Cash Price\

Tag

Type

Definition

Name <unknown> A human readable name for the price level
PriceLevelID Name A unique identifier for the price level

Back to Top

PriceLine

A defined range of retail prices delineated by a low retail and a high retail price. For example price line A may be bounded by a low of $.01 to a high of $.99 (the \"Dollar Line\"), price line B may be bounded by a low of $1.00 and a high of $4.99 and so on. Price lines allow the retail store to group items around retail price ranges for price management purposes.

Tag

Type

Definition

HighAmount Money The high end of a price range that bounds a price line.
LowAmount Money The low end of a price range that bounds a price line.
PriceLineID Identity A unique identifier for this price point.

Back to Top

PriceLinePriceDerivationRuleEligibility

Defines an association between a MERCHANDISE STRUCTURE PRICE DERIVATION RULE and a PRICE LINE for the purposes of triggering a PRICE DERIVATION RULE.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense ( in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or the increase calculated as a result of the application of the PRICE DERIVATION RULE will be handled when more than one rule is applied within a sales transaction.
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied.
ExpirationDateTimestamp TimeStampExpiration The time and date this rule is no longer valid or applicable.

Back to Top

Promotion

A collection of eligibilities and price derivation rules, during a specific time group.

Tag

Type

Definition

ConcurrenceCode Code2
CustomerDisplayName Name Text to be displayed to the customer.
EffectiveDate Datetime The first date and time that this promotion is effective.
ExpiryDate Datetime The last date and time that this promotion is effective.
MultipleEligibilityCompbinationCode Code2 An code that indicates how multiple eligibilities apply.
OperatorDisplayName Name Text to be displayed to the Operator.
PromtionID Identity The unique identifier for a promotion.
ReceiptPrinterName Name The name of the receipt printer.
UpSellTypeCode Code2 A code that indicates how up selling is to be performed.

Back to Top

PromotionalLineItem

A detail line item of TRANSACTION that records the crediting or debiting of a CUSTOMER PROMOTIONAL ACCOUNT with points/dollars/miles.
Back to Top

PromotionalProduct

Something that is given for free or at a discount. This can be an Item, a Gift Certificate, or any other member of a specific Merchandise Structure Level.

Tag

Type

Definition

PromotionalProductID Identity A unique identifier for a Promotional Product.
TypeCode Code2 A cod that indicates the type of Promotional Product.

Back to Top

Prospect

An individual, collection of individuals, company, or public institution that does not currently purchase merchandise or services from the retailer, but who may in the future. A prospect has no recorded relationship with the retaile
Back to Top

PrototypePriceDerivationRuleEligibility

This is a template entity used for modelling purposes only.

Tag

Type

Definition

RecurrenceFlag Flag Determines whether the price derivation rule is to be applied one time based on attributed effective and ending date timestamps or on a recurring basis as specified in the attribute recurrenc entity type.

Back to Top

PrototypePriceDerivationRuleEligibilityRecurrence

Specifies rules for the recurrence of the price derivation rule eligibility.

Tag

Type

Definition

Name Name A name or label given to this prototype derivation rule recurrence.
PriceDerivationRuleEligibilityRecurrenceEndTime Time The time at which the price derivation rule is no longer valid.
PriceDerivationRuleEligibilityRecurrenceStartTime Time The time for which the price derivation rule is valid.
PriceDerivationRuleEligibilityRecurrenceWeekDay DateFiscalDay The day of the week for which the price derivation rule is valid.

Back to Top

ReceivingDocument

A type of INVENTORY CONTROL DOCUMENT that is used by a store to record its acceptance of items shipped to it by a supplier against an ORDER and the SUPPLIER's packing slip.
Back to Top

RegisteredItemClass

The registration of a desired class or group of items at a level above a SKU.

Tag

Type

Definition

Description DescriptionNarrative A description of a class or group of items that have been added to a gift registry for a customer.

Back to Top

RelatedItemAssociation

An association between two items that are generally sold together. For each association between related items, transaction and sales summaries will be calculated to analyze how frequently they are purchased together in a sale and how frequently they are purchased separately.

Tag

Type

Definition

Name Name The name to denote the type of association between the two RELATED ITEMs.

Back to Top

RelatedItemAssociationSalesSummary

A collection of accumulators for an association between two items that are generally sold together. For each association between related items, transaction and sales summaries will be calculated to analyze how frequently they are purchased together in a sale and how frequently they are purchased separately.

Tag

Type

Definition

RelatedItemSoldSeparatelyTransactionCount QuantityTransactionCount Count of transactions in which the associated item is sold without the item.
SoldSeparatelyTransactionCount QuantityTransactionCount Count of transactions in which the item is sold without the associated item.
SoldTogetherTransactionCount QuantityTransactionCount A count of the number of transactions in which the items in the item association were sold together.
TotalSalesTransactionCount QuantityTransactionCount Total sale transaction count for the same period as the item association accumulators - used to calculate ratios and percentages.

Back to Top

RentalObject

Describes the type of asset being rented in a rental contract with a customer.

Tag

Type

Definition

Name Name The name of the RENTAL OBJECT. For example in the case of video rental this could refer to the film title.
RentalObjectID Identity The reference which uniquely identifies the RENTAL OBJECT.
TypeCode Code2 The type of OBJECT being offered for rental.

Back to Top

RentalService

A type of SERVICE ITEM that involves loaning an asset (i.e. a video taped movie, lawn mower, rug cleaner, etc.) to a customer for a contractually specified period of time for which the customer pays a predefined fee.

Tag

Type

Definition

DepositAmount Money A deposit related to the value of the RENTAL OBJECT which is paid by the CUSTOMER and is refundable if the ITEM is returned in the same condition.
DepositPercent Percent The percentage of the value of the RENTAL OBJECT which is charged as a refundable deposit to the CUSTOMER. \
PenaltyAmount Money The penalty amount which is imposed by the RETAILER if the CUSTOMER fails to meet the rental terms.
PenaltyPercent Percent The percentage penalty which is imposed if the terms of the rental are abused by the CUSTOMER, eg if the rental item is delivered late the penalty is 10% of the rental fee for each date late.
PeriodCount QuantityDayCount The number of rental periods.
PeriodTypeCode Code2 A code to denote the rental period, 1 day, 3 days, 1 week, etc.
PerPeriodAmount Money The monetary charge for each rental period.
TermsID Identity A specific reference to the rental terms governing the rental of RENTAL OBJECT.

Back to Top

RentalUnit

The specific instance of a RENTAL OBJECT rented to a customer in a transaction.

Tag

Type

Definition

NumberOfTimesRentedCount QuantityTransactionCount A count of the number of times a specific OBJECT has been rented or hired out.
RentalUnitID Identity A reference for a particular copy or product. For example this would refer to the second copy of a video title.

Back to Top

ReportingPeriod

A time interval bounded by a starting and ending calendar date, used to divide the retailer's fiscal year into periods

Tag

Type

Definition

Name Name The business name for the reporting period.
ReportingPeriodID Identity The identifier for a particular REPORTING PERIOD.
ReportingPeriodTypeCode Code2 A code to denote a specific REPORTING PERIOD.

Back to Top

RequestForDebitCreditDocument

A type of INVENTORY CONTROL DOCUMENT initiated by the store advising the supplier of a discrepancy in: the number of items delivered versus the number indicated in a packing slip and/or - the confirmed ORDER price versus the invoiced price. This document requests an adjustment to the store's account.

Tag

Type

Definition

AdjudicationCode Code4 Adjudication to the request for credit or debit.
ApprovalDocumentID Identity The serial number of the document approving the request for debit or credit.
ReasonCode Code2 Reason code for debit or credit request. This code refers to the UCC code, Adjustment Reason Code, data element 426.
RequestedByEmployeeID Identity The EMPLOYEE requesting the debit or credit
TypeCode Code2 A code to denote whether the request is for a debit or credit. This code refers to the UCC code, Credit/Debit Flag Code, data element 478.

Back to Top

Resource

RESOURCE entity contains all identifiable applications, functions, screens, and fields available for user and GROUP access

Tag

Type

Definition

Description DescriptionShort A textual description of the application RESOURCE. Examples include descriptions of application invocation functions, screens and fields.
ResourceID Identity A code to uniquely identify a given application or application component.

Back to Top

RetailPriceModifier

A line item modifier that reflects a modification of the retail selling price. It is provided by PLU through the application of a predefined price change rule that depends on parameters provided during the sale transaction. Examples of the kinds of par

Tag

Type

Definition

Amount Money The flat amount to be applied to the unit retail to arrive at the modified selling price.
DerivationRuleID Identity Identifies the rule fired off to create and apply this retail price modifier. Note that this attribute may be replaced by a foreign key reference as the retail price derivation rules view is further developed. The intent here is to provide an audit trail that shows HOW a retail selling price is derived from the look up price read from the ITEM UNIT RETAIL AND COST entity.
Percent Percent The percent of the look up retail price to be applied to the unit retail to arrive at the modified selling price.
ReasonCode Code2 A code that describes why the price modifier is applied to the line item.
StockLedgerAccountingDispositionCode Code4 A code that determines how the price change reflected in this modifier is to be treated for stock ledger accounting purposes. This code allows price change modifiers to be treated as discounts (expenses below the gross margin line) OR as markdowns (treated as changes to the inventory value which alter the stock ledger's cumulative markon for the item).

Back to Top

RetailStore

An organization that sells merchandise and services through a physical location, catalog, web page or other presentation venue which also provides a mechanism for settling the sale transaction. Within the ARTS Data Model, the RETAIL STORE defines the business area domain to be supported by the data model.

Tag

Type

Definition

ClosingDate DateCalendar The closing date for the RETAIL STORE
OpenDate DateCalendar The opening date for the RETAIL STORE
PriceZoneCode Code4 A code to signify the pricing zone to which this particular RETAIL STORE belongs.
RetailStoreID Identity A unique identifier for a specific RETAIL STORE within the organization. Typically, STOREs are given a unique reference number.
SellingAreaSquareFeetCount Quantity The number of square feet of the selling floor. in a large STORE this is further split by the sales floor and by the merchandise departments.
SquareFeetCount Quantity The number of square feet in the RETAIL STORE. This is usually split by the non-sales and sales areas.

Back to Top

RetailStoreClient

A CUSTOMER who has a closer relationship to a retail store or employee.

Tag

Type

Definition

ClienteleID Identity An alternate ID assigned to a clienteling customer.

Back to Top

RetailStoreItem

A specific ITEM carried by a RETAIL STORE.

Tag

Type

Definition

CompareAtSaleUnitRetailPriceAmount MoneyShortRetail Provides the monetary saving that can be gained by the purchase of this ITEM at this time from this RETAIL STORE. Used as a promotional tool, this saving (normally between the normal selling retail price and the price shown at the point of sale) is usually printed on the shelf label and the customer receipt to reinforce the marketing strategy of this retailer.
CurrentSaleUnitRetailPriceAmount MoneyShortRetail The current retail price per sale unit of the item. This monetary amount is used as the basis for deriving retail price at the point of sale.
CurrentSaleUnitRetailPriceEffectiveDate DateCalendar The date on which the item-current-sale-retail-price-amount becomes effective and is used as the basis for deriving the retail price used at the point of sale.
CurrentSaleUnitRetailPriceExpirationDate DateCalendar The date the item-current-sale-unit-retail-price-amount expires and is no longer valid as the basis for deriving the point of sale price.
CurrentSaleUnitRetailPricePointAllowedFlag Flag This flag determines whether thisITEM may or may not have an associted price point.
CurrentSaleUnitRetailPriceTypeCode Code2 Defines the type of retail price represented in the item-current-sale-unit-retail-price-amount. Examples include marked down merchandise (permanent markdown price), promotional markdown (temporarily marked down and owned at low.
ManufacturerSaleUnitRecommendedRetailPriceAmount MoneyShortRetail The suggested sale unit retail price provided by the item's manufacturer.
ManufacturerSaleUnitRecommendedRetailPriceEffectiveDate DateCalendar The date the manufacturer's suggested retail price becomes effective.
PermanentRetailPriceEffectiveDate DateCalendar The date when the permanent retail price becomes effective. This will impact the stock ledger valuation (retail method).
PermanentRetailPricePermanentMarkdownCount QuantityTransactionCount The number of permanent markdowns taken against this item.
PermanentSaleUnitRetailPriceAmount MoneyShortRetail The sale unit monetary value of the item which is the original retail minus permanent markdowns taken against this item.
PermanentSaleUnitRetailPriceOriginalMarkdownFlag Flag This flag indicates whether the permanent sale unit retail price amount is the original retail value or the value after one or more permanent markdowns.
SellingStatusCode Code2Status Defines the selling status of the item. Examples include active, discontinued, seasonal, to be discontinued, held for future release, etc.
SellingStatusCodeEffectiveDate DateCalendar The date the current item selling status code became effective.
StatusCode Code2Status This code defines the current state of an item within the retail store. An item's state limits what actions may be taken on an item in terms of ordering, receiving, selling, returns, transfers, counting and so on. Sample statuses include active, inactive, discontinued, pending, etc.
UpdateStockOnHandFlag Flag A flag that determines whether the POS sale or return of an item will be posted to the stock ledger for each transaction so that a perpetual inventory for that item can be maintained. For SERVICE ITEMs the flag will be set to .FALSE. For most merchandise carried on the stock ledger the flag will be set to .TRUE. For consignment items, the supplier may assume responsibility for maintaining a perpetual inventory and the store may set the flag to .FALSE.

Back to Top

RetailStoreLocationEvent

An EVENT that is scheduled for a specific LOCATION (or LOCATIONs) within the RETAIL STORE.
Back to Top

RetailStorePOSDepartment

An in-store department that is relevant to a point of sale transaction
Back to Top

RetailTransaction

A type of TRANSATION that records the business conducted between the RETAIL STORE and another party involving the exchange in ownership and/or accountability for merchandise and/or tender or involving the exchange of tender for services

Tag

Type

Definition

IdleElapsedTime QuantityShortCountSeconds The total time taken that a particular WORKSTATION or operator is idle, ie the time in which the operator was not performing any TRANSACTIONs on the WORKSTATION.
KeyDepartmentCount QuantityTransactionCount The total number of ITEMs which are keyed by department at the point of sale.
KeyDepartmentPercent Percent The total number of individual ITEMs which are keyed by department at the point of sale, as a percentage of the total data capture time.
LineItemsKeyedCount QuantityTransactionCount the total number of ITEMs which are keyed at the point of sale in comparison to scanned.
LineItemsKeyedPercent Percent The total number of individual ITEMs which are keyed at the point of sale, as a percentage of the total data capture time.
LineItemsScannedCount QuantityTransactionCount The total number of individual ITEMs which are scanned at the point of sale, in comparison to those keyed.
LineItemsScannedPercent Percent The total number of individual ITEMs which are scanned at the point of sale, as a percentage of the total data capture time.
LockElapsedTime QuantityShortCountSeconds The total time the workstation is in lock mode, ie securement of the WORKSTATION to prevent misuse by another party.
RingElapsedTime QuantityShortCountSeconds The total time taken spent recording all the RETAIL TRANSACTION.
TenderElapsedTime QuantityShortCountSeconds The total time taken to receive all the tender and complete the RETAIL TRANSACTION.

Back to Top

RetailTransactionLineItem

A detail line item of TRANSATION that records the business conducted between the retail store and another party involving the exchange in ownership and/or accountability for merchandise and/or tender or involving the exchange of tender for services

Tag

Type

Definition

BeginDateTimestamp TimeStampEffective The start time of the RETAIL TRANSACTION line item.
EndDateTimestamp TimeStampExpiration The end time of the RETAIL TRANSACTION line item.
RetailTransactionLineItemSequenceNumber LineNumber The sequence number of line item within a TRANSACTION.
TypeCode Code2 A code to denote the type of retail transaction line item, such as sale, employee, miscellaneous fee, etc.
VoidFlag Flag Flag that determines whether this line item has been voided/reversed by another line item in the transaction.

Back to Top

RetailTransactionLineItemOverride

A supervisory authorization for overriding a transaction parameter such as price or quantity limits.

Tag

Type

Definition

ReasonDescription DescriptionShort Descriptive narrative about the reason a transaction line item is being overridden.
Timestamp TimeStampAudit The date and time that a transaction line item is being overridden.

Back to Top

ReturnAgent

A third party to which DEPOSIT ITEMs are sent for recycling or refurbishment.

Tag

Type

Definition

Name Name The name of the company to whom returns on which a deposit was paid are returned.
ReturnAgentID Identity The company to whom the returns for ITEMs, such as empty bottles, are made.

Back to Top

ReturnAuthorizationRequest

A type of INVENTORY CONTROL DOCUMENT that makes a request to a supplier to grant permission to return merchandise that is received and found to be unsuitable for sale or other use at the store.

Tag

Type

Definition

AdjudicationCode Code4 The code to denote authorization by the receiving agent.
GrantedEmployeeID Identity The individual who approves the AUTHORIZATION REQUEST.
ReasonCode Code2 The reason code for the RETURN AUTHORIZATION REQUEST, eg excess stock, faulty merchandise, etc. This code refers to the UCC code, Return Request Reason Code, data element 1293.
RequestedByEmployeeID Identity The individual who originates the AUTHORIZATION REQUEST.
ReturnAuthorizationDocumentID Identity The reference number of the authorization document.
TypeCode Code2 The code to indicate the nature of the request, eg return to vendor, transfer to another store, etc.

Back to Top

ReturnDocument

A type of INVENTORY CONTROL DOCUMENT that lists the merchandise items to be returned by the store to the supplier as a result of: - Errors in delivery against the store's purchase order; substitutions in shipment; late delivery; defective materials, workmanship or fit; or other breaches of contract
Back to Top

SafeTransferTransaction

A type of FINANCIAL ACCOUNTING TRANSACTION that records the movement of tender from one TENDER REPOSITORY to another.
Back to Top

SalariedEmployee

An employee whose compensation package is based on a flat dollar amount.
Back to Top

SaleReturnLineItem

A line item component of a RETAIL TRANSACTION that records the exchange in ownership of a merchandise item (i.e. a sale or return) or the sale or refund related to a service.

Tag

Type

Definition

ExtendedAmount Money The product or multiplying sale-return-line-item-quantity by the retail selling unit price derived from price lookup. This retail sale unit price excludes sales and/or value added tax.
ItemIDEntryMethodCode Code4 A code that describes how this line item's item identification is being entered (e.g. it is scanned, keyed SKU, keyed department, etc.)
MerchandiseReturnFlag Flag A boolean flag indicating whether this line item is dealing with a merchandise return or a sale.
MerchandiseReturnReasonCode Code2 A code that describes why a customer is returning merchandise.
Quantity Quantity The number of retail selling units sold to or returned by a customer. For services the number of units (e.g. hours or job) sold or in the case of refunds, reduced to zero revenue.
SellUnitRetailPriceDerivationMethodCode Code4 A code that documents how the selling unit retail prices were derived for this line item.
SellUnitRetailPriceEntryMethodCode Code4 A code that describes how this line item's retail selling unit price is being entered (e.g. it is manually keyed, obtained from price lookup, etc.)
ServiceRefundFlag Flag A boolean flag indicating whether this line item is dealing with a refund for services provided.
ServiceRefundReasonCode Code2 A code that describes why a customer is receiving a refund for services previously purchased (and provided).
VATAmount Money The monetary value of the value added tax added to the sale-return-line-item-extended-amount to arrive at the the total amount the customer pays for this item. Note that this amount can only be derived after all price changes and price derivation rules have been applied to this line item in this transaction.

Back to Top

SaleReturnLineItemAddress

A transaction sale/return line item modifier used to capture a name and address related to a specific merchandise sale or return. The usage of the name and address is relevant only within the context of the SALE/RETURN LINE ITEM. Its intended use is for ship to name and address, merchandise return from name and address and so on.

Tag

Type

Definition

AddressLine1 Address The first address line of the person returning an item.
AddressLine2 Address The second address line of the person returning an item.
AddressLine3 Address The third address line of the person returning an item.
AddressLine4 Address The fourth address line of the person returning an item.
City City The city of the address of the person who is returning an item.
FirstName Name The first name of the person who is returning an item.
LastName Name The last name of the person who is returning an item.
MiddleInitial NameMiddleInitial The middle initial of the person who is returning an item.
PostalCode PostalCode The postal code of the address of the person who is returning an item.
SaleReturnLineItemAddressTypeCode Code2 Defines the usage for the sale/return line item address entity. The usage types are to be determined by the retailer and may distinguish between a ship to address, a returned from address and so on.
StateOrProvince State The state or province of the person who is returning an item.

Back to Top

SaleReturnTaxModifier

A modifier to record tax or tax exemption by line item

Tag

Type

Definition

TaxableAmount Money The monetary amount for which tax is applicable.
TaxAmount Money The monetary value of the tax for a given tax authority for a SALE/RETURN LINE ITEM.
TaxExemptAmount Money The monetary value of the tax exemption for a given tax authority for a SALE/RETURN LINE ITEM. This amount will be subtracted from the sale-return-tax-amount (and nearly always result in a zero tax due amount) to reflect the tax exemption of a line item.
TaxExemptionReasonCode Code2 Defines the basis for exempting a SALE/RETURN LINE ITEM from tax.

Back to Top

SalesMeter

A mechanical or electronic meter that counts the monetary value or volume of blended ITEM dispensed during all FUELLING TRANSACTIONS ever.

Tag

Type

Definition

DeviceMeterID Number The MeterID the FuelingPoint uses to identify this SalesMeter. Cannot use this MeterID as the Primary Key because Meters break and need to be replaced.
SalesMeterID Identity A unique identifier for a sales meter.
StatusCode Code2Status A code denoting the status of the SalesMeter. Possible values include Active and InActive.

Back to Top

SalesMeterReading

The value of a SALES METER recorded at a particular time for a particular reason.

Tag

Type

Definition

MeterReadingQuantity Number The value of the meter being read
ReadingNumber Number A sequential number for a sales meter reading.
ReasonCode Code2 A 2 character code denoting the reason the meter reading was taken
TimeStamp Datetime The date & time the meter reading was taken

Back to Top

SalesRestriction

A type of limitation that restricts the sale of a particular type of item.

Tag

Type

Definition

SalesRestrictionCode Code6 A unique, automatically assigned code for a specific limitation on an ITEM's sale.
SalesRestrictionTypeCode Code4 A unique code for a group of SALES RESTRICTIONS.

Back to Top

Season

A defined selling period of the year for merchandise ( e.g. Spring, Summer, Fall, Winter). The number of weeks can vary by season and by retailer. Seasons can be further divided into subseasons.

Tag

Type

Definition

Description DescriptionShort A description of the SEASON, such as Spring '97.
SeasonCode Code2 A unique identifier for the SEASON and year.

Back to Top

SeasonPriceDerivationRuleEligibility

Defines an association between a SEASON and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise ( in which case it impacts the stock ledger) or as an expense ( in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or the increase calculated as a result of the application of the PRICE DERIVATION RULE will be handled when more than one rule is applied within a sales transaction.
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied.
ExpirationDateTimestamp TimeStampExpiration The time and date this rule is no longer valid.

Back to Top

SendCheckTenderLineItem

A type of TENDER LINE ITEM used to record the information needed to issue a check from the store to the customer to settle a return, refund or other transfer of tender to a customer. A send check is usually settled through the home office issuing a check to the customer through the enterprise accounts payable system. A send check relationship between a store and the customer exists only until the check is issued and cashed.

Tag

Type

Definition

PayableToAddress Address The address of the payable to party to be printed on the check
PayableToCity City The city of the payable to party to be printed on the check
PayableToName Name The name of the payable to party to be printed on the check
PayableToPostalCode PostalCode The postal code of the payable to party to be printed on the check
PayableToState State The state or province of the payable to party to be printed on the check
ReasonCode Code2 A code identifying the reason for issuing a check (e.g. refund, return, etc.)

Back to Top

SerializedUnit

A specific instance of a SERIALIZED ITEM with a unique serial number, usually allocated by the manufacturer, and is used for tracking the ITEM through the supply chain.

Tag

Type

Definition

SerialNumber Name A unique code, which can be either alpha, numeric or alpha-numeric, to identify an individual ITEM.
TypeCode Code2 A code to indicate the type of SERIAL ITEM, eg TV, refrigerator, PC, etc.
WarrantyCode Code2 A code to signify the type of warranty associated with the SERIAL ITEM. This code will include the length of the warranty.

Back to Top

ServiceItem

A type of ITEM that provides a detailed identifier and description for a service offered for sale to a customer in the retail store. This entity also identifies and describes rental items and other tangible items that are used by a customer for a contracted period of time but not purchased.

Tag

Type

Definition

BaseCostAmount Money The base cost amount of the SERVICE ITEM. This cost excludes all promotional allowances.
CostsEstablishedDate DateCalendar The effective date of the current cost price for the SERVICE ITEM.
Description DescriptionShort A textual description of the SERVICE ITEM.
NetCostAmount Money The net cost price of the SERVCE ITEM. this cost includes all promotional allowances.
TypeCode Code2 A code to denote the type of SERVICE ITEM.

Back to Top

ServiceItemProvider

The association between a SERVICE ITEM sold by a retail store and the third party SERVICE PROVIDER who actually performs the service.

Tag

Type

Definition

UnitOfServiceAmount MoneyShortRetail The retail amount of each unit of service offered by the service provider.
UnitOfServiceCode Code2 A code to denote the type of service provided by the SUPPLIER.

Back to Top

ServiceLevel

A collection of service levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are \"Full Service\" & \"Self Service\"

Tag

Type

Definition

Name <unknown> A human readable name for the service level
ServiceLevelID Name A unique identifier for the service level

Back to Top

ServiceProvider

A third party that provides a service.

Tag

Type

Definition

DUNSNumber IdentityDunsIdentifier The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the retail community and credit worthiness.
Name Name The name of the service provider's company.
ServiceProviderID Identity A unique identifier for the service provider.

Back to Top

ServiceTermsAndConditions

The terms and conditions that apply to the provision of any services either by the RETAIL STORE or by arrangement through a third party. The terms and conditions are normally listed in a separate document which the customer is requested to sign as acceptance of these terms.

Tag

Type

Definition

Description DescriptionShort A description of the service terms and conditions
EffectiveDate DateCalendar The date when the service terms and conditions become effective.
ExpirationDate DateCalendar The date on which the service terms and conditions will expire.
IssuerName Name The issuer of the service terms and conditions associated with this ITEM.
ServiceTermsCode Code2 The type of service terms and conditions \

Back to Top

Session

A transient association between an OPERATOR, and a WORKSTATION, that must exist to enable the creation of a RETAIL TRANSACTION or FINANCIAL TRANSACTION that involves the receipt, disbursement, pick up or loan of tender. A SESSION is created when an OPERATOR signs on to a WORKSTATION and is terminated when an OPERATOR signs off of a WORKSTATION. This entity exists to support tender reconciliation and accountability at an OPERATOR level.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount of container deposits collected by SESSION.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts recorded by SESSION.
EndDateTimestamp TimeStampAudit The time and date recorded at the end of the SESSION.
GrossNegativeTotalAmount Money The total monetary gross negative sales amount recorded by SESSION.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by SESSION.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax recorded by SESSION.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by SESSION.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by SESSION.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by SESSION.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts recorded by SESSION.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by SESSION.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by SESSION.
PaymentsCollectedTotalAmount Money The total monetary amount of payments on account collected by SESSION.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash payments disbursed by SESSION.
PostTransactionVoidTotalAmount Money The total monetary amount of post transactions actioned by SESSION.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by SESSION.
RefundTotalAmount Money The total monetary amount of refunds recorded by SESSION.
ReturnTotalAmount Money The total monetary amount of returns recorded by SESSION.
SessionStartDateTimestamp TimeStampAudit The time and date at the start of the SESSION.
StoreCouponTotalAmount Money The total monetary amount of store coupons recorded by SESSION.
TaxExemptTotalAmount Money The total tax exempt amount recorded by SESSION.
TaxTotalAmount Money The total tax amount recorded by SESSION.
TenderLoanTotalAmount Money The total monetary amount of tender loans by SESSION.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by SESSION.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by SESSION.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee line item discounts recorded by SESSION.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by SESSION where no sales are being recorded at the WORKSTATION.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway payments collected by SESSION.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by SESSION.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed compared to the total sold ITEMs by SESSION.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by SESSION.
TotalLineItemOpenDepartmentPercentage Percent The percentage of ITEMs sold through an open department compared to the total sold ITEMs by SESSION.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides made by SESSION.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by SESSION.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by SESSION.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded by SESSION.
TotalLockTime QuantityShortCountSeconds The total time expressed in minutes when the WORKSTATION is locked but the OPERATOR is logged on the WORKSTATION by SESSION.
TotalMarkdownCount QuantityTransactionCount The total number of price markdowns made by SESSION.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of line item miscellaneous discounts recorded by SESSION.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by SESSION.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded by SESSION.
TotalPaymentsCollectedCount QuantityTransactionCount The number of payments on account collected by SESSION.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of petty cash line item payments disbursed by SESSION.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post transaction voids recorded by SESSION.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by SESSION.
TotalRefundCount QuantityTransactionCount The total number of refunds recorded by SESSION.
TotalReturnCount QuantityTransactionCount The total number of returns recorded by SESSION.
TotalRingTime QuantityShortCountSeconds the total time expressed in minutes spent either scanning or keying ITEMs into the WORKSTATION by SESSION.
TotalSaleLineItemCount QuantityTransactionCount The total number of sale line items by SESSION.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons recorded by SESSION.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by SESSION.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by SESSION.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups by SESSION.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by SESSION.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by SESSION.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items by SESSION.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids by SESSION.

Back to Top

SessionTax

A collection of tax totals for a tax authority by operator workstation session for a tender reconciliation period.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total monetary amount of taxable sales by SESSION..
TaxCollectedTotalAmount Money The total monetary amount of tax collected by SESSION.
TaxExemptSaleTotalAmount Money The total monetary amount of taxable sales by SESSION.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions by SESSION

Back to Top

SessionTender

A collection of tender type accumulators by operator-workstation-session for a tender reconciliation period. This entity is used to support operator-workstation-session tender accountability.

Tag

Type

Definition

DepositTotalAmount Money The total monetary value of tender media deposited in the EXTERNAL DEPSITORY by SESSION.
OverTotalAmount Money The total amount of tender overages by SESSION.
PickupMediaTotalAmount Money Total monetary amount of pickups made by media type by SESSION.
ShortTotalAmount Money The total monetary amount of tender pickup media unit shortages by SESSION.
TenderLoanMediaTotalAmount Money Total monetary amount of loans made by media type by SESSION.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of tender units at the beginning of the SESSION.
TotalTenderDepositMediaUnitCount QuantityTransactionCount The total number of tender media deposited in the EXTERNAL DEPOSITORY by SESSION.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender loan media units by SESSION.
TotalTenderMediaOverCount QuantityTransactionCount The total number of tender media overages by SESSION.
TotalTenderMediaShortCount QuantityTransactionCount The total number of tender media shortages by SESSION.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units by SESSION.

Back to Top

ShipmentContainer

A specific instance of a CONTAINER within a SHIPMENT.

Tag

Type

Definition

FreightBillLineNumber LineNumber The line number on the FREIGHT BILL to which this particular shipment container applies.

Back to Top

ShipmentContainerMerchandiseLineItem

An association between a SHIPMENT CONTAINER and an INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM. This association describes which container a specific item is being shipped in to the store.

Tag

Type

Definition

ShipmentContainerPackUnitCount Quantity The standard number of packs in each CONTAINER.

Back to Top

Shopper

An individual that may purchase (and return goods) and services from a retailer and without establishing a persistent relationship with that retailer. A shopper's relationship with the retailer is limited to each retail transactio
Back to Top

SignOffTransaction

A non sales transaction that no longer assigns TRANSACTIONS to that particular EMPLOYEE.
Back to Top

SignOnTransaction

A non sales transaction that establishes a SESSION and enables a WORKSTATION to accept RETAIL TRANSACTIONs, TENDER CONTROL TRANSACTIONs, FINANCIAL TRANSACTIONs and other CONTROL TRANSACTIONs.
Back to Top

Size

This entity type is a further classification of the STOCK ITEM and is typically referred to as an option of style.

Tag

Type

Definition

ActualSizeCode Code4 The last four characters of the NRF size code. This code uniquely identifies a particular size, eg dress size 12 or combination of sizes, eg pants, waist size 36, inseam 31.
ActualSizeProportionDescription DescriptionShort The proportions typically used to measure this particular ITEM type, eg 36 (waist) x 31(inseam).
ActualSizeTypeDescription Name A description of the industry convention typically used to signify the size to the customer, eg waist used for pants, body for coats, neck for shirts, chest for sweaters, etc.
Description DescriptionShort A description of the apparel cataegories encompassed within the size table code.
SizeCode Code6 A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous coding structure as specified by the NRMA to facilitate data interchange between vendors and retailers. This code permits the use of both standard and proprietary coding format.
TableCode Code2 The first character of the size code as designated by the NRF (1-9). This first digit refers to the size table, for example 1=adult male clothing, 5=footwear and 7=home decorating accessories. Retailers using proprietary in-house size codes use a \"0\" size table.
TableName Name The name of the size table code, eg size code 4=infant's and children's clothing.

Back to Top

StandardizedAddress

An address that has be standardized via a postal standardization system.

Tag

Type

Definition

ForeignDomesticTypeCode Code2 A code that categorizes an Address into Foreign or Domestic.

Back to Top

StandardizedDomesticAddress

A non-foreign address that conforms to postal standards.

Tag

Type

Definition

ContactCity City The city component of the CONTACT's address
ContactCountry Address The country component of the CONTACT's address. This is only used where the CONTACT's company is outside the country in which the retailer operates.
ContactPostalCode PostalCode The postal or zip code of the CONTACT's address
ContactState State The state component of the CONTACT's address

Back to Top

StandardizedForeignAddress

A non-domestic address that conforms to postal address standards.
Back to Top

StockItem

A unit of merchandise that may be sold to a customer or used by the RETAIL STORE.

Tag

Type

Definition

AvailableForSaleDate DateCalendar The date when this STOCK ITEM becomes available for sale. For example, certain books have specific publication dates, music entertainment release dates.
BulkToSellingUnitWasteFactorPercent Percent The pre-defined waste factor percentage, e.g. boning allowance.
BulkToSellingUnitWasteTypeCode Code2 The code to signify the type of waste associated with the BULK ITEM when breaking down to retail units.
CustomerPickupTypeCode Code2 A code that defines where and how a customer may pickup this item. For examples a refrigerator may have to be picked up at the shipping dock or at the retailer's warehouse.
DisplayUnitDispositionCode Code2 The code to denote how the DISPLAY UNIT is to be disposed, ie returned to the supplier, destroyed or retained until the next promotion.
DisplayUnitSetUpDate DateCalendar The date on which the display unit can to be set up within the RETAIL STORE.
DisplayUnitTakeDownDate DateCalendar The date on which the display unit can be taken down by the RETAIL STORE.
DisplayUnitTypeCode Code2 A code to denote the type of display unit, i.e. free-standing, shelf end, etc.
EnvironmentTypeCode Code2 A code that defines the temperature, relative humidity, lighting and other physical or climatic environmental requirements for storing and displaying the item.
FabricDescription DescriptionShort Describes the material used to make the apparel item.
HazardousMaterialTypeCode Code2 This code defines the relevant hazardous material handling properties of the item. This code is provided for oil products, petsicides, swimming pool suppliers, fertilizers (especially bomb grade), etc.
InventoryAccountingMethodCode Code2 A code to define the inventory accounting method to be used for the item. Examples of methods include the retail method, cost method, etc.
PackItemCubeCount Quantity The volume of the PACK ITEM.
PackItemUnitNumberCount Quantity The number of units within the PACK ITEM.
PackItemWeightCount Quantity The actual weight of the PACK ITEM including tare.
SaleUnitOfMeasureCode Code2 Identifies the unit of measure used for each retail sale unit. This is the unit that a customer buys and in which the store presents the item.
SaleUnitPrimaryMeasurementSystemCode Code2 Identifies the primary system of measurement used with the item's unit of measures. Valid values are I = Imperial and M= Metric.
SaleWeightOrUnitCountCode Code2 A code to indicate whether the STOCK ITEM is sold by weight or as an unit.
SecurityRequiredTypeCode Code2 A code that defines the security environment and procedures required for receiving, displaying and selling the item. This is for high-priced merchandise like jewelry, certain prescription drugs, ordinance, fireworks, etc.
SellUnitLandedCostAmount MoneyShortCost The cost of the item plus the insurance, drayage, cartage, delivery, insurance, customs duties, etc. which add up to the full delivered cost of an imported item to the store.
SellUnitLastReceivedBaseCostAmount MoneyShortCost The base cost per sell unit derived from the last receipt of this item. The base cost excludes allowances, discounts, charges and other amounts that may change the item cost.
SellUnitLastReceivedCostsEstablishedDate DateCalendar The date the last received costs (net and base) were established.
SellUnitLastReceivedNetCostAmount MoneyShortCost The net cost per sell unit derived from the last receipt of this item. The base cost includes allowances, discounts, charges and other amounts that may change the item cost. Where there are no allowances, etc. the net cost will equal the base cost for an item.
SerializedItemManufacturerColorDescription DescriptionShort The code to signify the manufacturer's color shade
SerializedItemManufacturerSizeDescription DescriptionShort A code to signify the manufacturer's size reference.
SerializedItemManufacturerWarrantyDescriptionCode Code4 A code to denote the type of warranty offered on the ITEM by the MANUFACTURER.
SerializedItemModelNumber Name The model reference for a specific SERIALIZED ITEM
SerializedItemModelYear DateCalendarYear The year of release or production of a SERIALIZED ITEM.
SerializedItemStoreWarrantyDescriptionCode Code4 A code to signify the type of warranty offered by the RETAIL STORE. This warranty normally supplements the warranty offered by the MANUFACTURER.
SerializedItemValidationFlag Flag An indicator used to identify if the SERIALIZED ITEM requires operator validation after payment has been made and prior to customer pickup.
ShelfItemAisleLocation DescriptionShort The aisle where the SHELF ITEM is located within the RETAIL STORE.
ShelfItemBrokerID Identity The broker through whom the SHELF ITEM is supplied.
ShelfItemConsumerPackageDepth Quantity The dimension from front to back of the consumer package on the shelf
ShelfItemConsumerPackageDimensionUnitOfMeasureCode Code2 An indicator by dimension assigned to the unit of measure, eg inches, etc.
ShelfItemConsumerPackageHeight Quantity The dimension from top to bottom of the consumer package on the shelf
ShelfItemConsumerPackageSizeUnitOfMeasureCode Code4 The code to denote the unit of measure for this particular SHELF ITEM
ShelfItemConsumerPackageWeight Quantity The weight of the SHELF ITEM.
ShelfItemConsumerPackageWeightUnitOfMeasureCode Code2 An indicator by weight assigned to the unit of measure, eg ounces etc.
ShelfItemConsumerPackageWidth Quantity The dimension from left to right of the consumer package on the shelf
ShelfItemDSDAuthorizedFlag Flag An indicator used to identify whether the RETAIL STORE is authorized to accept the SHELF ITEM as a direct store delivery item.
ShelfItemFacingsCount Quantity the number of units that can be contained in one facing. For example, if you can fit 30 units of a product on a shelf and there are 3 facings, then the units per facing are 10.
ShelfItemsHeldCapacityCount Quantity The maximum number of SHELF ITEMs that can be stocked on the display unit.
ShelfItemShelfLifeDayCount QuantityDayCount The number of days that the SHELF ITEM is available for sale before being removed from the sales area.
ShelfItemShelfLocation DescriptionShort The shelf within the aisle where the SHELF ITEM is located
ShelfItemSideLocation DescriptionShort Identifies the side of the aisle where the ITEM is located.
ShelfItemStaplePerishableTypeCode Code2 A code to indicate whether the SHELF ITEM is a staple or perishable product.
ShelfItemUnitPricingRequiredFlag Flag An indicator to identify if the SHELF ITEM needs to be individually priced, rather than conveyed through a shelf label. Examples include high priced merchandise and variable weight product.
ShelfLifePeriodDayCount QuantityDayCount The number of business days the item may be displayed for sale to customers and after which must be removed. This attribute is for perishable produce items, drugs, and other time sensitive items (like newspapers).
ShrinkFlag Flag A flad to denote if the STOCK ITEM could loose weight from the time of order until the time of receipt.
SilhouetteDescription DescriptionShort Describes the cut or fit of the apparel item. Example shirts may be sold as slim or standard fit.
StockItemTypeCode Code2 A code to indicate the STOCK ITEM type, ie SHELF ITEM, APPAREL ITEM, SERIALIZED ITEM, etc.
SwellFlag Flag A flag used to indicate if the STOCK ITEM may gain weight or swell from time of order to time of receipt.
UnitPriceFactor Quantity The number of units of measure per selling unit. Used as the divisor when calculating the STOCK ITEM's unit retail price, eg $1.67 per pound or $2.59 for 32 floz.

Back to Top

StockItemConsumerProductLabel

Identifies and describes the stock item for presentation on a label designed to inform or warn consumers about the product.

Tag

Type

Definition

CalciumDailyMinimumPercent Percent The percentage of minimum daily requirement for Calcium
CaloriesCount Quantity A count of the number of calories in the serving unit.
CaloriesFromFatCount Quantity The number of calories derived from fat for the serving unit of the item
CholesterolMilligramsCount Quantity The weight (in milligrams) of cholesterol found in a serving.
CholesterolPercent Percent The percent of daily recommended allowance for cholesterol in a serving.
ConsumerLabelTypeCode Code2 Defines the type of information to be carried on the label. Examples include nutritional information, hazard warnings, OSHA warnings, handling warnings, laundering instructions, etc.
DietaryFiberGramsCount Quantity The weight in grams of the dietary fiber contained in a serving
HazardousMaterialFlag Flag A flag to denote whether this product is classified as a hazardous item.
HazardousMaterialTypeCode Code4 A code to denote the type of hazardous material, eg fireworks.
IronDailyMinimumPercent Percent The percentage of minimum daily requirement for iron
NutritionalDescriptionText DescriptionNarrative General text description for nutritional information.
ProteinGramsCount Quantity The weight of protein, in grams, for a serving
SaturatedFatGramsAmount Quantity Total saturated fat weight in grams for the serving of the item.
SaturatedFatPercent Percent The input percentage of saturated fat based on the total-fat-grams amount.
ServingsInRetailSaleUnitCount Quantity Number of servings in a retail sale unit for the item.
ServingSizeUnitOfMeasureCode Quantity The unit of measure assigned to the item for serving size counts.
ServingSizeUnitOfMeasureCount Quantity The count or number of serving unit of measures in a serving.
SodiumMilligramsCount Quantity The weight (in milligrams) of sodium found in a serving.
SodiumPercent Percent The percent of daily recommended allowance for sodium in a serving.
SugarsGramsCount Quantity The weight in grams of sugars for a serving.
Total CarbohydratePercent Percent The percent of daily recommended allowance for carbohydrate in a serving.
TotalCarbohydrateMilligramsCount Quantity The weight (in milligrams) of carbohydrate found in a serving.
TotalFatDailyIntakePercent Percent The input percentage of fat based on the total-fat-grams amount.
TotalFatGramsAmount Quantity Total fat weight in grams for the serving of the item.
VitaminADailyMinimumPercent Percent The percentage of minimum daily requirement for Vitamin A
VitaminBDailyMinimumPercent Percent The percentage of minimum daily requirement for Vitamin B
VitaminCDailyMinimumPercent Percent The percentage of minimum daily requirement for Vitamin C

Back to Top

StockItemLocation

A many-to-many join resolving entity that allows us to record the fact that a RetailStoreItem lives in a particular Location without there being a StockLedgerAccount for the Item in that Location. Used in forecourt where two or three underground storage tanks (Locations) are manifolded together. The group of manifolded tanks is the location for which there is a StockLedgerAccount, the three storage tank Locations still have stock in them, and will be used when the system has TankGauge Equipmen
Back to Top

StockLedgerAccount

A unit record of a LOCATION inside a store where a STOCK ITEM is stored or displayed for sale, and for which an item stock on hand count and dollar value is maintained.

Tag

Type

Definition

AccountingMethodCode Code2 This code defines the accounting method used by the store, ie the retail or cost method of accounting.
AverageWeightedUnitCost MoneyShortCost The weighted average cost for each retail sale unit of this item. The weighted average cost is updated each time a shipment of this item is received.
BeginningBalancesResetDate DateCalendar The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the end of the accounting period.
BeginningBudgetedShrinkPercent Percent The amount of budgeted shrink expressed as a percentage of sales that is likely to occur over the length of the period.
BeginningBudgetedShrinkPercentBaseTypeCode Code2 A code that defines how a retailer will calculate their budgeted shrink. For example a retailer may calculate their budgeted shrink based on gross sales or on net sales (gross_sales - returns)
BeginningCumulativeMarkonAmount Money The markon amount at the beginning of the period ( initial markon).
BeginningCumulativeMarkonPercent Percent The markon percentage at the beginning of the period ( initial markon).
BeginningRetailValueAmount Money The monetary value of the units present at the beginning of the accounting period.
BeginningUnitCount QuantityTransactionCount The number of units present at the beginning of the accounting period.
CumulativeAdjustmentRetailAmount Money The cumulative retail value of inventory adjustments (overages and shortages) made to the stock ledger account.
CumulativeAdjustmentUnitCount QuantityTransactionCount The cumulative adjustment made to the on hand amount of an ITEM since the start of the period.
CumulativeCompanyAffiliateDiscountAmount Money Cumulative discount amount granted to non-employee store affiliates. This accumulator is used to track discounts granted to employees of business partners and other parties as determined by the store and/or home office.
CumulativeDamagedItemDepreciationAmount Money Cumulative retail value lost due to damage to stock.
CumulativeEmployeeDiscountAmount Money Cumulative value of employee discounts granted for the item
CumulativeGrossSalesRetailAmount Money The cumulative gross sales for a specific ITEM since the beginning of the period. The gross figure excludes returns.
CumulativeGrossSalesUnitCount QuantityTransactionCount The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any returns.
CumulativeOutOfDateItemDepreciationAmount Money Cumulative retail value lost due to stock aging past its sell-by date.
CumulativePermanentMarkdownAmount Money The cumulative value of permanent markdowns taken against this item.
CumulativePermanentMarkupAmount Money The cumulative value of permanent markups taken against this item.
CumulativeReceivedCostAmount Money The cumulative cost value of units received for a particular ITEM since the beginning of the period.
CumulativeReceivedRetailAmount Money The cumulative retail value of units received for a particular ITEM since the beginning of the period.
CumulativeReceivedUnitCount QuantityTransactionCount The cumulative number of units received for a particular ITEM since the beginning of the period.
CumulativeReturnRetailAmount Money The cumulative retail value of merchandise that is returned by customers to the store.
CumulativeReturnToVendorRetailAmount Money The cumulative retail value of merchandise returned to the vendor from the store.
CumulativeReturnToVendorUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM returned to the vendor since the beginning of the period.
CumulativeReturnUnitCount QuantityTransactionCount The cumulative number of units returned of a specific ITEM since the beginning of the season.
CumulativeTemporaryMarkdownAmount Money The cumulative temporary or promotional markdown value taken against this item either as a price change or through the application of price derivation rules at the point of sale.
CumulativeTemporaryMarkupAmount Money The cumulative temporary or promotional markup value taken against this item either as a price change or through the application of price derivation rules at the point of sale.
CumulativeTransferInRetailAmount Money The cumulative retail value of merchandise transferred into the store from other stores or distribution centers.
CumulativeTransferInUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the beginning of the period.
CumulativeTransferOutRetailAmount Money The cumulative retail value of merchandise transferred from the store to another store or distribution center.
CumulativeTransferOutUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred out to other RETIL STOREs or other FACILITYs within the retail enterprise since the beginning of the period.
PhysicalCountDate DateCalendar The date this item was last physically counted
PhysicalCountRetailValuationAmount Money The retail valuation of the current physical count based on the retail method of accounting.
PhysicalCountUnitCount QuantityTransactionCount The retail sale unit count determined by the last physical inventory for this item.

Back to Top

StockLedgerAccountFiscalPeriodHistory

A reporting period historical record of the beginning balance and cumulative activity for an ITEM - STOCK LEDGER ACCOUNT.

Tag

Type

Definition

AverageWeightedUnitCost MoneyShortCost The weighted average cost for each retail sale unit of this item. The weighted average cost is updated each time a shipment of this item is received.
BeginningBalancesResetDate DateCalendar The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the end of the accounting period.
BeginningBudgetedShrinkPercent Percent The amount of budgeted shrink expressed as a percentage of sales that is likely to occur over the length of the period.
BeginningBudgetedShrinkPercentBaseTypeCode Code2 A code that defines how a retailer will calculate their budgeted shrink. For example a retailer may calculate their budgeted shrink based on gross sales or on net sales (gross_sales - returns)
BeginningCumulativeMarkonAmount Money The markon amount at the beginning of the period ( initial markon).
BeginningCumulativeMarkonPercent Percent The markon percentage at the beginning of the period ( initial markon).
BeginningRetailValueAmount Money The monetary value of the units present at the beginning of the accounting period.
BeginningUnitCount QuantityTransactionCount The number of units present at the beginning of the accounting period.
CumulativeAdjustmentRetailAmount Money The cumulative retail value of inventory adjustments (overages and shortages) made to the stock ledger account.
CumulativeAdjustmentUnitCount QuantityTransactionCount The cumulative adjustment made to the on hand amount of an ITEM since the start of the period.
CumulativeCompanyAffiliateDiscountAmount Money Cumulative discount amount granted to non-employee store affiliates. This accumulator is used to track discounts granted to employees of business partners and other parties as determined by the store and/or home office.
CumulativeDamagedItemDepreciationAmount Money Cumulative retail value lost due to damage to stock.
CumulativeEmployeeDiscountAmount Money Cumulative value of employee discounts granted for the item
CumulativeGrossSalesRetailAmount Money The cumulative gross sales for a specific ITEM since the beginning of the period. The gross figure excludes returns.
CumulativeGrossSalesUnitCount QuantityTransactionCount The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any returns.
CumulativeOutOfDateItemDepreciationAmount Money Cumulative retail value lost due to stock aging past its sell-by date.
CumulativePermanentMarkdownAmount Money The cumulative value of permanent markdowns taken against this item.
CumulativePermanentMarkupAmount Money The cumulative value of permanent markups taken against this item.
CumulativeReceivedCostAmount Money The cumulative cost value of units received for a particular ITEM since the beginning of the period.
CumulativeReceivedRetailAmount Money The cumulative retail value of units received for a particular ITEM since the beginning of the period.
CumulativeReceivedUnitCount QuantityTransactionCount The cumulative number of units received for a particular ITEM since the beginning of the period.
CumulativeReturnRetailAmount Money The cumulative retail value of merchandise that is returned by customers to the store.
CumulativeReturnToVendorRetailAmount Money The cumulative retail value of merchandise returned to the vendor from the store.
CumulativeReturnToVendorUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM returned to the vendor since the beginning of the period.
CumulativeReturnUnitCount QuantityTransactionCount The cumulative number of units returned of a specific ITEM since the beginning of the season.
CumulativeTemporaryMarkdownAmount Money The cumulative temporary or promotional markdown value taken against this item either as a price change or through the application of price derivation rules at the point of sale.
CumulativeTemporaryMarkupAmount Money The cumulative temporary or promotional markup value taken against this item either as a price change or through the application of price derivation rules at the point of sale.
CumulativeTransferInRetailAmount Money The cumulative retail value of merchandise transferred into the store from other stores or distribution centers.
CumulativeTransferInUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the beginning of the period.
CumulativeTransferOutRetailAmount Money The cumulative retail value of merchandise transferred from the store to another store or distribution center.
CumulativeTransferOutUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred out to other RETIL STOREs or other FACILITYs within the retail enterprise since the beginning of the period.
PhysicalCountDate DateCalendar The date this item was last physically counted
PhysicalCountRetailValuationAmount Money The retail valuation of the current physical count based on the retail method of accounting.
PhysicalCountUnitCount QuantityTransactionCount The retail sale unit count determined by the last physical inventory for this item.

Back to Top

StockMeter

A mechanical or electronic meter that counts the monetary value or volume of unblended BULK ITEM dispensed during all FUELLING TRANSACTIONS ever.

Tag

Type

Definition

DeviceMeterID Number The MeterID the FuelingPoint uses to identify this StockMeter. Cannot use this MeterID as the Primary Key because Meters break and need to be replaced.
StatusCode Code2Status A code denoting the status of the StockMeter. Possible values include Active and InActive.
StockMeterID Identity A unique identifier for the stock meter

Back to Top

StockMeterReading

The value of a STOCK METER recorded at a particular time for a particular reason.

Tag

Type

Definition

MeterValue Number The value of the STOCK METER at the time of the reading
ReadingNumber Number A sequential number for a stock meter reading.
ReasonCode Code2 A 2character code denoting the reason the meter reading was taken
TimeStamp Datetime The date & time the meter reading was taken

Back to Top

StoreFinancialLedgerAccount

An organized collection of data in which the monetary transactions of the RETAIL STORE are posted in the form of debits and credits reflecting the income, expenses, current assets and current liabilities created through the regular conduct of busines

Tag

Type

Definition

BeginningBalanceAmount Money The beginning balance on the STORE FINANCIAL LEDGER ACCOUNT.
CurrentBalanceAmount Money The current financial balance on the STORE FINANCIAL LEDGER ACCOUNT.
Description DescriptionShort Description of the account type on the STORE FINANCIAL LEDGER.
StoreFinancialLedgerAccountID Identity The reference for the STORE FINANCIAL LEDGER ACCOUNT
TypeCode Code2 A code to denote the account type on the STORE FINANCIAL LEDGER.

Back to Top

StoreFinancialLedgerFiscalPeriodHistory

A reporting period historical record of the beginning balance and cumulative activity for a STORE FINANCIAL LEDGER ACCOUNT.

Tag

Type

Definition

BeginningAmount Money The opening balance for each account for a specific fiscal period on the STORE FINNCIAL LEDGER.
CumulativeAmount Money The cumulative monetary amount of each account for a specific fiscal period on the STORE FINNCIAL LEDGER.
StatusCode Code2Status A code to denote the status of the STORE FINANCIAL LEDGER for a specific fiscal period, ie open or closed.

Back to Top

StoreHistory

A collection of monetary and operational totals used to track the activity volume for the entire store during a REPORTING PERIOD.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount container deposits collected by RETAIL STORE for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by RETAIL STORE for each REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary negative gross sales amount recorded by RETAIL STORE for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by RETAIL STORE for each REPORTING PERIOD.
GrossSalesExTaxTotalAmount Money The total gross sales excluding tax recorded by RETAIL STORE for each REPORTING PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliations performed on the RETAIL STORE for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by RETAIL STORE for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by RETAIL STORE for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of line item markdowns made by RETAIL STORE for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by RETAIL STORE for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by RETAIL STORE for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by RETAIL STORE for each REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by RETAIL STORE for each REPORTING PERIOD.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash line disbursements by RETAIL STORE for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of post transaction voids recorded by RETAIL STORE for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by RETAIL STORE for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount refunded by RETAIL STORE for each REPORTING PERIOD.
ResumedTotalAmount Money The total monetary value of suspended transactions resumed by RETAIL STORE for each REPORTING PERIOD.
ResumedTransactionCount QuantityTransactionCount The total number of suspended transactions resumed by RETAIL STORE for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns by RETAIL STORE for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons by RETAIL STORE for each REPORTING PERIOD.
SuspendedTotalAmount Money The total monetary value of suspended transactions made by RETAIL STORE for each REPORTING PERIOD.
SuspendedTransactionCount Quantity The total number of suspended transactions made by RETAIL STORE for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total monetary amount of tax exempt transactions by RETAIL STORE for each REPORTING PERIOD.
TaxTotalAmount Money The total tax recorded by RETAIL STORE for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary amount of tender loans by the RETAIL STORE for each REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by the RETAIL STORE for each REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by RETAIL STORE for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee discount line items by RETAIL STORE for each REPORTING PERIOD.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for each REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway payments collected by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemOpenDepartmentPercentage Percent The number of ITEMs recorded through an open department by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemScannedPercentage Percent The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by RETAIL STORE for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded by RETAIL STORE for each REPORTING PERIOD.
TotalLockTime QuantityShortCountSeconds he total time expressed in minutes when the WORKSTATION is locked even though an OPERATOR is signed on by RETAIL STORE for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of line item markdowns made by RETAIL STORE for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous line items by RETAIL STORE for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by RETAIL STORE for each REPORTING PERIOD.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded by RETAIL STORE for each REPORTING PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account collected by RETAIL STORE for each REPORTING PERIOD.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount he total number of petty cash line disbursements by RETAIL STORE for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post transaction voids recorded by RETAIL STORE for each REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by RETAIL STORE for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by RETAIL STORE for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by RETAIL STORE for each REPORTING PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for each REPORTING PERIOD.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales recorded by RETAIL STORE for each REPORTING PERIOD.
TotalSendCheckAmount Money The total monetary amount of send checks by RETAIL STORE for each REPORTING PERIOD.
TotalSendCheckCount QuantityTransactionCount The total number of send checks by RETAIL STORE for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of operator sign-offs on this RETAIL STORE for each REPORTING PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons by RETAIL STORE for each REPORTING PERIOD.
TotalTaxExemptTransactionCount Money The total number of tax exempt transactions by RETAIL STORE for each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderOverAmount Money The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
TotalTenderPickupCount Money The total number of tender pickups from this RETAIL STORE for each REPORTING PERIOD.
TotalTenderUnderAmount Money The total monetary amount of shortages by RETAIL STORE for each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transactions voids by RETAIL STORE for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items by RETAIL STORE for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids recorded by RETAIL STOREfor each REPORTING PERIOD.

Back to Top

StoreSafe

A repository within the store for safekeeping TENDER removed from the TILL. Also used to secure petty cash and till loans.

Tag

Type

Definition

Description DescriptionShort A textual description of the SAFE. The term safe can apply to any repository within the office.

Back to Top

StoreSafeHistory

A record of the TRANSACTIONs involving the movement of TENDER.
Back to Top

StoreSafeSettlementTransaction

A transaction that records closing of the ledger for the store safe. A new ledger will be opened with a new beginning onhand accountability, and zero incremental accumulators (pickup, loan, deposit, etc.
Back to Top

StoreSafeTender

A set of tender repository totals for each type of tender in a STORE SAFE.

Tag

Type

Definition

DepositTotalAmount Money The total monetary amount deposited in the EXTERNAL DEPOSITORY from the STORE SAFE in each REPORTING PERIOD.
LoanTotalAmount Money The total monetary value of tender loan media made to the WORKSTATION from the STORE SAFE in each REPORTING PERIOD.
OpenBalanceTotalAmount Money The opening monetary balance amount in the STORE SAFE in each REPORTING PERIOD.
OverTenderDiscrepancyTotalAmount Money The total monetary amount of tender overages in the STORE SAFE in each REPORTING PERIOD.
PettyCashDisbursementTransactionTotalAmount Money The total monetary amount of petty cash disbursements made from the STORE SAFE in each REPORTING PERIOD.
PickupTotalAmount Money The total monetary value of tender pickup media from the STORE SAFE in each REPORTING PERIOD.
ReceiptTotalAmount Money The total monetary receipts made in the STORE SAFE in each REPORTING PERIOD.
TotalPettyCashDisbursementTransactionCount QuantityTransactionCount The total number of petty cash disbursements made from the STORE SAFE in each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans made to the WORKSTATION from the STORE SAFE in each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups from the STORE SAFE in each EPORTING PERIOD.
UnderTenderDiscrepancyTotalAmount Money The total monetary amount of tender shortages reported from the STORE SAFE in each REPORTING PERIOD.

Back to Top

StoreSafeTenderHistory

An accumulator for various tender amounts and units held and transferred to and from the STORE SAFE.

Tag

Type

Definition

OverTenderDiscrepancyTotalAmount Money The total monetary amount of tender overages recorded for the SAFE for each REPORTING PERIOD.
PettyCashDisbursementTransactionTotalAmount Money The total monetary amount of cash disbursements made from the SAFE for each REPORTING PERIOD.
TenderDepositTotalAmount Money The total monetary amount of the tender deposits made from the SAFE to the EXTERNAL DEPOSITORY in each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary amount of the tender loans made to the SAFE in each REPORTING PERIOD.
TenderOpenBalanceTotalAmount Money The monetary amount of the opening balance of the STORE SAFE TENDER by REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of the tender pickups loans made from the SAFE in each REPORTING PERIOD.
TenderReceiptTotalAmount Money The total monetary amount of the tender receipts made to the SAFE from the EXTERNAL DEPOSITORY in each REPORTING PERIOD.
TotalPettyCashDisbursementTransactionCount QuantityTransactionCount The total number of cash disbursements made from the SAFE for each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans to the SAFE in each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups from the SAFE in each REPORTING PERIOD.
UnderTenderDiscrepancyTotalAmount Money The total monetary amount of tender shortages recorded for the SAFE for each REPORTING PERIOD.

Back to Top

StoreTaxHistory

A collection of tax totals for a tax authority for the store for a REPORTING PERIOD.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total monetary amount of taxable sales recorded by the RETAIL STORE for each REPORTING PERIOD.
TaxCollectedTotalAmount Money The total monetary amount of tax collected by the RETAIL STORE for each REPORTING PERIOD.
TaxExemptSaleTotalAmount Money The total monetary amount of tax exempt sales recorded by the RETAIL STORE for each REPORTING PERIOD.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by the RETAIL STORE for each REPORTING PERIOD.

Back to Top

StoreTenderHistory

A collection of tender type accumulators for the store for a REPORTING PERIOD. This entity is used to support store-level tender accountability.

Tag

Type

Definition

TenderDepositTotalAmount Money The total monetary value of tender media deposited by the RETAIL STORE for each REPORTING PERIOD.
TenderLoanMediaTotalAmount Money The total monetary value of tender loans recorded by the RETAIL STORE for each REPORTING PERIOD.
TenderOverTotalAmount Money The total monetary value of tender overages recorded by the RETAIL STORE for each REPORTING PERIOD.
TenderPickupMediaTotalAmount Money The total monetary value of tender pickup recorded by the RETAIL STORE for each REPORTING PERIOD.
TenderShortTotalAmount Money The total monetary value of tender shortages recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of the number of tender media units recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderDepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender loan media units recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderMediaCount QuantityTransactionCount The total number of tender media units by RETAIL STORE for each REPORTING PERIOD.
TotalTenderMediaOverCount QuantityTransactionCount The total monetary value of tender overages recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderMediaShortCount QuantityTransactionCount The total monetary value of tender shortages recorded by the RETAIL STORE for each REPORTING PERIOD.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units by the RETAIL STORE for each REPORTING PERIOD. \

Back to Top

Style

This entity type identifies and describes the general appearance of retail items.

Tag

Type

Definition

Description DescriptionShort A textual description of the appearance type denoted by the STYLE CODE.
Name Name The descriptive name given to the STYLE CODE.
StyleCode Code4 A code that uniquely identifies the specific appearance type or variety in which an APPAREL ITEM is available.

Back to Top

Subseason

A SEASON that is divided into shorter time periods. Although each SUBSEASON may promote different merchandise it normally maintains the overall theme of the SEASON. For example, the summer season may be split into early, middle and late summer SUBSEASONS.

Tag

Type

Definition

Description DescriptionShort A textual description of the subseason, such as early Spring, mid Spring, late Spring.
SubseasonCode Code2 A code for a specific subseason. This is normally stated as SUBSEASON, within SEASON, within FISCAL YEAR.

Back to Top

SubseasonPriceDerivationRuleEligibility

Defines an association between a SUBSEASON and PRICE DERIVATION RULE and the conditions which govern the application of the associated rule to an item falling under the merchandise structure at the time an instance of the item is recorded as a line item in a sale.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation ( in which case it impacts the stock ledger) or as an expense ( in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase as a result of the application of the PRICE DERIVATION RULE will be handled within a sales transaction.
EffectiveDateTimestamp TimeStampEffective The time and date this rule is activated and may be applied.
ExpirationDateTimestamp TimeStampExpiration The time and date this rule is no longer valid.

Back to Top

Supplier

An external party that acts as a source for merchandise and services offered for sale through the RETAIL STORE, or for supplies and services consumed by the store in conducting its business.

Tag

Type

Definition

DUNSNumber IdentityDunsIdentifier The non-indicative nine-digit number assigned and maintained by Dun & Bradstreet to identify unique business establishements, worldwide. For each reference number ( or\" address\"), Dun & Bradsheet hold detailed marketing and credit information.
Name Name The name of the suppler.
SupplierID Identity A code assigned by the retailer to uniquely identify the supplier.
SupplierIsManufacturerFlag Flag A flag that indicates that this supplier is the MANUFACTURER of an item.

Back to Top

SupplierItem

This entity type assigns a supplier-specific item identifier to a retail item and provides the supplier-specific attributes of the item. The supplier item entity type is used to order merchandise items from a supplier price list, catalogue, etc. It provides the supplier's view of an item and uses the supplier's nomenclature in describing the items attribute

Tag

Type

Definition

AvailabilityStatusCode Code2 A code to signify the availability of the SUPPLIER ITEM.
CaseUPCEANNumber ProductCodeGlobal The UPC/EAN case code, eg UPC/EAN-14, EAN-128.
ColorDescription DescriptionShort The supplier's color description of the SUPPLIER ITEM.
Description DescriptionShort The description of the SUPPLIER ITEM.
MarketCostOverrideAllowedFlag Flag A flag that indicates (if true) that this SUPPLIER ITEM catalog cost may be superceded by a market cost (known only when the item is received). This flag is intended to support produce, fresh seafood and other perishable items with market costs that vary with every receipt.
ResponsibleBuyerID Identity The buyer responsible for the procurement of this SUPPLIER ITEM.
SaleUnitPerPackUnitCount Quantity The number of retail sale units in the supplier item pack. For example 24 cans of Coke (the retail sale units) in a case (supplier item pack) or 4 six packs (the retail sale units) in a case (supplier item pack).
SizeDescription DescriptionShort The size dimensions of the SUPPLIER ITEM.
StoreOrderAllowedFlag Flag A flag to indicate that the RETAIL STORE is permitted to order a particular SUPPLIER ITEM.
StoreReceiptAllowedFlag Flag An indicator to signify whether the RETAIL STORE is permitted to receive the SUPPLIER ITEM.
StyleDescription DescriptionShort The style description of the SUPPLIER ITEM.
SupplierItemID Identity The code assigned by the supplier to uniquely identify the ITEM

Back to Top

SupplierItemCatalogBaseCost

The supplier's catalog base cost (the cost before any promotions, allowances, charges, discounts, etc.) for the SUPPLIER ITEM.

Tag

Type

Definition

NetCostPerUnitAmount MoneyShortCost The published unit cost including allowances and charges for the item.
PerUnitAmount MoneyShortCost The published cost, excluding any allowances for discounts, for the SUPPLIER ITEM.
SupplierItemCostPerUnitTypeCode Code2 Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types include: SALE UNIT, PACK UNIT and SHIP UNIT. A single SUPPLIER ITEM may in effect have 1 to three SUPPLIER ITEM BASE COST entities associated with it.

Back to Top

SupplierItemCatalogBaseCostBreak

The supplier's quantity adjusted catalog base cost (the cost before any promotions, allowances, charges, discounts, etc.) for the SUPPLIER ITEM. This entity supports price breaks provided for buying larger quantities of an item.

Tag

Type

Definition

CostPerUnitAmount MoneyShortCost The revised cost price for each unit when the break point has been attained.
SupplierItemUnitBreakPointCount Quantity The break point in units at which a further discount can be attained by the retailer.

Back to Top

SupplierItemReceivingLevel

Defines the valid supplier item receiving levels supported within a store. For example 02-Retail Sale Unit, 04-Inner Pack Unit, 06-Outer Pack Unit and 08-Lading Unit. This is a lowest to highest level illustration.

Tag

Type

Definition

Description DescriptionShort A description of the type of material used for shipping the product to store. .
MaterialReceivingLevelCode Code4 A code to denote the level at which the item is received where level refers to a pallet, carton, or some other aggregation. This code is equivalent to the UCC-735 hierarchical-level-code.
Name Name The name of the type of material used for shipping the product to store.

Back to Top

SupplierItemReceivingUnit

Defines and describes valid material handling units for a supplier item. Material handling unit refers to how a supplier item is packed for shipping, receiving and breakdown into retail sale units.

Tag

Type

Definition

DepthCount Quantity Defines the depth of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
HeightCount Quantity Defines the height of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
WidthCount Quantity Defines the width of a supplier item pack unit in supplier-item-linear-measure-unit-codes.

Back to Top

SupplierItemReceivingUnitConversionRule

Defines a conversion rule to explode a higher level material receiving unit into a lower level. For example a pallet may be exploded into 24 cases and each case may be exploded into 24 retail sale units. Each of these conversions is defined in a conversion rule entity type instanc

Tag

Type

Definition

ConversionFactorCount Quantity The number of units within each shipment container. This factor is multiplied by the number of containers to provide the total number of units.
ConversionToRetailSaleUnitCount Quantity The number of retail units calculated by multiplying the conversion factor count and the number of containers.

Back to Top

SupplierItemStockItem

This entity identifies an association between a STOCK ITEM identified and managed internally by the retail store and a SUPPLIER ITEM with the intent of providing a cross reference between the internal and supplier view of a STOCK ITEM

Tag

Type

Definition

AssortmentDescription DescriptionShort The description of the assortment the item belongs to.
AssortmentFlag Flag A code to signify the assortment contained within the receiving pack, eg assorted colors, assorted sizes, etc. The retailer will normally predetermine the assortment with the supplier.
LastReceiptSaleByUnitCount QuantityTransactionCount A count of retail sale unit's last received from a particular supplier for an item.
LastReceiptSaleUnitBaseCost MoneyShortCost The unit base cost (i.e. the cost excluding charges and allowances) of a retail sale unit of an item when it was last received from a particular supplier. This is used to develop average cost when a given STOCK ITEM is supplied by several suppliers.

Back to Top

SupplierPricePromotionZone

An association between the RETAIL STORE and a SUPPLIER used to describe the price and promotional geographical zone a store has been assigned to by a supplier.

Tag

Type

Definition

FreightZoneCode Code4 A code to signify the freight charges to retail stores within a specific geographic zone
PriceZoneCode Code4 A code to signify the pricing policy for a specific geographic zone
PromotionalZoneCode Code4 A code to signify the pricing promotion policy for a specific geographic zone

Back to Top

SurveyQuestion

An inquiry of a customer's opinion.
Back to Top

Tare

TARE defines the weight of the container that must be subtracted from the gross weight in order to calculate net selling weight for items priced and purchased in weight unit of measures.

Tag

Type

Definition

BulkItemTareID Identity Uniquely identifies the tare property. This normally represented by a numeric code.
Count Quantity Defines the number of weight units of measure for the tare.
Description DescriptionShort Describes the tare.

Back to Top

TaxableGroup

A group of Items that share the same tax rates and application rules.

Tag

Type

Definition

Description DescriptionShort A description of the taxes represented in the group
Name Name The name of the tax group. The individual taxes that can be levied are listed by type as codes in the UCC code, Tax Type Code, data element 963.
TaxGroupID Identity A tax group which links a TAX AUTHORITY to the merchandise to which the tax applies.

Back to Top

TaxAuthority

A government authority that levies sales taxes and on whose behalf the store collects these sales taxes.

Tag

Type

Definition

Name Name The name of the TAX AUTHORITY.
RoundingCode Code2 A code that indicates how tax is to be rounded when calculated.
RoundingDigitsQuantity Quantity The number of digits to which rounding is to be calculated.
TaxAuthorityID Identity A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a government body.

Back to Top

TaxExemptionModifier

A line item modifier to the SALES TAX LINE ITEM component of a RETAIL TRANSACTION that provides supplementary data regarding tax exemptions and exceptions for a specific sales tax line item.

Tag

Type

Definition

CertificateHolderName Name The name of the individual or organization who holds the tax exemption certificate.
CertificateNumber Identity The certificate number assigned to a purchaser by a taxing jurisdiction (state, county, etc). Sometimes referred to as Tax Identification Number..
ExemptionAmount Money The amount of TAX the CUSTOMER is exempt from paying.
ReasonCode Code2 A reason code for the tax exemption. Typically the CUSTOMER belongs a special group, such foreign diplomats, religious bodies, etc. The bearer must have a certificate to qualify for the tax exemption. AUTHORITY.

Back to Top

TaxExemptOrganization

An organization whose purchases are exempt from sales tax.

Tag

Type

Definition

TaxExemptOrganizationTypeCode Code2 An indicator of the type of tax exemption this organization holds.

Back to Top

TaxGroupRule

A rule that prescribes how a sales tax is to be applied to a group of retail items.

Tag

Type

Definition

CompoundFlag Flag An indicator of whether or not this tax should be applied on top of other taxes.
CompoundSequenceNumber LineNumber A sequential number that indicates the order to which taxes should be applied.
Description DescriptionShort A description as to how and when taxes are applied to ITEMs sold by the RETAIL STORE.
Name Name The name of the tax rule that establishes as, how and when taxes are applied.
TaxedAtTransactionLevelFlag Flag An indicator of whether or not the tax applies at that transaction level.
TaxOnGrossAmountFlag Flag An indicator of whether or not tax applies to the gross amount.
TaxRuleSequenceNumber LineNumber A squential number for a Tax Group Rule.

Back to Top

TaxLineItem

A line item component of a RETAIL TRANSACTION that records the charging and offsetting liability credit for sales tax on merchandise items and services sold by the store or debit for merchandise returned to the store.

Tag

Type

Definition

TaxableAmount Money The amount of the line for which tax is applicable.
TaxAmount Money The monetary amount of sales TAX calculated by applying a set percentage to the line item. These percentages can vary by county, state and country.

Back to Top

TaxRate

A rate or amount of tax which is applied to retail sales.

Tag

Type

Definition

Amount Money The tax rate if expressed as a flat amount.
Percent Percent The tax rate, expressed as a percentage.
TaxRateMinimumTaxableAmount <unknown> The minimum amount for which tax is to be applied.

Back to Top

Telephone

A telephone, cellular, pager, fax or other telecommunication device number.

Tag

Type

Definition

AreaCode PhoneNumberAreaCode A code that identifies a geographic grouping of telephone numbers within the US and Canada.
CountryCode PhoneNumberCountryCode A code assigned by the telephone industry to a country or other region.
ExtensionNumber PhoneNumberExtension Addtional numbers required to reach a person, extension, or voice mailbox.
TelephoneNumber PhoneNumberLocal A number that is used to contact a PARTY via a telephone or device.

Back to Top

TelephoneType

A classification of telephone numbers according to what they are assigned to - telephone, cell phone, pager, fax, TTY, etc.

Tag

Type

Definition

Description DescriptionNarrative A description of a categortization of telephones or other devices.
TelephoneTypeID Identity A category or telephone (number) types (cell, fax, voice, etc.)

Back to Top

TemporaryPriceChange

A type of ITEM - MAINTENANCE EVENT that is a temporary change to the current retail price for a specific time period, usually for the duration of a promotion. The WORKSTATION will record the net sales of these ITEMs.

Tag

Type

Definition

SaleUnitAmount MoneyShortRetail The amount (either monetary or percent) to be used to change or replace the current selling price for a sale unit of the item.
SaleUnitAmountTypeCode Code2 A code to define how the temporary-price-change-sale-unit-amount is to be interpreted. Valid values include: PCT percent of current retail price to be added to or subtracted from the current retail to arrive at a selling price; AMT, flat monetary amount to be added to or subtracted from the current retail to arrive at a selling price; and AMTREPL, a retail sale unit price amount that is to replace the current selling pric

Back to Top

TemporaryPriceChangeItem

This association between a TEMPORARY PRICE CHANGE and ITEM establishes the application of a new permanent price (or percentage or monetary increase or decrease) for an item. A TEMPORARY PRICE CHANGE is posted to an ITEM for a predefined period of time marked by beginning and ending date and time. TEMPORARY PRICE CHANGEs are posted to an item and are applied in all transaction involving that item.
Back to Top

Tender

Tender includes all the forms of payment that are accepted by the RETAIL STORE in settling sales and other transactions.

Tag

Type

Definition

AcceptanceForPaymentOnAccountFlag Flag A flag to signify that a certain tender type can be accepted to credit a customer's account.
AccountIdentificationRequiredFlag Flag A flag to signify that the status of the account has to be checked before this method of tender can be accepted.
AuthorizationExpirationDateRequiredFlag Flag Defines a requirement that this type of tender requires an authorization expiration date and that it must be recorded at the time of settlement.
AuthorizationMaximumWaitAllowedSecondsCount Quantity Maximum time delay (measured in seconds) allowed to wait for external tender authorization for this TENDER type.
AuthorizationMethodCode Code2 A code to signify the method of authorization. For example, checks may be authorized by either a third party or by validation against the customer's driving license.
AuthorizationRequiredFlag Flag A flag that signifies whether authorization is required before a specific tender can be accepted.
ChangeThresholdAmount Money The maximum change that can be offered to a customer for a specific tender type.
CheckEncodingFlag Flag A flag to denote whether a check is encoded with the bank deposit account and the reserve and transit number to facilitate automated handling by the EXTERNAL DEPOSITORY.
CustomerIdentificationRequiredFlag Flag A flag to signify that customer identification is required, such as driver's license.
CustomerSignatureRequiredFlag Flag A flag that requires the customer to sign the tender( check) or resultant voucher (card) in the presence of the operator.
Description DescriptionShort Description of the tender type.
EndorsementRequiredFlag Flag A flag to signify that an endorsement, normally the customer's signature, is required before a specific tender type can be accepted.
ItemRestrictionsApplyFlag Flag A flag to signify that specific groups of items cannot be purchased using certain tender types. For example, food stamps cannot be used to purchase alcohol or tobacco items.
LoanPermissabilityFlag Flag A flag to signify whether a specific transaction can be paid for on credit.
LocalCurrencyAvailabilityFlag Flag A flag to signify that change can be offered to the customer in the currency tendered.
MagneticStripeReaderRequiredFlag Flag A flag to signify that the tender type has to be inserted into the magnetic card reader. For example, credit and debit cards.
MaximumAcceptAmount Money The maximum amount that can be accepted for a specific tender type.
MinimumAcceptAmount Money The minimum value that can be accepted for an individual tender. For example, certain retailers will not accept card payments below $5.
OffLineTenderCeilingApprovalAmount Money The maximum value of an individual tender that can be accepted without authorization.
OffLineTenderFloorApprovalAmount Money The value of an individual tender below which approval is not required.
OnLineTenderCeilingApprovalAmount Money The maximum amount of an individual tender type that can be authorized either in-house or by a third party. This especially applies to checks where the check authorization company sets a ceiling by retailer.
OnLineTenderFloorApprovalAmount Money The value of an individual tender above which authorization has to be sought before acceptance. This limit is normally referred to as the floor limit and may vary by merchandise and store.
OpenCashDrawerRequiredFlag Flag A flag that signifies that the cash drawer opens if a certain specific tender type is offered by the customer. For example, cash. Other forms of tender, such as checks, can be inserted into the till through a slit in the cash drawer door without the cash drawer opening, or alternatively, into a separate security device adjacent to the register.
OverrideTriggerMaximumAmount Money A trigger to override the maximum amount normally accepted for a specific tender type.
PersonalIdentificationNumberRequiredFlag Flag A flag that requires the customer to enter a personal identification number (PIN) to validate the method of payment. PINs are normally required for debit card payments.
RealtimeBalanceUpdateFlag Flag A flag to signify that the customer's account is updated in real-time.
SerialIdentificationNumberRequiredFlag Flag A flag to signify that the serial number of the tender type has to be captured as part of the tender process. Examples include gift certificates, checks, etc.
TenderTypeCode Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
UnitCountRequiredFlag Quantity A flag to signify that specific tender types need to be counted and recorded by the operator prior to a pickup.

Back to Top

TenderAccountApprovalReference

Repository of external account numbers against which an individual tender can be approved or rejected depending on the status of that account.

Tag

Type

Definition

AccountNumber Identity The CUSTOMER's account number against which previous tender authorization is held.
CeilingLimitAmount Money The monetary amount up to which approval can be sought.
CreateDateTimestamp TimeStampAudit The date and time this tender approval reference was created.
LastApprovalGivenDateTimestamp TimeStampAudit The date and time this tender approval reference last approved a tender payment at the store.
LastUpdateDateTimestamp TimeStampAudit The date and time the tender approval reference was last modified.
TenderAuthorizationFollowUpActionCode Code2 A retailer defined code that indicates that follow up action may be required by the retailer after accepting or rejecting a customer tender.
TenderAuthorizationLastActionCode Code2 A retailer defined code that indicates the last action taken on this approval reference. Examples include an increase or decrease in the ceiling limit amount
TenderAuthorizationPermissionFlag Flag Flag that grants or revokes permission to accept this tender for this account.
TenderIssuingBankID Identity The bank or financial services organization that issued the credit or debit card.

Back to Top

TenderChangeLineItem

A line item component of a POS TRANSACTION that records the tender returned to a customer as change as part of the settlement of a TRANSACTION.

Tag

Type

Definition

Amount Money A line item for the monetary amount due back to a CUSTOMER when an overtender is made in exchange for ITEMs.

Back to Top

TenderClass

A type of tender with common characteristics.

Tag

Type

Definition

TenderClassCode Code2 A code to denote a group of tenders with common characteristics, eg charge cards, certificates, etc.
TenderClassDescription DescriptionShort A description of a group of tenders with common characteristics.

Back to Top

TenderControlTransaction

A type of TRANSACTION that records the physical movement of tender from one tender repository to another.

Tag

Type

Definition

ExternalDepositReceiptFlag Flag Flag determines whether this transaction is a deposit to or receipt from a bank or other external tender repository.
PickupOrLoanCode Code2 A code to determine whether this is a pick up or loan.
ReasonCode Code2 The reason for this tender control transaction (e.g. normal end of shift, end of day, special audit, etc.)

Back to Top

TenderControlTransactionTenderLineItem

This is a line item in financial transactions involving tender transfers into or out of the store safe that are NOT part of the pickup and loan tender transfer between tills and the store safe

Tag

Type

Definition

Amount Money The monetary amount of the FINANCIAL ACCOUNTING TRANSACTION LINE ITEM.
Count QuantityTransactionCount The number of tender units involved in the FINANCIAL ACCOUNTING TRANSACTION LINE ITEM, eg 20x$100 bills. \

Back to Top

TenderDepositTransaction

A periodic collection of tender that is counted, verified and physically transferred to an account held on behalf of the retail store by a bank or other DEPOSITORY
Back to Top

TenderLineItem

A line item component of a POS TRANSACTION that records the settlement of that transaction with an offsetting, valid tender type.

Tag

Type

Definition

Amount Money The monetary value of the tender submitted by the CUSTOMER.
TenderAccountNumber Identity The account number of the customer tendering the TENDER. This account number is retained as a means of an authorization history against which future payments can be referenced.

Back to Top

TenderLoanTransaction

A FINANCIAL ACCOUNTING TRANSACTION that records the movement of tender from the store safe to a till.

Tag

Type

Definition

Amount Money The monetary value of the loan made to the TENDER REPOSITORY.
ReasonCode Code2 The reason code for the tender loan made to the TENDER REPOSITORY.

Back to Top

TenderPickupTransaction

A type of FINANCIAL ACCOUNTING TRANSACTION that records the movement of tender from a till to the store safe.

Tag

Type

Definition

Amount Money The amount of tender pickup.
ReasonCode Code2 The reason code for the tender pickup, such as too much cash in TILL.

Back to Top

TenderRepository

Describes the types of physical tender containers used in a RETAIL STORE. Tender repository generally includes assets like, store safe(s), tills, etc.

Tag

Type

Definition

Description DescriptionShort The textual description of the TENDER REPOSITORY.
Name Name The name of the TENDER RESPOSITORY.
TenderRepositoryID Identity The unique identifier for the TENDER RESPOSITORY.

Back to Top

TenderRepositoryClass

Defines the type of TENDER REPOSITORY, eg SAFEs, TILLs, etc.

Tag

Type

Definition

Description DescriptionShort The description of the type of TENDER REPOSITORY.
TenderRepositoryTypeCode Code2 A code to denote the type of TENDER REPOSITORY.

Back to Top

TenderRepositoryTenderAccount

An account held on the STORE FINANCIAL LEDGER of all TENDER movements by repository.
Back to Top

TestDelivery

A type of TRANSATION that records the clearing of a FUELLING TRANSACTION without accepting payment because the fuelling transaction was for testing or calibrating the FUELLING POINT. The fuel delivered may or may not have been put back into a stora
Back to Top

ThirdPartyCustomerIdentification

A specific KEY CUSTOMER's identification number or card.

Tag

Type

Definition

CustomerIdentificationItemNumber LineNumber A sequential number used to distinguish one THIRD PARTY CUSTOMER ID.
ExpirationDate DateCalendar The date that a CUSTOMER's third party ID is no longer valid.
Number DescriptionShort The account, member, or other number on a third party ID.

Back to Top

ThirdPartyCustomerIdentificationType

A categorization of 3rd party customer identification cards or numbers given by a customer to identify himself.

Tag

Type

Definition

Description DescriptionNarrative A description of a categorization of third party IDs.
ThirdPartyCustIdentificationTypeName Name The name or label given to a a third party ID.

Back to Top

Till

A type of TENDER REPOSITORY that is a drawer insert, operationally associated with a WORKSTATION and optionally an EMPLOYEE. It is used to keep cash and other TENDER collected through RETAIL TRANSACTIONS and used to make change.

Tag

Type

Definition

DefaultOpeningCashBalanceAmount Money The opening TENDER balance with which the TILL will typically start.
MaximumAllowedTenderAmount Money The maximum amount of TENDER allowed in the TILL at any one time.
StatusCode Code2 A status code to denote the status of the TILL, eg active, inactive.
StatusDateTimeStamp TimeStampAudit A time and date stamp to denote the last change in the status of the TILL.

Back to Top

TillHistory

A collection of monetary and operational totals used to track the activity volume of a till between TILL SETTLEMENT TRANSACTIONS. The period covered by TILL HISTORY is delineated by a TILL SETTLEMENT TRANSACTION which when initiated sets a TILL state to reconciling and when completed resets the state of a TILL to cleared for business.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount of container deposits collected by TILL for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by TILL for each REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary amount of negative sales by TILL for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary amount of positive sales by TILL for each REPORTING PERIOD.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax by TILL for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by TILL for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids by TILL for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of markdowns by TILL for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by TILL for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees by TILL for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales by TILL for each REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments on account collected by TILL for each REPORTING PERIOD.
PettyCashDisbursementTotalAmount Money The total monetary amount of cash disbursements by TILL for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of post transaction voids by TILL for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by TILL for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds by TILL for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns by TILL for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by TILL for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount by TILL for each REPORTING PERIOD.
TaxTotalAmount Money The total tax amount recorded by TILL for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary amount of tender loans by TILL for each REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by TILL for each REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by TILL for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The number of employee discount line items by TILL for each REPORTING PERIOD.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by TILL where no sales are being recorded for each REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway payments on account collected by TILL for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by TILL for each REPORTING PERIOD.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by TILL for each REPORTING PERIOD.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by TILL for each REPORTING PERIOD.
TotalLineItemOpenDepartmentPercentage Percent The percentage of ITEMs recorded through an open department compared to the total ITEMs by TILL for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by TILL for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by TILL for each REPORTING PERIOD.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by TILL for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids by TILL for each REPORTING PERIOD.
TotalLockTime QuantityShortCountSeconds The total time expressed in minutes where a WORKSTATION is locked even though an OPERATOR remains signed-on by TILL for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of markdowns recorded by TILL for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discount line items by TILL for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees line items by TILL for each REPORTING PERIOD.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions by TILL for each REPORTING PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account collected by TILL for each REPORTING PERIOD.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of cash disbursement line items by TILL for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post-transaction voids by TILL for each REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by TILL for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by TILL for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by TILL for each REPORTING PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes of the time taken to either scan or key line item sales by TILL for each REPORTING PERIOD.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales by TILL for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by TILL for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions by TILL for each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by TILL for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups by TILL for each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions by TILL for each REPORTING PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by TILL for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items by TILL for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids by TILL for each REPORTING PERIOD.

Back to Top

TillSettlementTransaction

A transaction that records the closing balances for the till. This is associated with the cash count of the TILL and reconciliation with the sales recorded by the WORKSTATION for that EMPLOYEE.
Back to Top

TillTaxHistory

A collection of tax totals for a tax authority by till for a tender reconciliation period.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total monetary amount of taxable sales by TILL for each REPORTING PERIOD.
TaxCollectedTotalAmount Money The total monetary amount of tax collected by TILL for each REPORTING PERIOD. \
TaxExemptSaleTotalAmount Money The total monetary amount of tax exempt sales by TILL for each REPORTING PERIOD.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions by TILL for each REPORTING PERIOD.

Back to Top

TillTender

The tender by TILL.

Tag

Type

Definition

CloseAmount Money The monetary amount of till tender by TILL at the end of the REPORTING PERIOD.
DepositAmount Money The total monetary amount of till tender deposited by TILL between each REPORTING PERIOD.
DepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited by TILL between each REPORTING PERIOD.
LoanAmount Money The total monetary amount loaned by TILL between each REPORTING PERIOD.
LoanMediaUnitCount QuantityTransactionCount The total number of tender media units loaned by TILL in each REPORTING PERIOD.
MediaCloseCount QuantityTransactionCount The number of tender media units by TILL at the end of the REPORTING PERIOD.
MediaOpenCount QuantityTransactionCount The number of tender media units by TILL at the start of the REPORTING PERIOD.
MediaOverCount QuantityTransactionCount The number of tender media overage units by TILL at the end of the REPORTING PERIOD.
MediaShortCount QuantityTransactionCount The number of tender media shortage units in the TILL at the end of the REPORTING PERIOD.
OpenAmount Money The monetary amount of till tender by TILL at the start of the REPORTING PERIOD.
OverAmount Money The monetary amount of of tender overages by TILL at the end of the REPORTING PERIOD.
PickupAmount Money The monetary amount of pickups made by TILL at the end of the REPORTING PERIOD.
PickupMediaUnitCount QuantityTransactionCount The monetary amount of pickups made by TILL at the end of the REPORTING PERIOD.
ShortAmount Money The monetary amount of of tender shortages by TILL at the end of the REPORTING PERIOD.

Back to Top

TillTenderHistory

A collection of tender type accumulators by till tender accumulation period. This entity is used to support till tender accountability.

Tag

Type

Definition

DepositMediaUnitCount QuantityTransactionCount The number of tender media units deposited by TILL for each REPORTING PERIOD.
DepositTotalAmount MoneyShortRetail The total number of tender media units deposited by TILL for each REPORTING PERIOD.
LoanMediaTotalAmount MoneyShortRetail The total monetary amount of tender loaned to the TILL for each REPORTING PERIOD.
OverTotalAmount MoneyShortRetail The total amount of overage recorded by TILL for each REPORTING PERIOD.
PickupMediaTotalAmount MoneyShortRetail The total monetary amount of tender picked up from the TILL for each REPORTING PERIOD.
PickupMediaUnitCount QuantityTransactionCount The total number of tender pickups by TILL for each REPORTING PERIOD.
ShortTotalAmount MoneyShortRetail The total amount of underage recorded by TILL. for each REPORTING PERIOD.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of tender media units for each REPORTING PERIOD.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender media units loaned to the TILL for each REPORTING PERIOD.
TotalTenderMediaCount QuantityTransactionCount The total number of tender media units by TILL for each REPORTING PERIOD.
TotalTenderMediaOverCount QuantityTransactionCount The number of tender media overage units by TILL for each REPORTING PERIOD.
TotalTenderMediaShortCount QuantityTransactionCount The number of tender media underage units in the TILL for each REPORTING PERIOD.

Back to Top

TimeGroup

A set of times on particular days of the week.

Tag

Type

Definition

Name String The human readable name for the time group
TimeGroupID Identity A unique identifier for the time group

Back to Top

TimeGroupTimePeriod

A many-to-many resolving entity
Back to Top

TimePeriod

A period of time on a particular day of the week.

Tag

Type

Definition

DayOfWeek Code A 2 character code denoting the day of the week that the time period falls on
EndTime Datetime The time of day that the time period stops.
Name Name A human readable name for the time period
StartTime Datetime The time of day that the time period commences
TimePeriodID Identity A unique identifier for the time period.

Back to Top

TotalPurchaseMarketBasketEligibilityRule

A generic rule that defines sell unit count and/or sell unit retail value trigger points for triggering the application of a price derivation rule in a sale transaction. This rule is based on the sales volume of a customer's total purchase and is not dependent on any specific item or items. This rule specifies the criteria for applying price derivation rules -- not the rules them selves.

Tag

Type

Definition

MarketBasketRuleID Identity A unique identifier for the market basket eligibility rule.
PriceChangeTriggerTypeCode Code2 Identifies the type of trigger (i.e. the condition that causes this rule to be applied to a point of sale transaction). The trigger type for example may be based on a transaction total sell unit count for an item or it may be based on the total retail value being purchased (before application of this rule).
TransactionItemQuantityTriggerCount Quantity The number of sell units required to cause application of this price change rule.
TransactionItemTotalRetailTriggerAmount Money The extended retail value of sell units required to cause application of this price change rule -- before application of this rule.
TransactionRandomDrawingTriggerMethodTypeCode Code2 Defines the method to be used to determine market basket eligibility that is determined by a random drawing or rub off ticket or some other random number based approach to choosing a price change to be applied to a complete customer purchase.

Back to Top

TotalPurchaseMarketBasketPriceDerivationRuleEligibility

This entity associates a market basket eligibility rule with a specific price derivation rule. This association links the rule with the condition triggering its application.

Tag

Type

Definition

AccountingDispositionCode Code4 Determines whether the price derivation for this rule is treated as a revaluation of merchandise (in which case it impacts the stock ledger) or an expense (in which case it impacts the store financial ledger).
ConcurrenceDispositionCode Code4 Determines how the retail price reduction or increase calculated as the result of the application of the PRICE DERIVATION RULE will be handled where more than one rule are applied within a sales transaction. Valid examples of values include: - Compound the price changes; Select the single best deal for the customer (i.e. the one rule that by itself yields the lowest price .
EffectiveDateTimestamp TimeStampEffective The time and date when the market basket price derivation rule becomes effective
ExpirationTimeDateStamp TimeStampExpiration The time and date when the market basket price derivation rule no longer applies
PriceChangeRuleID Identity A type of price change rule.

Back to Top

Trade-In-KindTenderLineItem

This rather unique entity is intended to support 3rd World retailers who accept fowl, pigs, goats, gold, wives, daughters, sons, uncles, diamonds and other commodities in exchange for merchandise.

Tag

Type

Definition

Address1 Address The first line of the address of the person offering the traded-in item.
Address2 Address The second line of the address of the person offering the traded-in item.
CertificateID Identity The unique identifier of the certificate bearing the agreed valuation amount of the traded-in item. This certificate will be accepted in part or whole exchange of another item in this or another company store.
City City The city component of the address of the person offering the traded-in item.
Name Name The name of the person offering the traded-in item.
PostalCode PostalCode The postal address or zip code of the address offering the person of the traded-in item.
ProofOfIdentityID Identity A unique reference id from the proof of identity proffered by the customer.
ProofOfIdentityTypeCode Code2 A code to signify the nature of the proof of identity proffered by the customer to confirm name, address and ownership of the trade-in item.
State State Thestate component of the address of the person offering the traded-in item.
TelephoneAreaCode PhoneNumberAreaCode The telephone area code of the person of the traded-in item.
TelephoneCountryCode PhoneNumberCountryCode The telephone country code of the person of the traded-in item.
TelephoneLocalNumber PhoneNumberCountryCode The telephone local number of the person of the traded-in item.
ValuationMonetaryAmount Money The monetary valuation of the traded-in item. The valuation can be either valued instore, to a central location or a third party.

Back to Top

Trade-InType

Defines valid types of trade-ins accepted by the store in exchange for merchandise.

Tag

Type

Definition

Description Name A text description of the traded-in item.
TradeInTypeCode Code2 Defines the permitted trade-in type

Back to Top

Transaction

A record of business activity that involves a financial and/or merchandise unit exchange or the granting of access to conduct business at a specific device, at a specific point in time for a specific employee.

Tag

Type

Definition

BeginDateTimestamp TimeStampEffective The time and date a transaction is initiated.
EndDateTimestamp TimeStampExpiration The time and date stamp a transaction is completed.
KeyedOfflineFlag Flag An indicator as to whether or not this transaction data was captured during a regular on-line POS session or was entered during an off-line period.
TrainingFlag Flag A flag to signify whether the workstation is in training mode.
TransactionSequenceNumber Identity A unique, non-significant, automatically assigned sequential number used to identify a TRANSACTION within the context of a WORKSTATION and a BUSINESS PERIOD

Back to Top

TransactionType

A specific action that may be captured through a work station.

Tag

Type

Definition

TransactionTypeCode Code6 A code to denote the type of TRANSACTION, eg CONTROL, FINANCIAL, and RETAIL.

Back to Top

TransferInDocument

A type of INVENTORY CONTROL DOCUMENT that is completed when there is no accompanying transfer-out document with the shipment of merchandise being received from another store. It is an exception document much like a receiving document without a Purchase Order.
Back to Top

TransferOutDocument

A type of INVENTORY CONTROL DOCUMENT prepared by the originating store listing the items it is sending to the receiving store. \
Back to Top

UnitOfMeasure

Identifies and describes valid units of measurements for counting RETAIL ITEMs and SUPPLIER ITEMs.

Tag

Type

Definition

Description DescriptionShort Description assigned to this unit of measure.
EnglishMetricFlag Flag Indicates whether this unit of measure is part of the English or Metric system of measurements.
Name Name Name assigned to this unit of measure.
UnitOfMeasureCode Code2 The code used to specify the units in which a value is being expressed, or manner in which a measurement has been taken. This code relates to the UCC data element 355.
UnitOfMeasureTypeCode Code2 Indicates what this unit of measure entity type instance measures. Examples include weight or mass, length, cube (length x width x depth), volume, discrete items (each), etc

Back to Top

Worker

A person who provides services to a retail store.

Tag

Type

Definition

WorkerTypeCode Code2

Back to Top

WorkGroup

WORK GROUP entity contains job classifications for purposes of grouping EMPLOYEEs

Tag

Type

Definition

Description DescriptionShort Describes the classification for the grouping of store EMPLOYEEs. Examples may include cashier, sales associate, manager, regional manager.
WorkGroupID Identity A unique identifier for a work classification group to which EMPLOYEEs are assigned.

Back to Top

Workstation

A device used as an as interface to any store business function . This includes the capture and storage of TRANSACTIONS and operational performance reporting

Tag

Type

Definition

ManufacturerName Name The name of the MANUFACTURER of the WORKSTATION. Currently most MANUFACTURERs simply assembly the components and place their badge on the device.
TerminalDeviceAddress Address The network node connection address assigned to the WORKSTATION.
TerminalFixedAssetNumber Identity The asset identifier assigned to the WORKSTATION by the RETAILER.
TerminalModelNumber Name The model number of the WORKSTATION.
TerminalStatusCode Code2Status The status code of the WORKSTATION, i.e. active, closed, off-line, etc.
TillCount QuantityShortCount The number of tills that can be supported through the one WORKSTATION. In most instances each WORKSTATION has one. In cases such as duty free stores or where the retailer wants to maintain operator accountability there may be two.
TrainingModeFlag Flag A flag to denote whether the WORKSTATION is in normal operation or training mode. In the latter none of the history accumulators are updated.
TypeCode Code4 A code to denote the type or use of WORKSTATION, such as POS register, goods receipt terminal.
WorkstationID Identity The unique identifier for the WORKSTATION, typically the serial number.

Back to Top

WorkstationHistory

A collection of accumulators by WORKSTATION for a REPORTING PERIOD This entity is used to support WORKSTATION accountability.

Tag

Type

Definition

ContainerDepositTotalAmount Money The total monetary amount of deposit container deposits collected by WORKSTATION for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by WORKSTATION for each REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary gross negative sales amount recorded by WORKSTATION for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by WORKSTATION for each REPORTING PERIOD.
GrossSalesExTaxTotalAmount Money The total gross sales excluding tax recorded by WORKSTATION for each REPORTING PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliation counts by WORKSATION for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by WORKSTATION for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by WORKSTATION for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by WORKSTATION for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by WORKSTATION for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by WORKSTATION for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by WORKSTATION for each REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by WORKSTATION for each REPORTING PERIOD.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash payments disbursed by WORKSTATION for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary value of post-transaction voids by WORKSTATION for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by WORKSTATION for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds recorded by WORKSTATION for each REPORTING PERIOD.
ResumedTotalAmount Money The total monetary amount of suspended transactions resumed by WORKSTATION for each REPORTING PERIOD.
ResumedTransactionCount QuantityTransactionCount The total number of suspended transactions resumed by WORKSTATION for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns recorded by WORKSTATION for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by WORKSTATION for each REPORTING PERIOD.
SuspendedTotalAmount Money The total monetary amount of suspended transactions by WORKSTATION for each REPORTING PERIOD.
SuspendedTransactionCount QuantityTransactionCount The total number of suspended transactions by WORKSTATION for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount recorded by WORKSTATION for each REPORTING PERIOD.
TaxTotalAmount Money The total tax amount recorded by WORKSTATION for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of deposit container deposits collected by WORKSTATION for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee item line discounts by WORKSTATION for each REPORTING PERIOD.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by WORKSTATION where no sales are being recorded for each REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway payments collected by WORKSTATION for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by WORKSTATION for each REPORTING PERIOD.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed at the point of sale compared to the total sold ITEMs by WORKSTATION for each REPORTING PERIOD.
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by WORKSTATION for each REPORTING PERIOD.
TotalLineItemOpenDepartmentPercentage Percent The percentage of ITEMs recorded through an open department compared to the total ITEMs by WORKSTATION for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides recorded by WORKSTATION for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by WORKSTATION for each REPORTING PERIOD.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by WORKSTATION for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded by WORKSTATION for each REPORTING PERIOD.
TotalLockTime QuantityShortCountSeconds The total time expressed in minutes when the WORKSTATION is locked but the OPERATOR is logged onto the WORKSTATION for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of price markdowns made by WORKSTATION for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous line items by WORKSTATION for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by WORKSTATION for each REPORTING PERIOD.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions by WORKSTATION for each REPORTING PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments collected by WORKSTATION for each REPORTING PERIOD.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of petty cash line item payments disbursed by WORKSTATION for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of the transaction voids by WORKSTATION for each REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by WORKSTATION for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds recorded by WORKSTATION for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns recorded by WORKSTATION for each REPORTING PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying line items into the WORKSTATION for each REPORTING PERIOD.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales by WORKSTATION for each REPORTING PERIOD.
TotalSendCheckAmount Money The total monetary amount of send checks recorded by WORKSTATION for each REPORTING PERIOD.
TotalSendCheckCount QuantityTransactionCount The total number of send checks recorded by WORKSTATION for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of operator sign-offs on this WORKSTATION for each REPORTING PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of operator sign-ons on this WORKSTATION for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by WORKSTATION for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by WORKSTATION for each REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans made to the WORKSTATION for each REPORTING PERIOD.
TotalTenderOverAmount Money The total monetary amount of tender overages by WORKSTATION for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number amount of tender pickups from this WORKSTATION for each REPORTING PERIOD.
TotalTenderUnderAmount Money The total monetary amount of tender shortages by WORKSTATION for each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions by WORKSTATION for each REPORTING PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by WORKSTATION for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items recorded by WORKSTATION for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary value of transaction voids by WORKSTATION for each REPORTING PERIOD.

Back to Top

WorkstationResource

WORKSTATION-RESOURCE defines the resources that can be performed on the WORKSTATION.

Tag

Type

Definition

ReadAccessLevel Code2 An indicator to signify that read access is granted to the referenced WORKSTATION for the corresponding resource identified in this record. Read access limitation may be set by, for example, no access, group access, user access, etc.
WriteAccessLevel Code2 An indicator to signify that write access is granted to the WORKSTATION for the corresponding resource identified in this record. Write access limitation may be set by, for example, no access, group access, user access, etc.

Back to Top

WorkstationRule

A rule governing the type and size of transactions that may be performed at a WORKSTATION.

Tag

Type

Definition

AboveUpperLimitActionRequiredTypeCode Code2 A code that specifies the type of supervisory action required when the WORKSTATION records an item movement above an upper limit.
ActionApprovalByTypeCode Code2 A code to signify the type of approval granted.
BelowLowerLimitActionRequiredTypeCode Code2 A code that specifies the type of supervisory action required when the WORKSTATION records an item movement below a lower limit.
LowerLimitAmount Money A WORKSTATION RULE that refers to a lower limit amount, below which supervisory approval is required.
MultiplierAmount Quantity A rule that specifies the amount by which a certain monetary amount can be multiplied. For example coupons can be tripled in value as part of a promotion.d
MultiplierMultiplicandTypeCode Code2 A code to signify how much a multiplicand can be multiplied. For example coupons can be doubled in value up to a coupon value of 50c. Beyond that value the coupon is accepted at its face value.
Name Name A label for a rule that may limit sales at a specific workstation.
UpperLimitAmount Money A WORKSTATION RULE that refers to an upper limit amount, above which supervisory approval is required. This can apply to individual item sale or the whole TRANSACTION.
WorkstationGroupID Identity A unique identifier for a group of WORKSTATIONs. This could refer to the WORKSTATIONs at the checkout, delicatessen, customer service or in the goods receiving area of the store.
WorkstationRuleNumber Identity A reference number for a specific WORKSTATION RULE.
WorkstationRuleTypeCode Code2 A code that refers to a specific WORKSTATION RULE type.

Back to Top

WorkstationRuleApplication

An association indicating applicability of a rule to a workstation.

Tag

Type

Definition

CreateDateTimestamp TimeStampEffective The time and date on which a specific WORKSTATION RULE is created.
EffectiveDate DateCalendar The date on which a specific WORKSTATION RULE becomes effective.
ExpirationDate DateCalendar The date on which a specific WORKSTATION RULE expires.

Back to Top

WorkstationRuleOverrideHistory

A transaction record of which WORKSTATION RULES are overriden and by which EMPLOYEE.

Tag

Type

Definition

OverrideFlag Flag A flag to signify that a certain limit has been overriden.

Back to Top

WorkstationRuleTender

A limitation for a specific WORKSTATION on what types of tenders may be accepted. For instance, a workstation without a card reader may be restricted to cash and checks only.
Back to Top

WorkstationTaxHistory

A collection of tax totals for a tax authority by workstation for a reporting period.

Tag

Type

Definition

TaxableSaleTotalAmount Money The total monetary amount of taxable sales by WORKSTATION for each REPORTING PERIOD.
TaxCollectedTotalAmount Money The total monetary amount of tax collected by WORKSTATION for each REPORTING PERIOD.
TaxExemptSaleTotalAmount Money The total monetary amount of tax exempt sales by WORKSTATION for each REPORTING PERIOD.
TaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions by WORKSTATION for each REPORTING PERIOD.

Back to Top

WorkstationTenderHistory

A collection of tender type accumulators by WORKSTATION for a REPORTING PERIOD. This entity is used to support workstation tender accountability.

Tag

Type

Definition

DepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited on behalf of that WORKSTATION for each REPORTING PERIOD.
DepositTotalAmount Money The total monetary value of tender pickup media recorded by WORKSTATION for each REPORTING PERIOD.
LoanMediaTotalAmount Money The total monetary value of tender media loans recorded by WORKSTATION for each REPORTING PERIOD.
OverTotalAmount Money The total monetary value of tender overages recorded by WORKSTATION for each REPORTING PERIOD.
PickupMediaTotalAmount Money The total monetary value of tender media pickups recorded by WORKSTATION for each REPORTING PERIOD.
ShortTotalAmount Money The total monetary value of tender underages recorded for that WORKSTATION for each REPORTING PERIOD.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of the number of tender media units for that WORKSTATION for each REPORTING PERIOD.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender loan media units collected from WORKSTATION for each REPORTING PERIOD.
TotalTenderMediaCount QuantityTransactionCount The total number of tender pickup media units recorded by WORKSTATION for each REPORTING PERIOD.
TotalTenderMediaOverCount QuantityTransactionCount The total number of tender media unit overages recorded by WORKSTATION for each REPORTING PERIOD.
TotalTenderMediaShortCount QuantityTransactionCount The total number of tender media unit shortages recorded by WORKSTATION for each REPORTING PERIOD.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units recorded by WORKSTATION for each REPORTING PERIOD.

Back to Top

WorkstationTimeActivityHistory

A set of time-bounded totals used to track the operational performance of a workstation primarily for workforce planning and service level planning. The time-bounded totals typically are for 6, 10 or 15 minute intervals.

Tag

Type

Definition

NetSalesTotalAmount Money The net sales amount recorded by the WORKSTATION in the defined time period intervals.
SignOnTimeMinutesCount QuantityTransactionCount The number of minutes since the OPERATOR signed on the WORKSTATION.
TimePeriodHour Time The time periods expressed in hours to measure line and transaction activity.
TimePeriodIntervalPerHourCount QuantityShortCount The number of time intervals per hour for measuring line and transaction activity.
TimePeriodMinuteIntervalCount QuantityShortCountMinutes The number of intervals in minutes for measuring line and transaction activity.
TotalSaleLineItemCount QuantityTransactionCount The total number of line items sold by the WORKSTATION in the defined time period intervals.
TotalTransactionCount QuantityTransactionCount A WORKSATION accumulator for holding the number of TRANSACTIONs across the defined time intervals.
WorkstationDate DateCalendar The actual date recorded by the WORKSTATION.

Back to Top

WorkstationTimeActivityTenderHistory

A historical record of ITEM and TRANSACTION movement by pre-defined time intervals so as to measure WORKSTATION productivity.

Tag

Type

Definition

NetTenderAmount Money The monetary amount of tender taken by the WORKSTATION in the defined time period intervals.

Back to Top