ListRequisition schema, example, validation rules, validation stylesheet

ListRequisition type: ListRequisition

The purpose of the ListRequisition is to send information relative to demand for goods or services to another business application. This may be in response to a GetlistRequisition request, or it may be a notification vehicle, initiated upon an event in a business application. The List verb describes the behavior of supplying one or several documents in a summary format to the requesting business application. These listings of information may be supplied for requisition documents, or requisition lines and/or requisition sub lines.

ListRequisition extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ListRequisitionDataArea

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

ListRequisitionDataArea extends: DataArea
Structure:
Elements:
Name Type Description
List reference
Requisition reference

ListRequisition Scenario Diagram

List schema

List type: List

The purpose of the LIST verb is to enable a business software component to respond to a GETLIST request or to proactively send a listing of summary information containing many instances of occurrences of data for a noun to one or more other business software components.The results of a LIST may then be used as is, or they may be used to select a specific instance of a document or entity in order to issue a detail GET request.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the LIST decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the LIST verb is quite straight forward with a few exceptions. The LIST response to any GETLIST request needs to read the request carefully to ensure the response is returning the requested Data Types. The LIST needs to ensure the response to the GETLIST does not exceed the maxItems value.The LIST needs to find the specific Field Identifiers that are used for the Field-Based Selection or Range-Based Selection and process them accordingly. The attributes associated with the LIST BODs are as follows: o rsstart attribute is a number that idicates the starting record for the section of the resulting set returned in the list message. This value should always match the rsstart value in the originating GetList BOD. o rscount attribute is a number that indicates the number of records returned in the message. The subsequent request for additional records should have a rsstart value of rscount + 1. o rstotal attribute is a number that indicates the total number of records in the result set. o rscomplete attribute is a Boolean that indicates that the list provided exhaust the possible values. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests.

List extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
rsComplete xs:boolean optional
rsCount xs:positiveInteger optional
rsRef xs:string optional
rsStart xs:positiveInteger optional
rsTotal xs:positiveInteger optional

Requisition schema

Requisition type: Requisition

Is a request for the purchase of goods or services. Typically, a requisition leads to the creation of a purchase order to a specific supplier.

Header type: RequisitionHeader

Information that applies to the Requisition.

Line type: RequisitionLine

Information that describes the requested item and its attributes.

SubLine type: RequisitionSubline

Used if the item on the REQLINE needs to be divided into smaller units such as sub-components or subassemblies.

Requisition extends: Order

Is a request for the purchase of goods or services. Typically, a requisition leads to the creation of a purchase order to a specific supplier.

Structure:

RequisitionHeader extends: OrderHeader

SalesOrderId subsumed into DocumentReferences

Structure:
Elements:
Name Type Description
ApprovalInd Indicator

Indicates whether an order has passed the credit checking criteria.Valid values are: “0” = Order does not meet the accounts receivable application approval criteria.“1” = Order meets the accounts receivable application approval criteria.

Indicates if the semantic name is needed or not.

Buyer reference
LoadingDock LoadingDockCode

Identifies the loading dock

Planner reference
PurchasingEntity PurchasingEntityCode

The business entity that is responsible for a particular purchase order. This entity is on the buying side and is responsible for all transactions regarding the purchase order.

Requester reference
Site reference

Identifier of physical location.

UserArea reference

RequisitionLine extends: OrderLine
Structure:
Elements:
Name Type Description
LoadingDock LoadingDockCode

Identifies the loading dock.

PurchasingEntity PurchasingEntityCode

Origanizational entity that is responsible for purchasing the line item.

Site reference

Indicates the location that is requisiting the line item to be purchased.

SubLine reference
UserArea reference

RequisitionSubline extends: OrderLineBase
Structure:
Elements:
Name Type Description
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

Order.xsd schema

Buyer type: Contact

Is the person(s) or department responsible for purchasing the ordered items from the Customers side.

A business Party contact is a person and has a specific role.

Requester type: Contact

Is the person(s) or department that requested that the ordereditems be purchased from the Customers side.

A business Party contact is a person and has a specific role.

SalesPerson type: Contact

Is the Sales Person(s) that were responsible for the sale from the Supplier's side.

A business Party contact is a person and has a specific role.

Planner type: Contact

Is the person that is responsible for planning when the ordered items are needed from the Customers side. From the Supplier's side the planner will determine when the ordered items can be available.

A business Party contact is a person and has a specific role.

SalesInformation type: SalesInformation

Communicates the information about the sale.

Order restricts: Document
Structure:
Elements:
Name Type Description
Header reference
Line reference

OrderHeader extends: DocumentOrderHeader
Structure:
Elements:
Name Type Description
BackOrderedInd Indicator

Inidicates if the Order is BackOrdered or not.

Indicates if the semantic name is needed or not.

Charges reference
Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DropShipInd Indicator

Indicates whether the order can be drop shipped or not.

