GetPriceList schema, example, validation rules, validation stylesheet

GetPriceList type: GetPriceList

The purpose of the GetPriceList is to enable a business application module or system to request information concerning new or existing product price lists. This BOD may be necessary to address the Make to Order, Assemble to Order, or Mixed Mode business ordering scenarios in an Order Management to Manufacturing application integration scenario. There are many possible business applications in several environments that may use this capability. For example, a Manufacturing, distributor or reseller business application could use this to communicate the price change or request a price list. It may also be necessary to support Component Supplier Management (CSM) scenarios. In this scenario a company will provide a service of sourcing and codifying the products of many companies and publishing a consolidated catalog. A customer purchases the product from the Catalog provider. They have the capability to do comparison shopping from the catalog. Supplier Certification may be provided by the Catalog provider. This definition of price list is intended to support simple pricing scenario, especially pricing that may accompany a published price list. It is not intended to support complex pricing environments that may be needed to support features such as; · Deals and Promotions · Coupons and Sales Incentives · Rebates and Accruals This functionality will be addressed in a subsequent release. It is a working assumption that the representation of complex qualifications, coupons and sales incentives are rarely communicated between systems.

GetPriceList extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetPriceListDataArea

Is where the information that the BOD message carries is provided, in this case GetPriceList. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (PriceList).

GetPriceListDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Get reference
PriceList reference

GetPriceList Scenario Diagram

Get schema

Get type: Get

The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned.

Get extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
show xs:string

PriceList schema

PriceList type: PriceList

Defines a list of items with their base price, price breaks, discounts and qualifiers. For each item, price breaks can be defined, above which certain discounts or overriding prices might apply. Price breaks can be defined in volume or in dollar amount. Price list qualifiers specify for which catalog, customer and/or effective dates this price list applies.

Header type: PriceListHeader

Line type: PriceListLine

ListPriceBreak type: ListPriceBreak

PriceListQualifier type: PriceListQualifier

This qualifies the intended audience or group of users of a Price List Qualifications for a given price list include, (but are not limited to): · Suppliers, Customers or Manufacturers · Specific Customer Site · Suppliers, Customers or Manufacturers · Catalogs

LinePriceBreak type: LinePriceBreak

This defines the prices and modifiers to the price for buying a given quantity or value of an item or item category on a price list line. For Price List Lines that specify Items the price breaks can be specified in terms of quantity or amount. For Price list lines that specify commodity, price breaks can only be specified in terms of currency amount

LinePriceBreak
Structure:
Elements:
Name Type Description
Description Description

Description of the PriceBreak.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DiscountPercent Percent

Indicates the percentage of the PriceBreak.

Indicates the percentage.

DiscountValue Amount

Allows a flat amount to be discounted per item.

Simple content with the currency as an attrbute

OverRidePrice AmountPerQuantity

This is the price that overrides the list price when a given price break requirement is reached. For example, if a customer orders over 50,000 dollars worth of computer equipment, he may qualify for an overriding price. The list price of $800 per will be modified to $700 per

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

PriceBreakAmount Amount

The monetary amount that must be spent on a given price list line before the benefit or until the detriment of a given price break line will apply. For example, if a customer orders up to 5000 dollars worth of flour, they will get a price of $8:00 a case. If the customer buys 5500 dollars worth of flour they will get a price of $7.50 a case

Simple content with the currency as an attrbute

PriceBreakQuantity Quantity

The quantity that must be purchased of the item or commodity on a given price list line before the benefit, or until the detriment of a given price break line will apply. For example, if a customer orders up to 5000 units of flour, they will get a price of $8:00 a case. If the customer buys 5500 units of flour they will get a price of $7.50 a case

A decimal value.

UserArea reference

ListPriceBreak
Structure:
Elements:
Name Type Description
Description Description

Description of the PriceBreak.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DiscountPercent Percent

Indicates the percentage of the PriceBreak.

Indicates the percentage.

DiscountValue Amount

Allows a flat amount to be discounted per item.

Simple content with the currency as an attrbute

PriceBreakAmount Amount

Is the amount of the PriceBreak.

Simple content with the currency as an attrbute

UserArea reference

PriceList extends: Noun
Structure:
Elements:
Name Type Description
Header reference
Line reference

PriceListHeader

The Price list may be issued by either a company within your Enterprise, represented by a GLEntity, a division of the company (represented by Business) or by any entity identified as a Catalog Party. A Party may be a supplier. The supplier may be a supplier to many companies within the enterprise

Structure:
Elements:
Name Type Description
Business reference
Currency Currency

Is the default currency of the PriceList.

Description Description

Is a description of the PriceList.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentId PartyDocumentId

Document specific identifier type.

EffectivePeriod TimePeriod

Indicates the effective period of the PriceList.

ListPriceBreak reference
PriceListQualifier reference
PublisherParty reference
Site reference

Is the GLEntity that is issuing the catalog

UserArea reference

PriceListLine
Structure:
Elements:
Name Type Description
CommodityCode Commodity

Is the Commodity for which the price is being specified

Are codes that identify user-defined groupings of items.

Description Description

Description of the PriceListLine.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

ItemId PartyAssignedItemId

Is the ItemId for which the price is being specified

Identifies an Items identifier that has been assigned by another Party.

LineNumber LineNumber

PriceList LineNumber

Identifies the instance of a Line within a given document.

LinePriceBreak reference
UnitPrice AmountPerQuantity

Price per unit.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

UserArea reference

PriceListQualifier
Structure:
Elements:
Name Type Description
Business reference
CatalogDocumentReference reference

Reference to the Catalog in which the PriceList applies.

Description Description

Description of the PriceList.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Parties reference
Site reference
UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files