Logical VolumeII

ARTS Data Model Committee
Retail Data Model Logical View

Volume II (Entity & Attribute Definitions)
August 25, 2003
Release 4.01
AccessPassword
Definition: A secret term used by an operator to obtain access to a workstation.
Attribute Domain Definition
RetailStoreID (PK) (FK) Identity A unique retailer assigned identifier for a RetailStore
OperatorID (PK) (FK) Identity A unique, automatically assigned number used to identify a workstation OPERATOR.
AccessPassword Password The password which permits the OPERATOR to specific RESOURCES and workstations within
the RETAIL STORE.
Retail Data Model Logical View - Release 4.01 Page 2
Association for Retail Technology Standards August 25, 2003
AccountReceivablePayableLineItem
Definition: 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.
WorkstationID (PK) (FK) Identity The unique identifier for the WORKSTATION, typically the serial number.
TransactionSequenceNumber (PK) (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify a
TRANSACTION within the context of a WORKSTATION and a BUSINESS PERIOD.
RetailTransactionLineItemSequenceNumber (PK) (FK) LineNumber The sequence number of line item within the context of this RetailTransaction.
BusinessDayDate (PK) (FK) DateCalendar The calendar date of the BusinessDay.
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.
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.
Address
Definition: A mail location for a party (i.e. a customer, supplier, etc.)
AddressID (PK) Identity A unique identifier for a location and mail address.
AddressTypeCode (FK) Code2 Defines a standard type of address usage.
AddressType
Definition: Describes a valid address usage for an ADDRESS entity type. Valid uses include billing, shipping, legal, etc.
AddressTypeCode (PK) Code2 Defines a standard type of address usage.
Description DescriptionShort Description of address type.
Name Name Business name for an address type.
AdvancedShipNoticeDocument
Definition: 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.
InventoryControlDocumentID (PK) (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
AgeRestrictionRule
Definition: 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.
SalesRestrictionCode (PK) (FK) Code6 A unique, automatically assigned code for a specific limitation on an ITEMs sale.
SalesRestrictionTypeCode (PK) (FK) Code4 A unique code for a group of SALES RESTRICTIONS.
Description DescriptionShort A description of the type of age restriction that applies to this ITEM
MinimumCustomerAge QuantityYearCount The minimum age under which the customer is prohibited from purchasing the ITEM.
MinimumEmployeeAge QuantityYearCount The minimum age under which the employee is prohibited from selling the ITEM.
AggregateItem
Definition: A sub-type of Item that is an aggregation of one or more constituent Items. The constituent items may be sold individually.
ItemID (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
TypeCode Code2 How are the items combined? Choices are Blend & Kit. If items are combined in a Blend, then
the PerAssemblyCount attribute of ItemCollection denotes the percentage of the blend.
AlternativeItem
Definition: A cross reference of items that may be substituted or offered in place of another item.
OriginalItem (PK) (FK) Identity The retailers SKU or unique item identifier for the original Item being substituted.
SubstituteItem (PK) (FK) Identity The retailers SKU or unique item identifier for the subtitute Item.
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.
ApparelItem
Definition: A dress, skirt, blouse, pair of trousers or any other item of clothing that can be related to other APPAREL ITEMS by way of SIZE, COLOR or STYLE.
SilhouetteDescription DescriptionShort Describes the cut or fit of the APPARELL ITEM. For example, shirts may be sold as slim or
standard fit.
FabricDescription DescriptionShort Describes the material used to make the APPAREL ITEM
AssociatedCalendarPeriod
Definition: (null)
CalendarID (PK) (FK) Identity A unique system assigned identifier for the Calendar.
ParentLevelID (PK) (FK) Identity A unique system assigned identifier for the CalendarLevel.
ChildLevelID (PK) (FK) Identity A unique system assigned identifier for the CalendarLevel.
ParentPeriodID (PK) (FK) Identity A unique system assigned identifier for the ParentCalendarPeriod
ChildPeriodID (PK) (FK) Identity A unique system assigned identifier for the ChildCalendarPeriod
AssociatedMerchandiseHierarchyGroup
Definition: An association between two MerchandiseHierarchies that establishes one as the higher and one as the lower level for summarizing item sales information.
MerchandiseHierarchyFunctionID (PK) (FK) Identity A unique system assigned identifier for the MerchandiseHierarchyFunction
ParentMerchandiseHierarchyID (PK) (FK) Identity Unique identifier for the Parent merchandise structure group in the association.
ChildMerchandiseHierarchyID (PK) (FK) Identity Unique identifier for the child merchandise structure group in the association.
ParentMerchandiseHierarchyLevelCode (PK) (FK) Code4 A unique system assigned identifier for the Level within the merchandise hierarchy tree.
AssociatedRetailStoreGroup
Definition: An associative entity resolving the recursive-many-to-many relationship on RetailStoreGroup. It denotes a parent & child relationship between two RetailStoreGroups
for a particular RetailStoreGroupFunction. Each child RetailStoreGroup will have a different parent RetailStoreGroup for each RetailStoreGroupFunction that is defined.
ParentRetailStoreGroupID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
ChildRetailStoreGroupID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
RetailStoreGroupFunctionID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroupFunction
ParentRetailStoreGroupLevelID (PK) (FK) Identity A unique system assigned identifier, for a level within the RetailStoreGroup hierarchy
Blender
Definition: 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
FuelingPointID (PK) (FK) Identity A unique identifier for the FuelingPoint that this Nozzle is a part of
NozzleID (PK) (FK) Identity A unique identifier for the Nozzle
InventoryLocationID (PK) (FK) Identity A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
StockMeterID (FK) Identity A unique identifier for the stock meter
BlendPercentage Percent The percentage of the final blend that the given BULK ITEM constitutes.
Brand
Definition: The selling and promotional name used to identify a product for advertising and name recognition purposes.
BrandName (PK) 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.
BrandPriceDerivationRuleEligbility
Definition: 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.
PriceDerivationRuleEligibilityID (PK) (FK) Identity A unique identifier for a Price Derivation Rule Eligibility.
BrandName (FK) Name A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer.
BulkItem
Definition: A sub-type of STOCK ITEM that is purchased in bulk and is measured and sold by weight, volume or linear measure.
BulkToSellingUnitWasteFactorPercent Percent The pre-defined waste factor percentage, e.g. boning allowance.
BulkToSellingUnitWasteTypeCode Code2 The code to denote the type of waste associated with the BULK ITEM when breaking down to
retail selling units.
BusinessDay
Definition: A calendar date that corresponds to an accounting period fiscal day at a particular RetailStore, has financial transactions attributed to it and is aggregated using the
CalendarPeriod structure. May be closed programmatically (eg: every day at 10:00pm precisely) or manually at each RetailStore using PeriodCloseTransaction
BusinessDayDate (PK) DateCalendar The calendar date of the BusinessDay.
WorkstationID (FK) Identity The unique identifier for the WORKSTATION, typically the serial number.
TransactionSequenceNumber (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify a
BeginDateTimestamp TimeStampAudit The date & time the BusinessDay begain at the nominated RetailStore - This is normally defined
by the closure of the previous BusinessDay
EndDateTimestamp TimeStampAudit The date & time the BusinessDay ended at the nominated RetailStore
CalculateTaxRateRule
Definition: A kind of TaxRateRule that denotes a percentage of the taxable total that is to be applied to a RetailTransaction.
TaxAuthorityID (PK) (FK) Identity A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
TaxGroupID (PK) (FK) Identity A unique retailer assigned identifier for the TaxGroup
TaxRateRuleSequenceNumber (PK) (FK) MoneyShortRetail A squential number for theTaxRateRule, denoting the order of creation of the rules.
Percent Percent The percentage tax-rate that is to be applied
Calendar
Definition: A business function for which a specific Calendar is maintained within the retail enterprise. Eg: Merchandising, SalesTax, Payroll, Promotions, Sales Reporting, etc...
CalendarID (PK) Identity A unique system assigned identifier for the Calendar.
Name Name The name of the Calendar
CalendarLevel
Definition: A level of roll-up within a particular Calendar. Eg: MerchandisingCalendar may have Weeks, SubSeason, Seasons and Years, while Payroll Calendar may have
Months and Years, SalesTax Calendar may have Quarters and Years.
CalendarLevelID (PK) Identity A unique system assigned identifier for the CalendarLevel.
ChildCalendarLevelID (FK) Identity A unique system assigned identifier for the CalendarLevel which is rolled-up into this
CalendarLevel. This allows: Years rollup from Months Quarters rollup from 3 months Months
rollup from 30/31 days Weeks rollup from 7 days Days are the base period
Name Name The name for this level with in the Calendar
ChildPeriodCount QuantityShortCount The number of instances of the ChildPeriod that go to make up this CalendarPeriod Possible
values include: NULL - period starts same time each Day/Week/Month rather than as a multiple
of child periods 3 Shifts = Day 7 Days = Week 30/31 Days = Month 12 Months = Year
PeriodStartDayCode Code4 A code denoting which day of week/month/year the period starts on. Suggested values include:
NULL - Period is pure multiple of child Mon, Tue, Wed, Thu, Fri, Sat, Sun - Period starts on
given week day FMon, FTue, FWed, FThu, FFri, FSat, FSun - Period starts on First given week
day of month LMon, LTue, LWed, LThu, LFri, LSat, LSun - Period starts on Last given week day
of month 125 - Julian day number 125 = 5-May
PeriodStartsTime Time The time of day that the period starts
CalendarPeriod
Definition: A period of time in a particular Calendar, defined by a start & end date & time stamp.
CalendarLevelID (PK) (FK) Identity A unique system assigned identifier for the CalendarLevel.
CalendarPeriodID (PK) Identity A unique system assigned identifier for this CalendarPeriod
StartDateTime TimeStampEffective The date and time the CalendarPeriod begins
EndDateTime TimeStampEffective The date and time the CalendarPeriod ends.
CalendarPeriodPriceDerivationRuleEligibility
Definition: A kind of PriceDerivationRuleEligibility that allows PriceDerivationRules and Promotions to be targetted to particular CalendarPeriods (Eg: Season, SubSeason,
Easter, Christmas, Thanksgiving etc..)
CalendarID (FK) Identity A unique system assigned identifier for the Calendar.
CalendarLevelID (FK) Identity A unique system assigned identifier for the CalendarLevel.
CalendarPeriodID (FK) Identity A unique system assigned identifier for this CalendarPeriod
Carrier
Definition: 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.
CarrierID (PK) Identity The carrier presenting the bill of lading.
PartyID (FK) Identity A unique, automatically assigned identity for a PARTY.
PartyRoleTypeCode (FK) Code6 A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
Name Name The legal name of the transportation company referenced by the CARRIER-ID.
DUNSNumber IdentityDunsIdentifier The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the
retail community and credit worthiness.
CensusGeographicCoding
Definition: Standardized national, state, and local codes created by a governmental census agency for the identification of geographic areas.
Charity
Definition: An organization that has been designated as a charitable organization for tax purposes.
OrganizationPartyID (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
CharitableRegistrationNumber TaxIdentityNumber An ID assigned by a tax authority for charitable organizations.
CheckTenderLineItem
Definition: A type of TENDER LINE ITEM that records the specifics about a check received from a customer in settling a transaction.
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.
CheckAccountNumberEntryMethodCode Code A code denoting how the CheckAccountNumber was entered into the system.
CheckSequenceNumber LineNumber A unique sequence number relating to a particular check authorization.
CheckSequenceNumberEntryMethodCode Code A code denoting how the CheckSequenceNumber was entered into the system.
PersonalIDRequiredTypeCode Code2 Identifies the type of personal identification required to authorize tender. Examples include
drivers license, a second credit card, social security card, etc.
PersonalIDNumber Identity The personal identification number that must be keyed by an individual at the point of sale when
paying by personal check.
AdjudicationCode Code4 A code to denote that approval has been received from the authorization center.
CustomerBirthDate DateCalendarDay The customers 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.
Color
Definition: 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.
ColorCode (PK) 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
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.
Description DescriptionShort A full description of the individual color, designated by the respective code and name.
CombinationPriceDerivationRuleEligibility
Definition: A kind of Price Derivation Rule Eligibility which combines two or more other Price Derivation Rule Eligibilities in some boolean fashion.
CombinationCode Code2 A retailer assigned code denoting the style of combination that is to be applied across the child
eligibilities that ve been defined in MultiplePriceDerivationRuleEligibilities Examples include: OR,
AND, XOR
CommercialEnterprise
Definition: An organization that is not exempt from sales taxes
CommissionedEmployee
Definition: An employee who receives a percentage or fee that is based on some type of sales metric.
EmployeeID (PK) (FK) Identity A unique, non-significant number used to identify a store employee.
CommissionModifier
Definition: 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.
CommissionModifierSequenceNumber (PK) LineNumber A sequential counter used to uniquely identify an instance of a COMMISSION MODIFIER.
CommissionEmployeeId (FK) Identity A unique, non-significant number used to identify a store employee.
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.
MethodCode Code A code denoting the commission calculation method to be used.
AssociateActionCode Code A code denoting what action the Associate did on this sale to earn the commission. This action
code may affect the commission calculation.
ActionDatetime Datetime The date and time that the associate performed the action for which a commission is payable.
Competitor
Definition: A retailer with a product range and customer base similar to those for the store.
CompetitorID (PK) 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.
CloseDate DateCalendar The date the date the competitor closed
StatusCode Code2Status The current status of the competitor.
CompetitorRetailItem
Definition: 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.
CompetitorID (PK) (FK) Identity The unique identifier assigned to a competitor by the store.
RetailStoreGroupID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
SaleUnitPriceAmount MoneyShortRetail The retail sale unit price that a competitor has assigned to the item.
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.
LocalAdvertisingFlag Flag A flag that indicates whether or not the competitor is advertising the item in local media.
Contact
Definition: 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.
ContactTypeCode (PK) (FK) Code2 A code used to categorize different kinds of contact.
Party Role (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
PersonOrganizationAffilationTypeName (PK) (FK) String A name or label for a group of affiliations of people and organizations. For instance, this might
be employment .
Effective Date (PK) (FK) DateCalendar The start date of a PERSONs affiliation with an organization.
PersonPartyID (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
FunctionCode Code2 A code to identify the major duty or responsibility of the contact. These codes relate to the UCC
data element 366.
ContactType
Definition: Defines valid types of contacts for a store. Contact types refer to the role played by a contact when interacting with a store.
ContactTypeCode (PK) Code2 A code used to categorize different kinds of contact.
Name Name The business name for this type of contact.
Description DescriptionShort The business description for this type of contact
RoleCode Code2 The role played by this type of contact (e.g., pays invoices, approves RTVs , etc.)
ContainerType
Definition: 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.
UCCPackagingFormCode (PK) Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element
list..
UCCPackagingMaterialCode (PK) 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.
Description Name A description of the container type.
Contractor
Definition: A person who is not an employee but provides services to the retail enterprise.
ContractorID (PK) Identity An alternate ID assigned to a CONTRACTOR.
WorkerTypeCode (FK) Code2 A unique retailer assigned code denoting the kind of Worker.
ControlTransaction
Definition: 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.
TypeCode Code4 A code that describes the type of control transaction, i.e. period close, etc.
CoordinateType
Definition: A system of identifying physical locations.
CoordinateTypeCode (PK) Code2 A categorization of co-ordinate systems.
Description DescriptionNarrative A description of a category of co-ordinate systems.
CouponHandlingRule
Definition: 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.
CouponTypeCode (PK) Code2 A code to denote the type of coupon, e.g. raincheck, manufacturer coupon, electronic coupon.
Description DescriptionShort A description of the coupon, e.g. money off a particular ITEM.
CouponValueAccountingDispositionCode Code4 The disposition code for the coupon, e.g. store coupons are charged as an expense or
markdown.
CouponTenderLineItem
Definition: Records the use of a coupon (which must be valiated against an item in the TRANSACTION) to tender part (or all) of a TRANSACTION.
ManufacturerID (FK) Identity A unique identifier to denote the ITEM MANUFACTURER.
ManufacturerFamilyCode (FK) ProductCodeFamily The UPC designated three digit coupon family code for the manufacturer item.
CouponValidationLineItem (FK) LineNumber The sequence number of line item within the context of this RetailTransaction.
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 manufacturers number system character, the offer code, and
end of offer code. The supplementary was introduced as a guideline in 1997.
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.
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.
KeyEnteredFlag Flag A flag to denote whether the coupon is key entered or scanned, i.e. 0=no (scanned), 1=yes (key
entered)
CreditDebitCardTenderLineItem
Definition: A type of TENDER LINE ITEM that records the specifics about a credit or debit card used to settle a transaction.
CardType Code6 A code denoting which kind of card is being accepted.
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.
AccountNumber Name The account number appearing on a debit/credit card and identifying the card issuers customer
account to be charged or credited for the transaction.
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.
EntrySourceCode Code2 A code denoting who entered the card: Merchant or Customer.
PersonalIDRequiredTypeCode Code2 Identifies the type of personal identification required to authorize tender. Examples include
drivers license, a second credit card, social security card, etc.
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.
AuthorizationMethodCode Code4 Identifies the method used to authorize tender. Examples include by electronic query, by sales
employee visual inspection of customer card and id.
Track1CreditCardBitMap BitMap Defines the bit pattern used on track 1 of the magnetic strip on the back of a credit card.
AdjudicationCode Code6 A code indicating the result of a request to authorize the use of tender to settle a transaction.
CustomerSignatureImage Code2Status Digitized image of the customers signature.
CardExpirationDate Code4 The expiration date of the Credit or Debit card, as taken from the card in MMYY format.
CardHolderName Name The name of the cardholder, as taken from the card.
CardIssueSequenceNumber Identity The IssueSequnce number of the credit card being used.
Currency
Definition: Specifies the national designation and quantitative value of monetary media used as tender in the processing of this TENDER LINE ITEM.
CurrencyID (PK) Identity The unique identifier of the CURRENCY.
Description DescriptionShort A description of the currency, i.e. pounds sterling, US dollars, Canadian dollars, etc.
Symbol Name National symbol for the main unit of currency, e.g. , $, etc
IssuingCountryCode Code4 Identification of the country issuing the currency. This code relates to the UCC data element
100, Currency Code,
Customer
Definition: A person or individual who purchases, may purchase, or did purchase goods and or services from a retail store.
CustomerID (PK) Identity A unique identifier for a customer.
LifecycleType Name A categorization of CUSTOMERs based on the type of relationship that customer has with the
retail enterprise.
AnnualIncomeAmount Money A customers annual salary or income.
MaritalStatusCode Code2Status A code that describes a CUSTOMERs current marital status. For instance, married, single, etc.
ReligiousAffiliationName Name A name or label that describes a CUSTOMERs religious preference.
HighestEducationLevelName Name A name or label that describes a CUSTOMERs highest level of education. For instance, primary
school, post-secondary, graduate, etc.
CustomerAccount
Definition: 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.
CustomerAccountID (PK) Identity A unique identifier for a customer account. Generally assigned by the home office.
CustomerID (FK) Identity A unique identifier for a customer.
StoreFinancialLedgerAccountID (FK) Identity The reference for the STORE FINANCIAL LEDGER ACCOUNT
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.
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.
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.
FrequentShopperPointsType Code2 A retailer assigned code that defines which kind of frequent shopper points are being
accumulated by the customer.
CustomerAccountCard
Definition: An card or other device used in association with an account.
CustomerAccountCardID (PK) Number A unique retailer assigned identifier for a CustomerAccountCard.
CustomerAccountID (FK) Identity A unique identifier for a customer account. Generally assigned by the home office.
ExpirationDate DateCalendar A date that a specific CUSTOMER ACCOUNT CARD is no longer valid.
CustomerAccountPriceDerivationRuleEligibility
Definition: 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.
CustomerAccountTenderLineItem
Definition: A sub-type of TenderLineItem whereby the RetailTransaction is tendered against a CustomerAccountCard or CustomerAccount
CustomerRepresentativeID (FK) Identity A customer assigned identifier for the Driver fueling the vehicle.
CustomerAccountCardID (FK) Number A unique retailer assigned identifier for a CustomerAccountCard.
CustomerAffiliation
Definition: Associates a customer with a customer group.
CustomerID (PK) (FK) Identity A unique identifier for a customer.
CustomerGroupID (PK) (FK) Identity A unique identification number assigned to a customer group
IdentityVerifyRequiredFlag Flag A flag to denote whether the CUSTOMERs identity has been verified as belonging to the
CUSTOMER AFFILIATION scheme.
CustomerAffiliationPriceDerivationRuleEligibility
Definition: 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.
CustomerGroupID (FK) Identity A unique identification number assigned to a customer group
CustomerAgent
Definition: A person (or other Party) who has some relationship with a Customer.
CustomerRepresentativeID (PK) Identity A customer assigned identifier for the Driver fueling the vehicle.
CustomerAsset
Definition: A customers asset of interest to a retailer. This item may be maintained or enhanced using products and services provided by the retailer
CustomerAssetID (PK) 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.
CustomerAssetAssociation
Definition: A cross reference of customers to assets they own or possess.
CustomerAssetID (PK) (FK) Identity A unique, automatically assigned identifier for an asset or other item of interest that belongs to or
is related to a customer.
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.
CustomerConsumerChargeAccount
Definition: 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.
CustomerAccountID (PK) (FK) Identity A unique identifier for a customer account. Generally assigned by the home office.
CustomerCorrespondence
Definition: An e-mail, letter, telegram, or other written communication from a CUSTOMER.
CustomerCorrespondenceReceivedDate (PK) DateCalendar The date and time that a CUSTOMERs 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 CUSTOMERs letter, fax, e-mail, or phone call was sent by the
customer.
CreatedDate DateCalendar The date and time that a CUSTOMERs letter, fax, or e-mail was created.
SummaryDescription DescriptionNarrative A brief interpretation summarizing the main points of the correspondence.
CustomerDemographicRole
Definition: A specific customers assignment to the most fitting demographic role.
DemographicRoleName (PK) (FK) Name A label or title given to a group of people or organizations that represents their assignment to a
class of buyers.
CustomerDemographicRoleEffectiveDate (PK) DateCalendar The date that a CUSTOMER is first assigned to a demographic role.
CustomerGiftRegistration
Definition: A specific CUSTOMERs registration for an occasion.
CustomerOccasionTypeName (PK) (FK) 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.
CustomerOccasionDate (PK) (FK) DateCalendar The start date of a an event or other occasion that a customer celebrates.
Date DateCalendar The date that a CUSTOMER GIFT RESTRATION is created.
CustomerGroup
Definition: 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.
CustomerGroupID (PK) Identity A unique identification number assigned to a customer group
Name Name The business name applied to a customer group.
Description DescriptionShort The text description applied to a customer group.
CustomerInformationLineItem
Definition: 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.
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 Instructions.
CustomerInformationLineModifier
Definition: 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.
CustomerInformationModifierSequenceNumber (PK) LineNumber A sequential number designed to uniquely identify each modifier for a CUSTOMER
INFORMATION LINE item.
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.
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.
CustomerInstallmentPaymentAccount
Definition: 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.
CustomerLayawayAccount
Definition: 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.
CustomerLoyaltyAccount
Definition: A type of CUSTOMER ACCOUNT established purely for the purposes of tracking a customers 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.
LoyaltyProgramID (FK) Identity A artificial, unique identifier for a loyalty program.
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.
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.
CustomerLoyaltyAccountRedemption
Definition: A members use of promotional account (points/dollars/miles) for a reward.
PromotionalProductID (PK) (FK) Identity A unique identifier for a Promotional Product.
CustomerOccasion
Definition: An event celebrated or observed by a customer.
CustomerOccasionDate (PK) DateCalendar The start date of a an event or other occasion that a customer celebrates.
CustomerOccasionType
Definition: A categorization of CUSTOMER OCCASIONs.
CustomerOccasionTypeName (PK) Name A short label for a group of CUSTOMER OCCASIONs. For instance, this could be a wedding, a
Description DescriptionNarrative A description of a categorization of celebrated events or occasions.
CustomerPreference
Definition: A description of a KEY CUSTOMERs merchandise preferences for classes of items or general categories..
PreferenceTypeCode (PK) (FK) Code2 A unique code for a group of preferences. For instance, all the types of material (clothing)
preferences may be grouped together.
Description DescriptionNarrative A description of customers likes or dislikes of classes of items, colors, sizes, materials, etc.
CustomerRelationship
Definition: A grouping of customers who tend to jointly make purchasing decisions.
First (PK) (FK) Identity A unique identifier for a customer.
Second (PK) (FK) Identity A unique identifier for a customer.
CustomerRelationshipTypeName (PK) (FK) Name The name or code assigned to a type of CUSTOMER RELATIONSHIP.
CustomerRelationshipType
Definition: A categorization of CUSTOMER RELATIONSHIPS.
CustomerRelationshipTypeName (PK) Name The name or code assigned to a type of CUSTOMER RELATIONSHIP.
Description DescriptionNarrative A description of a categorization of customer relationships.
CustomerRentalAccount
Definition: A sub-type of CustomerAccount that records details of the customer as a rentor of RentalService items.
CustomerRentalAccountHistory
Definition: A summary of all rentals made against the CustomerRentalAccount during the ReportingPeriod.
ReportingPeriodID (PK) (FK) Identity The identifier for a particular REPORTING PERIOD.
RentalCount QuantityShortCount The number of RentalUnits that were rented by the customer during the reporting period.
LateReturnCount QuantityShortCount The number of RentalUnits that were rented and were not returned promptly by the customer
during the reporting period.
DamagedReturnCount QuantityShortCount The number of RentalUnits that were rented and were returned in a damaged condition by the
customer during the reporting period.
DirtyReturnCount QuantityShortCount The number of RentalUnits that were rented and were returned in a dirty condition by the
customer during the reporting period.
CustomerSurvey
Definition: A collection of questions or other inquiries for soliciting responses from customers (shoppers too?).
CustomerSurveyResponse
Definition: A specific customers survey responses
CustomerTradeAccount
Definition: 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.
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.
DataMaintenanceEvent
Definition: A type of EVENT which represents a collection of changes to configuration data stored in the database. These changes may reflect a promotional activity, a set of price
changes, item additions and deletions, or general maintenance of data.
EventID (PK) (FK) Identity A unique, automatically assigned identifier for each EVENT instance.
EmployeeID (FK) Identity A unique, non-significant number used to identify a store employee.
CompetitorID (FK) Identity The unique identifier assigned to a competitor by the store.
Name Name Assigns a name to the maintenance event.
Description DescriptionShort Describes the maintenance event in business terms.
ReasonCode Code4 Establishes a reason for the maintenance event. Reason codes will be determined by each
retailer.
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.
StatusCode Code2Status The current status of the maintenance event. Valid status conditions include pending, applied,
canceled, expired, etc.
AppliedTimestamp TimeStampAudit The date and time the maintenance events associated adds, changes and deletes are applied to
the store database.
CreateDateTimestamp TimeStampAudit The date and time this maintenance event was created.
OriginTypeCode Code4 The origin for this maintenance event. Examples of origins include: home office, store, etc.
Deal
Definition: 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.
DealCode (PK) 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.
SupplierID (PK) (FK) Identity A code assigned by the retailer to uniquely identify the supplier.
Name Name The business name for the deal.
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.
DealSupplierItem
Definition: 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.
DealCode (PK) (FK) Identity A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the
SupplierItemCostPerUnitTypeCode (PK) (FK) 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.
SupplierItemID (PK) (FK) Identity The code assigned by the supplier to uniquely identify the ITEM
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.
DealSupplierItemCostBreak
Definition: 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.
DealCode (PK) (FK) Identity A code which uniquely identifies the type of DEAL offered by the SUPPLIER. For example the
SupplierItemUnitDealThresholdCount (PK) Quantity A count associated with an item that triggers a cost reduction as part of a DEAL.
ChangeAmount Money The additional allowance amount which is applied when the SUPPLIERs breakpoint is attained.
ChangePercent Percent The additional allowance percentage that is applied when the SUPPLIERs breakpoint is
attained.
DemographicRole
Definition: An industry or proprietary categorization of a person or organization based on his/her/its purchasing behaviors, age, desires, geographic location, job type, etc.
DemographicRoleName (PK) 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.
Denomination
Definition: Specifies the quantitative value of the referenced CURRENCY media.
CurrencyID (PK) (FK) Identity The unique identifier of the CURRENCY.
DenominationID (PK) 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.
DepositRedemption
Definition: 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.
DepositRedemptionTypeCode (PK) 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.
DepositRedemptionLineItem
Definition: 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.
DepositRedemptionTypeCode (FK) 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.
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.
DepositRule
Definition: 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.
DepositRuleID (PK) Identity A unique system assigned identifier for the deposit rule
ReturnAgentID (FK) Identity The company to whom the returns for ITEMs, such as empty bottles, are made.
ItemID (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
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.
DevicePrice
Definition: The current mapping between the system ItemPrice and a FuelingPoint device specific identifier used to identify aretail unit price.
FuelingPointID (PK) (FK) Identity A unique identifier for the FuelingPoint at a particular retail store
DevicePriceID (PK) Identity The devicePriceID used by the FuelingPoint to identifiy the retail price.
ItemPriceID (FK) Identity A unique identifier for the ItemPrice.
DisbursementFundsReceiptReason
Definition: The reason why a petty cash disbursement has been made or funds receipt received.
DisbursementReceiptReasonCode (PK) Code2 The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
Description DescriptionShort A textual description of the reason for the DISBURSEMENT or FUNDS RECEIPT
DisbursementTransaction
Definition: A type of FINANCIAL ACCOUNTING TRANSACTION that records disbursement (with an offsetting miscellaneous expense).
TenderRepositoryID (FK) Identity The unique identifier for the TENDER RESPOSITORY.
DisbursementReceiptReasonCode (FK) Code2 The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
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.
Discount
Definition: A reduction in the selling price that is normally charged as an expense to the RETAIL STOREs general ledger. Can be applied by transaction line item or to the whole
transaction.
DiscountTypeCode (PK) Code2 The type code used as a look up key for the standard discount types represented in the
DISCOUNT entity collection
Name Name The name of the standard discount types represented in the DISCOUNT entity collection.
Description DescriptionShort A text description of the standard discount types represented in the DISCOUNT entity collection.
ReductionMethodCode Code2 A code denoting the method of discounting that is being applied to the transaction. Possible
values include, Monetary Amount Reduction, Percentage Reduction, New Price Amount and
Cost Plus Price
ReductionAmount MoneyShortRetail The amount of the discount expressed as a dollar amount
ReductionPercent Percent The amount of the discount expressed as a percentage of the normal price.
NewPriceAmount MoneyShortRetail The discount amount expressed as the new price for the item.
DiscountLineItem
Definition: 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.
DiscountTypeCode (FK) Code2 The type code used as a look up key for the standard discount types represented in the
DISCOUNT entity collection
Amount Money The monetary value for the discount line item.
DiscrepancyToleranceRule
Definition: A rule that defines permissible variance between the total inventory control document cost (based on the suppliers cost) and the stores receiving total (based on the
stores record of supplier item cost). Any variance that exceeds the discrepancy threshold will trigger an invoice or item-level reconciliation.
DiscrepancyRuleID (PK) 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.
TypeCode Code2 Determines whether the discrepancy rule applies to cost (in monetary units), weight or quantity
(i.e. item count).
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.
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.
MessageText DescriptionNarrative Message to detail the reason for the difference between the billed and ITEM cost amounts,
weights or counts.
DisplayUnitItem
Definition: A sub-type of STOCK ITEM for shelf, rack or other display unit that is used by the store to display merchandise. Particularly used for racks & shelves custom designed
for a particular item. Not normally for sale.
DispositionCode Code2 A code to denote how the DISPLAY UNIT is to be disposed, ie returned to the supplier,
destroyed, or retained until the next promotion.
TakeDownDate DateCalendar The date on which the display unit can be taken down by the RETAIL STORE
SetupDate DateCalendar The date on which the DISPLAY UNIT can be setup within the RETAIL STORE
DisplayUnitTypeCode Code2 A code to denote the type of display unit, i.e. free-standing, shelf end, refrigerator, etc.
ShelfItemsHeldCapacityCount Quantity The maximum number of SHELF ITEMS that can be stocked on the DISPLAY UNIT.
DriveOffTransaction
Definition: 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 off
FuelingTransactionID (FK) Identity A unique identifier for the fuelling transaction
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
EmailAddress
Definition: An electronic mail address.
PartyID (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
EmailAddressID (PK) Email address An electronic address for sending messages..
Employee
Definition: 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.
EmployeeID (PK) Identity A unique, non-significant number used to identify a store employee.
WorkerTypeCode (FK) Code2 A unique retailer assigned code denoting the kind of Worker.
LanguageID (FK) Code4External A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular
country.
CommissionPlanID (FK) Code4 A unique reference number for an employees commission plan. This may be the employees
payroll number.
Name Name The full name of the EMPLOYEE.
StatusCode Code2Status The status code regarding the EMPLOYEE, i.e. active or inactive.
SocialSecurityNumber IdentitySocialSecurityNumber The social security number of the EMPLOYEE.
EmployeeCompensationTypeCode Code Defines how the employee is paid. (Hourly or Salaried)
EmployeeAssignment
Definition: An employees assignment to a specific position, at one point in time.
PositionID (PK) (FK) Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR
function.
StatusCode Code2Status A code that represents the current state of an EMPLOYEE ASSIGNEMENT.
EffectiveDate DateCalendar The date that an EMPLOYEE ASSIGMENT is first valid.
ExpirationDate DateCalendar The date that an employees assignment is no longer valid.
EmployeeCommissionPlan
Definition: A plan for compensating employees for sales they make to customers.
EmployeeCommissionPlanID (PK) Code4 A unique reference number for an employees commission plan. This may be the employees
payroll number.
Description DescriptionShort A textual description of the type of employees commission plan
EmployeeDiscountedSalesHistory
Definition: A collection of accumulators for each employee who purchases merchandise, at a discount, from the store.
ReturnTotalAmount Money The total monetary amount of refunds made for 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.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees discounted for EMPLOYLEEs 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.
LineItemCount QuantityTransactionCount The total number of ITEMs discounted as part of EMPLOYEE purchases in each REPORTING
PERIOD.
TotalAmount Money The total monetary amount of discount granted in EMPLOYEE purchases 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.
RefundTotalAmount Money 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.
EmployeeDiscountGroup
Definition: A group of EMPLOYEEs who share the same employee discount privilege.
EmployeeDiscountGroupID (PK) 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.
EmployeeDiscountGroupPriceDerivationRuleEligibility
Definition: 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.
EmployeeDiscountGroupID (FK) Identity The identifier for a specific EMPLOYEE DISCOUNT GROUP.
Description DescriptionShort Describes the derivation rule for the employee group price discount.
ApplyAfterAllMarkdownsFlag Flag A flag to denote whether the EMPLOYEE DISCOUNT is applied after all the ITEM markdowns
have been applied.
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.
EligibilityDescription DescriptionShort Describes this employee-group discount eligibility rule.
EmployeeDiscountLineItem
Definition: A special kind of retail line item set up to record and keep track of employee discounts taken in a transaction.
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.
EmployeeMembershipDiscountGroup
Definition: An association between an employee and an employee discount group which makes the employee eligible for the price reductions available to the discount group.
EmployeeDiscountGroupID (PK) (FK) Identity The identifier for a specific EMPLOYEE DISCOUNT GROUP.
Description DescriptionShort Description associated with this employee discount group.
IdentityVerifyRequiredFlag Flag A flag to denote whether the identity of the EMPLOYEE has been verified.
EmployeeRetailStoreAssignment
Definition: 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.
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.
EnvironmentClass
Definition: A category of environmental properties, such as humidity, lighting, and temperatures.
EnvironmentClassCode (PK) Code6 A code that identifies a class environmental properties of a location. For instance, this might
describe humidity, temperature, or lighting restrictions or requirements
Description DescriptionNarrative A descriptive narrative of the environmental class.
Equipment
Definition: An instance of EQUIPMENT CLASS, it comes in a variety of flavours Workstation, FuelPump, TankGauge, TankProbe.
EquipmentID (PK) Identity The fixed asset number assigned by the retailer for this particular piece of equipment.
EquipmentClassID (FK) Identity A unique identifier for the class of equipment.
EquipmentTypeCode Code2 A 2 character code denoting the kind of equipment. Choices are currently Workstation,
FuelPump, TankGauge and TankProbe
ModelNumber Name The model number assigned to the piece of equipment by the manufacturer.
EquipmentClass
Definition: A class of device used as an as interface to any store business function. All instances of the class have a common manufacturer, service provider and supplier. Class
instanaces are currently Workstation, FuelPump, TankGuage and TankProbe.
EquipmentClassID (PK) Identity A unique identifier for the class of equipment.
SupplierID (FK) Identity A code assigned by the retailer to uniquely identify the supplier.
ServiceProviderID (FK) Identity A unique identifier for the service provider.
ManufacturerName Name The name of the hardware manufacturer
Event
Definition: 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.
EventID (PK) Identity A unique, automatically assigned identifier for each EVENT instance.
TypeCode Code4 Identifies the category for the event. Examples include holiday promotion, physical inventory
count, Presidents Day, Back to School Sale, Register Roulette, etc.
Description DescriptionShort Describes the event.
Name Name The business name of the 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.
OwnerName Name Identifies who in the retailer organization owns and is responsible for the EVENT.
PlanStartDateTimestamp TimeStampEffective The planned starting time and date for an event.
PlanEndDateTimestamp TimeStampExpiration The planned time and date when the event terminates
ActualStartDateTimestamp TimeStampEffective The actual start date and time for an event.
ActualEndDateTimestamp TimeStampExpiration The actual time and date when the event terminates.
ExchangeRate
Definition: Expresses the quantitative conversion factor between two kinds of CURRENCY, one which must be the stores home currency.
FromCurrencyID (PK) (FK) Identity The unique identifier of the CURRENCY.
ToCurrencyID (PK) (FK) Identity The unique identifier of the CURRENCY.
SequenceNumber (PK) LineNumber A sequence number denoting the order in which Exchange rate records were created for this
pairing of currencies.
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.
ToBuyAmount Money The buying rate of the tender type, based on the stores local currency.
ToSellAmount Money The selling rate of the tender type, based on the stores local currency
ServiceFeeAmount Money The add-on fee, in local currency amounts, imposed on the exchange
MinimumCurrencyAmount Money The minimum monetary amount the store will either purchase or sell foreign tender.
ExCustomer
Definition: 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 retailer.
ExternalDepository
Definition: A bank or other institution that accepts periodic deposits of TENDER from the retail store.
TenderRepositoryID (PK) (FK) Identity The unique identifier for the TENDER RESPOSITORY.
Name Name The business name of the external repository.
Description DescriptionShort Business description of the external depository
ExternalDepositoryPartyID (FK) Identity A unique identifier for an External Depository Party. The identifiers are only unique within this
type of PARTY.
ExternalDepositoryHistory
Definition: A record of the TRANSACTIONs that lists the deposit of TENDER in the EXTERNAL DEPOSITORY by the store.
ExternalDepositoryParty
Definition: A type of party related to an EXTERNAL DEPOSITORY.
ExternalDepositoryPartyID (PK) Identity A unique identifier for an External Depository Party. The identifiers are only unique within this
type of PARTY.
ExternalDepositorySettlementTransaction
Definition: 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.
ExternalDepositoryTender
Definition: A set of tender repository totals for each type of tender in an EXTERNAL DEPOSITORY
TenderTypeCode (PK) (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
OpenBalanceTotalAmount Money The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at
the start of the current deposit..
TenderDepositTotalAmount Money The total amount of tender deposited in the EXTERNAL DEPOSITORY.
TotalTenderDepositCount QuantityTransactionCount The total number of TENDER deposits made in the EXTERNAL DEPOSITORY.
TenderDepositDateTimestamp TimeStampAudit The timestamp when tender is deposited in the EXTERNAL DEPOSITORY.
TenderReceiptTotalAmount Money The total amount of money received from 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.
OverTenderDiscrepancyAmount Money The overage, expressed as an amount, between the actual and recorded tender deposited in the
EXTERNAL DEPOSITORY.
ExternalDepositoryTenderHistory
Definition: 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.
OpenBalanceTotalAmount Money The monetary amount of the opening balance of TENDER in the EXTERNAL DEPOSITORY at
the start of the accumulation period.
DepositTotalAmount Money The total amount of tender deposited in the EXTERNAL DEPOSITORY for each accumulation
period..
TotalTenderDepositCount QuantityTransactionCount The total number of TENDER deposits made in the EXTERNAL DEPOSITORY for each
accumulation period.
DepositDateTimestamp TimeStampAudit The timestamp when tender is deposited in the EXTERNAL DEPOSITORY for each
ReceiptTotalAmount Money The total amount of money received from the EXTERNAL DEPOSITORY in each accumulation
period.
TotalTenderReceiptCount QuantityTransactionCount The total number of receipts to the STORE from the EXTERNAL DEPOSITORY in each
UnderTenderDiscrepancyAmount Money The shortage, expressed as an amount, between the actual and recorded tender deposited in
the EXTERNAL DEPOSITORY for each 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.
Facility
Definition: A distribution center, warehouse or store which ships merchandise to and accepts returned merchandise from the retail store.
FacilityID (PK) 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.
FinancialAccountingTransaction
Definition: A type of TRANSACTION that records the physical movement of tender from one tender repository to another.
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.)
FinancialTransactionJournalEntry
Definition: An entry in a journal of transaction details for posting to a STORE FINANCIAL LEDGER ACCOUNT and/or the STOCK LEDGER.
FinancialTransactionJournalEntryID (PK) Identity The unique reference of the FINANCIAL TRANSACTION JOURNAL ENTRY.
FinancialTransactionJournalEntrySequenceNumber (PK) LineNumber The sequence number of the FINANCIAL TRANSACTION JOURNAL ENTRY.
BusinessDayDate (FK) DateCalendar The calendar date of the BusinessDay.
InventoryControlDocumentID (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
DateTimestamp TimeStampAudit The time at which the FINANCIAL TRANSACTION JOURNAL ENTRY is made.
Amount Money The monetary value of the FINANCIAL TRANSACTION JOURNAL ENTRY.
DebitCreditCode Code2 A code to denote whether the value of the FINANCIAL TRANSACTION JOURNAL ENTRY is
debited or credited to the FINANCIAL LEDGER.
StatusCode Code2Status Defines the current status of the FINANCIAL TRANSACTION JOURNAL ENTRY. Examples
include pending, booked, etc.
FlatTaxRateRule
Definition: A kind of TaxRateRule that denotes a monetary amount of tax that is to be applied to a RetailTransaction.
government body.
Amount Money The flat tax amount that is to be applied
FleetInfo
Definition: Vehicle, Driver & other fleet management data that is collected as part of the process of tendering a transaction (that includes the sale of a FuelItem) with a
CustomerAccount
VehicleID unknown A unique customer assigned identifier for the vehicle being fueled. Usually this will be the
vehicles license plate number, but not always.
TemporaryVehicleFlag Flag A flag denoting that this FleetInfo refers to a temporary vehicle, which means there is no valid
VehicleID present.
OdometerReading String The OdometerReading for the vehicle being fueled.
FoodServiceTransaction
Definition: A sub-type of RetailTransaction specifically for the Food Service segment of the retail industry. Which can be used to record TableNumber, PartySize, Servers, etc...
ServerID (FK) Identity A unique identifier for the Server
TableID Identity A unique identifier for the table that was used for the hospitality transaction.
PartySize QuantityShortCount The number of people served at the table during the hospitality transaction.
ForecourtSettlementTransaction
Definition: 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-off the
EventID (FK) Identity A unique, automatically assigned identifier for each EVENT instance.
ForecourtTransaction
Definition: A type of TRANSATION that records the clearing of FUELLING TRANSACTIONs without accepting money for them by an operator at a workstation.
ForecourtTransactionType Code2 A code to denote the type of ForecourtTransaction , eg DriveOff, TestDelivery
ForeignCurrencyTenderLineItem
Definition: 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 stores host country currency).
Amount Money A tender line item identifying the foreign currency tendered by the CUSTOMER as payment.
FreightBill
Definition: 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.
CarrierID (PK) (FK) Identity The carrier presenting the bill of lading.
FreightBillID (PK) Identity The carrier-assigned shipping document number
CarrierWeightRestrictionCode Code2 A code to denote the maximum weight of each carton that can be handled by the carrier.
StoreCartonCount Quantity The number of cartons as established by the store.
ShippedCartonCount Quantity The number of cartons listed on the FREIGHT BILL.
StoreReceiptTime TimeStampAudit The time and date when the freight is received at the store.
Status Code2Status The status of the receiving event: scheduled, initiated, completed, processed, reviewed,
modified.
SpecialHandlingCode Code2 A code that specifies special handling instructions.
SpecialHandlingMessage DescriptionNarrative Free form additional description of special handling conditions if special handling code
inadequate.
SerialFormID String An identifier for this document, usually preprinted on the form stock prior to being filled out.
FuelingPoint
Definition: A device used to deliver fuel.
FuelingPointID (PK) Identity A unique identifier for the FuelingPoint at a particular retail store
FuelPumpID (FK) Identity A unique identifier for the FuelPump
UnitOfMeasureCode (FK) 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.
WeightsAndMeasuresSoftwareVersion Name The software version in the FuellingPoint as reported to Weights & Measures
WeightsAndMeasuresSoftwareDate DateCalendar The date of the software version in the FuellingPoint as reported to Weights & Measures
WeightsAndMeasuresSecurityCode Code2 A security code in the FuellingPoint as reported to Weights & Measures
ProtocolVersionCode Code2 The version of the protocol this FuellingPoint uses.
FuelingTransaction
Definition: An auditing event, recording a particular NOZZLE completing a delivery of fuel.
FuelingTransactionID (PK) Identity A unique identifier for the fuelling transaction
FuelingPointID (FK) Identity A unique identifier for the FuelingPoint that this Nozzle is a part of
NozzleID (FK) Identity A unique identifier for the Nozzle
ItemPriceID (FK) Identity A unique identifier for the ItemPrice.
OperatorID (FK) Identity A unique, automatically assigned number used to identify a workstation OPERATOR.
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 refund.
TimeStamp Datetime The date & time of the completion of the fuelling transaction
Volume Number The volume of fuel delivered in the fuelling transaction.
UnitPrice Number The price per volume unit charged by the FUELLING POINT for the fuel delivered in the
FUELLING TRANSACTION
TotalPrice Number The total price charged by the FUELLING POINT for the fuel delivered in the FUELLING
TRANSACTION.
TotalSalesTax MoneyShortRetail The sales tax 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.
AuthorizationElapsedTime QuantityShortCountMilliseconds The number of milli-seconds elapsed between CUSTOMER lifting NOZZLE and FUELING
TRANSACTION commencing
DeliveryElapsedTime QuantityShortCountSeconds The number of seconds between FUELING TRANSACTION commencing and completing.
SaleElapsedTime QuantityShortCountSeconds The number of seconds elapsed between FUELING TRANSACTION completing and being sold
at a point of sale.
RetailStoreID (FK) Identity A unique retailer assigned identifier for a RetailStore
FuelItem
Definition: A sub-type of STOCK ITEM for Petroleum products such as Petrol, Gas, Diesel and Kerosene. It is purchased in bulk and blended, measured and dispensed by a
FUELING POINT..
ProductGroupCode Code Specifies the product group of the Item for calculation of temperature corrected volume. Defined
by ASTM D 1250 table 54 or American Petroleum Institute (API) Std 2540 table 6
ReferenceDensity Quantity The reference density at reference temperature of the product, used for calculating the volume
correction factor. Cf. ASTM D 1250 table 54 or American Petroleum Institute (API) Std 2540
table 6
FuelItemPrice
Definition: A sparse array allowing combinations of Time, Forecourt Service Level, Price Level and Fueling Point 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 FUELING POINT, this entity provides a mapping from all the parameters to the set of
available prices.
ItemPriceID (PK) Identity A unique identifier for the ItemPrice.
ServiceLevelID (FK) Identity A unique identifier for the service level for which this FuelItemPrice is valid
PriceLevelID (FK) Identity A unique identifier for the price level for which this FuelItemPrice is valid
TimeGroupID (FK) Identity A unique identifier for the time group for which this FuelItemPrice is valid
Name Name A descriptive short name that people use to identify the ItemPrice
StatusCode Code2Status The current status of the ItemPrice entry. Possible values include Active, InActive and Pending.
EffectiveDate DateCalendar The calendar day this ItemPrice becomes active
ExpirationDate DateCalendar The calendar day this ItemPrice becomes inactive
RetailPrice MoneyShortRetail The price per unit for this FuelItem when all the other parameters have been satisfied.
FuelPriceLevel
Definition: A collection of price levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are "Cash Price ", "Credit Price "
PriceLevelID (PK) Identity A unique identifier for the price level
Name Name A human readable name for the price level
FuelPump
Definition: The piece of EQUIPMENT on the forecourt that houses one or more FUELING POINTs
FuelPumpID (PK) Identity A unique identifier for the FuelPump
EquipmentID (FK) Identity The fixed asset number assigned by the retailer for this particular piece of equipment.
FuelSalesLineItem
Definition: A line item component of a RETAIL TRANSACTION that records the collection of money in return for the fuel dispensed by a FUELLING TRANSACTION.
Prepay (FK) Identity A unique identifier for the FuelingPoint at a particular retail store
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 money
FuelServiceLevel
Definition: A collection of service levels, which are merely parameters to the ITEM PRICE structure for fuel prices. Examples are "Full Service " & "Self Service "
ServiceLevelID (PK) Identity A unique identifier for the service level
Name Name A human readable name for the service level
FundsReceiptTransaction
Definition: A type of FINANCIAL ACCOUNTING TRANSACTION that records a cash receipt (with an offsetting miscellaneous income).
TenderRepositoryID (FK) Identity The unique identifier for the TENDER RESPOSITORY.
DisbursementReceiptReasonCode (FK) Code2 The reason code for the DISBURSEMENT or the FUNDS RECEIPT.
FundsReceiptPartyID Identity The identifier for the party who submitted the FUNDS RECEIPT.
GiftCertificate
Definition: 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.
IssuingStoreNumber (PK) Identity A unique store number reference to identify the RETAIL STORE that issued the GIFT
CERTIFICATE.
GiftCertificateSerialNumber (PK) Name The serial number that uniquely identifies a GIFT CERTIFICATE.
GiftCertificateTypeCode (FK) Code2 Identifies a gift certificate type.
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.
IssueDateTimestamp TimeStampEffective The time and date when the gift certificate was issued by the RETAIL STORE to the
CUSTOMER.
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.
UnspentBalanceAmount Money The monetary value of the unspent amount outstanding on a specific GIFT CERTIFICATE.
UnspentBalanceDispositionCode Code2 A code denoting how any unspent balance is to be treated when the GiftCertificate is redeemed.
GiftCertificateClass
Definition: Defines a class of gift certificates and establishes the business rules governing their issuance and redemption.
GiftCertificateTypeCode (PK) Code2 Identifies a gift certificate type.
TypeDescription DescriptionShort Describes a gift certificate type
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.
RedemptionPeriodDayCount QuantityDayCount Defines the number of days this gift certificate remains outstanding and redeemable.
FormID Identity Identifies the format and type of paper used to print this type of gift certificate.
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.
GiftCertificateLineItem
Definition: 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.
IssuingStoreNumber (FK) Identity A unique store number reference to identify the RETAIL STORE that issued the GIFT
CERTIFICATE.
GiftCertificateSerialNumber (FK) Name The serial number that uniquely identifies a GIFT CERTIFICATE.
ScannedOrKeyedCode Code2 A code that indicates whether the serial number for the gift certificate was keyed or scanned.
GiftCertificateTenderLineItem
Definition: A type of TENDER LINE ITEM that records the specifics about a GIFT CERTIFICATE redeemed as part of settling a transaction.
CERTIFICATE.
GiftRegisteredItem
Definition: A customers selection of an item for inclusion in his or her gift registry.
DesiredQuantity QuantityShortCount The quantity of ITEMs that are asked for in the GIFT REGISTRATION.
GiftRegistryLineItem
Definition: A linkage of ITEMs that have been registered for and items that have been purchased.
Quantity Quantity The number of items purchased for the GIFT REGRISTRATION on this line item.
GroupResourceAccess
Definition: GROUP RESOURCE ACCESS defines a specific Groups access privileges to a given RESOURCE.
WorkGroupID (PK) (FK) Identity A unique identifier for a work classification group to which EMPLOYEEs are assigned.
ResourceID (PK) (FK) Identity A code to uniquely identify a given application or application component.
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.
GroupSelectItem
Definition: An item which is a group of items, only one of which will be sold. The choice of which item is made by the customer at the POS.
HourlyEmployee
Definition: An employee that is compensated based on hours worked.
InventoryAdjustmentDocument
Definition: A document that captures an increment or decrement to an items unit on hand count and/or financial valuation.
InventoryAdjustmentDocumentID (PK) Identity A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments
between actual and notified amounts.
InventoryAdjustmentLineItem
Definition: The detail line item on the INVENTORY ADJUSTMENT DOCUMENT which applies an increment or decrement to the ITEMs unit on hand and /or the financial
valuation.
InventoryAdjustmentDocumentID (PK) (FK) Identity A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments
InventoryAdjustmentLineNumber (PK) LineNumber The line number for a specific line item adjustment.
ReasonCode Code2 The reason code for the line item adjustment.
InventoryCondition
Definition: 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.
InventoryConditionCode (PK) 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.
InboundDescription DescriptionShort A textual description of the condition of the shipment.
InventoryControlDocument
Definition: A written or printed paper, or digital equivalent, that evidences an exchange in the ownership of merchandise or supply STOCK ITEMs.
InventoryControlDocumentID (PK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
PackingSlipID (FK) Identity the unique identifier for the packing slip, typically the reference number.
CurrencyID (FK) Identity The unique identifier of the CURRENCY.
FacilityID (FK) 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.
CompleteDateTimestamp TimeStampAudit The time and date when the processing of the inventory control document was completed.
DocumentTypeCode Code2 This code identifies the type of INVENTORY CONTROL DOCUMENT.
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.
FromPartyID Identity The party that originated the inventory control document.
CreateDateTimestamp TimeStampAudit The time and date when the inventory control document was originally created.
LastUpdateDate DateCalendar The date when the inventory control document was last updated by the store.
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.
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.
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.
ExpectedDeliveryDate DateCalendar The expected delivery date of the shipment, to which this particular inventory control document
relates.
ActualDeliveryDate DateCalendar The actual delivery date of the shipment, to which this particular inventory control document
relates.
SupplierExpectedShipDate DateCalendar The expected arrival date of the shipment, to which this particular inventory control document
relates.
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.
UnitDiscrepancyCount Quantity The discrepancy count between the units recorded on the INVENTORY CONTROL
DOCUMENT and the actual units counted.
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.
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.
ContractReferenceNumber Identity The contract against which the delivery has been made.
SerialFormID String An idenfier for this document, usually preprinted on the form stock prior to being filled out.
InventoryControlDocumentAllowanceLineItem
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records allowances applicable to the whole INVENTORY CONTROL DOCUMENT.
InventoryControlDocumentLineNumber (PK) (FK) LineNumber The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
INVENTORY CONTROL DOCUMENT.
Amount Money The monetary allowance made by the supplier against a specific line on the INVENTORY
CONTROL DOCUMENT.
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.
ReasonCode Code2 The reason code for applying the allowance.
SupplierAllowanceNumber Identity The number assigned by the supplier referencing an allowance, promotion or deal.
RetailerSerialFormID String An idenfier for this document, usually preprinted on the form stock prior to being filled out.
InventoryControlDocumentChargeLineItem
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records charges applicable to the whole INVENTORY CONTROL DOCUMENT.
Amount Money The monetary charge levied against a specific line on the INVENTORY CONTROL
DOCUMENT.
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.
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.
InventoryControlDocumentFreightLineItem
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records the type and amount of freight cost incurred on an INVENTORY CONTROL
DOCUMENT.
CostCode Code2 A code to signify whether the freight cost is met by the retailer or supplier.
CostAmount Money The freight charges.
InventoryControlDocumentLineItem
Definition: 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.
InventoryControlDocumentLineNumber (PK) LineNumber The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
DocumentTypeCode Code2 The DOCUMENT LINE ITEM CODE TYPE CODE specifies the item type.
InventoryControlDocumentMerchandiseLineItem
Definition: 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.
InventoryLocationID (FK) Identity A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
InventoryConditionCode (FK) 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.
PurchaseOrder (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
CostPerUnitTypeCode Code2 Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types
UnitCount Quantity A count of all item units (in the item-cost-per-unit-type) received or shipped in this document line
item.
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.
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.
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 stores staff.
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.
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.
InventoryControlDocumentMerchandiseLineItemModifier
Definition: A modifier that applies an allowance or a charge to a single line item on an INVENTORY CONTROL DOCUMENT.
InventoryControlDocumentLineModifierNumber (PK) 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.
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.
InventoryControlDocumentMerchandiseTaxLineItem
Definition: A Line Item to record taxation implications of a single INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM rather than an entire INVENTORY
CONTROL DOCUMENT
government body.
TaxableAmount MoneyShortRetail The monetary value for which tax must be paid for the INVENTORY CONTROL DOCUMENT
MERCHANDISE LINE ITEM
TaxAmount MoneyShortRetail The amount of tax to be paid for the INVENTORY CONTROL DOCUMENT MERCHANDISE
LINE ITEM
TaxExemptAmount MoneyShortRetail The amount of tax that does not have to be paid for the INVENTORY CONTROL DOCUMENT
MERCHANDISE LINE ITEM
TaxExemptionReasonCode Code2 A code denoting the reason why the tax that should ve been paid was exempt for the
INVENTORY CONTROL DOCUMENT MERCHANDISE LINE ITEM
InventoryControlDocumentReference
Definition: Defines instances where one inventory control document refers to one or more other inventory control documents.
ReferToBy (PK) (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
ReferTo (PK) (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
InventoryControlDocumentTaxExemptionModifier
Definition: A line item modifier to the InventoryControlDocumentTaxLineItem that provides supplementary data regarding tax exemptions that have been applied.
ExemptionAmount MoneyShortRetail The monetary amount of the tax exemption
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.
InventoryControlDocumentTaxLineItem
Definition: A type of INVENTORY CONTROL DOCUMENT LINE ITEM that records sales, use and value added taxes applicable to the whole INVENTORY CONTROL
DOCUMENT.
TaxAuthorityID (FK) Identity A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
TaxGroupID (FK) Identity A unique retailer assigned identifier for the TaxGroup
TaxableAmount MoneyShortRetail The taxable amount for which tax is to be paid
TaxAmount MoneyShortRetail The amount of tax that is being paid
InventoryLocation
Definition: 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 stores performance.
InventoryLocationID (PK) Identity A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
ParentLocationID (FK) Identity A unique system assigned identifier for the parent InventoryLocation of the nominated
InventoryLocation within the retail enterprise.
LocationLevelID (FK) Identity A unique identifier for the location level of the parent InventoryLocation.
Name Name The name designated to identify the LOCATION, eg first floor sales area.
Size Quantity The size of the location in an appropriate UnitOfMeasure
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 another.
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.
InventoryLocationEnvironmentClass
Definition: 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
EnvironmentClassCode (PK) (FK) Code6 A code that identifies a class environmental properties of a location. For instance, this might
describe humidity, temperature, or lighting restrictions or requirements
InventoryLocationLevel
Definition: A group of locations at the same hierarchical level within the location hierarchy.
LocationLevelID (PK) Identity A unique identifier for a specific location level.
Description DescriptionNarrative A narrative that describes a 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 .
InventoryTransactionJournalEntry
Definition: 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.
InventoryTransactionJournalID (PK) Identity A unique identifier for the INVENTORY TRANSACTION JOURNAL.
RetailStoreGroupID (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
RetailTransactionLineItemSequenceNumber (FK) LineNumber The sequence number of line item within the context of this RetailTransaction.
InventoryAdjustmentDocumentID (FK) Identity A unique identifier for an INVENTORY ADJUSTMENT DOCUMENT which lists adjustments
InventoryAdjustmentLineNumber (FK) LineNumber The line number for a specific line item adjustment.
PhysicalItemCountLineNumber (FK) Identity The physical count line item.
PhysicalCountDocumentID (FK) Identity The identifier for the physical count document on which the actual item counts are recorded.
InventoryControlDocumentLineNumber (FK) LineNumber The INVENTORY CONTROL DOCUMENT LINE NUMBER specifies the line number within the
InventoryControlDocumentID (FK) Identity The reference number that uniquely identifies the INVENTORY CONTROL DOCUMENT.
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.
RetailUnitCount Quantity The actual number of units of a specific ITEM.
StockLedgerActionCode Code4 Defines the action taken against a specific stock ledger item location by the source transaction.
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.
RetailUnitAllowanceAmount Money The allowance permitted between the actual count and the inventory on hand unit amount.
Item
Definition: The lowest level of merchandise for which inventory and sales records are retained within the retail store. It is analogous to the SKU ( Stock Keeping Unit).
ItemID (PK) Identity The retailers SKU or unique item identifier for items sold or returned.
ItemSellingPricesID (FK) Identity A unique system assigned identifier for the ItemSellingPrices.
ItemSellingRuleID (FK) Identity A unique system assigned identifier for the ItemSellingPrices.
POSDepartmentID (FK) Identity A unique system-assigned identifier for the POSDepartment
PriceLineID (FK) Identity A unique identifier for this price point.
MerchandiseHierarchyID (FK) Identity Unique identifier for a merchandise structure.
BrandName (FK) Name A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer.
AuthorizedForSaleFlag Flag A flag to indicate that the RETAIL STORE is authorized to stock this particular ITEM.
DiscountFlag Flag A flag to indicate whether this ITEM can be discounted.
PriceAuditFlag Flag A flag to denote whether this ITEM was validated (scanned) during verification of the ITEM table.
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.
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.
Name Name The name by which the ITEM is known.
Description DescriptionShort The textural description of the ITEM and its characteristics.
TypeCode Code4 This code indicates whether the item is a STOCK ITEM or SERVICE ITEM.
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.
SubstituteIdentifiedFlag Flag An ITEM for which there is a substitute available for sale within the RETAIL STORE.
OrderCollectionCode Code2 A code to signify that this ITEM is ordered as part of a collection of ITEMs.
ItemAlternateIdentity
Definition: Defines an alternative identifier for a STOCK ITEM entity type instance. The alternative identifier is assigned by the retail store.
RetailItemAlternateID (PK) Identity An alternate identifying number or code for an item.
ColorCode (FK) 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
SizeCode (FK) 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.
StyleCode (FK) Code4 A code that uniquely identifies the specific appearance type or variety in which an APPAREL
ITEM is available.
UsageCode Code2 A code that defines how this ITEM ALTERNATE IDENTITY is to be used.
Description DescriptionShort The textual description for the alternate ITEM.
CaseCodePackCount Quantity The number of units in the case for the alternate ITEM.
ItemChoice
Definition: A mapping from a parent GroupSelectItem to Item denoting one of the choices that may be made by the customer at the time of sale.
MemberID (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
ItemCollection
Definition: 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.
CollectionID (PK) (FK) Identity The retailers SKU or unique item identifier for an Item which is a collection of other items.
MemberID (PK) (FK) Identity The retailers SKU or unique item identifier for an Item which is a member of the collection Item.
SequenceNumber LineNumber Assigns a sequence / sorting order for the items in the collection.
PerAssemblyCount Quantity The number of individual constituent ITEMs within the ITEM COLLECTION.
BlendPercent Percent The percentage of the parent item that comes from the child item.
ItemCreation
Definition: A type of ITEM - MAINTENANCE EVENT that creates a new ITEM entity and related supporting attributive entities.
ItemDeletion
Definition: A type of ITEM - MAINTENANCE EVENT that deletes an ITEM entity and its associated supporting attributive entities.
ItemDescriptonUpdate
Definition: A type of ITEM - MAINTENANCE EVENT that updates the non-retail price descriptive data for an ITEM and its attributive entities.
ItemElectronicLabel
Definition: 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.
LabelID (PK) (FK) Identity A unique identifier for a specific ITEM LABEL.
ItemLabel
Definition: 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.
LabelID (PK) 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.
ItemLot
Definition: 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.
ItemLotID (PK) Identity An identifier for a LOT of specific ITEMs.
ItemLoyaltyAccountEligibility
Definition: A specific items eligibility for loyalty account point accrual.
ItemMaintenanceEvent
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of an Item.
FunctionCode Code2 Defines the maintenance action taken by this ITEM - MAINTENANCE EVENT against an ITEM.
ItemPriceDerivationRule
Definition: 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 the items that triggered the eligibility.
PriceDerivationRuleID (PK) (FK) Identity A identifier for a specific price derivation rule.
ReductionMethodCode Percent A code denoting the method for calculating the new price for the item. Possible values include,
Amount Reduction, Percent Reduction, New Price, and Cost Price Plus.
ReductionFromPriceCode Code A code denoting which price is to be used as the base price when calculating the price
reduction. Possible values include: ManufacturerPrice, PermanentSellingPrice,
CurrentSellingPrice.
ReductionAmount MoneyShortRetail The reduction to be appled to the item being marked down, expressed as a dollar amount.
ReductionPercent Percent The reduction to be appled to the item being marked down, expressed as a percentage of the
original price
NewPriceAmount MoneyShortRetail The reduction to be appled to the item being marked down, expressed as the new price for the
item.
ItemPriceDerivationRuleEligibility
Definition: 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.
ThresholdTypeCode Code4 A code for the type of threshold wich applies to a price derivation rule eligibility.
ThresholdQuantity Quantity A quanity of items within a single merchandise structure level required to be purchased to trigger
this price derivation rule.
ThresholdAmount Money A monetary amount within a single merchandise structure level required to be purchased to
trigger this price derivation rule.
IntervalQuantity Quantity An interval quantiy for which this price derivation rulle eligible.
IntervalAmount Money An interval monetary armount for which this price derivation rulle eligible.
LimitQuantity Quantity The maximum number of items within a merchanidise structure level for which this price
deriviation rule is eligible.
LimitAmount Money The maximum monetary amount within a merchanidise structure level for which this price
ItemPriceMaintenance
Definition: A type of ITEM MAINTENANCE EVENT that updates the current retail price of an item or creates, updates or deletes a PRICE DERIVATION RULE.
TypeCode Code2 A code to denote how the permanent price is actioned, ie global or individual ITEM amendment.
ItemSalesProhibitionPeriodRule
Definition: 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.
StartDayOfWeekCode DateFiscalDay A code to denote the start date in the week for the item sales restriction.
EndDayOfWeekCode DateFiscalDay A code to denote the end 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.
EndTime Time A code to denote the end time on a specified day for the item sales restriction.
ItemSalesSummary
Definition: Sales accumulations for RETAIL ITEMS by different FISCAL PERIODs.
ItemSalesAmount Money The monetary value of ITEMS sold during the REPORTING PERIOD
ItemSalesUnitCount QuantityShortCount The number of ITEMs sold during the REPORTING PERIOD
ItemSalesTransactionCount QuantityTransactionCount The number of TRANSACTIONS featuring the sale of this ITEM during the REPORTING
PERIOD
ItemReturnAmount Money The monetary value of ITEMS returned during the REPORTING PERIOD
ItemReturnUnitCount QuantityShortCount The number of ITEMs returned during the REPORTING PERIOD
ItemReturnTransactionCount QuantityTransactionCount The number of TRANSACTIONS featuring the return of this ITEM during the REPORTING
PERIOD
ItemDiscountAmount Money The monetary value of all ordinary discounts applied to this ITEM during the REPORTING
PERIOD
ItemDiscountUnitCount QuantityShortCount The number of ITEMs that had an ordinary discount applied to during the REPORTING PERIOD
ItemDicountTransactionCount QuantityTransactionCount The number of TRANSACTIONS featuring the application of ordinary discounts to this ITEM
during the REPORTING PERIOD
ItemEmployeeDiscountAmount Money The monetary value of all employee discounts applied to this ITEM during the REPORTING
PERIOD
ItemEmployeeDiscountUnitCount QuantityShortCount The number of ITEMs that had an employee discount applied to during the REPORTING
PERIOD
ItemEmployeeDiscountTransactionCount QuantityTransactionCount The number of TRANSACTIONS featuring the application of employee discounts to this ITEM
ItemStoreCouponAmount Money The monetary value of all StoreCoupons presented for this ITEM during the REPORTING
PERIOD
ItemStoreCouponUnitCount QuantityShortCount The number of ITEMs for which StoreCoupons presented during the REPORTING PERIOD
ItemStoreCouponTransactionCount QuantityTransactionCount The number of TRANSACTIONSs during which StoreCoupons were presented for this ITEM
ItemStoreRefundAmount Money The monetary amount of all Store Refunds applied to this ITEM during the REPORTING
PERIOD
ItemStoreRefundUnitCount QuantityShortCount The number of store refunds that were applied to this ITEM during the REPORTING PERIOD
ItemStoreRefundTransactionCount QuantityTransactionCount The number of TRANSACTIONS during which store refunds were applied to this ITEM during
the REPORTING PERIOD
ItemMarkdownAmount Money The total value of ITEM markdowns sold within the REPORTING PERIOD.
ItemMarkdownUnitCount QuantityShortCount The total number of items marked down within the REPORTING PERIOD.
ItemMarkdownTransactionCount QuantityTransactionCount The number of TRANSACTIONS during which this ITEM was marked down during the
REPORTING PERIOD
ItemVoidAmount Money The total monetary value of items voided items within the REPORTING PERIOD.
ItemVoidUnitCount QuantityShortCount The total number of items voided within the REPORTING PERIOD.
ItemVoidTransactionCount QuantityTransactionCount The number of TRANSACTIONS during which this ITEM was voided during the REPORTING
PERIOD
ItemSellingPriceHistory
Definition: 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.
ItemRetailPriceSequenceNumber (PK) LineNumber The reference number that applies to each occurrence of a price change.
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.
UnitRetailPriceAmount MoneyShortRetail The historical unit retail price of an item associated with an event.
ItemSellingPrices
Definition: The set of prices that re applied to an Item
ItemSellingPricesID (PK) Identity A unique system assigned identifier for the ItemSellingPrices.
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.
PermanentRetailPricePermanentMarkdownCount QuantityTransactionCount The number of permanent markdowns taken against this item.
PermanentRetailPriceEffectiveDate DateCalendar The date when the permanent retail price becomes effective. This will impact the stock ledger
valuation (retail method).
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.
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.
CurrentSaleUnitRetailPricePointAllowedFlag Flag This flag determines whether this ITEM may or may not have an associted price point.
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.
ManufacturerSaleUnitRecommendedRetailPriceAmount MoneyShortRetail The suggested sale unit retail price provided by the items manufacturer.
ManufacturerSaleUnitRecommendedRetailPriceEffectiveDate DateCalendar The date the manufacturers suggested retail price becomes effective.
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.
QuantityPricingFlag Flag Denotes whether the item is priced using Quantity Package Price (Eg: 3 for $0.89)
CurrentPackagePriceQuantity QuantityShortCount The Quantity part of the current package quantity price (Eg: 3 for $1.00)
CurrentPackagePrice MoneyShortRetail The Price part of the current package quantity price (Eg: 3 for $1.00)
PermanentPackagePriceQuantity QuantityShortCount The Quantity part of the permanent package quantity price (Eg: 3 for $1.00)
PermanentPackagePrice MoneyShortRetail The Price part of the permanent package quantity price (Eg: 3 for $1.00)
PermanentSaleUnitReturnPrice MoneyShortRetail The ordinary or regular price to be refunded when the item is returned by a customer.
CurrentSaleUnitReturnPrice MoneyShortRetail The crrent price to be refunded when the item is returned by a customer.
ItemSellingRule
Definition: A set of commonly used selling rules for Items. Usually this entity will be in a one-to-one relationship with Item, except when each combination of Size/Color/Style of
a particular piece of merchandise are individually assigned to a new SKU for inventory recording purposes but all Sizes/Colors/Styles of that item have the same selling rules.
ItemSellingRuleID (PK) Identity A unique system assigned identifier for the ItemSellingPrices.
ItemTenderRestrictionGroupCode (FK) Code2 A code to denote a specific group of ItemTenderRestrictions which are part of the SellingRule.
ManufacturerFamilyCode (FK) ProductCodeFamily The UPC designated three digit coupon family code for the manufacturer item.
DepositRuleID (FK) Identity A unique system assigned identifier for the deposit rule which is part of the ItemSellingRule
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.
CouponRestrictedFlag Flag A flag to indicate whether a coupon can be redeemed for this ITEM
ElectronicCouponFlag Flag A flag to denote whether an electronic coupon us available for this ITEM. The value of the
coupon is automatically applied to the purchase, no coupon media is exchanged.
PriceEntryRequiredFlag Flag A flag to denote that the retail price is to be manually entered when this ITEM is sold.
WeightEntryRequiredFlag Flag A flag to indicate that the weight of the Item being sold, has to be entered into the system (either
manually or automatically) to derive the retail price.
EmployeeDiscountAllowedFlag Flag A flag that enables or disables price derivation rule eligibility to all employees for this Item.
AllowFoodStampFlag Flag A flag to inicate whether food stamps can be tendered for this Item.
AllowCouponMultiplyFlag Flag A flag that enables or disables multiple coupon promotions. Used to enable or disable double or
triple coupon promotions.
MaximumSaleUnitCount QuantityShortCount Defines the maximum number of retail sale units that may be purchased in a single
RetailTransaction. Typically this is used for "rationed " merchandise. (Eg: Nintendo 64 in
Christmas 1995)
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 an Item rather than use a Repeat key to ensure
inventory integrity and avoid arithmetic errors.
VisualVerifyPriceFlag Flag A flag to denote whether the operator must verify the price on the Item with the price dervied
from the price lookup table.
FrequentShopperPointsEligibilityFlag Flag A flag to denote that the Item is eligible for frequent shopper points.
FrequentShopperPointsCount Quantity The number of frequent shopper points awarded for the purchase of the Item.
QuantityKeyProhibitFlag Flag A flag denoting that the Quantity key may not be used when selling this Item.
ProhibitReturnFlag Flag A flag to denote whether or not this item may be returned. (Eg: Freezer or Chilled merchandise)
WICFlag Flag A flag denoting if this Item is allowed in a WIC transaction
GiveawayFlag Flag A flag denoting whether this item may be given away free as part of a promotion.
ItemShelfLabel
Definition: 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.
ItemSubstitution
Definition: A 3-way join of Items, MemberID within CombinedItemID may be substituted with SubstituteID.
CollectionID (PK) (FK) Identity The retailers SKU or unique item identifier for an Item which is a collection of other items.
MemberID (PK) (FK) Identity The retailers SKU or unique item identifier for an Item which is a member of the collection Item.
SubstituteID (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
Count QuantityShortCount The number of Substitute Items that constitute a fair replacement of a Member Item within the
Combined Item.
PriceAdjustment MoneyShortRetail A monetary value being the change in price for the Combined Item that occurs when the
substitution occurs.
ItemTenderRestrictionGroup
Definition: 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.
ItemTenderRestrictionGroupCode (PK) Code2 A code to denote a specific group of ITEM TENDER RESTRICTIONs.
Description DescriptionShort The description of a group of TENDER RESTRICTIONs which apply to specific ITEMs.
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.
ItemTenderRestrictionRule
Definition: 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.
ItemTenderRestrictionGroupCode (PK) (FK) Code2 A code to denote a specific group of ITEM TENDER RESTRICTIONs.
Name Name The rule that prohibits the purchase of certain ITEMs by certain tender types.
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.
StatusCode Code2Status A code to indicate whether the restriction rule applies to a certain ITEM or not.
ItemTicket
Definition: 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.
Job
Definition: Defines the functions, duties, responsibilities and authority delegated to one or more positions within the retail enterprise.
JobCode (PK) Code6 A unique identifier for a JOB or funcation.
Name Name A name or label that describes a JOB.
Description DescriptionNarrative A narrative that describes the functions and responsibilities of a JOB.
KeyCustomer
Definition: 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 retailer.
KeyCustomerClient
Definition: 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.
KeyCustomerID (PK) (FK) Identity A unique identifier for a customer.
TypeCode String A grouping of clients based on the relationship between the key customer and the client.
Language
Definition: An infrastructural entity defining Languages for which the system keeps some string translations.
LanguageID (PK) Code4External A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular
country.
Name Name The name of the language (in the language itself) eg: English, Francais, Deutch
LicenseSalesRestriction
Definition: A restriction or limitation on the sales of a class of items based on the purchasers profession, license, or other certification.
Description String A narrative that describes the restriction of sales to those holding a license or certification.
LoyaltyAccountAgreement
Definition: An agreement between the loyalty account member and the enterprise.
LoyaltyProgramID (PK) (FK) Identity A artificial, unique identifier for a loyalty program.
LoyaltyAccountTerm
Definition: Terms and conditions associated with a promotional program.
LoyaltyProgramID (PK) (FK) Identity A system assigned unique identifier for a loyalty program.
LoyaltyProgramTermID (PK) Identity A system assigned unique identifier for the Loyalty Program Terms & Conditions being defined.
Description DescriptionNarrative A human readable description of the terms & conditions.
LoyaltyAward
Definition: 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.
LoyaltyAwardID (PK) Identity A unique system generated identifier for the LoyaltyAward.
ItemID (FK) Identity The retailers SKU or unique item identifier for the item that is being given away as a
LoyaltyAward.
TypeCode Code2 Indicates the type of promotional award given. For example the award may be an item, a gift
certificate, as savings bond, etc.
LoyaltyProgram
Definition: A membership-based customer incentive initiative.
LoyaltyProgramID (PK) Identity A artificial, unique identifier for a loyalty program.
Name Name A name or tradename for a loyalty program.
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.
Manufacturer
Definition: The external party that manufactures the ITEM.
ManufacturerID (PK) Identity A unique identifier to denote the ITEM MANUFACTURER.
Name Name The name of the MANUFACTURERs organization.
ManufacturerBrand
Definition: 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
BrandName (PK) (FK) Name A unique name to denote a class of ITEMs as a product of a single supplier or manufacturer.
ManufacturerID (PK) (FK) Identity A unique identifier to denote the ITEM MANUFACTURER.
ManufacturerCouponFamily
Definition: Code assigned by the manufacturer to classify product for promotion purposes. In the ARTS model it is used to validate manufacturers coupons.
ManufacturerID (PK) (FK) Identity A unique identifier to denote the ITEM MANUFACTURER.
ManufacturerFamilyCode (PK) ProductCodeFamily The UPC designated three digit coupon family code for the manufacturer item.
CouponTypeCode (FK) Code2 A code to denote the type of coupon, e.g. raincheck, manufacturer coupon, electronic coupon.
Description DescriptionShort The description for a coupon family code for the manufacturer item.
ManufacturerPriceDerivationRuleEligibility
Definition: 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.
MerchandiseHierarchyFunction
Definition: A business function for which new MerchandiseHierarchy classifications are created.
MerchandiseHierarchyFunctionID (PK) Identity A unique system assigned identifier for the MerchandiseHierarchyFunction
Name DescriptionShort The name of MerchandiseHierarchyFunction
MerchandiseHierarchyGroup
Definition: An aggregation level for rolling ITEM sales and units for reporting purposes and for mapping item-level activity into the retailers merchandise structure.
MerchandiseHierarchyID (PK) Identity Unique identifier for a merchandise structure.
Merchant (FK) Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR
function.
Name Name The business name for the merchandise structure.
Description DescriptionShort A brief text description of the merchandise structure.
MerchandiseHierarchyLevel
Definition: Establishes the levels of the merchandise hierarchy structure for rolling up sales units and financial amounts for ITEMs.
MerchandiseHierarchyFunctionID (PK) (FK) Identity A unique system assigned identifier for the MerchandiseHierarchyFunction
MerchandiseHierarchyLevelCode (PK) Code4 A unique system assigned identifier for the Level within the merchandise hierarchy tree.
ParentMerchandiseHierarchyLevelCode (FK) 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.
Name Name The retailer-specific description associated with a merchandise-hierarchy-level-code. This
attribute allows retailers to assign any description they choose to each level.
MerchandiseHierarchySalesPlan
Definition: Budgeted sales for a MerchandiseHierarchy by different ReportingPeriods
MerchandiseHierarchyID (PK) (FK) Identity Unique identifier for a merchandise structure.
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.
MerchandiseHierarchySalesSummary
Definition: Sales accumulations for MERCHANDISE HIERARCHY points by different FISCAL PERIODs.
ItemSalesAmount 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.
ItemSalesUnitCount QuantityShortCount The cumulative number of ITEMs sold by the RETAIL STORE. The ITEMs are recorded at the
various merchandise hierarchy for each REPORTING PERIOD.
ItemSalesTransactionCount QuantityTransactionCount The cumulative number of transactions involving item sales. The item sales are recorded at the
various MERCHANDISE HIERARCHY levels for each REPORTING PERIOD.
ItemReturnAmount Money The cumulative monetary value of item returns for the RETAIL STORE, recorded at the various
merchandise hierarchy levels, for each REPORTING PERIOD.
ItemReturnUnitCount QuantityShortCount The cumulative number of item returns for the RETAIL STORE, recorded at the various
ItemReturnTransactionCount QuantityTransactionCount The cumulative number of item returns for the RETAIL STORE, recorded at the various
ItemDiscountAmount 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.
ItemDiscountUnitCount QuantityShortCount 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.
ItemDiscountTransactionCount 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.
ItemEmployeeDiscountAmount 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.
ItemEmployeeDiscountUnitCount QuantityShortCount 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.
ItemEmployeeDiscountTransactionCount 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.
ItemStoreCouponAmount 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.
ItemStoreCouponUnitCount QuantityShortCount 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.
ItemStoreCouponTransactionCount 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.
ItemStoreRefundAmount Money The cumulative monetary value of item refunds for the RETAIL STORE, recorded at the various
ItemStoreRefundUnitCount QuantityShortCount The cumulative number of item refunds for the RETAIL STORE, recorded at the various
ItemStoreRefundTransactionCount QuantityTransactionCount The cumulative number of transaction refunds for the RETAIL STORE, recorded at the various
ItemMarkdownAmount 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.
ItemMarkdownUnitCount QuantityShortCount The cumulative number of markdowns recorded by the RETAIL STORE. These markdowns are
recorded at the various merchandise hierarchy levels for each REPORTING PERIOD.
ItemMarkdownTransactionCount 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.
ItemTransactionCount QuantityTransactionCount The cumulative number of transactions for the RETAIL STORE, recorded at the various
ItemDaysOnPromotionCount 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.
MerchandiseStructureLevelSalesRestriction
Definition: A restriction that limits a particular levels eligibility for sale.
MerchandiseStructureLevelSize
Definition: A cross reference of SIZEs that are available for a specific MERCHANDISE STRUCTURE LEVEL, specifically the department level.
SizeCode (PK) (FK) Code6 A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous
MerchandiseStructurePriceDerivationRuleEligibility
Definition: 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.
ThresholdTypeCode Code4 A code for the type of threshold wich applies to a price derivation rule eligibility.
ThresholdQuantity Quantity A quanity of items within a single merchandise structure level required to be purchased to trigger
this price derivation rule.
ThresholdAmount Money A monetary amount within a single merchandise structure level required to be purchased to
trigger this price derivation rule.
IntervalQuantity Quantity An interval quantiy for which this price derivation rulle eligible.
IntervalAmount Money An interval monetary armount for which this price derivation rulle eligible.
LimitQuantity Quantity The maximum number of items within a merchanidise structure level for which this price
LimitAmount Money The maximum monetary amount within a merchanidise structure level for which this price
MiscellaneousFee
Definition: 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.
Description DescriptionShort Describes this miscellaneous fee
CustomerPaysForDispositionFlag Code4 Flag that determines whether the customer is charged for this misc. fee or the store absorbs it as
an expense.
MiscellaneousFeeLineItem
Definition: 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.
Amount Money The amount of the miscellaneous fee to be booked.
MissingVolumeEvent
Definition: 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.
StockMeterID (FK) Identity A unique identifier for the stock meter
FirstReading (FK) Number The first StockMeter value that was used to deduce the missing volume event.
SecondReading (FK) Number The second StockMeter value that was used to deduce the missing volume event.
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
MixAndMatchPriceDerivationItem
Definition: 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.
PromotionalProductID (PK) (FK) Identity A unique identifier for a Promotional Product.
ReductionMethodCode Code2 A code denoting the method for calculating the new price for the item. Possible values include,
Amount Reduction, Percent Reduction, New Price, and Cost Price Plus.
ReductionPercent Percent The percentage markdown each time this rule is applied.
ReductionAmount Money The monetary amount of the markdown each time this rule is applied.
NewPriceAmount Money A reduction expressed as a new price.
MarkdownAllocationPercent Percent The percentage of the total markdown from the PROMOTION that is to be applied to this item.
Example: Burger normally costs $2.00 with Fries & Coke normally $1.00 each. When combined
in a Mix n Match Promotion at $3.50 the missing 50cents may need to be allocated back to the
constituent parts for taxation and other reasons.
MixAndMatchPriceDerivationRule
Definition: 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 eligibility.
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.
MultiplePriceDerivationRuleEligibility
Definition: A recursive associative entity linking a parent PriceDerivationRuleEligibility with a child PriceDerivationRuleEligibility. The parent will be of type
CombinatonPriceDerivationRuleEntity - which defines the combination function for the children Eg: AND, OR, XOR
Parent (PK) (FK) Identity A unique identifier for a Price Derivation Rule Eligibility.
Child (PK) (FK) Identity A unique identifier for a Price Derivation Rule Eligibility.
MultipleUnitThreshold
Definition: 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.
ThresholdLevelID (PK) 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.
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.
NonProfitEnterprise
Definition: An organization that has been designated as non-profit or not-for-profit for tax purposes.
RegistrationNumber DescriptionShort A tax or other government identifier that is assigned to non-profit organization.
NonStandardAddress
Definition: An address that is not covered by address postal standards.
AddressID (PK) (FK) Identity A unique identifier for a location and mail address.
AddressLine1 Address A generic holder of non-standardized address infomration.
AddressLine2 Address A generic holder of non-standardized address infomration.
UnitName Name An appartment, suite, office or other locations ID.
TerritoryName Name A state, provice, or other region within a country.
CountryName Name The name of a country or territory.
PostalCode PostalCode A code assigned by the postal authority and used for mail delivery.
Nozzle
Definition: That part of the FUELING POINT that blends and measures the volume of fuel dispensed during a FUELING TRANSACTION.
NozzleID (PK) Identity A unique identifier for the Nozzle
SalesMeterID (FK) Identity A system-assigned unique identifier for a sales meter.
NozzleFuelingTransactionHistory
Definition: 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 FuelingTransactions
ServiceLevelID (PK) (FK) Identity A unique identifier for the service level
PriceLevelID (PK) (FK) Identity A unique identifier for the price level
TimeGroupID (PK) (FK) Identity A unique identifier for the time group
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
PostPayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions performed 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.
PrepayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the
ReportingPeriod
NozzleHistory
Definition: 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 FuelingTransactio
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
PostpayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions performed 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
PrepayFuelingTransactionVolume Quantity The number of Prepay FuelingTransactions performed on the LogicalNozzle during the period of
PrepayFuelingTransactionAmount Money The total monetary amount of FuellingTransactions prepaid at the LogicalNozzle during the
period of time covered by the ForecourtSettlementTransaction
OccasionRecommendation
Definition: 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.
Operator
Definition: An employee or any other authorized individual who may enter transactions into the stores workstations. The OPERATOR is accountable for the tender collected and
dispensed while assigned to a WORKSTATION.
OperatorID (PK) Identity A unique, automatically assigned number used to identify a workstation OPERATOR.
AccessPassword Password A security password entered by an operator and used to verify his/her identity when signing on
to a WORKSTATION.
OperatorGroup
Definition: 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.
WorkGroupID (PK) (FK) Identity A unique identifier for a work classification group to which EMPLOYEEs are assigned.
OperatorHistory
Definition: A collection of monetary and operational totals used to track the activity volume of an operator during a reporting period.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans recorded against the workstation OPERATOR for each
REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary amount of positive gross sales recorded by OPERATOR for each
REPORTING PERIOD. Positive gross sales exclude returns.
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.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by OPERATOR for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by OPERATOR for each REPORTING
PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids made by OPERATOR for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of post transaction voids by OPERATOR for each REPORTING
PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING
PERIOD.
TransactionVoidTotalAmount Money The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
TotalTranactionVoidCount QuantityTransactionCount The total number of transaction voids recorded by OPERATOR for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups recorded against the workstation OPERATOR for each
REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by OPERATOR for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary amount of tender loans by OPERATOR for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns made by OPERATOR for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of item returns received by OPERATOR for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds made by OPERATOR for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of item refunds actioned by OPERATOR for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts actioned by OPERATOR for each
REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of line item employee discounts recorded by OPERATOR for each
REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts recorded by OPERATOR for each
REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discounts actioned by OPERATOR for each REPORTING
PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by OPERATOR for each REPORTING
PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by OPERATOR for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by OPERATOR for each
REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING
PERIOD.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by OPERATOR for each REPORTING
PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of item markdowns actioned by OPERATOR for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by OPERATOR for each REPORTING
PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by OPERATOR for each
REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fee item sales recorded by OPERATOR for each
REPORTING PERIOD.
ContainerDepositTotalAmount Money The total monetary amount of container discounts collected by OPERATOR for each
PORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by OPERATOR for each REPORTING
PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by OPERATOR for each REPORTING
PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account received by OPERATOR for each REPORTING
PERIOD.
LayawayPaymentsCollectedTotalAmount MoneyShortCost The total monetary amount of layaway payments collected by OPERATOR for each
REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaways payments collected by OPERATOR for each REPORTING
PERIOD.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash disbursements by OPERATOR for each REPORTING
PERIOD.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of disbursement line items made by OPERATOR for each REPORTING
PERIOD.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax recorded by OPERATOR for each
REPORTING PERIOD.
TaxTotalAmount Money The total tax amount recorded by OPERATOR for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount recorded by OPERATOR for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by OPERATOR for each REPORTING
PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides made by OPERATOR for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items recorded 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.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned 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.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by the OPERATOR for
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
NoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded 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.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by operator where no sales are being recorded 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.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales recorded by OPERATOR for each REPORTING PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of sign-offs made by OPERATOR for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of sign-on made by OPERATOR for each REPORTING PERIOD.
TotalTenderOverAmount Money The total monetary amount of tender overages recorded against the workstation OPERATOR for
TotalTenderUnderAmount Money The total monetary amount of tender shortages recorded by OPERATOR for each REPORTING
PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliations for an 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.
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.
ResumedTotalAmount Money The total monetary amount of TRANSACTIONs resumed by OPERATOR for each REPORTING
PERIOD.
WorkstationResumedTransactionCount QuantityTransactionCount The total number of resumed transactions recorded by OPERATOR for each REPORTING
PERIOD.
OperatorResourceAccess
Definition: This entity defines the rules which permits an OPERATOR to gain access to a specific RESOURCE within the RETAIL STORE.
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
OperatorTaxHistory
Definition: A collection of tax totals for a tax authority by operator for a reporting period.
government body.
TaxCollectedTotalAmount Money The total monetary amount of tax recorded by OPERATOR for each REPORTING PERIOD.
TaxableSaleTotalAmount Money The total monetary amount of taxable sales 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.
OperatorTenderHistory
Definition: A collection of tender type accumulators by operator for a reporting period. This entity is used to support employee tender accountability.
OperatorTender (PK) (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
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.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The open balance of the number of tender media units for that OPERATOR for each
REPORTING PERIOD.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender media units loaned by operator for each REPORTING PERIOD.
LoanMediaTotalAmount Money The total monetary amount of tender media units loaned by operator for each REPORTING
PERIOD.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender media units picked up by operator for each REPORTING PERIOD.
PickupMediaTotalAmount Money The total monetary amount of tender media units picked up by operator for each REPORTING
PERIOD.
DepositTotalAmount Money The total monetary value of tender media deposited in the EXTERNAL DEPOSITORY by
TotalTenderDepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited in the EXTERNAL DEPOSITORY by
OverTotalAmount Money The total monetary value of tender overages recorded by OPERATOR for each REPORTING
PERIOD.
ShortTotalAmount Money The total monetary value of tender shortages recorded for that OPERATOR for each
REPORTING PERIOD.
OrderDocument
Definition: 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.
BuyerID Identity The BUYER_ID specifies the corporate buyer responsible for the purchase of merchandise
specified in the order document.
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.
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.
Organization
Definition: A company, association, institution, or other enterprise of interest to a retail store or retail enterprise.
Name Name An ORGANIZATIONs legal trade name.
TaxID DescriptionShort A tax or other number assigned by a governing body that is unique to all ORGANIZATIONs
within that governing bodys jurisdiction.
LegalStatusCode Code2Status A code that indicates the ORGANIZATIONs legal or tax status. For example, this may be
Commercial Corporation, Not-for-profit, Non-profit, Academic, Government, etc.
FederalTaxID DescriptionShort A tax or other number assigned by a federal government that is unique to all ORGANIZATIONs
within that federal governments jurisdiction.
StateTaxID DescriptionShort A tax or other number assigned by a state government that is unique to all ORGANIZATIONs
within that state governments jurisdiction.
OrganizationalAffiliation
Definition: A non-hierarchical affiliation of organizations.
Affiliated Organization (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
OrganizationalStructure
Definition: The hierarchical reporting or ownership relationship within an organization
Parent (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
Subordinate (FK) Identity A unique, automatically assigned identity for a PARTY.
PackingSlip
Definition: A document that identifies the merchandise items a supplier claims to be shipping to the store against one or more purchase orders.
PackingSlipID (PK) 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.
PackItem
Definition: A set of two or more of the same STOCK ITEM which are sold together, although they can be broken apart and sold separately if required. e.g. Carton of cigarettes or
6-pack of soda.
UnitNumberCount Quantity The number of units within the PACK ITEM
CubeCount Quantity The volume of the PACK ITEM
WeightCount Quantity The acual weight of the PACK ITEM including tare.
Party
Definition: An individual or firm that exchanges information and/or goods and services with the store.
PartyID (PK) Identity A unique, automatically assigned identity for a PARTY.
OrganizationTypeCode Code2 Describes the type of organization from the legal aspect, ie company which is either private,
public, limited liability, etc.
PartyTypeCode Code2 Defines the type of party a store is dealing with (e.g. a supplier, carrier, customer, etc.)
PartyAddress
Definition: A specific partys address.
PartyRoleTypeCode (PK) (FK) Code6 A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
StatusCode Code2Status An indicator of the addresss currency. For instance, this address may be valid, invalid,
temporary, etc.
EffectiveDate DateCalendar The date that a PARTYs address is valid for that PARTY.
ExpirationDate DateCalendar The date that a PARTYs address is no longer valid for that PARTY.
PartyAffiliation
Definition: A relationship between two Partys that has some meaning to the Retailer.
PartyAffiliationTypeCode (PK) (FK) Code2 A unique retailer assigned 2 leter code denoting the type of affiliation between two Partys.
MasterPartyID (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
SubPartyID (PK) (FK) Identity A unique, automatically assigned identity for a PARTY.
PartyAffiliationType
Definition: A type code defining a potential relationship between two Partys that has some meaning to the retailer.
PartyAffiliationTypeCode (PK) Code2 A unique retailer assigned 2 leter code denoting the type of affiliation between two Partys.
Description DescriptionShort A human readable description of the Party Affiliation reason.
PartyIdentification
Definition: An official number that may be used to identify a Party. People have multiple forms of such identification: Drivers License number , Passport number, Credit / Debit
Card number, Social Security number, Tax number, etc... Businesses may also have multiple identifiers to prove that they are a legal entity: Company Incorporation number, Tax
number, etc....
PartyIdentificationTypeCode (PK) (FK) Code2 A code denoting a form of identification that the customer uses to identify themselves.
Identifier Identity The number on the Identification that identifies the Party.
ExpirationDate DateCalendar The date after which the identification is no longer valid.
PartyIdentificationType
Definition: A particular type of Party Identification eg: Drivers License, Passport, Credit/Debit Card etc...
PartyIdentificationTypeCode (PK) Code2 A code denoting a form of identification that the customer uses to identify themselves.
Description DescriptionShort A short text string describing the PartyIdentificationType
PartyRole
Definition: A type of relationship that a person or organization has with the enterprise.
EffectiveDate DateCalendar The date that this role is valid.
ExpirationDate DateCalendar The date that this role is no longer valid.
PartyRoleStatus
Definition: The current state of a PARTY ROLE.
PartyRoleStateCode (PK) (FK) Code6 A unique code that will identify a group of party roles.
PartyRoleType
Definition: A categorization of PARTY ROLEs.
PartyRoleTypeCode (PK) Code6 A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.
Name Name A name or label for a group of party roles.
Description DescriptionNarrative A narrative that describes this group of party roles.
PartyRoleTypeState
Definition: This dependent entity defines ALL valid states that a specific PARTY ROLE TYPE may assume.
PartyRoleStateCode (PK) Code6 A unique code that will identify a group of party roles.
Name Name A name or label for a status of a PARTY ROLE
Description DescriptionNarrative A narrative that describes the status of a PARTY ROLE.
PaymentOnAccountLineItem
Definition: 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.
CustomerAccountCardID (FK) Number A unique retailer assigned identifier for a CustomerAccountCard.
PaymentReceivableFlag Flag A flag to denote that payment is outstanding on the account.
PaymentAgainstReceivableAmount Money The monetary payment on account received from the CUSTOMER.
PaymentAgainstReceivableAccountCode Code4 A code to denote the type of payment on account, eg layaway, house, etc.
PaymentAgainstReceivableCustomerAccountID Identity The unique identifier for the customer account .
PeriodCloseTransaction
Definition: A transaction that declares the end of a BusinessDay at the RetailStore where it is conducted.
PermanentPriceChange
Definition: A price change that modifies the inventory value for the ITEMs included in the EVENT. This price change normally only has a start date.
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 price.
PermanentPriceChangeItem
Definition: 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.
NewPrice MoneyShortRetail The new Permanent Retail Price to be applied to the Item in all stores in the RetailStoreGroup
as a consequence of the PriceChangeEvent
Person
Definition: A individual of interest to the retail store or retail enterprise.
Salutation Name Extra words that don t form part of the persons name but are normally printed before the
FirstName as a courtesy title. For instance, Mr. Ms., Miss, Dr., Prof. etc.
FirstName Name A persons first name. In western cultures, this is the given name, in other cultures it may be the
family name.
FirstNameType Code2 A code denoting what kind of name the FirstName is, possible values include: GivenName,
OtherGivenName, FamilyName, Patronymic
MiddleNames Name One or more middle names, that are printed between the persons first and last names.
MiddleNameType Code2 A code denoting what kind of name the MiddleName is, possible values include: GivenName,
LastName Name A persons last name. In western cultures, this is the family (or patronymic) name, in other
cultures it may be the given name.
LastNameType Code2 A code denoting what kind of name the LastName is, possible values include: GivenName,
Suffix Name Extra words that don t form part of the persons name but are normally printed after the
LastName to help identify the person. Example values include, Sr, Jr, III
GenderType Code2 A code for specifying a persons gender.
BirthDate DateCalendar A persons date of birth.
SortingName Name A culturally sensitive version of the persons name that is used when producing a sorted list of
names. Examples: Jones, W S McGrigor, S F Tryggvi, T
MailingName Name A culturally sensitive version of the persons name that is used when contacting them Examples:
Bill Jones, Stuey McGrigor Tryggvi Thordarson
OfficialName Name A culturally sensitive version of the persons name that is used for all legal documents.
Examples: William Stephen Jones Stuart Fergus McGrigor Tryggvi Magnus Thordarson
PersonOrgAffiliationType
Definition: A categorization of relationships between a PERSON and an ORGANIZATION.
PersonOrganizationAffilationTypeName (PK) String A name or label for a group of affiliations of people and organizations. For instance, this might
be employment .
Description DescriptionNarrative A narrative for a group of affiliations of people and organizations.
PersonOrganizationAffiliation
Definition: A relationship between a person and an organization that is of interest to the retailer.
PersonOrganizationAffilationTypeName (PK) (FK) String A name or label for a group of affiliations of people and organizations. For instance, this might
be employment .
Effective Date (PK) DateCalendar The start date of a PERSONs affiliation with an organization.
PhysicalCountDocument
Definition: 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.
PhysicalCountDocumentID (PK) Identity The identifier for the physical count document on which the actual item counts are recorded.
PhysicalCountLineItem
Definition: 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.
PhysicalCountDocumentID (PK) (FK) Identity The identifier for the physical count document on which the actual item counts are recorded.
PhysicalItemCountLineNumber (PK) Identity The physical count line item.
TankID (FK) Identity A unique identifier for the Tank that was measured by the reading.
TankProbeID (FK) Identity A system assigned unique identifier for the TankProbe that was used for the reading.
ReadingNumber (FK) LineNumber A unique identifier for this particular reading on this TankProbe
PhysicalInventoryEvent
Definition: An EVENT at which time the physical inventory occurs.
PhysicalLocation
Definition: A location of interest due to delivery or other service provision.
CoordinateTypeCode (PK) (FK) Code2AccessControl A categorization of co-ordinate systems.
PhysicalLocationCode (PK) Code6 A code that identifies a specific physical location.
PhysicalLocationAddress
Definition: A physical locations use of an address.
PhysicalLocationCode (PK) (FK) Code6 A code that identifies a specific physical location.
CoordinateTypeCode (PK) (FK) Code2AccessControl A categorization of co-ordinate systems.
POSDepartment
Definition: 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.
POSDepartmentID (PK) Identity A unique system-assigned identifier for the POSDepartment
ParentPOSDepartmentID (FK) Identity A unique system-assigned identifier for the parent POSDepartment.
Name Name The human readable name for the POSDepartment
POSDepartmentHistory
Definition: A collection of monetary and operational totals used to track the activity volume for a POS DEPARTMENT during a reporting period.
POSDepartmentID (PK) (FK) Identity A unique system-assigned identifier for the POSDepartment
LineItemVoidTotalAmount Money The total monetary amount of line item voids by POS department for each REPORTING
PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids 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
TotalPostTransactionVoidCount QuantityTransactionCount The total number of items cancelled by a post transaction void 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.
TotalTranactionVoidCount QuantityTransactionCount The total number of items cancelled by transaction void by POS department for each
REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns by POS department for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by POS department for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds by POS department for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by POS department for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by POS department for each REPORTING
PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee discounted items by POS department for each REPORTING
PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by POS department for each
REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discounted items 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.
TotalStoreCouponCount QuantityTransactionCount he total number of lines purchased in part or in full by store coupons by POS department for
RedeemedContainerDepositTotalAmount Money The total monetary amount of redeemed container deposits by POS department for each
REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount he total number of redeemed container deposits by POS department for each REPORTING
PERIOD.
MarkdownTotalAmount Money The total monetary amount of markdowns by POS department for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of markdowns by POS department for each REPORTING PERIOD.
NetItemSalesTotalAmount Money The total monetary amount of net item sales by POS department for each REPORTING
PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees by POS department for each REPORTING
PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees by POS department for each REPORTING PERIOD.
ContainerDepositTotalAmount Money The total monetary amount of container deposits by POS department for each REPORTING
PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits by POS department for each REPORTING PERIOD.
TaxTotalAmount Money The total monetary amount of tax item sales 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.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt item sales by POS department for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by POS department for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed item sales by POS department for each REPORTING PERIOD.
TotalLineItemKeyedCount QuantityTransactionCount The total number of keyed item sales by POS department for each REPORTING PERIOD.
TotalLineItemScannedCount QuantityTransactionCount The total number of scanned 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.
TotalLineItemScannedPercentage Percent The number of items scanned 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.
TotalSaleLineItemCount QuantityTransactionCount The total number of item sales by POS department for each REPORTING PERIOD.
POSDepartmentTaxHistory
Definition: A collection of tax totals for a tax authority for a POS DEPARTMENT for a reporting period.
government body.
TaxCollectedTotalAmount Money The total amount of tax collected by POS department for each REPORTING PERIOD.
TaxableSaleTotalAmount Money The total amount of taxable sales 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.
POSIdentity
Definition: A simple cross-reference between the barcode, point of sale scan code or other keyed identifying number used at POS and the internal stock keping ItemID for the
item. The POSItemID will generally be filled with the GTIN (UPC, EAN etc) for an item -- but it is not mandatory -- A retailer may develop and maintain its own set of POS
identifiers.
POSItemID (PK) Identity The barcode, point of sale scan code or other keyed identifying number used at POS and the
internal stock keping ItemID for the item. Will generally be filled with the GTIN (UPC, EAN etc)
for an item -- but it is not mandatory -- A retailer may develop and maintain its own set of POS
identifiers.
POSItemIDQualifier (PK) Identity A secondary qualifier on the POSItemID which denotes a separate item. Eg: When single bottles
& six-packs of the same beverage both have the same UPC or other barcode, the
POSItemIDQualifier holds denotes the two different items.
Position
Definition: A job or role that employees fill.
PositionID (PK) Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR
function.
JobCode (FK) Code6 A unique identifier for a JOB or funcation.
Description DescriptionNarrative A narrative that describes the POSTION or job.
Title Name A job title associated with a POSITION.
PayrollTypeCode Code6 A code indicating how this position is paid.
ShareFlag Flag An indicator for whether or not this position is eligible for job sharing.
CommissionFlag Flag An indicatory of whether or not this position is eligible for commission.
AccessLevelCode Code6 A code that indicates what access privileges are granted to a position.
PositionAllocation
Definition: The allotment of POSITIONs that have been approved for a specific RETAIL STORE.
RetailStoreID (PK) Identity A unique identifier for a specific RETAIL STORE within the organization. Typically, STOREs are
given a unique reference number.
LocationID (PK) Identity A unique identifier for a specific LOCATION within the RETAIL STORE.
function.
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.
PositionHierarchy
Definition: The reporting structure of POSTIONs.
Subordinate (PK) (FK) Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR
function.
Supervisor (PK) (FK) Identity A unique identifier for a specific job. This may or may not be controlled by a centralized HR
function.
EffectiveDate DateCalendar The valid start date for a positions reporting structure
ExpirationDate DateCalendar The date that a positions reporting structure is no longer valid.
PositionWorkSchedule
Definition: A shift schedule for a position
PositionWorkScheduleWeekDay (PK) Name The name of the day that this schedule is for.
function.
StartTime Time The beginning time for this schedule.
FinishTime Time The ending time for this schedule.
Hours Number Total hours for this schedule.
POSLockTransaction
Definition: 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.
POSNoSaleTransaction
Definition: 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
PostVoidTransaction
Definition: A non sales transaction that cancels a prior SALES/ RETURN TRANSACTION. The workstation will normally record each individual instance of this
TRANSACTION by EMPLOYEE.
VoidedWorkstationID (FK) Identity The unique identifier for the WORKSTATION, typically the serial number.
VoidedBusinessDayDate (FK) DateCalendar The calendar date of the BusinessDay.
VoidedTransactionSequenceNumber (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify a
POSUnlockTransaction
Definition: 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.
PreferenceType
Definition: A grouping of preferences. For instance, clothing style -related preferences may be grouped together under a type.
PreferenceTypeCode (PK) Code2 A unique code for a group of preferences. For instance, all the types of material (clothing)
preferences may be grouped together.
Description DescriptionNarrative A narrative that describes the group of preferences.
PreparedItem
Definition: A sub-type of Item that is manufactured (or prepared) for sale from a set of BulkItem via a Recipe. The distinction from StockItem being that PreparedItem is not
booked into inventory when the item is manufactured; nor is it removed from inventory when it is sold; rather the inventory for the BulkItem constituent parts as defined by the
recipe is reduced when the PreparedItem is sold.
FoodItemHoldingTime QuantityShortCountMinutes The number of minutes that a prepared food item may be held ready for sale. At the end of this
time, the item must not be sold to a customer.
PrepayHistory
Definition: The total number and monetary value of all Prepay and PrepayRefund FuelSaleLineItems that were sold to a FuelingPoint during a ReportingPeriod.
FuelingPointID (PK) (FK) Identity A unique identifier for the FuelingPoint at a particular retail store
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
PrepayFuelingRefundCount Quantity The number of prepay refund FuellingTransactions performed at the FuellingPoint during the
ReportingPeriod
PrepayFuelingRefundAmount Money The total monetary value of prepay refund FuellingTransactions performed at the FuellingPoint
during the ReportingPeriod
PriceDerivationRule
Definition: 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.
PriceDerivationRuleID (PK) Identity A identifier for a specific price derivation rule.
Name Name Price derivation rule name
Description DescriptionShort Business description for this price derivation rule.
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).
StatusCode Code2Status Defines the current status for the price derivation rule. Examples of valid codes include:
Pending, Active, Canceled, Inactive
TypeCode Code2 Defines the type of price derivation rule.
PriceDerivationRuleEligibility
Definition: Defines the conditions which govern the application of a PRICE DERIVATION RULE to a sale
PriceDerivationRuleEligibilityID (PK) Identity A unique identifier for a Price Derivation Rule Eligibility.
TypeCode Code4 A code that indicates the type of Price Derivation Rule Eligibility.
PriceDerivationRuleEligibilityMaintenance
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a PriceDerivationRuleEligibility.
PriceDerivationRuleEligibilityID (FK) Identity A unique identifier for a Price Derivation Rule Eligibility.
MaintenanceFunctionCode Code4 Defines the maintenance function to be performed. Valid values include creation, update or
deletion of a price derivation rule eligibility
PriceDerivationRuleMaintenance
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a PriceDerivationRule.
PriceDerivationRuleID (FK) Identity A identifier for a specific price derivation rule.
MaintenanceFunctionCode Code4 Defines the maintenance function to be performed. Valid values include creation, update or
deletion of a price derivation rule.
PriceLine
Definition: 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.
PriceLineID (PK) Identity A unique identifier for this price point.
LowAmount Money The low end of a price range that bounds a price line.
HighAmount Money The high end of a price range that bounds a price line.
PriceLinePriceDerivationRuleEligibility
Definition: Defines an association between a MERCHANDISE STRUCTURE PRICE DERIVATION RULE and a PRICE LINE for the purposes of triggering a PRICE
DERIVATION RULE.
PriceLineID (FK) Identity A unique identifier for this price point.
Promotion
Definition: A collection of eligibilities and price derivation rules, during a specific time group.
PromotionID (PK) Identity The unique identifier for a promotion.
EffectiveDate Datetime The first date and time that this promotion is effective.
ExpiryDate Datetime The last date and time that this promotion is effective.
MultipleEligibilityCombinationCode Code2 When a promotion consists of more than one pairing of PriceDerivationRuleEligibility and
PriceDerivationRule then how are the multiple pairings to be combined.
ConcurrenceCode Code2 A code denoting how this promotion works in relation to other promotions.
UpSellTypeCode Code2 A code that indicates how up selling is to be performed.
OperatorDisplayName Name Text to be displayed to the Operator.
CustomerDisplayName Name Text to be displayed to the customer.
ReceiptPrinterName Name Text to be printed on the receipt
AccountingDispositionCode Code4 A code that determines how the price change made as a result of this PROMOTION 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 ledgers cumulative markon for the item).
PromotionalLineItem
Definition: A detail line item of TRANSACTION that records the crediting or debiting of a CUSTOMER PROMOTIONAL ACCOUNT with points/dollars/miles.
PromotionID (FK) Identity The unique identifier for a promotion.
PromotionalProduct
Definition: 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.
PromotionalProductID (PK) Identity A unique identifier for a Promotional Product.
CERTIFICATE.
TypeCode Code2 A cod that indicates the type of Promotional Product that is being given away as a result of the
promotion. Possible values include: Gift Certificate, Item, Merchandise Hierarchy. Frequent
Shopper Points
PromotionPriceDerivationRule
Definition: An entity that associates a Price Derivation Rule Eligibility and a Price Derivation Rule together with a valid Time Group to be part of a Promotion
PromotionID (PK) (FK) Identity The unique identifier for a promotion.
TimeGroupID (FK) Identity A unique identifier for the time group
PromotionPromotionType
Definition: An associative entity resolving the many-to-many relationship between Promotion and PromotionType. This allows Promotions to be grouped together for reporting
purposes.
PromotionTypeID (PK) (FK) Identity A system assigned unique identifier for the PromotionType
PromotionID (PK) (FK) Identity The unique identifier for a promotion.
PromotionType
Definition: An infrastructural entity defining types of Promotions which allows Promotions to be grouped together for reporting purposes.
PromotionTypeID (PK) Identity A system assigned unique identifier for the PromotionType
Description DescriptionShort A human readable descripton of the Promotion Type.
Prospect
Definition: 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 retailer.
PurchaseOrderInfo
Definition: Customer issued purchase order data that is collected as part of the process of tendering a RetailTransaction with a CustomerAccount
ContactPartyID (FK) Identity A unique, automatically assigned identity for a PARTY.
PurchaseOrderId Identity The identifier on the customer supplied purchase order, that is being used to tender this
transaction.
AuthorizedAmount MoneyShortRetail The monetary amount included on the purchase order
RawMaterialComponent
Definition: An abstract standardized Recipe ingredient that is re-used in many recipes. Used to define a common quantity & UnitOfMeasure for the Ingredient. Eg: "5oz Tomato
Ketchup " which may be used once in a small hamburger and twice or three times in a large hamburger, and BBQ sauce is an acceptable substitute.
ComponentID (PK) Identity A unique system assigned identifier for the RawMaterialComponent
UnitAmount QuantityShortCount The amount of the RawItem that make up a single serving of the RawMaterialComponent
Description DescriptionShort A short description denoting what the ingredient is. Eg: 5oz Ketchup/BBQ
RawMaterialComponentItem
Definition: An associative entity that denotes an acceptable substitution for a particular RawMaterialComponent an a Recipe. Eg: BBQ Sauce is an acceptable substitute for
Ketchup.
ComponentID (PK) (FK) Identity A unique system assigned identifier for the RawMaterialComponent
ReceivingDocument
Definition: 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
SUPPLIERs packing slip.
CarrierID (FK) Identity The carrier presenting the bill of lading.
FreightBillID (FK) Identity The carrier-assigned shipping document number
Recipe
Definition: The Recipe or Bill of Materials that is used to assemble a PreparedItem from other (usually Bulk) Items. A recursive relationship "variations produce " allows recipe
variations to be recorded.
RecipeID (PK) Identity A system assigned unique identifier for the recipe
RecipeVariationOf (FK) Identity A system assigned unique identifier for the recipe which this recipe is a variation of
LastChangeDate DateCalendar The date the recipe was last changed.
CreateDate DateCalendar The date the recipe was created
StatusCode Code2 The status of the recipe, possible values include Active, Inactive, Testing
Description DescriptionNarrative A short narrative description describing the recipe. When the recipe is a variant of another
recipe, the description includes a description of the variation.
RecipeLineItem
Definition: A single ingredient in a Recipe
RecipeID (PK) (FK) Identity A system assigned unique identifier for the recipe
ComponentID (PK) (FK) Identity A unique system assigned identifier for the RawMaterialComponent that goes into the Recipe
ServingsCount QuantityShortCount The number of servings of a component that make up the Ingredient.
CostInclusiveFlag Flag A flag denoting if the cost of the ingredient is (or is not) included in the cost of the completed
PreparedItem
WasteFlag Flag A flag denoting if the recipe ingredient is wasted when the PreparedItem is discarded. e.g. When
a piece of cake is discarded the whipped cream & spoon that are included with the cake when it
is sold, are not discarded
KeyIngredientFlag Flag A flag denoting that the ingredient is required to make up the PreparedItem. e.g. Patties are key
ingredients in a burger, but pickles are not.
RegisteredItemClass
Definition: The registration of a desired class or group of items at a level above a SKU.
Description DescriptionNarrative A description of a class or group of items that have been added to a gift registry for a customer.
RelatedItemAssociation
Definition: 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.
ItemID (PK) (FK) Identity The retailers SKU or unique item identifier for the main item in the related item association.
Related (PK) (FK) Identity The retailers SKU or unique item identifier for the associated item in the related item association.
Name Name The name to denote the type of association between the two RELATED ITEMs.
RelatedItemAssociationSalesSummary
Definition: 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.
ItemID (PK) (FK) Identity The retailers SKU or unique item identifier for the main item in the related item association.
Related (PK) (FK) Identity The retailers SKU or unique item identifier for the associated item in the related item association.
SoldTogetherTransactionCount QuantityTransactionCount A count of the number of transactions in which the items in the item association were sold
together.
SoldSeparatelyTransactionCount QuantityTransactionCount Count of transactions in which the item is sold without the associated item.
RelatedItemSoldSeparatelyTransactionCount QuantityTransactionCount Count of transactions in which the associated item is sold without the item.
TotalSalesTransactionCount QuantityTransactionCount Total sale transaction count for the same period as the item association accumulators - used to
calculate ratios and percentages.
RentalService
Definition: The terms and conditions that apply to the rental of a RentalService item.
TermsID (PK) Identity A retailer assigned unique identifier for the set of terms and conditions governing the rental of
RentalService
PeriodTypeCode Code2 A code to denote the rental and overdue periods; Hour, Day, Week, etc...
PeriodCount QuantityDayCount The number of rental periods the item may be rented by the customer; as well as the number of
rental periods per penalty charge.
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.
PenaltyMethodCode Code2 A code denoting how the penalty is calculated, using PenaltyAmount or PenaltyPercent.
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.
RentalUnit
Definition: An associative entity denoting which SerializedItems may be rented via a particular RentalService
TermsID (PK) (FK) Identity A retailer assigned unique identifier for the set of terms and conditions governing the rental of
RentalService
ReportingPeriod
Definition: A time interval bounded by a starting and ending calendar period, used as the basis of all financial and performance reporting. This entity is included to resolve the 5
columns defining the start and end CalendarPeriod into a single ReportingPeriodID.
ReportingPeriodID (PK) Identity The identifier for a particular REPORTING PERIOD.
CalendarID (FK) Identity A unique system assigned identifier for the Calendar.
CalendarLevelID (FK) Identity A unique system assigned identifier for the CalendarLevel.
StartCalendarPeriodID (FK) Identity A unique system assigned identifier for this CalendarPeriod
EndCalendarPeriodID (FK) Identity A unique system assigned identifier for this CalendarPeriod
Name Name The business name for the reporting period.
RequestForDebitCreditDocument
Definition: 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 stores account.
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.
RequestedByEmployeeID Identity The EMPLOYEE requesting the 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.
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.
Resource
Definition: RESOURCE entity contains all identifiable applications, functions, screens, and fields available for user and GROUP access.
ResourceID (PK) Identity A code to uniquely identify a given application or application component.
ParentResourceID (FK) Identity The next highest ownership level for a given RESOURCE. For example, a field resource is
owned by the application screen resource to which that field is assigned.
Description DescriptionShort A textual description of the application RESOURCE. Examples include descriptions of
application invocation functions, screens and fields.
RestrictionValidationModifier
Definition: A modifier to a SaleReturnLineItem denoting how a particular SalesRestriction was validated. Eg: In some jurisdictions it is a legal requirement to record the
Customers fire-arms license number in order to sell ammunition.
QuestionID (FK) Identity A unique identifer for the restriction validation question.
Answer DescriptionShort The answer given by the customer to the given question.
RestrictionValidationQuestion
Definition: A standard question that may be asked of a Customer as part of the process of negotiating a SalesRestriction that has been placed upon a class of items.
QuestionID (PK) Identity A unique identifer for the restriction validation question.
QuestionText DescriptionShort The text of the question that the customer is to be asked when validating a restriction.
RetailPriceModifier
Definition: 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
RetailPriceModifierSequenceNumber (PK) Identity The sequence number for this RetailPriceModifier allowing more than one price modification to
occur on each retail transaction line item.
PromotionID (FK) Identity The unique identifier for a promotion.
ReasonCode Code2 A code that describes why the price modifier is applied to the line item. Possible values include
PROMOTION fired and Price label is always right.
Percent Percent The percent reduction that was applied to the unit retail price to arrive at the modified selling
price.
Amount Money The flat amount of the price reduction that was removed from the unit selling price to arrive at
the modified selling price.
AccountingDispositionCode 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 ledgers cumulative markon for the item). This code reflects the
setting of AccountingDispositionCode in the PROMOTION that caused the price modification at
the time of the RETAIL TRANSACTION.
PreviousPrice MoneyShortRetail The unit price that was used as the basis of the price modification.
NewPrice MoneyShortRetail The unit price that was the result of the price modification.
RetailStore
Definition: An organization that sells merchandise and services through a physical location, catalog, web page or other channel.
RetailStoreID (PK) Identity A unique retailer assigned identifier for a RetailStore
RetailStoreGroupID (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
OpenDate DateCalendar The opening date for the RETAIL STORE
ClosingDate DateCalendar The closing date for the RETAIL STORE
Size Quantity The size of the RETAIL STORE. This is usually split by the non-sales and sales areas.
SellingAreaSize Quantity The size of the selling floor. in a large STORE this is further split by the sales floor and by the
merchandise departments.
RetailStoreClient
Definition: A CUSTOMER who has a closer relationship to a retail store or employee.
ClienteleID Identity An alternate ID assigned to a clienteling customer.
RetailStoreGroup
Definition: A particular group of retail stores, such as Group, Cluster, Region, State, Territory, Country, Zone, etc... The lowest level of RetailStoreGroup is in a one-to-one
relationship with RetailStore. IE: The lowest level of each RetailStoreGroupFunction hierarchy is a RetailStoreGroup containing one & only one RetailStore.
RetailStoreGroupID (PK) Identity A unique system-assigned identifier for the RetailStoreGroup
LanguageID (FK) Code4External A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular
country.
Name Name The name of a RetailStoreGroup
RetailStoreGroupFunction
Definition: A business function for which RetailStores are placed into a separate grouping hierarchies. Taxation: The stores are placed into groups along the boundaries of various
TaxAuthorities. Eg: State, County & City. Merchandising: The stores are placed into groups along the boundaries of various climactic regions, Eg: East Coast, Mid-West, Pacific
NorthWest. With the implication being that umbrellas sell very well in Washington state all year round, while they don t sell at all in Texas.
RetailStoreGroupFunctionID (PK) Identity A unique system-assigned identifier for the RetailStoreGroupFunction
Name Name The human readable name of the RetailStoreGroupFunction
RetailStoreGroupItem
Definition: Lists the Items that are carried by a particular RetailStoreGroup
SellingStatusCode Code2Status Defines the selling status of the item. Examples include active, discontinued, seasonal, to be
discontinued, held for future release, etc.
StatusCode Code2Status This code defines the current state of an item within the retail store. An items 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.
SellingStatusCodeEffectiveDate DateCalendar The date the current item selling status code became effective.
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.
RetailStoreGroupLevel
Definition: A grouping level for sets of retail stores, such as District, Group, Cluster, Region, State, Territory, Country, Zone etc...
RetailStoreGroupFunctionID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroupFunction
RetailStoreGroupLevelD (PK) Identity A unique system assigned identifier, for a level within the RetailStoreGroup hierarchy
ParentRetailStoreGroupLevelID (FK) Identity A unique system assigned identifier, for the Parent level of a particular level within the
RetailStoreGroup hierarchy
Name Name The name of the Level within the RetailStoreGroup hierarchy.
RetailStoreGroupRecipe
Definition: An associative entity denoting which Recipes for a particular PreparedItem are valid in a particular group of RetailStores. Eg: A recipe variation for a hamburger may
call for the use of a patty made from Lamb rather than Beef. RetailStores in areas with a high Hindu population may have this recipe variation.
RetailStoreGroupID (PK) (FK) Identity A unique system-assigned identifier for the RetailStoreGroup which makes use of the Recipe
RecipeID (PK) (FK) Identity A system assigned unique identifier for the Recipe that the RetailStoreGroup uses.
EffectiveDate (PK) DateCalendar The date from which the RetailStoreGroup makes use of the Recipe
ExpirationDate DateCalendar The date at which the RetailStoreGroup (will) cease to use the Recipe
RetailStoreLocationEvent
Definition: An EVENT that is scheduled for a specific LOCATION (or LOCATIONs) within the RETAIL STORE.
RetailStorePOSDepartment
Definition: An associative entity showing which POSDepartments are valid in which RetailStoreGroups
Name Name The title or label given to a point-of-sale department.
RetailTransaction
Definition: 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.
CustomerID (FK) Identity A unique identifier for the customer that conducted the RetailTransaction.
RingElapsedTime QuantityShortCountSeconds The total time elapsed between commencement of the RetailTransaction and the
commencement of the transaction tendering process.
TenderElapsedTime QuantityShortCountSeconds The total time taken to receive all the tender and complete the RetailTransaction.
IdleElapsedTime QuantityShortCountSeconds The total time taken that a particular Workstation was idle between completion of the previous
and commencement of the current RetailTransaction
LockElapsedTime QuantityShortCountSeconds The total time the workstation is in lock mode, ie securement of the WORKSTATION to prevent
misuse by another party, between the previous and current RetailTransactions.
UnitCount QuantityShortCount The total number of individual ITEMs which are sold in the transaction
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.
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.
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.
SuspendFlag Flag A flag denoting that the transaction is suspended, and may be resumed and completed at some
time in the near future.
RetailTransactionLineItem
Definition: A detail line item of a RetailTransaction 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.
RetailTransactionLineItemSequenceNumber (PK) LineNumber The sequence number of line item within the context of this RetailTransaction.
VoidsLine (FK) LineNumber The sequence number of another line item within the transaction - THAT THIS LINE ITEM voids.
TypeCode Code2 A code to denote the type of retail transaction line item, such as Sale/Return, Void,
miscellaneous fee, etc.
BeginDateTimestamp TimeStampEffective The start time of the RETAIL TRANSACTION line item.
VoidFlag Flag Flag that determines whether this line item has been voided/reversed by another line item in the
transaction.
EndDateTimestamp TimeStampExpiration The end time of the RETAIL TRANSACTION line item.
EntryMethod Code A retailer assigned code to denote how the ReteailTransactionLineItem was entered at the
Workstation. Example values include: Keyed, Scanned, MICR, MSR, SmartCard, RFID.
RetailTransactionLineItemOverride
Definition: A supervisory authorization for overriding a transaction parameter such as price or quantity limits.
Timestamp TimeStampAudit The date and time that a transaction line item is being overridden.
ReasonDescription DescriptionShort Descriptive narrative about the reason a transaction line item is being overridden.
RetailTransactionShipment
Definition: The record of a shipment which was made to deliver the goods purchased in a particular RetailTransaction to the customers shipping address(es)
RetailTransactionShipmentID (PK) Identity A unique, retailer supplied identifier for a RetailTransactionShipment.
CarrierID (FK) Identity The carrier who does the actual shipping of the RetailTransactionShipment
AddressID (FK) Identity A unique identifier for a location and mail address.
TrackingID Identity A tracking number provided by the service provider who actually delivers the shipment.
TrackingURL DescriptionShort A URL to the service providers website, which allows interested parties to track the shipment.
ServiceLevelCode Code2 A code denoting the level of delivery service that is being used to deliver this shipment
PreferredDateTime Datetime The preferred delivery date & time
RequiredPaymentAmount MoneyShortRetail How much is required to be paid for COD shipment?
PaymentMethodCode Code2 A code denoting which payment method was used when paying for a COD shipment.
SpecialInstructions DescriptionNarrative Narrative text, giving special delivery instructions.
RetailTransactionShipmentItem
Definition: A associative entity that relates a particular item sale to a the Shipment that was used to deliver the merchandise to the Customers shipping address(es)
RetailTransactionShipmentID (PK) (FK) Identity A unique, retailer supplied identifier for a RetailTransactionShipment.
ShipmentLineItemNumber (PK) LineNumber A unique, non-significant, automatically assigned sequential number used to identify this item
within the context of the RetailTransactionShipment.
RetailTransactionLineItemSequenceNumber (FK) LineNumber The sequence number of line item within the context of this RetailTransaction.
Quantity QuantityShortCount Denotes how many of the items in the relevant SaleReturnLineItem are to be delivered in this
shipment. The implication being that one may purchase more than one of an item in a single
SaleReturnLineItem and each instance of the item purchased may be shipped to a different
address.
RetailTransactionTotal
Definition: A monetary or unit count total for the RetailTransaction. Ususally TotalTaxableAmount, TotalTaxCollected, TotalAmountPaid, TotalItemCount, etc...
TransactionTotalTypeCode (PK) (FK) Code A unique assigned mnemonic identifier that identifies the TransactionTotalType
Amount Number The monetary total being recorded, for this RetailTransaction.
ReturnAgent
Definition: A third party to which DEPOSIT ITEMs are sent for recycling or refurbishment.
ReturnAgentID (PK) Identity The company to whom the returns for ITEMs, such as empty bottles, are made.
Name Name The name of the company to whom returns on which a deposit was paid are returned.
ReturnAuthorizationRequest
Definition: 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.
TypeCode Code2 The code to indicate the nature of the request, eg return to vendor, transfer to another store, etc.
RequestedByEmployeeID Identity The individual who originates the AUTHORIZATION REQUEST.
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.
AdjudicationCode Code4 The code to denote authorization by the receiving agent.
ReturnAuthorizationDocumentID Identity The reference number of the authorization document.
ReturnDocument
Definition: 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 stores purchase order; substitutions in shipment; late delivery; defective materials, workmanship or fit; or other breaches of contract
SafeTransferTransaction
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from one STORE SAFE to another.
Outbound (FK) Identity The unique identifier for the TENDER RESPOSITORY.
Inbound (FK) Identity The unique identifier for the TENDER RESPOSITORY.
SalariedEmployee
Definition: An employee whose compensation package is based on a flat dollar amount.
SaleReturnLineItem
Definition: 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.
OriginalRetailStoreID (FK) Identity A unique retailer assigned identifier for a RetailStore
OriginalWorkstationID (FK) Identity The unique identifier for the WORKSTATION, typically the serial number.
OriginalBusinessDayDate (FK) DateCalendar The calendar date of the BusinessDay.
OriginalTransactionSequenceNumber (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify a
OriginalRetailTransactionLineItemSequenceNumber (FK) LineNumber The sequence number of line item within the context of this RetailTransaction.
POSItemIDRetailStoreGroupID (FK) Identity A unique system-assigned identifier for the RetailStoreGroup
POSItemID (FK) Identity The barcode, point of sale scan code or other keyed identifying number used at POS and the
internal stock keping ItemID for the item. Will generally be filled with the GTIN (UPC, EAN etc)
for an item -- but it is not mandatory -- A retailer may develop and maintain its own set of POS
identifiers.
POSItemIDQualifier (FK) Identity A secondary qualifier on the POSItemID which denotes a separate item. Eg: When single bottles
& six-packs of the same beverage both have the same UPC or other barcode, the
POSItemIDQualifier holds denotes the two different items.
POSDepartmentID (FK) Identity A unique system-assigned identifier for the POSDepartment
ItemType Code4 Meta-Data denoting the kind of item being sold (or returned) in the line item
RegularUnitPrice MoneyShortRetail The regular or lookup per-unit price for the item before any discounts have been applied.
ActualUnitPrice MoneyShortRetail The actual per-unit price paid by the customer for this particular sale. It is obtained by applying
applicable price derivation rules to the regular unit price.
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.
Units Quantity The number of units sold, when selling bulk merchandise. Eg: A sale of 20 Gallons of Gas:
Quantity=1, Units=20, UnitOfMeasure=Ga Eg: A sale of 3 cans of Beans: Quantity=3, Units=1,
UnitOfMeasure=Ea
ExtendedAmount Money The product of multiplying Quantity by the retail selling unit price derived from price lookup (and
any applicable price derivation rules). This retail sale unit price excludes sales and/or value
added tax.
ReturnReasonCode Code2 A code that describes why a customer is returning merchandise.
ItemIDEntryMethodCode Code4 A code that describes how this line items item identification is being entered (e.g. it is scanned,
keyed SKU, keyed department, etc.)
SellUnitRetailPriceEntryMethodCode Code4 A code that describes how this line items retail selling unit price is being entered (e.g. it is
manually keyed, obtained from price lookup, etc.)
SellUnitRetailPriceDerivationMethodCode Code4 A code that documents how the selling unit retail prices were derived for this line item.
ActionCode Code2 A code denoting how the item is being treated in the item.
SaleReturnTaxExemptionModifier
Definition: A line item modifier to the SaleReturnTaxLineItem component of a RetailTransaction that provides supplementary data regarding tax exemptions.
government body.
ExemptTaxableAmount MoneyShortRetail The Taxable amount which the customer would ve been liable to pay tax on had they not been
granted this exemption.
ExemptTaxAmount MoneyShortRetail The amount of tax that the customer would ve been liable to pay had thus TaxExemption not
been granted.
ReasonCode Code2 A retailer assigned code denoting why this TaxExemption was granted.
CertificateNumber Identity A unique identifier taken from the TaxExemption Certificate that the customer presented in order
to get this Tax Exemption.
CertificateHolderName Name The Customer name taken from the TaxExemption Certificate that the customer presented in
order to get this Tax Exemption.
SaleReturnTaxLineItem
Definition: A Line Item to record taxation implications of a single SALE RETURN LINE ITEM rather than an entire RETAIL TRANSACTION.
government body.
TaxableAmount Money The monetary amount for which tax is applicable.
TaxAmount Money The monetary value tax that is being collected by this LineItem.
SaleReturnTaxOverideModifier
Definition: A line item modifier to the SaleReturnTaxLineItem component of a RetailTransaction that provides supplementary data regarding tax overrides. (Where the amount of
tax collected is reduced rather than exempted).
government body.
OriginalTaxAmount MoneyShortRetail The Original amount of Tax that should ve been collected but wasn t because of this
TaxOverrideModifier.
ReasonCode Code2 A retailer assigned reason code denoting why this TaxOverride is being granted.
CertificateNumber Identity A unique identifier taken from a TaxOverride certificate that was presented by the Customer in
order to claim the TaxOverride.
CertificateHolderName Name The name of the Customer taken from a TaxOverride certificate that was presented by the
Customer in order to claim the TaxOverride.
SalesMeter
Definition: A mechanical or electronic meter that counts the monetary value or volume of blended ITEM dispensed during all FUELLING TRANSACTIONS ever.
SalesMeterID (PK) Identity A system-assigned unique identifier for a sales meter.
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.
StatusCode Code2Status A code denoting the status of the SalesMeter. Possible values include Active and InActive.
SalesMeterReading
Definition: The value of a SALES METER recorded at a particular time for a particular reason.
SalesMeterID (PK) (FK) Identity A system-assigned unique identifier for the sales meter that was used to take this reading.
ReadingNumber (PK) Number A sequential number uniquely identifying this particular reading within the context of the
SaleMeter being used.
MeterReadingQuantity Number The Meter Reading value.
TimeStamp Datetime The date & time the meter reading was taken
ReasonCode Code2 A 2 character code denoting the reason the meter reading was taken
SalesRestriction
Definition: A type of limitation that restricts the sale of a particular class of item.
SalesRestrictionCode (PK) Code6 A unique, automatically assigned code for a specific limitation on an ITEMs sale.
SalesRestrictionTypeCode (PK) Code4 A unique code for a group of SALES RESTRICTIONS.
QuestionID (FK) Identity A unique identifer for the restriction validation question.
SatelliteNozzle
Definition: A physical nozzle which dispenses fuel during a FUELING TRANSACTION. The SatelliteNozzle does not measure any fuel dispensed, that is left to the NOZZLE
that it is attached to. The SatelliteNozzle can however, be addressed, and enabled or disabled during a FUELING TRANSACTION
SatelliteNozzleID (PK) Identity A unique identifier for a physical nozzle.
SeasonPriceDerivationRuleEligibility
Definition: 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.
SerializedItem
Definition: Extra attributes for a StockItem that can be identified by a (normally) Manufacturer assigned Serial Number.
ValidationFlag Flag An indicator used to identify if the SERIALIZED ITEM requires operator validation after payment
has been made and prior to customer pickup.
StoreWarrantyDescriptionCode Code4 A code to signify the type of warranty offered by the RETAIL STORE. This warranty normally
supplements the warranty offered by the MANUFACTURER
ManufacturerWarrantyDescriptionCode Code4 A code to denote the type of warranty offered on the SERIALIZED ITEM by the
MANUFACTURER
ManufacturerSizeDescription DescriptionShort A code to signify the maufacturers size reference.
ModelYear DateCalendarYear The year of release or production of the SERIALIZED ITEM
ModelNumber Name The model reference for a specific SERIALIZED ITEM.
ManufacturerColorDescription DescriptionShort The code to signify the manufacturers color shade.
SerializedUnit
Definition: 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.
SerialNumber (PK) 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.
SerializedUnitModifer
Definition: A record of the serial number of some item that is related to a particular SaleItem. Eg: Sale of camera & service contract may result in two SaleReturnLineItems each
with an instance of SerializedUnitSaleModeifier - one for the camera and one for the related service contract
SerialNumber (FK) Name A unique code, which can be either alpha, numeric or alpha-numeric, to identify an individual
ITEM.
TypeCode Code2 A code denoting if this is a sale, rental or sale of a related item (eg: Service Contract)
Server
Definition: An employee or any other authorized individual who conducts FoodServiceTransactions.
ServerID (PK) Identity A unique identifier for the Server
ServiceItem
Definition: 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.
ServiceTermsCode (FK) Code2 The type of service terms and conditions
Description DescriptionShort A textual description of the SERVICE ITEM.
TypeCode Code2 A code to denote the type of SERVICE ITEM.
BaseCostAmount Money The base cost amount of the SERVICE ITEM. This cost excludes all promotional allowances.
NetCostAmount Money The net cost price of the SERVCE ITEM. this cost includes all promotional allowances.
CostsEstablishedDate DateCalendar The effective date of the current cost price for the SERVICE ITEM.
ServiceItemProvider
Definition: The association between a SERVICE ITEM sold by a retail store and the third party SERVICE PROVIDER who actually performs the service.
ServiceProviderID (PK) (FK) Identity A unique identifier for the service provider.
UnitOfServiceCode Code2 A code to denote the type of service provided by the SUPPLIER.
UnitOfServiceAmount MoneyShortRetail The retail amount of each unit of service offered by the service provider.
ServiceProvider
Definition: A third party that provides a service.
ServiceProviderID (PK) Identity A unique identifier for the service provider.
Name Name The name of the service providers company.
DUNSNumber IdentityDunsIdentifier The identifier assigned by Dun & Bradstreet for the purposes of corporate identification in the
retail community and credit worthiness.
ServiceTermsAndConditions
Definition: 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.
ServiceTermsCode (PK) Code2 The type of service terms and conditions
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.
Session
Definition: 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.
RetailStoreID (PK) (FK) Identity A unique retailer assigned identifier for the RetailStore at which the SignOnTransaction was
performed.
WorkstationID (PK) (FK) Identity The unique identifier for the Workstation, typically the serial number. at which the
SignOnTransaction was peformed.
SessionStartDateTimestamp (PK) TimeStampAudit The time and date at the start of the SESSION.
OpenBusinessDayDate (FK) DateCalendar The calendar date of the BusinessDay on which the SignOnTransaction was performed.
OpenTransactionSequenceNumber (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify the
SignOnTransaction within the context of a Workstation and a BusinessDay.
CloseBusinessDayDate (FK) DateCalendar The calendar date of the BusinessDay on which the SignOffTransaction was performed.
CloseTransactionSequenceNumber (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify the
SignOffTransaction within the context of a Workstation, BusinessDay & Retailstore.
EndDateTimestamp TimeStampAudit The time and date recorded at the end of the SESSION.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by SESSION.
GrossNegativeTotalAmount Money The total monetary gross negative sales amount recorded by SESSION.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by SESSION.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by SESSION.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded by SESSION.
PostTransactionVoidTotalAmount Money The total monetary amount of post transactions actioned by SESSION.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post transaction voids recorded by SESSION.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids by SESSION.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by SESSION.
TenderLoanTotalAmount Money The total monetary amount of tender loans by SESSION.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by SESSION.
TenderPickupTotalAmount Money The total monetary amount of tender pickups by SESSION.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups by SESSION.
ReturnTotalAmount Money The total monetary amount of returns recorded by SESSION.
TotalReturnCount QuantityTransactionCount The total number of returns recorded by SESSION.
RefundTotalAmount Money The total monetary amount of refunds recorded by SESSION.
TotalRefundCount QuantityTransactionCount The total number of refunds recorded by SESSION.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts recorded by SESSION.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee line item discounts recorded by SESSION.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts recorded by SESSION.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of line item miscellaneous discounts recorded by SESSION.
StoreCouponTotalAmount Money The total monetary amount of store coupons recorded by SESSION.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons recorded by SESSION.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by SESSION.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by SESSION.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by SESSION.
TotalMarkdownCount QuantityTransactionCount The total number of price markdowns made by SESSION.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by SESSION.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by SESSION.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by SESSION.
ContainerDepositTotalAmount Money The total monetary amount of container deposits collected by SESSION.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by SESSION.
PaymentsCollectedTotalAmount Money The total monetary amount of payments on account collected by SESSION.
TotalPaymentsCollectedCount QuantityTransactionCount The number of payments on account collected by SESSION.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by SESSION.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway payments collected by SESSION.
PettyCashDisbursementTotalAmount Money The total monetary amount of petty cash payments disbursed by SESSION.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of petty cash line item payments disbursed by SESSION.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax recorded by SESSION.
TaxTotalAmount Money The total tax amount recorded by SESSION.
TaxExemptTotalAmount Money The total tax exempt amount recorded by SESSION.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by SESSION.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides made by SESSION.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items by SESSION.
TotalLineItemKeyedCount QuantityTransactionCount The total number of ITEMs keyed at the point of sale by SESSION.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned by SESSION.
TotalLineItemKeyedPercentage Percent The percentage of ITEMs keyed compared to the total sold ITEMs by SESSION.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned 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.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded by SESSION.
TotalRingTime QuantityShortCountSeconds the total time expressed in minutes spent either scanning or keying ITEMs into the
WORKSTATION by SESSION.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by SESSION where no sales are being recorded at the
WORKSTATION.
TotalLockTime QuantityShortCountSeconds The total time expressed in minutes when the WORKSTATION is locked but the OPERATOR is
logged on the WORKSTATION by SESSION.
TotalSaleLineItemCount QuantityTransactionCount The total number of sale line items by SESSION.
SessionTax
Definition: A collection of tax totals for a tax authority by operator workstation session for a tender reconciliation period.
performed.
government body.
SessionStartDateTimestamp (PK) (FK) TimeStampAudit The time and date at the start of the SESSION.
TaxOnSalesTotalAmount Money The total monetary amount of tax collected by SESSION.
TaxableSalesTotalAmount Money The total monetary amount of taxable sales by SESSION..
TaxExemptSalesTotalAmount Money The total monetary amount of taxable sales by SESSION.
TaxExemptSalesCount QuantityTransactionCount The total number of tax exempt transactions by SESSION
SessionTender
Definition: 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.
performed.
Session (PK) (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
SessionStartDateTimestamp (PK) (FK) TimeStampAudit The time and date at the start of the SESSION.
TotalTenderMediaOverCount QuantityTransactionCount The total number of tender media overages by SESSION.
TotalTenderMediaShortCount QuantityTransactionCount The total number of tender media shortages by SESSION.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of tender units at the beginning of the SESSION.
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender loan media units by SESSION.
TenderLoanMediaTotalAmount Money Total monetary amount of loans made by media type by SESSION.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units by SESSION.
PickupMediaTotalAmount Money Total monetary amount of pickups made by media type by SESSION.
DepositTotalAmount Money The total monetary value of tender media deposited in the EXTERNAL DEPSITORY by
SESSION.
TotalTenderDepositMediaUnitCount QuantityTransactionCount The total number of tender media deposited in the EXTERNAL DEPOSITORY by SESSION.
OverTotalAmount Money The total amount of tender overages by SESSION.
ShortTotalAmount Money The total monetary amount of tender pickup media unit shortages by SESSION.
ShelfItem
Definition: Extra attributes for Items that are placed upon shelves for display before being sold. These attributes are used when creating Shelving plans for the store as well as
managing perishable StockItems.
ConsumerPackageWeightUOM (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
ConsumerPackageSizeUOM (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
UnitPricingRequiredFlag Flag An indicator to identify if the SHELF ITEM needs to be individually priced rather than conveyed
through a shelf lable. Examples include high priced merchandise and variable weight products.
FacingsCount Quantity The number of units that can be containied 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 is 10.
StaplePerishableTypeCode Code2 A code to indicate whether the SHELF ITEM is a staple or perishable product.
ShelfLifeDayCount QuantityDayCount The number of business days the SHELF 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).
DSDAuthorizedFlag Flag An indicator used to identify whether the RETAIL STORE is authorized to accept the SHELF
ITEM as a direct store delivery (DSD) item.
ConsumerPackageDepth Quantity The dimension from front to back of the consumer package on the shelf.
ConsumerPackageWidth Quantity The dimension from left to right of the consumer package on the shelf.
ConsumerPackageHeight Quantity The dimension from top to bottom of the consumer package on the shelf
ConsumerPackageWeight Quantity The weight of the consumer package when placed upon the shelf.
ShipmentContainer
Definition: A specific instance of a CONTAINER within a SHIPMENT.
FreightBillID (PK) (FK) Identity The carrier-assigned shipping document number
FreightBillLineNumber (PK) LineNumber The line number on the FREIGHT BILL to which this particular shipment container applies.
UCCPackagingMaterialCode (FK) Code4External A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This
UCCPackagingFormCode (FK) Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element
list..
ShipmentContainerMerchandiseLineItem
Definition: 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.
FreightBillID (PK) (FK) Identity The carrier-assigned shipping document number
FreightBillLineNumber (PK) (FK) LineNumber The line number on the FREIGHT BILL to which this particular shipment container applies.
ShipmentContainerPackUnitCount Quantity The standard number of packs in each CONTAINER.
ShippingTaxAuthorityRule
Definition: An associative entity which provides a list of TaxAuthorities that have jurisdiction when merchandise is being shipped to a particular Address.
ShippingFromRetailStoreGroupID (PK) (FK) Identity A unique system-assigned identifier for the group of stores from which the goods are being
shipped.
ShippingToPostalCode (PK) (FK) Identity The PostalCode (or other suitable identifier) that uniquely identifies the TaxJurisdiction to which
the goods are being shipped.
ApplicableTaxAuthorityID (PK) (FK) Identity A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
Shopper
Definition: An individual that may purchase (and return goods) and services from a retailer and without establishing a persistent relationship with that retailer. A shoppers
relationship with the retailer is limited to each retail transaction.
SignOffTransaction
Definition: A non sales transaction that no longer assigns TRANSACTIONS to that particular EMPLOYEE.
RetailStoreID (PK) (FK) Identity A unique retailer assigned identifier for the RetailStore where the SignOffTransaction was
performed
WorkstationID (PK) (FK) Identity The unique identifier for the WORKSTATION, typically the serial number, at which the
SignOffTransaction was performed.
BusinessDayDate (PK) (FK) DateCalendar The calendar date of the BusinessDay on which the SignOffTransaction was performed.
TransactionSequenceNumber (PK) (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify the
SignOffTransaction within the context of a Workstation, BusinessDay & Retailstore.
SignOnTransaction
Definition: 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.
performed.
BusinessDayDate (PK) (FK) DateCalendar The calendar date of the BusinessDay on which the SignOnTransaction was performed.
TransactionSequenceNumber (PK) (FK) Identity A unique, non-significant, automatically assigned sequential number used to identify the
SignOnTransaction within the context of a Workstation and a BusinessDay.
Size
Definition: This entity type is a further classification of the STOCK ITEM and is typically referred to as an option of style.
SizeCode (PK) Code6 A code to designate the size of the ITEM. It is proposed to use the 5 apparel and miscellaneous
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=infants and childrens clothing.
Description DescriptionShort A description of the apparel cataegories encompassed within the size table code.
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.
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.
ActualSizeProportionDescription DescriptionShort The proportions typically used to measure this particular ITEM type, eg 36 (waist) x 31(inseam).
StandardizedAddress
Definition: An address that has be standardized via a postal standardization system.
ForeignDomesticTypeCode Code2 A code that categorizes an Address into Foreign or Domestic.
StandardizedDomesticAddress
Definition: A non-foreign address that conforms to postal standards.
AddressLine1 Address The first line of the address, normally the street number and name.
AddressLine2 Address The second line of an address, normally the Flat or Building Suite number.
City City The city component of an address
State State The state component of an address
PostalCode PostalCode The postal or zip code of an address
StandardizedForeignAddress
Definition: A non-domestic address that conforms to postal address standards.
AddressLine1 Address The first line of the address, normally the street number & name.
AddressLine2 Address The second line of the address, normally Building Suite or Flat number.
City City The city of the address
Territory Address The state, province, prefecture or other administrative area of the address
Country Address The CountryCode of the address
PostalCode Address The postal code of the address.
StockItem
Definition: A unit of merchandise that may be sold to a customer or used by the RETAIL STORE.
Primary (FK) Identity A code assigned by the retailer to uniquely identify the supplier.
RetailSelling (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
StockItemTypeCode Code2 A code to indicate the STOCK ITEM type, ie SHELF ITEM, APPAREL ITEM, SERIALIZED
ITEM, etc.
SaleWeightOrUnitCountCode Code2 A code to indicate whether the STOCK ITEM is sold by weight or as an unit.
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 retailers warehouse.
UnitPriceFactor Quantity The number of units of measure per selling unit. Used as the divisor when calculating the
STOCK ITEMs unit retail price, eg $1.67 per pound or $2.59 for 32 floz.
AvailableForSaleDate DateCalendar The date when this STOCK ITEM becomes available for sale. For example, certain books have
specific publication dates, music entertainment release dates.
EnvironmentTypeCode Code2 A code that defines the temperature, relative humidity, lighting and other physical or climatic
environmental requirements for storing and displaying the item.
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.
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.
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.
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.
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.
SellUnitLastReceivedCostsEstablishedDate DateCalendar The date the last received costs (net and base) were established.
ShrinkFlag Flag A flad to denote if the STOCK ITEM could loose weight from the time of order until the time of
receipt.
SwellFlag Flag A flag used to indicate if the STOCK ITEM may gain weight or swell from time of order to time of
receipt.
StockItemConsumerProductLabel
Definition: Identifies and describes the stock item for presentation on a label designed to inform or warn consumers about the product.
ServingSizeUnitOfMeasureCode Quantity The unit of measure assigned to the item for serving size counts.
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.
ServingSizeUnitOfMeasureCount Quantity The count or number of serving unit of measures in a serving.
ServingsInRetailSaleUnitCount Quantity Number of servings in a retail sale unit for the item.
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
TotalFatGramsAmount Quantity Total fat weight in grams for the serving of the item.
TotalFatDailyIntakePercent Percent The input percentage of fat based on the total-fat-grams amount.
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.
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.
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.
TotalCarbohydrateMilligramsCount Quantity The weight (in milligrams) of carbohydrate found in a serving.
Total CarbohydratePercent Percent The percent of daily recommended allowance for carbohydrate in a serving.
DietaryFiberGramsCount Quantity The weight in grams of the dietary fiber contained in a serving
SugarsGramsCount Quantity The weight in grams of sugars for a serving.
ProteinGramsCount Quantity The weight of protein, in grams, for a serving
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
CalciumDailyMinimumPercent Percent The percentage of minimum daily requirement for Calcium
IronDailyMinimumPercent Percent The percentage of minimum daily requirement for iron
NutritionalDescriptionText DescriptionNarrative General text description for nutritional information.
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.
StockLedgerAccount
Definition: 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.
AccountingMethodCode Code2 This code defines the accounting method used by the store, ie the retail or cost method of
accounting.
BeginningUnitCount QuantityTransactionCount The number of units present at the beginning of the accounting period.
BeginningRetailValueAmount Money The monetary value of the units present at the beginning of the accounting period.
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).
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).
BeginningBalancesResetDate DateCalendar The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the
end of the accounting period.
CumulativeReceivedUnitCount QuantityTransactionCount The cumulative number of units received for a particular ITEM since the beginning of the period.
CumulativeGrossSalesUnitCount QuantityTransactionCount The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any
returns.
CumulativeReturnUnitCount QuantityTransactionCount The cumulative number of units returned of a specific ITEM since the beginning of the season.
CumulativeTransferInUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the
beginning of the period.
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.
CumulativeReturnToVendorUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM returned to the vendor since the beginning of
the period.
CumulativeAdjustmentUnitCount QuantityTransactionCount The cumulative adjustment made to the on hand amount of an ITEM since the start of the
period.
CumulativeReceivedRetailAmount Money The cumulative retail value of units received for a particular ITEM since the beginning of the
period.
CumulativeReceivedCostAmount Money The cumulative cost value of units received for a particular ITEM since the beginning of the
period.
CumulativeGrossSalesRetailAmount Money The cumulative gross sales for a specific ITEM since the beginning of the period. The gross
figure excludes returns.
CumulativeReturnRetailAmount Money The cumulative retail value of merchandise that is returned by customers to the store.
CumulativeTransferInRetailAmount Money The cumulative retail value of merchandise transferred into the store from other stores or
distribution centers.
CumulativeTransferOutRetailAmount Money The cumulative retail value of merchandise transferred from the store to another store or
distribution center.
CumulativeReturnToVendorRetailAmount Money The cumulative retail value of merchandise returned to the vendor from the store.
CumulativeAdjustmentRetailAmount Money The cumulative retail value of inventory adjustments (overages and shortages) made to the
stock ledger account.
CumulativePermanentMarkdownAmount Money The cumulative value of permanent markdowns taken against this item.
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.
CumulativePermanentMarkupAmount Money The cumulative value of permanent markups taken against this item.
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.
CumulativeEmployeeDiscountAmount Money Cumulative value of employee discounts granted for the item
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.
CumulativeOutOfDateItemDepreciationAmount Money Cumulative retail value lost due to stock aging past its sell-by date.
PhysicalCountDate DateCalendar The date this item was last physically counted
PhysicalCountUnitCount QuantityTransactionCount The retail sale unit count determined by the last physical inventory for this item.
PhysicalCountRetailValuationAmount Money The retail valuation of the current physical count based on the retail 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.
StockLedgerAccountFiscalPeriodHistory
Definition: A reporting period historical record of the beginning balance and cumulative activity for an ITEM - STOCK LEDGER ACCOUNT.
BeginningUnitCount QuantityTransactionCount The number of units present at the beginning of the accounting period.
BeginningRetailValueAmount Money The monetary value of the units present at the beginning of the accounting period.
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).
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).
BeginningBalancesResetDate DateCalendar The date at which the STOCK LEDGER ACCOUNT is reset. This normally coincides with the
end of the accounting period.
CumulativeReceivedUnitCount QuantityTransactionCount The cumulative number of units received for a particular ITEM since the beginning of the period.
CumulativeGrossSalesUnitCount QuantityTransactionCount The cumulative unit sales for a specific ITEM since the beginning of the period, excluding any
returns.
CumulativeReturnUnitCount QuantityTransactionCount The cumulative number of units returned of a specific ITEM since the beginning of the season.
CumulativeTransferInUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM transferred into the RETIL STORE since the
beginning of the period.
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.
CumulativeReturnToVendorUnitCount QuantityTransactionCount The cumulative number of units of a specific ITEM returned to the vendor since the beginning of
the period.
CumulativeAdjustmentUnitCount QuantityTransactionCount The cumulative adjustment made to the on hand amount of an ITEM since the start of the
period.
CumulativeReceivedRetailAmount Money The cumulative retail value of units received for a particular ITEM since the beginning of the
period.
CumulativeReceivedCostAmount Money The cumulative cost value of units received for a particular ITEM since the beginning of the
period.
CumulativeGrossSalesRetailAmount Money The cumulative gross sales for a specific ITEM since the beginning of the period. The gross
figure excludes returns.
CumulativeReturnRetailAmount Money The cumulative retail value of merchandise that is returned by customers to the store.
CumulativeTransferInRetailAmount Money The cumulative retail value of merchandise transferred into the store from other stores or
distribution centers.
CumulativeTransferOutRetailAmount Money The cumulative retail value of merchandise transferred from the store to another store or
distribution center.
CumulativeReturnToVendorRetailAmount Money The cumulative retail value of merchandise returned to the vendor from the store.
CumulativeAdjustmentRetailAmount Money The cumulative retail value of inventory adjustments (overages and shortages) made to the
stock ledger account.
CumulativePermanentMarkdownAmount Money The cumulative value of permanent markdowns taken against this item.
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.
CumulativePermanentMarkupAmount Money The cumulative value of permanent markups taken against this item.
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.
CumulativeEmployeeDiscountAmount Money Cumulative value of employee discounts granted for the item
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.
CumulativeOutOfDateItemDepreciationAmount Money Cumulative retail value lost due to stock aging past its sell-by date.
PhysicalCountDate DateCalendar The date this item was last physically counted
PhysicalCountUnitCount QuantityTransactionCount The retail sale unit count determined by the last physical inventory for this item.
PhysicalCountRetailValuationAmount Money The retail valuation of the current physical count based on the retail 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.
StockMeter
Definition: A mechanical or electronic meter that counts the monetary value or volume of unblended BULK ITEM dispensed during all FUELLING TRANSACTIONS ever.
StockMeterID (PK) Identity A unique identifier for the stock meter
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.
StockMeterReading
Definition: The value of a STOCK METER recorded at a particular time for a particular reason.
StockMeterID (PK) (FK) Identity A unique identifier for the stock meter
ReadingNumber (PK) Number A sequential number for a stock meter reading.
MeterValue Number The value of the STOCK METER at the time of the reading
TimeStamp Datetime The date & time the meter reading was taken
ReasonCode Code2 A 2character code denoting the reason the meter reading was taken
StoreFinancialLedgerAccount
Definition: 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 business.
StoreFinancialLedgerAccountID (PK) Identity The reference for the STORE FINANCIAL LEDGER ACCOUNT
TypeCode Code2 A code to denote the account type on the STORE FINANCIAL LEDGER.
Description DescriptionShort Description of the account type on the STORE FINANCIAL LEDGER.
BeginningBalanceAmount Money The beginning balance on the STORE FINANCIAL LEDGER ACCOUNT.
CurrentBalanceAmount Money The current financial balance on the STORE FINANCIAL LEDGER ACCOUNT.
StoreFinancialLedgerFiscalPeriodHistory
Definition: A reporting period historical record of the beginning balance and cumulative activity for a STORE FINANCIAL LEDGER ACCOUNT.
StoreFinancialLedgerAccountID (PK) (FK) Identity The reference for the STORE FINANCIAL LEDGER ACCOUNT
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.
StoreHistory
Definition: A collection of monetary and operational totals used to track the activity volume for the entire store during a REPORTING PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by the RETAIL STORE for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by RETAIL STORE for each
REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary negative gross sales amount recorded by RETAIL STORE for each
REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions recorded by the RETAIL STORE for each REPORTING
PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by RETAIL STORE for each REPORTING
PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded 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.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post transaction voids recorded by RETAIL STORE for each REPORTING
PERIOD.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids recorded by RETAIL STOREfor each
REPORTING PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transactions voids by RETAIL STORE for each REPORTING PERIOD.
TotalTenderPickupCount Money The total number of tender pickups from this 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.
ReturnTotalAmount Money The total monetary amount of returns by RETAIL STORE for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by RETAIL STORE for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount refunded by RETAIL STORE for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by RETAIL STORE for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by RETAIL STORE for each REPORTING
PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee discount line items by RETAIL STORE for each REPORTING
PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by RETAIL STORE for each
REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous line items by RETAIL STORE for each REPORTING
PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons by RETAIL STORE for each REPORTING
PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons by RETAIL STORE for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by RETAIL STORE for each
REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed 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.
TotalMarkdownCount QuantityTransactionCount The total number of line item markdowns made by RETAIL STORE for each REPORTING
PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by RETAIL STORE for each REPORTING
PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by RETAIL STORE for each
REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by RETAIL STORE for each REPORTING
PERIOD.
ContainerDepositTotalAmount Money The total monetary amount container deposits collected by RETAIL STORE for each
REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by RETAIL STORE for each REPORTING
PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by RETAIL STORE for each REPORTING
PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account collected by RETAIL STORE for each REPORTING
PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by RETAIL STORE for each
REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway 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.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount he total number of petty cash line disbursements by RETAIL STORE for each REPORTING
PERIOD.
GrossSalesExTaxTotalAmount Money The total gross sales excluding tax recorded by RETAIL STORE for each REPORTING
PERIOD.
TaxTotalAmount Money The total tax recorded by RETAIL STORE for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total monetary amount of tax exempt transactions by RETAIL STORE for each
REPORTING PERIOD.
TotalTaxExemptTransactionCount Money The total number of tax exempt transactions by RETAIL STORE for each REPORTING
PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by RETAIL STORE for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items 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.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned 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.
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.
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.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions recorded by RETAIL STORE for each REPORTING
PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying ITEMs by RETAIL STORE for
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.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales recorded by RETAIL STORE for each REPORTING
PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of operator sign-offs on this RETAIL STORE for each REPORTING PERIOD.
TotalTenderOverAmount Money The total number of operator sign-ons on this RETAIL STORE for each REPORTING PERIOD.
TotalTenderUnderAmount Money The total monetary amount of shortages by RETAIL STORE for each REPORTING PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliations performed on the RETAIL STORE for
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.
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.
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.
StoreSafe
Definition: A repository within the store for safekeeping TENDER removed from the TILL. Also used to secure petty cash and till loans.
Description DescriptionShort A textual description of the SAFE. The term safe can apply to any repository within the office.
StoreSafeHistory
Definition: A record of the TRANSACTIONs involving the movement of TENDER.
StoreSafeSettlementTransaction
Definition: 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.)
StoreSafeTender
Definition: A set of tender repository totals for each type of tender in a STORE SAFE.
OpenBalanceTotalAmount Money The opening monetary balance amount in 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.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans made to the WORKSTATION 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.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups from the STORE SAFE in each EPORTING PERIOD.
DepositTotalAmount Money The total monetary amount deposited in the EXTERNAL DEPOSITORY from the STORE SAFE
in each REPORTING PERIOD.
ReceiptTotalAmount Money The total monetary receipts made 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.
UnderTenderDiscrepancyTotalAmount Money The total monetary amount of tender shortages reported from 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.
TotalPettyCashDisbursementTransactionCount QuantityTransactionCount The total number of petty cash disbursements made from the STORE SAFE in each
REPORTING PERIOD.
StoreSafeTenderHistory
Definition: An accumulator for various tender amounts and units held and transferred to and from the STORE SAFE.
TenderOpenBalanceTotalAmount Money The monetary amount of the opening balance of the STORE SAFE TENDER by REPORTING
PERIOD.
TenderLoanTotalAmount Money The total monetary amount of the tender loans made to the SAFE in each REPORTING
PERIOD.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans to the SAFE in each REPORTING PERIOD.
TenderPickupTotalAmount Money The total monetary amount of the tender pickups loans made from the SAFE in each
REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups from the SAFE in 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.
TenderReceiptTotalAmount Money The total monetary amount of the tender receipts made to the SAFE from the EXTERNAL
DEPOSITORY in each REPORTING PERIOD.
OverTenderDiscrepancyTotalAmount Money The total monetary amount of tender overages recorded for the SAFE for each REPORTING
PERIOD.
UnderTenderDiscrepancyTotalAmount Money The total monetary amount of tender shortages 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.
TotalPettyCashDisbursementTransactionCount QuantityTransactionCount The total number of cash disbursements made from the SAFE for each REPORTING PERIOD.
StoreTaxHistory
Definition: A collection of tax totals for a tax authority for the store for a REPORTING PERIOD.
ReportingPeriodID (PK) (FK) Identity The identifier for a particular ReportingPeriod that delimits the store tax history.
government body.
TaxOnSalesTotalAmount Money The total monetary amount of tax collected by the RetailStore.
TaxableSalesTotalAmount Money The total monetary amount of taxable sales recorded by the RetailStore.
TaxExemptSalesTotalAmount Money The total monetary amount of tax exempt sales recorded by the RetailStore.
TaxExemptSalesCount QuantityTransactionCount The total number of tax exempt transactions recorded by the RetailStore.
TaxOnPurchasesTotalAmount Money The total monetary amount of tax paid by the RetailStore on supply-side purchases.
TaxablePurchasesTotalAmount Money The total monetary amount of taxable purchases made by the RetailStore on the s upply-side of
the business.
TaxExemptPurchasesTotalAmount Money The total monetary amount of tax exempt pruchases made by the RetailStore on the s
upply-side of the business.
TaxExemptPurchasesCount Money The number of tax exempt purchases made by the Retailer on the s upply-side of the business.
TaxRateRulePercent Percent The percentage of the TaxRateRule being summarized.
TaxRateRuleAmount MoneyShortRetail The flat-tax amount of the TaxRateRule being summarized.
StoreTenderHistory
Definition: A collection of tender type accumulators for the store for a REPORTING PERIOD. This entity is used to support store-level tender accountability.
StoreTenderHistory (PK) (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
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.
TotalBeginningTenderMediaUnitCount QuantityTransactionCount The opening balance of the number of tender media units recorded by the RETAIL STORE for
TotalTenderLoanMediaUnitCount QuantityTransactionCount The total number of tender loan media units recorded 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.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units 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.
TenderDepositTotalAmount Money The total monetary value of tender media deposited 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.
TenderOverTotalAmount Money The total monetary value of tender overages 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.
Style
Definition: This entity type identifies and describes the general appearance of retail items.
StyleCode (PK) Code4 A code that uniquely identifies the specific appearance type or variety in which an APPAREL
ITEM is available.
Description DescriptionShort A textual description of the appearance type denoted by the STYLE CODE.
Name Name The descriptive name given to the STYLE CODE.
SubseasonPriceDerivationRuleEligibility
Definition: 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.
Supplier
Definition: 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.
SupplierID (PK) Identity A code assigned by the retailer to uniquely identify the supplier.
Name Name The name of the suppler.
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.
SupplierIsManufacturerFlag Flag A flag that indicates that this supplier is the MANUFACTURER of an item.
SupplierItem
Definition: 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 suppliers view of an item and uses the suppliers nomenclature in describing the items attributes.
SupplierItemID (PK) Identity The code assigned by the supplier to uniquely identify the ITEM
SupplierRetailSaleUnitCode (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
SupplierLinearMeasureCode (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
CaseUPCEANNumber ProductCodeGlobal The UPC/EAN case code, eg UPC/EAN-14, EAN-128.
Description DescriptionShort The description of the SUPPLIER ITEM.
ColorDescription DescriptionShort The suppliers color description of the SUPPLIER ITEM.
SizeDescription DescriptionShort The size dimensions of the SUPPLIER ITEM.
StyleDescription DescriptionShort The style description 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.
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.
AvailabilityStatusCode Code2 A code to signify the availability of the SUPPLIER ITEM.
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).
SupplierItemCatalogBaseCost
Definition: The suppliers catalog base cost (the cost before any promotions, allowances, charges, discounts, etc.) for the SUPPLIER ITEM. .
SupplierItemCostPerUnitTypeCode (PK) Code2 Defines the unit type the owned attribute costs are assigned to for this item. Valid unit types
PerUnitAmount MoneyShortCost The published cost, excluding any allowances for discounts, for the SUPPLIER ITEM.
NetCostPerUnitAmount MoneyShortCost The published unit cost including allowances and charges for the item.
SupplierItemCatalogBaseCostBreak
Definition: The suppliers 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.
SupplierItemUnitBreakPointCount (PK) Quantity The break point in units at which a further discount can be attained by the retailer.
CostPerUnitAmount MoneyShortCost The revised cost price for each unit when the break point has been attained.
SupplierItemReceivingLevel
Definition: 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.
MaterialReceivingLevelCode (PK) 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.
Description DescriptionShort A description of the type of material used for shipping the product to store. .
SupplierItemReceivingUnit
Definition: 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.
UCCPackagingFormCode (PK) (FK) Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element
list..
UCCPackagingMaterialCode (PK) (FK) Code4External A UCC defined code that describes the material used to fabricate the CONTAINER TYPE. This
Receiving (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
MaterialReceivingLevelCode (FK) 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.
Linear (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
DepthCount Quantity Defines the depth 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.
HeightCount Quantity Defines the height of a supplier item pack unit in supplier-item-linear-measure-unit-codes.
SupplierItemReceivingUnitConversionRule
Definition: 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 instance
ToReceivingItemID (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
ToUCCPackingFormCode (PK) (FK) Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element
list wich denotes the package size of the Item being extracted from the SupplierReceivingUnit by
the conversion rule.
ToUCCPackingMaterialCode (PK) (FK) 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,
denoting the packaging materials for the Item being extracted from the SupplierReceivingUnit by
the conversion rule.
FromReceivingItemID (PK) (FK) Identity The retailers SKU or unique item identifier for items sold or returned.
FromUCCPackingFormCode (PK) (FK) Code4External The UCC code to denote the type of packaging from the UCC 103 packaging code data element
list, denoting the package size of the SupplierReceivingUnit being broken down by the
conversion rule.
FromUCCPackingMaterialCode (PK) (FK) 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,
denoting the packaging material for the SupplierReceivingUnit being broken down by the
conversion rule.
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.
SupplierItemStockItem
Definition: 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.
LastReceiptSaleByUnitCount QuantityTransactionCount A count of retail sale units 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.
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.
AssortmentDescription DescriptionShort The description of the assortment the item belongs to.
SupplierPricePromotionZone
Definition: 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.
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
FreightZoneCode Code4 A code to signify the freight charges to retail stores within a specific geographic zone
SurveyQuestion
Definition: An inquiry of a customers opinion.
Tank
Definition: A kind of Location used to store a FuelItem that is measured & dispensed by one or more FuelingPoints
TankID (PK) Identity A unique identifier for this Tank
TankDiameter Quantity The diameter of the tank
ShellCapacity Quantity The largest volume of product that a tank can hold.
MaximumSafeFillCapacity Quantity The largest capacity that the tank safely holds, taking temperature effects into consideration.
LowCapacity Quantity The volume to which a tank may be emptied without prumping vapour into the line. The amount
of product that just reaches the entrance of the suction pipe.
HighLevelSetPoint Quantity The level at which the TankLevelGauge will set off the High Level Alarm .
LowLevelSetPoint Quantity The level at which the TankLevelGuage will set off the Low Level Alarm
LowLowLevelSetPoint Quantity The level at which the TankLevelGuage will set off the Low Low Level Alarm This alarm is the I
really mean it this time, and you better do something real soon Low Level Alarm
HighWaterSetPoint Quantity The level at which the TankLevelGuage will set off the High Water Alarm
StrapLevel Quantity The Strap Level Height (a technical term)
StrapVolume Quantity The volume of product stored in the Tank when the height reading is equal to the StrapLevel
TankLevelGauge
Definition: A piece of equipment that takes measurements from TANK_PROBEs to report the amount of Fuel in TANK.
TankLevelGaugeID (PK) Identity A unique identifier for the Tank Level Gauge
ReferenceTemperature QuantityShortCount The temperature value used in the caluclations to adjust TotalObservedVolume into the
temperature corrected GrossObservedVolume In Europe this is 15C in the U.S.A this is 60F
TankProbe
Definition: A device that is housed in the Tank and periodically (or on demand) returns height (and/or volume) readings to the TankLevelGuage to which it is connected.
TankID (PK) (FK) Identity A unique identifier for the Tank that houses the TankProbe
TankProbeID (PK) Identity A system assigned unique identifier for the TankProbe
TypeCode Code4 A manufacturer specific ID that specifies the type of probe that is installed.
TankTiltOffset Quantity The height offset that should be added to the measured fuel and water heights to account for the
fact that the TankProbe is not installed in the centre of the Tank.
TankReading
Definition: A reading of the height (and/or volumes) of Fuel and Water measurements of the contents of a Tank.
TankID (PK) (FK) Identity A unique identifier for the Tank that was measured by the reading.
TankProbeID (PK) (FK) Identity A system assigned unique identifier for the TankProbe that was used for the reading.
ReadingNumber (PK) LineNumber A unique identifier for this particular reading on this TankProbe
DateTimeStamp TimeStampAudit The date & time the reading was taken
ProductLevel Quantity The measured level of the product in the Tank
TotalObservedVolume Quantity The volume of product (including free water) in the tank.
GrossStandardVolume Quantity The volume, excluding the free water in the tank, corrected to reference temperature.
AverageTemperature Quantity The average temperature of the product in the tank
ObservedDensity Quantity The average density of the product
TankTemperatureReading
Definition: A reading of the temperature of the Fuel that is stored in a Tank.
TankID (PK) (FK) Identity A unique identifier for this Tank
TankTemperatureSensorID (PK) (FK) Identity A unique identifier for the TemperatureSensor in a particular Tank
ReadingNumber (PK) Number A unique identifier for this reading of a particular TankTemperatureSensor
DateTime Datetime The date & time the TemperatureReading was taken.
Temperature Quantity The measured temperature
TankTemperatureSensor
Definition: A device that is housed in the Tank and periodically (or on demand) returns temperature readings for the FuelItem that is stored there.
TankID (PK) (FK) Identity A unique identifier for this Tank
TankTemperatureSensorID (PK) Identity A unique identifier for the TemperatureSensor in a particular Tank
Height Quantity The height of the temperature sensor from the bottom of the Tank
Tare
Definition: 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.
BulkItemTareID (PK) Identity Uniquely identifies the tare property. This normally represented by a numeric code.
WeigntUnitOfMeasure (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
Count Quantity Defines the number of weight units of measure for the tare.
Description DescriptionShort Describes the tare.
TaxableGroup
Definition: A group of Items for which a TaxAuthority defines TaxGroupRules
TaxGroupID (PK) Identity A unique retailer assigned identifier for the TaxGroup
Name Name The name of the tax group.
Description DescriptionShort A description of the taxes represented in the group
ReceiptPrintCode Code2 A short code that is printed on a receipt to denote items that are in this TaxableGroup
TaxAuthority
Definition: A government authority that levies sales taxes and on whose behalf the store collects these sales taxes.
TaxAuthorityID (PK) Identity A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a
government body.
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.
TaxAuthorityRule
Definition: An associative entity that provides a list of Tax Authorities that all the stores in a particular RetailStoreGroup are governed by.
government body.
TaxExemptionModifier
Definition: A line item modifier to the TaxLineItem component of a RetailTransaction that provides supplementary data regarding tax exemptions.
ExemptTaxableAmount MoneyShortRetail The value of tax exampt goods that the Customer is purchasing.
ExemptTaxAmount 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.
CertificateNumber Identity The certificate number assigned to a purchaser by a TaxAuthority exempting the purchaser from
tax in that aurhority.
CertificateHolderName Name The name of the individual or organization who holds the tax exemption certificate.
TaxExemptOrganization
Definition: An organization whose purchases are exempt from sales tax.
TaxExemptOrganizationTypeCode Code2 An indicator of the type of tax exemption this organization holds.
TaxGroupRule
Definition: A rule that prescribes how a particular tax is to be applied to a group Items.
government body.
StoreFinancialLedgerAccountID (FK) Identity The unique identifier for the GLAccount where taxes collectected by this TaxGroupRule are
accumulated.
Name Name The name of the TaxGroupRule
Description DescriptionShort A longer description of the how & when the TaxGroupRule is applied
CompoundSequenceNumber LineNumber A sequential number that indicates the order to which multiple applicable TaxGroupRules should
be applied. Example: City, County & State TaxGroupRules are not compounding - All three rules
will contain zero (or NULL) for this value Example: PST & GST TaxGroupRules are to be applied
in a compounding fashion with PST going first - The rule for PST will contain 1 for this value, the
rule for GST will contain 2 for this value.
TaxOnGrossAmountFlag Flag A flag denoting that the TaxGroupRule is to be applied to the gross amount of the items being
sold ie: before any discounts, price-rules or deals have been applied to the regular retail price.
CalculationMethodCode Code A code denoting how the TaxGroupRule is to be applied in a single transaction. Possible values
include: 1 - Calculate & round at transaction level 2 - Calculate at line item level & round at
transaction level 3 - Calcualte & round at line item unit level There is no default value, as this
setting is dictated by the TaxAuthority who defines the rule.
TaxRateRuleUsageCode Code A code denoting how theTaxRateRules are to be applied within the confines of this
TaxGroupRule. Possible values are: 1 - Pick one (default) 2 - Use as taxation table
TaxGroupRuleMaintenance
Definition: A type of TaxMaintenanceEvent that results in the creation, update or deletion of a TaxGroupRule
government body.
TaxJurisdiction
Definition: A geographical area over which one or more TaxAuthoritys have jurisdiction.
PostalCode (PK) Identity The PostalCode (or other suitable identifier) that uniquely identifies the TaxJurisdiction.
TaxLineItem
Definition: 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.
government body.
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.
TaxMaintenanceEvent
Definition: A type of DataMaintenanceEvent that results in the creation, update or deletion of a TaxGroupRule or TaxRateRule.
TaxOverrideModifier
Definition: A line item modifier to the TaxLineItem component of a RetailTransaction that provides supplementary data regarding tax overrides. (Where the amount of tax
collected is reduced rather than exempted).
government body.
OriginalTaxAmount MoneyShortRetail The original amount of tax that does not have to be collected.
ReasonCode Code2 A code denoting the reason this tax override was performed.
CertificateNumber Identity The certificate number assigned to a purchaser by a TaxAuthority, validating the overriding the
normal taxation rules.
CertificateHolderName Name The name on the certificate validating the overriding of the normal taxation rules.
TaxRateRule
Definition: A rule denoting what percentage or dollar amount of tax is applied to a particular taxable total in a RetailTransaction
government body.
TaxRateRuleSequenceNumber (PK) MoneyShortRetail A squential number for theTaxRateRule, denoting the order of creation of the rules.
TypeCode Code2 A code denoting the kind of TaxRateRule. Possible values include: 1 - Calculate percentage of
taxable amount (default) 2 - Apply a flat amount
MinimumTaxableAmount Money The minimum taxable amount that this TaxRateRule applies to
MaximumTaxableAmount Money The maximum taxable amount that this TaxRateRule applies to
TaxRateRuleMaintenance
Definition: A type of TaxMaintenanceEvent that results in the creation, update or deletion of a TaxRateRule
government body.
TaxRateRuleSequenceNumber (FK) MoneyShortRetail A squential number for theTaxRateRule, denoting the order of creation of the rules.
Telephone
Definition: A telephone, cellular, pager, fax or other telecommunication device number.
TelephoneTypeID (PK) (FK) Identity A category or telephone (number) types (cell, fax, voice, etc.)
CountryCode PhoneNumberCountryCode A code assigned by the telephone industry to a country or other region.
AreaCode PhoneNumberAreaCode A code that identifies a geographic grouping of telephone numbers within the US and Canada.
TelephoneNumber PhoneNumberLocal A number that is used to contact a PARTY via a telephone or device.
ExtensionNumber PhoneNumberExtension Addtional numbers required to reach a person, extension, or voice mailbox.
TelephoneType
Definition: A classification of telephone numbers according to what they are assigned to - telephone, cell phone, pager, fax, TTY, etc.
TelephoneTypeID (PK) Identity A category or telephone (number) types (cell, fax, voice, etc.)
Description DescriptionNarrative A description of a categortization of telephones or other devices.
TemporaryPriceChange
Definition: 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.
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 price.
TemporaryPriceChangeItem
Definition: 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.
NewPrice MoneyShortRetail The new Temporary Retail Price to be applied to the Item in all stores in the RetailStoreGroup as
a consequence of the PriceChangeEvent
Tender
Definition: Tender includes all the forms of payment that are accepted by the RETAIL STORE in settling sales and other transactions.
TenderTypeCode (PK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
ClassCode (FK) Code2 A code to denote a group of tenders with common characteristics, eg charge cards, certificates,
etc.
LocalCurrency (FK) Identity The unique identifier of the CURRENCY.
Description DescriptionShort Description of the tender type.
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.
AuthorizationRequiredFlag Flag A flag that signifies whether authorization is required before a specific tender can be accepted.
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 customers driving license.
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.
CustomerIdentificationRequiredFlag Flag A flag to signify that customer identification is required, such as drivers license.
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.
CustomerSignatureRequiredFlag Flag A flag that requires the customer to sign the tender( check) or resultant voucher (card) in the
presence of the operator.
AccountIdentificationRequiredFlag Flag A flag to signify that the status of the account has to be checked before this method of tender
can be accepted.
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.
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.
OffLineTenderFloorApprovalAmount Money The value of an individual tender below which approval is not required.
OffLineTenderCeilingApprovalAmount Money The maximum value of an individual tender that can be accepted without authorization.
MinimumAcceptAmount Money The minimum value that can be accepted for an individual tender. For example, certain retailers
will not accept card payments below $5.
MaximumAcceptAmount Money The maximum amount that can be accepted for a specific tender type.
OverrideTriggerMaximumAmount Money A trigger to override the maximum amount normally accepted for a specific tender type.
LoanPermissabilityFlag Flag A flag to signify whether a specific transaction can be paid for on credit.
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.
LocalCurrencyAvailabilityFlag Flag A flag to signify that change can be offered to the customer in the currency tendered.
RealtimeBalanceUpdateFlag Flag A flag to signify that the customers account is updated in real-time.
EndorsementRequiredFlag Flag A flag to signify that an endorsement, normally the customers signature, is required before a
specific tender type can be accepted.
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.
ChangeThresholdAmount Money The maximum change that can be offered to a customer for a specific tender type.
UnitCountRequiredFlag Quantity A flag to signify that specific tender types need to be counted and recorded by the operator prior
to a pickup.
AcceptanceForPaymentOnAccountFlag Flag A flag to signify that a certain tender type can be accepted to credit a customers account.
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.
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.
TenderAccountApprovalReference
Definition: Repository of external account numbers against which an individual tender can be approved or rejected depending on the status of that account.
AccountNumber (PK) Identity The CUSTOMERs account number against which previous tender authorization is held.
TenderAuthorizationPermissionFlag Flag Flag that grants or revokes permission to accept this tender for this account.
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.
CeilingLimitAmount Money The monetary amount up to which approval can be sought.
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.
TenderIssuingBankID Identity The bank or financial services organization that issued the credit or debit card.
CreateDateTimestamp TimeStampAudit The date and time this tender approval reference was created.
LastUpdateDateTimestamp TimeStampAudit The date and time the tender approval reference was last modified.
LastApprovalGivenDateTimestamp TimeStampAudit The date and time this tender approval reference last approved a tender payment at the store.
TenderAuthorization
Definition: A request to an external agency to authorize the use of some form of tender to complete a RetailTransaction. Eg: Cheques, Credit & Debit Cards, Gift Certificates or
Vouchers.
TenderAuthorizationSequenceNumber (PK) LineNumber A unique sequence number for this TenderAuthorization. Required because a particular
TenderLineItem may have more than one TenderAuthorization attempt.
TenderAuthorizationProviderID (FK) Identity A unique identifier for the external agency that is providing this TenderAuthorization
PreAuthorizationID (FK) LineNumber A unique sequence number for the TenderAuthorization that "Pre-Authorized " this
TenderAuthorization
RequestedAmount MoneyShortRetail The monetary value of the purchases for which an authorization is being requested.
RequestedChangeAmount MoneyShortRetail The monetary value cash-back for which an authorization is being requested
AdjudicationCode Code The adjudication code returned by the external agency to this TenderAuthorizationRequest
ReferenceNumber Identity A unique identifier (which may be assigned by the external authorization agency) for this
TenderAuthorization
AuthorizationDatetime Datetime The Date and Time the TenderAuthorization was made. This may be assigned by the external
agency that is providing the TenderAuthorization.
RequestingTerminalID Identity A unique identifier (usually assigned by an external agency that provides TenderAuthorizations)
that identifies the financial terminal that is making this TenderAuthorization
HostAuthorizedFlag Flag A flag denoting that this TenderAuthorization was authorized by an external agency.
ElectronicSignature Flag A bitmap image of the customers signature that was captured as part of the TenderAuthorization
process.
HostText DescriptionShort Narrative text provided by the external agency for inclusion on any reciepts printed as a result of
the TenderAuthorization
CustomerPresentFlag Flag A flag denoting whether the Customer was or was not present during the transaction. This flag
would be False for Phone, Web & Mail-Order sales.
TenderAuthorizationProvider
Definition: An external party that authorizes the use of a particular tender via electronic & telephone means.
TenderAuthorizationProviderID (PK) Identity A unique system defined identifier for the Provider.
TenderAuthorizationReversal
Definition: A request to an external agency to revers a previously requested authorization of the use of some form of tender to complete a RetailTransaction. Eg: Cheques, Credit
& Debit Cards, Gift Certificates or Vouchers.
TenderAuthorizationSequenceNumber (PK) (FK) LineNumber A unique sequence number for this TenderAuthorization. Required because a particular
TenderLineItem may have more than one TenderAuthorization attempt.
TenderAuthorizationReversalSequenceNumber (PK) Identity A unique sequence number for this TenderAuthorizationReversal. Required because a particular
TenderAuthorization may have more than one reversal attempt.
AdjudicationCode Money The adjudication code returned by the external agency for this TenderAuthorizationReversal
ReversalDatetime Datetime The date and time that this reversal was performed.
ReferenceNumber Identity The identifying reference number for this reversal. (Usually assigned by the external agency that
performs TenderAuthorizations).
HostText DescriptionShort Narrative text provided by the external agency for inclusion on any reciepts printed as a result of
the TenderAuthorizationReversal
TenderChangeLineItem
Definition: 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.
TenderTypeCode (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
Amount Money A line item for the monetary amount due back to a CUSTOMER when an overtender is made in
exchange for ITEMs.
TenderClass
Definition: A type of tender with common characteristics.
TenderClassCode (PK) 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.
TenderControlTransaction
Definition: A type of TRANSACTION that records the physical movement of tender from one tender repository to another.
TenderControlTypeCode Code2 A code to denote the type of FINANCIAL ACCOUNTING TRANSACTION, e.g. tender loan or
pickup.
ReasonCode Code2 A 2 character code denoting why this tender control transaction was performed
TenderControlTransactionTenderLineItem
Definition: 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.
DenominationID (FK) Identity An identifier which uniquely identifies the quantitative value of a specific currency, e.g. $100,
50, etc.
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.
TenderDepositTransaction
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from a STORE SAFE to an EXTERNAL REPOSITORY
TenderLineItem
Definition: A line item component of a POS TRANSACTION that records the settlement of that transaction with an offsetting, valid tender type.
TenderTypeCode (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
AccountNumber (FK) Identity The CUSTOMERs account number against which previous tender authorization is held.
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.
ForeignCurrencyAmount MoneyShortRetail The monetary value (in the currency submitted by the Customer) of the tender submitted by the
Customer.
Amount Money The monetary value (in the default currency of the RetailStore) of the tender submitted by the
Customer.
AddressVerificationCode Code2 A code denoting how the customers address was verified.
TenderLoanTransaction
Definition: A TENDER CONTROL TRANSACTION that records the movement of tender from the store safe to a till.
TenderPickupTransaction
Definition: A type of TENDER CONTROL TRANSACTION that records the movement of tender from a till to the store safe.
TenderRepository
Definition: Describes the types of physical tender containers used in a RETAIL STORE. Tender repository generally includes assets like, store safe(s), tills, etc.
TenderRepositoryID (PK) Identity The unique identifier for the TENDER RESPOSITORY.
TypeCode (FK) Code2 A code to denote the type of TENDER REPOSITORY.
Name Name The name of the TENDER RESPOSITORY.
Description DescriptionShort The textual description of the TENDER REPOSITORY.
TenderRepositoryClass
Definition: Defines the type of TENDER REPOSITORY, eg SAFEs, TILLs, etc.
TenderRepositoryTypeCode (PK) Code2 A code to denote the type of TENDER REPOSITORY.
Description DescriptionShort The description of the type of TENDER REPOSITORY.
TenderRepositoryTenderAccount
Definition: An account held on the STORE FINANCIAL LEDGER of all TENDER movements by repository.
TestDelivery
Definition: 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 storage
ReturnedToLocationID (FK) Identity A unique system assigned identifier for a specific InventoryLocation within the retail enterprise.
ReasonCode Code2 A ReasonCode denoting why the TEST DELIVERY was performed.
ThirdPartyCustomerIdentification
Definition: A specific KEY CUSTOMERs identification number or card.
ThirdPartyCustIdentificationTypeName (PK) (FK) Name The name or label given to a a third party ID.
CustomerIdentificationItemNumber (PK) LineNumber A sequential number used to distinguish one THIRD PARTY CUSTOMER ID.
Number DescriptionShort The account, member, or other number on a third party ID.
ExpirationDate DateCalendar The date that a CUSTOMERs third party ID is no longer valid.
ThirdPartyCustomerIdentificationType
Definition: A categorization of 3rd party customer identification cards or numbers given by a customer to identify himself.
ThirdPartyCustIdentificationTypeName (PK) Name The name or label given to a a third party ID.
Description DescriptionNarrative A description of a categorization of third party IDs.
Till
Definition: 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.
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.
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.
TillHistory
Definition: 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.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans by TILL for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary amount of positive sales by TILL for each REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary amount of negative sales by TILL for each REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions by TILL for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids by TILL for each REPORTING PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids by TILL for each REPORTING PERIOD.
PostTransactionVoidTotalAmount Money The total monetary amount of post transaction voids by TILL for each REPORTING PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of post-transaction voids by TILL for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary amount of transaction voids by TILL for each REPORTING PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by TILL for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number of tender pickups 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.
ReturnTotalAmount Money The total monetary amount of returns by TILL for each REPORTING PERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns by TILL for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds by TILL for each REPORTING PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds by TILL for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by TILL for each REPORTING PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The number of employee discount line items by TILL for each REPORTING PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by TILL for each REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous discount line items by TILL for each REPORTING PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by TILL for each REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by TILL for each REPORTING PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by TILL for each REPORTING
PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by TILL for each REPORTING PERIOD.
MarkdownTotalAmount Money The total monetary amount of markdowns by TILL for each REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of markdowns recorded by TILL for each REPORTING PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales by TILL for each REPORTING PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees by TILL for each REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees line items by TILL for each REPORTING PERIOD.
ContainerDepositTotalAmount Money The total monetary amount of container deposits collected by TILL for each REPORTING
PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of container deposits collected by TILL for each REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments on account collected by TILL for each REPORTING
PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments on account collected by TILL for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by TILL for each REPORTING
PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway 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.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of cash disbursement line items by TILL for each REPORTING PERIOD.
GrossSalesExTaxTotalAmount Money The total monetary amount of gross sales excluding tax by TILL for each REPORTING PERIOD.
TaxTotalAmount Money The total tax amount recorded by TILL for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount by TILL for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions by TILL for each REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides by TILL for each REPORTING PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items 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.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned 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
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned 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.
TILL for each REPORTING PERIOD.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions 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.
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by TILL where no sales are being recorded 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.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales by TILL for each REPORTING PERIOD.
TillSettlementTransaction
Definition: 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.
TillTaxHistory
Definition: A collection of tax totals for a tax authority by till for a tender reconciliation period.
government body.
TaxCollectedTotalAmount Money The total monetary amount of tax collected by TILL for each REPORTING PERIOD.
TaxableSaleTotalAmount Money The total monetary amount of taxable sales 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.
TillTender
Definition: A set of tender repository totals for each type of tender in a TILL
MediaOpenCount QuantityTransactionCount The number of tender media units by TILL at the start of the REPORTING PERIOD.
OpenAmount Money The monetary amount of till tender by TILL at the start of the REPORTING PERIOD.
LoanMediaUnitCount QuantityTransactionCount The total number of tender media units loaned by TILL in each REPORTING PERIOD.
LoanAmount Money The total monetary amount loaned by TILL between each REPORTING PERIOD.
PickupMediaUnitCount QuantityTransactionCount The monetary amount of pickups made 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.
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.
MediaCloseCount QuantityTransactionCount The number of tender media units by TILL at the end of the REPORTING PERIOD.
CloseAmount Money The monetary amount of till tender by TILL at the end of the REPORTING PERIOD.
OverAmount Money The monetary amount of of tender overages 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.
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.
TillTenderHistory
Definition: A collection of tender type accumulators by till tender accumulation period. This entity is used to support till tender accountability.
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.
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.
LoanMediaTotalAmount MoneyShortRetail The total monetary amount of tender loaned to the TILL for each REPORTING PERIOD.
PickupMediaUnitCount QuantityTransactionCount The total number of tender pickups by TILL for each REPORTING PERIOD.
PickupMediaTotalAmount MoneyShortRetail The total monetary amount of tender picked up from the TILL for each REPORTING PERIOD.
DepositTotalAmount MoneyShortRetail The total number of tender media units deposited by TILL for each REPORTING PERIOD.
DepositMediaUnitCount QuantityTransactionCount The number of tender media units deposited by TILL for each REPORTING PERIOD.
OverTotalAmount MoneyShortRetail The total amount of overage recorded by TILL for each REPORTING PERIOD.
ShortTotalAmount MoneyShortRetail The total amount of underage recorded by TILL. for each REPORTING PERIOD.
TimeGroup
Definition: A set of times on particular days of the week.
TimeGroupID (PK) Identity A unique identifier for the time group
Description DescriptionShort The human readable description for the time group
TimeGroupTimePeriod
Definition: A many-to-many resolving entity
TimePeriodID (PK) (FK) Identity A unique identifier for the time period.
TimeGroupID (PK) (FK) Identity A unique identifier for the time group
TimePeriod
Definition: A period of time on a particular day of the week.
TimePeriodID (PK) Identity A unique identifier for the time period.
Name Name A human readable name for the time period
DayOfWeek Code A 2 character code denoting the day of the week that the time period falls on
StartTime Datetime The time of day that the time period commences
Duration QuantityShortCountMinutes The number of minutes included in the time period from the StartTime.
TotalPurchaseMarketBasketEligibilityRule
Definition: 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 customers 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.
MarketBasketRuleID (PK) 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.
TotalPurchaseMarketBasketPriceDerivationRuleEligibility
Definition: 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.
PriceChangeRuleID (PK) Identity A type of price change rule.
MarketBasketRuleID (FK) Identity A unique identifier for the market basket eligibility rule.
Trade-In-KindTenderLineItem
Definition: Support retailers who accept various goods in part-payment for merchandise. Eg: white-ware retailers will give $100.00 credit an an old (working) appliance, when
purchasing a new similar appliance
Valuation (FK) Identity A unique, non-significant number used to identify a store employee.
TypeCode (FK) Code2 Defines the permitted trade-in type
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.
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.
Name Name The name of the person offering the traded-in item.
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.
City City The city component of the address of the person offering the traded-in item.
State State Thestate component of the address 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.
TelephoneCountryCode PhoneNumberCountryCode The telephone country code of the person of the traded-in item.
TelephoneAreaCode PhoneNumberAreaCode The telephone area code of the person of the traded-in item.
TelephoneLocalNumber PhoneNumberCountryCode The telephone local number of the person of the traded-in item.
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.
ProofOfIdentityID Identity A unique reference id from the proof of identity proffered by the customer.
Trade-InType
Definition: Defines valid types of trade-ins accepted by the store in exchange for merchandise.
TradeInTypeCode (PK) Code2 Defines the permitted trade-in type
Description Name A text description of the traded-in item.
Transaction
Definition: 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.
performed.
TransactionSequenceNumber (PK) Identity A unique, non-significant, automatically assigned sequential number used to identify a
SessionStartDateTimestamp (FK) TimeStampAudit The time and date at the start of the SESSION.
TransactionTypeCode (FK) Code6 A code to denote the type of TRANSACTION, eg CONTROL, FINANCIAL, and RETAIL.
BeginDateTimestamp TimeStampEffective The time and date a transaction is initiated.
EndDateTimestamp TimeStampExpiration The time and date stamp a transaction is completed.
CancelledFlag Flag A flag denoting that this entire transaction has been cancelled BEFORE it was completed at the
POS. Various business rules may surround the setting of this flag, Eg: Perhaps all sub-ordinate
RetailTransactionLineItems must have the VoidFlag set.
VoidedFlag Flag A flag denoting that this entire transaction has been voided (and reversed) after it was
completed at the POS via a PostVoidTransaction. Various business rules may surround the
setting of this flag. Eg: May only use PostVoid at the same POS as the voided transaction, and
may only PostVoid the last transaction performed, and it must be done before starting a new
transaction.
TrainingFlag Flag A flag to signify whether the workstation is in training mode.
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.
TransactionTotalType
Definition: One of many different kinds of Total kept in a RetailTransaction. Ususally TotalTaxableAmount, TotalTaxCollected, TotalAmountPaid, TotalItemCount, etc...
TransactionTotalTypeCode (PK) Code A unique assigned mnemonic identifier that identifies the TransactionTotalType
Name Name The human readable name for the TransactionTotalType
TransactionType
Definition: A specific action that may be captured through a work station.
TransactionTypeCode (PK) Code6 A code to denote the type of TRANSACTION, eg CONTROL, FINANCIAL, and RETAIL.
ResourceID (FK) Identity A code to uniquely identify a given application or application component.
TransferInDocument
Definition: 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.
TransferOutDocument
Definition: A type of INVENTORY CONTROL DOCUMENT prepared by the originating store listing the items it is sending to the receiving store.
TranslationItem
Definition: An infrastructural entity, mirroring Item, and providing translations of any natural language string attributes in Item.
LanguageID (PK) (FK) Code4External A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular
country.
Name Name The name of the Item translated into the nominated Language.
Description DescriptionShort The description of the Item translated into the nominated Language.
TranslationTender
Definition: An infrastructural entity, mirroring Tender, and providing translations of any natural language string attributes in Tender.
LanguageID (PK) (FK) Code4External A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular
country.
Description DescriptionShort The Description of the tender translated into the nominated Language.
UnitOfMeasure
Definition: Identifies and describes valid units of measure that are used throughout the model.
UnitOfMeasureCode (PK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
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.
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.
Description DescriptionShort Description assigned to this unit of measure.
UnitOfMeasureConversion
Definition: Provides the multplication factor required to convert one UnitOfMeasure to another. Eg: 1in = 2.54cm
ConvertsFrom (PK) (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
ConvertsTo (PK) (FK) Code2 The code used to specify the units in which a value is being expressed, or manner in which a
Amount Quantity The multiplier that converts the FromUOM to the ToUOM
Worker
Definition: A person who provides services to a retail store.
WorkerTypeCode (PK) Code2 A unique retailer assigned code denoting the kind of Worker.
WorkGroup
Definition: WORK GROUP entity contains job classifications for purposes of grouping EMPLOYEEs
WorkGroupID (PK) Identity A unique identifier for a work classification group to which EMPLOYEEs are assigned.
ParentWorkGroupID (FK) Identity The WORK GROUP this WORK GROUP belongs to. This pointer allows a store to establish a
hierarchy of work groups to facilitate making mass changes to operator access control
privileges.
Description DescriptionShort Describes the classification for the grouping of store EMPLOYEEs. Examples may include
cashier, sales associate, manager, regional manager.
Workstation
Definition: A device used as an as interface to any store business function . This includes the capture and storage of TRANSACTIONS and operational performance reporting
WorkstationID (PK) Identity The unique identifier for the WORKSTATION, typically the serial number.
ManufacturerName Name The name of the MANUFACTURER of the WORKSTATION. Currently most MANUFACTURERs
simply assembly the components and place their badge on the device.
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.
TypeCode Code4 A code to denote the type or use of WORKSTATION, such as POS register, goods receipt
terminal.
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.
OutsideFlag Flag A flag denoting that this Workstation is positioned outside the store (Perhaps at a
FuelingPosition in the Forecourt business segment)
DeviceAddress Name The device address of this WORKSTATION
WorkstationHistory
Definition: A collection of accumulators by WORKSTATION for a REPORTING PERIOD This entity is used to support WORKSTATION accountability.
TotalTenderLoanCount QuantityTransactionCount The total number of tender loans made to the WORKSTATION for each REPORTING PERIOD.
GrossPositiveTotalAmount Money The total monetary positive gross sales amount recorded by WORKSTATION for each
REPORTING PERIOD.
GrossNegativeTotalAmount Money The total monetary gross negative sales amount recorded by WORKSTATION for each
REPORTING PERIOD.
TotalTransactionCount QuantityTransactionCount The total number of transactions by WORKSTATION for each REPORTING PERIOD.
LineItemVoidTotalAmount Money The total monetary amount of line item voids made by WORKSTATION for each REPORTING
PERIOD.
TotalLineItemVoidCount QuantityTransactionCount The total number of line item voids recorded by WORKSTATION for each REPORTING
PERIOD.
PostTransactionVoidTotalAmount Money The total monetary value of post-transaction voids by WORKSTATION for each REPORTING
PERIOD.
TotalPostTransactionVoidCount QuantityTransactionCount The total number of the transaction voids by WORKSTATION for each REPORTING PERIOD.
TransactionVoidTotalAmount Money The total monetary value of transaction voids by WORKSTATION for each REPORTING
PERIOD.
TotalTransactionVoidCount QuantityTransactionCount The total number of transaction voids by WORKSTATION for each REPORTING PERIOD.
TotalTenderPickupCount QuantityTransactionCount The total number amount of tender pickups from this WORKSTATION for each REPORTING
PERIOD.
TenderPickupTotalAmount Money The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
TenderLoanTotalAmount Money The total monetary value of tender pickups by WORKSTATION for each REPORTING PERIOD.
ReturnTotalAmount Money The total monetary amount of returns recorded by WORKSTATION for each REPORTING
ERIOD.
TotalReturnCount QuantityTransactionCount The total number of returns recorded by WORKSTATION for each REPORTING PERIOD.
RefundTotalAmount Money The total monetary amount of refunds recorded by WORKSTATION for each REPORTING
PERIOD.
TotalRefundCount QuantityTransactionCount The total number of refunds recorded by WORKSTATION for each REPORTING PERIOD.
EmployeeDiscountTotalAmount Money The total monetary amount of employee discounts by WORKSTATION for each REPORTING
PERIOD.
TotalEmployeeDiscountCount QuantityTransactionCount The total number of employee item line discounts by WORKSTATION for each REPORTING
PERIOD.
MiscellaneousDiscountTotalAmount Money The total monetary amount of miscellaneous discounts by WORKSTATION for each
REPORTING PERIOD.
TotalMiscellaneousDiscountCount QuantityTransactionCount The total number of miscellaneous line items by WORKSTATION for each REPORTING
PERIOD.
StoreCouponTotalAmount Money The total monetary amount of store coupons accepted by WORKSTATION for each
REPORTING PERIOD.
TotalStoreCouponCount QuantityTransactionCount The total number of store coupons accepted by WORKSTATION for each REPORTING
PERIOD.
RedeemedContainerDepositTotalAmount Money The total monetary amount of container deposits redeemed by WORKSTATION for each
REPORTING PERIOD.
TotalRedeemedContainerDepositCount QuantityTransactionCount The total number of container deposits redeemed by WORKSTATION for each REPORTING
PERIOD.
MarkdownTotalAmount Money The total monetary amount of price markdowns made by WORKSTATION for each
REPORTING PERIOD.
TotalMarkdownCount QuantityTransactionCount The total number of price markdowns made by WORKSTATION for each REPORTING
PERIOD.
NetSalesTotalAmount Money The total monetary amount of net sales recorded by WORKSTATION for each REPORTING
PERIOD.
MiscellaneousFeeTotalAmount Money The total monetary amount of miscellaneous fees recorded by WORKSTATION for each
REPORTING PERIOD.
TotalMiscellaneousFeeCount QuantityTransactionCount The total number of miscellaneous fees recorded by WORKSTATION for each REPORTING
PERIOD.
ContainerDepositTotalAmount Money The total monetary amount of deposit container deposits collected by WORKSTATION for each
REPORTING PERIOD.
TotalContainerDepositCount QuantityTransactionCount The total number of deposit container deposits collected by WORKSTATION for each
REPORTING PERIOD.
PaymentsCollectedTotalAmount Money The total monetary amount of payments collected by WORKSTATION for each REPORTING
PERIOD.
TotalPaymentsCollectedCount QuantityTransactionCount The total number of payments collected by WORKSTATION for each REPORTING PERIOD.
LayawayPaymentsCollectedTotalAmount Money The total monetary amount of layaway payments collected by WORKSTATION for each
REPORTING PERIOD.
TotalLayawayPaymentsCollectedCount QuantityTransactionCount The total number of layaway 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.
TotalPettyCashDisbursementLineItemCount QuantityTransactionCount The total number of petty cash line item payments disbursed by WORKSTATION for each
REPORTING PERIOD.
GrossSalesExTaxTotalAmount Money The total gross sales excluding tax recorded by WORKSTATION for each REPORTING
PERIOD.
TaxTotalAmount Money The total tax amount recorded by WORKSTATION for each REPORTING PERIOD.
TaxExemptTotalAmount Money The total tax exempt amount recorded by WORKSTATION for each REPORTING PERIOD.
TotalTaxExemptTransactionCount QuantityTransactionCount The total number of tax exempt transactions recorded by WORKSTATION for each
REPORTING PERIOD.
TotalLineItemOverrideCount QuantityTransactionCount The total number of line item overrides recorded by WORKSTATION for each REPORTING
PERIOD.
TotalWeighedLineItemCount QuantityTransactionCount The total number of weighed line items recorded 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.
TotalLineItemScannedCount QuantityTransactionCount The total number of ITEMs scanned 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.
TotalLineItemScannedPercentage Percent The percentage of ITEMs scanned compared to the total sold ITEMs by WORKSTATION for
TotalLineItemOpenDepartmentCount QuantityTransactionCount The number of ITEMs recorded through an open department by WORKSTATION for each
REPORTING PERIOD.
TotalNoSaleTransactionCount QuantityTransactionCount The total number of no sale transactions by WORKSTATION for each REPORTING PERIOD.
TotalRingTime QuantityShortCountSeconds The total time expressed in minutes spent scanning or keying line items into the
TotalIdleTime QuantityShortCountSeconds The total time expressed in minutes by WORKSTATION where no sales are being recorded for
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.
TotalSaleLineItemCount QuantityTransactionCount The total number of line item sales by WORKSTATION for each REPORTING PERIOD.
TotalSignOnCount QuantityTransactionCount The total number of operator sign-ons on this WORKSTATION for each REPORTING PERIOD.
TotalSignOffCount QuantityTransactionCount The total number of operator sign-offs on this WORKSTATION for each REPORTING PERIOD.
TotalTenderOverAmount Money The total monetary amount of tender overages by WORKSTATION for each REPORTING
PERIOD.
TotalTenderUnderAmount Money The total monetary amount of tender shortages by WORKSTATION for each REPORTING
PERIOD.
IntermediateTenderReconciliationCount QuantityTransactionCount The total number of intermediate tender reconciliation counts by WORKSATION 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.
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.
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.
WorkstationResource
Definition: WORKSTATION-RESOURCE defines the resources that can be performed on the WORKSTATION.
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
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.
WorkstationRule
Definition: A rule governing the type and size of transactions that may be performed at a WORKSTATION.
WorkstationGroupID (PK) 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.
WorkstationRuleTypeCode (PK) Code2 A code that refers to a specific WORKSTATION RULE type.
WorkstationRuleNumber (PK) Identity A reference number for a specific WORKSTATION RULE.
Name Name A label for a rule that may limit sales at a specific workstation.
LowerLimitAmount Money A WORKSTATION RULE that refers to a lower limit amount, below which supervisory approval
is required.
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.
BelowLowerLimitActionRequiredTypeCode Code2 A code that specifies the type of supervisory action required when the WORKSTATION records
an item movement below a lower limit.
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.
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.
WorkstationRuleApplication
Definition: An association indicating applicability of a rule to a workstation.
WorkstationRuleTypeCode (PK) (FK) Code2 A code that refers to a specific WORKSTATION RULE type.
WorkstationRuleNumber (PK) (FK) Identity A reference number for a specific WORKSTATION RULE.
WorkstationGroupID (PK) (FK) Identity A unique identifier for a group of WORKSTATIONs. This could refer to the WORKSTATIONs at
EffectiveDate DateCalendar The date on which a specific WORKSTATION RULE becomes effective.
ExpirationDate DateCalendar The date on which a specific WORKSTATION RULE expires.
CreateDateTimestamp TimeStampEffective The time and date on which a specific WORKSTATION RULE is created.
WorkstationRuleOverrideHistory
Definition: A transaction record of which WORKSTATION RULES are overriden and by which EMPLOYEE.
OverrideAuthorized (FK) Identity A unique, non-significant number used to identify a store employee.
OverrideFlag Flag A flag to signify that a certain limit has been overriden.
WorkstationRuleTender
Definition: 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.
WorkstationTaxHistory
Definition: A collection of tax totals for a tax authority by workstation for a reporting period.
government body.
TaxCollectedTotalAmount Money The total monetary amount of tax collected by WORKSTATION for each REPORTING PERIOD.
TaxableSaleTotalAmount Money The total monetary amount of taxable sales 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.
WorkstationTenderHistory
Definition: A collection of tender type accumulators by WORKSTATION for a REPORTING PERIOD. This entity is used to support workstation tender accountability.
WorkstationAccumulator (PK) (FK) Code4 A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.
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.
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.
LoanMediaTotalAmount Money The total monetary value of tender media loans recorded by WORKSTATION for each
REPORTING PERIOD.
TotalTenderPickupMediaUnitCount QuantityTransactionCount The total number of tender pickup media units recorded by WORKSTATION for each
REPORTING PERIOD.
PickupMediaTotalAmount Money The total monetary value of tender media pickups recorded by WORKSTATION for each
REPORTING PERIOD.
DepositTotalAmount Money The total monetary value of tender pickup media recorded by WORKSTATION for each
REPORTING PERIOD.
DepositMediaUnitCount QuantityTransactionCount The total number of tender media units deposited on behalf of that WORKSTATION for each
REPORTING PERIOD.
OverTotalAmount Money The total monetary value of tender overages recorded by WORKSTATION for each
REPORTING PERIOD.
ShortTotalAmount Money The total monetary value of tender underages recorded for that WORKSTATION for each
REPORTING PERIOD.
WorkstationTimeActivityHistory
Definition: 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.
WorkstationDate (PK) DateCalendar The actual date recorded by the WORKSTATION.
TimePeriodHour (PK) Time The time periods expressed in hours to measure line and transaction activity.
TimePeriodMinuteIntervalCount (PK) QuantityShortCountMinutes The number of intervals in minutes for measuring line and transaction activity.
TimePeriodIntervalPerHourCount (PK) QuantityShortCount The number of time intervals per hour for measuring line and transaction activity.
NetSalesTotalAmount Money The net sales amount recorded by the WORKSTATION in the defined time period intervals.
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.
SignOnTimeMinutesCount QuantityTransactionCount The number of minutes since the OPERATOR signed on the WORKSTATION.
WorkstationTimeActivityTenderHistory
Definition: A historical record of ITEM and TRANSACTION movement by pre-defined time intervals so as to measure WORKSTATION productivity.
TimePeriodHour (PK) (FK) Time The time periods expressed in hours to measure line and transaction activity.
TimePeriodMinuteIntervalCount (PK) (FK) QuantityShortCountMinutes The number of intervals in minutes for measuring line and transaction activity.
TimePeriodIntervalPerHourCount (PK) (FK) QuantityShortCount The number of time intervals per hour for measuring line and transaction activity.
WorkstationDate (PK) (FK) DateCalendar The actual date recorded by the WORKSTATION.
NetTenderAmount Money The monetary amount of tender taken by the WORKSTATION in the defined time period
intervals.

Logical VolumeII

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Logical VolumeII

Загружено:

Авторское право:

Доступные форматы

ARTS Data Model Committee

Retail Data Model Logical View

Вам также может понравиться