Indicates if the semantic name is needed or not.

EarliestShipDate DateTimeAny

Indicates the earliest ship date for the order.

ExtendedPrice Amount

Indicates the total value of the order line items. It does not include any additional charges or fees.

Simple content with the currency as an attrbute

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

License License

Indicates what type of licenses are required in order to make the sell.

Indicates whether a license is need for a given transaction.

NeedDeliveryDate DateTimeAny

Indicates the date the order needs to be delivered to the customer..

OrderStatus reference
Parties reference
PaymentTerms reference

Identifies the payment terms for an Order or Invoice. Supports the abiility to specify an absolute due date, a number of days from a start daye, a percent discount or an absolute discount. A common term like "Net30Days" is explicitly code as either a calculated DueDateTime or a PaymentTermsDateTime and NumberOfDays.

Priority Priority

Inidicates the Priority that the Customer is requesting for the order.

PromisedDeliveryDate DateTimeAny

Indicates the date in which the order was promised to be delivered to the customer.

PromisedShipDate DateTimeAny

Indicates the date in which the order was promised to be shipped from the supplier to the customer.

ReasonCode ReasonCode

Is used as a reason indicator for any type of business event or activity.

Used as a reason indicator for any type of business event or activity.

ShipNote Note

Is the shipping instructions or notes. This is a free form area that contains special instructions such as: Second Day Air, Hurry, Rush, Handle with Care.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

ShipPriorToDueDateInd Indicator

Indicates if the order can be shipped prior to the dates on the order.

Indicates if the semantic name is needed or not.

SpecialPriceAuthorization AuthorizationId

Is the supplier’s code to authorize special pricing as a result of an agreement.

SYNONYMS: Price Authorization, Price Code

TaxWithholdingExempt TaxWithholdingExempt

Specifies whether the document is exempt from withholding taxes..

TotalAmount Amount

Indicates the total value of the order. It is possible for this to be provided in both the currency of the given transaction or in the default currency of the sending orginization (the functional currency). This is necessary for internal application communication.

Simple content with the currency as an attrbute

TransportationTerm reference

When a seller ships something via common to a buyer in accordance with the Uniform Commerical Code and international legal agreements, you must specify a particular "phrase" that states who assumes the risk of shipment, who is responsible for loading and unloading the goods, where ownership or title to the goods passes, who paid or pays the carrirer, etc. Examples of these "phrases" include: - "FOB Origin Prepaid and Add" (Free On Board - no cost for loading, title passes at seller's dock, seller prepaid freight cost and delivery insurance, seller will freight costs to cost of goods) - "FOB Destination" or "FOB Destination Prepaid" (Free On Board - no cost for loading, title passes at buyer's dock, seller prepaid freight cost and delivery insurance) In software applications, this phrase is commonly split into two coded pieces, a "legal terms" risk and responsibility component for use with common carriers (FOB Destination) and some kind of qualifying component (Prepaid and Add).

OrderLine extends: OrderLineBase
Structure:
Elements:
Name Type Description
Attachments reference
Charges reference
DocumentReferences reference
OrderStatus reference
Parties reference
PaymentTerms reference

Identifies the payment terms for an Order or Invoice. Supports the abiility to specify an absolute due date, a number of days from a start daye, a percent discount or an absolute discount. A common term like "Net30Days" is explicitly code as either a calculated DueDateTime or a PaymentTermsDateTime and NumberOfDays.

Tax reference

Identifies a type of tax on order related BODs

OrderLineBase extends: DocumentLine
Structure:
Elements:
Name Type Description
BackOrderedInd Indicator

Inidicates if the Order is BackOrdered or not.

Indicates if the semantic name is needed or not.

BackOrderedQuantity Quantity

Indicates the number of the ordered quantity placed on back order for the line.

A decimal value.

Description Description

Is a free form description of the line.

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

Distribution reference

A distribution identifies how monetary amounts are distributed accross an organization.

DropShipInd Indicator

Indicates whether the order can be drop shipped or not.

Indicates if the semantic name is needed or not.

EarliestShipDate DateTimeAny

Indicates the earliest ship date for the order line.

ExtendedPrice Amount

Indicates the accumulated cost of the ordered items for this line. It is OrderedQuantity multiplied by the UnitPrce.

Simple content with the currency as an attrbute

FreightClass FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers. EXAMPLES National Motor Freight Carriers (NMFC) Class Code Based on an evaluation of density, stowability, ease of handling and liability, the commodities are grouped into one of 18 classes.

License License

Indicates what type of licenses are required in order to make the sell.

Indicates whether a license is need for a given transaction.

MaximumTemperature Temperature

Is maximum temperature the Line item can reach.

A temperature value in decimal.

MinimumTemperature Temperature

Is minimum temperature the Line item can reach.

A temperature value in decimal.

NeedDeliveryDate DateTimeAny

Indicates the date the order line needs to be delivered to the customer..

OrderItem reference

Provides information on the Orderable Item. When associated with an order like a Purchase Order, it identifies the item being ordered at the associated Line.

OrderQuantity Quantity

Indicates the number of ordered items for the given line..

A decimal value.

PackingMaterial PackingMaterial
Priority Priority

Inidicates the Priority that the Customer is requesting for the order.

PromisedDeliveryDate DateTimeAny

Indicates the date in which the order line was promised to be delivered to the customer.

PromisedShipDate DateTimeAny

Indicates the date in which the order line was promised to be shipped from the supplier to the customer.

ReasonCode ReasonCode

Is used as a reason indicator for any type of business event or activity.

Used as a reason indicator for any type of business event or activity.

ShipNote Note

Is the shipping instructions or notes. This is a free form area that contains special instructions such as: Second Day Air, Hurry, Rush, Handle with Care.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

ShipPriorToDueDateInd Indicator

Indicates if the semantic name is needed or not.

SubstitutionAllowedInd Indicator

Indicates if the semantic name is needed or not.

TaxWithholdingExempt TaxWithholdingExempt

Specifies whether the item is exempt from withholding taxes..

TotalAmount Amount

Indicates the total cost of the ordered items for this line.This includes any additional charges or handling fees.

Simple content with the currency as an attrbute

TransportationTerm reference

When a seller ships something via common to a buyer in accordance with the Uniform Commerical Code and international legal agreements, you must specify a particular "phrase" that states who assumes the risk of shipment, who is responsible for loading and unloading the goods, where ownership or title to the goods passes, who paid or pays the carrirer, etc. Examples of these "phrases" include: - "FOB Origin Prepaid and Add" (Free On Board - no cost for loading, title passes at seller's dock, seller prepaid freight cost and delivery insurance, seller will freight costs to cost of goods) - "FOB Destination" or "FOB Destination Prepaid" (Free On Board - no cost for loading, title passes at buyer's dock, seller prepaid freight cost and delivery insurance) In software applications, this phrase is commonly split into two coded pieces, a "legal terms" risk and responsibility component for use with common carriers (FOB Destination) and some kind of qualifying component (Prepaid and Add).

UnitPrice AmountPerQuantity

Indicates the price per unit of the items ordered.

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.

OrderSchedule extends: OrderLineBase
Structure:
Elements:
Name Type Description
EffectivePeriod TimePeriodAny

Is the starting point in time in which the schedule applies.

FixedTimeDuration Duration

Indicates how often a shipment of Order Items are to be sent to the Customer.

OverShipTolerance Quantity

Indicates the number over the RequiredQuantity a given shipment may be.

A decimal value.

OverToleranceDuration Duration

Indicates the number of days late that a shipment of the scheduled items can be.

RequiredQuantity Quantity

Indiactes the quatity of Order Items that are required in for a given shipment for the schedule.

A decimal value.

UnderShipTolerance Quantity

Indicates the number under the RequiredQuantity a given shipment may be.

A decimal value.

UnderToleranceDuration Duration

Indicates the number of days early that a shipment of scheduled items can be.

OrderSubLine extends: OrderLineBase
Structure:
Elements:
Name Type Description
UserArea reference

SalesInformation

Communicates the Sales Information like the sales person, and their commision, indcates the Sales Organizations involved and their commision rates.

Structure:
Elements:
Name Type Description
CommisionQuantity Quantity

Indicates the Quantity of items in which the commision is received for.

A decimal value.

CommissionAmount Amount

Monitary Amount of the commision.

Simple content with the currency as an attrbute

OrderAmount Amount

Is the total Amount of the Order.

Simple content with the currency as an attrbute

OrderQuantity Quantity

Is the total Ordered Quantity.

A decimal value.

PercentQuantity Quantity

Is the Commision Percentage for the Sales Person or Organization.

A decimal value.

SalesOrganization SalesOrganization

Indicates the Sales Organizations involved in the sell.

Idenitifies the SalesOrganizations.

SalesPerson reference

Is the Sales Person that were involved in the order.

UserArea reference

Document.xsd schema

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

DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

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

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

Status reference

DocumentLine
Structure:
Elements:
Name Type Description
LineNumber LineNumber

Is the Line Number of the given Line Coponent within the document. LineNumbers are assigned by the sending system.

Identifies the instance of a Line within a given document.

DocumentOrderHeader restricts: DocumentHeader
Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Is a description of the document.

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

DocumentDateTime DateTime

Is the date and time the document was last created. This is not the date and time that the BOD message instance was created.

DocumentIds reference

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

Is the identifier for the document. It is possible to carry the document identifier for the other Parties. These DocumentIds are referenced by sematic names.

DocumentReferences reference
LastModificationDateTime DateTime

Is the date and time the document was last modified. This is not the date and time that the BOD message was sent.

Note Note

Is Note for the document in which it is contained.

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.