ShowDeliveryReceipt schema, example, validation rules, validation stylesheet

ShowDeliveryReceipt type: ShowDeliveryReceipt

The ShowDeliveryReceipt may be used to obtain information about a specific expected (unreceived) or previously received goods delivery. The ShowDeliveryReceipt may be issued in response to a GetDeliveryReceipt request, or emitted asynchronously for notification upon some business event. For expected deliveries, the ShowDeliveryReceipt document content may act as a receiving template or checklist to identify the quantity and shipping configuration of the expected goods. In this manner the ShowDeliveryReceipt may be considered logically equivalent to the Advance Ship Notice information in a ShowShipment document. This similarity is by design, as the receiver’s ShowDeliveryReceipt may be directly derived from shipper’s ShowShipment content after the receiver’s business logic has appropriately validated the Advance Ship Notification information. The ShowDeliveryReceipt supports describing shipment content at either the line item level and/or the ship unit level. Intermediate transportation/logistics providers or freight forwarding partners can use this document to acknowledge the receipt of entire shipping units without detailing the corresponding contents.

ShowDeliveryReceipt extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea ShowDeliveryReceiptDataArea

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

ShowDeliveryReceiptDataArea extends: DataArea
Structure:
Elements:
Name Type Description
DeliveryReceipt reference
Show reference

ShowDeliveryReceipt Scenario Diagram

Show schema

Show type: Show

The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show 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 Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types.

Show extends: ConfirmableVerb
Structure:

DeliveryReceipt schema

DeliveryReceipt type: DeliveryReceipt

Represents a transaction for the receiving of goods or services. It may be used to indicate receipt of goods in conjunction with a purchase order system.

The DELIVERY document contains CHARGE and DISTRIBUTN elements at various levels to support the assessment of receiving service or compliance penalty charges. Several large retailers that demand receiving efficiency commonly assess penalty charges for supplier deliveries that are not compliant with the retailer’s policies. Charges may be incurred for deliveries, ship units or items that contain discrepancies from what was ordered or electronically manifested, for improper labeling of items and ship units and the incorrect packing or loading of ship units.

Header type: DeliveryReceiptHeader

Provides general information about the DeliveryReceipt receipt document that is used to receive a specific quantity of material goods from a supplier.

ReceiptLine

Provides general information about the item inventory being delivered, including the requested and actual quantities. This information usually directly references a line item or shipment schedule line on a sales order, purchase order or other inventory transfer document.

ReceiptDiscrepancy type: ReceiptDiscrepancy

Provides receiving discrepancy information for the DeliveryReceipt header as a whole, for a particular ReceiptLine, for the receipt of a shipping unit as a whole ReceiptLine, or to a particular item within the shipping unit (ReceiptUnit).

ReceiptItem

ReceiptUnit type: ReceiptUnit

ReceiptDisposition type: Disposition

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

ItemDisposition type: Disposition

Indicates the disposition of the Item being received.

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

DeliveryReceipt extends: Noun

A DeliveryReceipt is a Noun that details the receipt of goods by a customer or consignee destination from a supplier business partner via the services of a transportation provider (carrier). The DeliveryReceipt Noun has been modeled for use in conjunction with the Shipment Noun when issued by the shipping business partner as an Advance Shipment Notification (see OAGIS BOD ShowShipment for more information). DeliveryReceipt was designed to support the physical process of receiving of goods from a carrier and is not biased toward receiving against a particular purchase, transfer or sales order reference document. This feature enables the receiving of goods simultaneously across multiple orders that were consolidated for shipping efficiency. The DeliveryReceipt Noun is modeled to extend and accommodate the following existing business object design work: - ANSI X12 EDI #861 Receiving Advice/Acceptance Certificate - ANSI X12 EDI #944 Warehouse Stock Transfer Receipt Advice - RosettaNet Cluster 4, Segment 4B, Notification of Shipment Receipt Note that the DeliveryReceipt Nooun contains additional structures to record various detail and discrepancy information against the contents of a shipment. This information is owned by the receiving party, and thus requires a new Business Object Document apart from Shipment to describe the delivery of the shipment from the receiver’s business process point-of-view.

Structure:
Elements:
Name Type Description
Header reference
ReceiptLine reference
ReceiptUnit reference

DeliveryReceiptHeader extends: SCEHeader

Provides general information about the DeliveryReceipt document that is used to receive a specific quantity of material goods

Structure:
Elements:
Name Type Description
ActualDeliveryDateTime DateTime

Is the date and time that the delivery actually occured.

ContainersShippedQuantity Quantity

Contains the quantity of units or things shipped. This represents the container(s), not the product shipped. An example of this is “4 truck loads” or “2 wooden crates”.

A decimal value.

DeliverToContact reference
Disposition reference

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

DistributionCenter Location

Is the identifier or location in which the shipment was shipped from by the supplier.

The replacement for SiteLevel, the original, flattened concept of numbered, sibling site levels. Location is intended to capture all of the location information for a given, named location. This could include more than one location descriptor, such as a PostalAddress and the GPS Coordinates. Location can also be described relative to other locations, by including a "Proximal Location" (a location nearby or surrounding/containing this location). In this fashion, locations can be identified and cascaded, e.g., the top floor of The Forrester Building which is at 400 Tech Square, right next to the Acamai Building: top floor The Forrester Building 400 Tech Square Next to the Acamai Building or in Bin 21 on Shelf 4 at Row 3B in Building 19: Bin 31 Shelf 4 Row 3B Building 19 ...

DockId Id

Indicates the Dock in which the delivery was made.

Generic identifier type with open qualifyingAgency.

EffectivePeriod TimePeriod

Indicates the effective time period of the DeliveryReceipt.

Parties reference
ReceivedBy UserAccount

Identifies who signed off on the receipt of the Delivery.

ReceivedDateTime DateTime

Date and Time that the Delivery was Received.

ScheduledDeliveryDateTime DateTime

Is the Date and Time in which the delivery was scheduled to occur.

ShippedDateTime DateTime

Is the date the shipment was shipped.

Site reference
Status reference
Type reference
UserArea reference

ReceiptDiscrepancy

This identifies discrepancy information for the receipt

Structure:
Elements:
Name Type Description
Description Description

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

ItemQuantity Quantity

If the discrepancy applies to specific quantities of the item, then the quantity can be specified. If no quantity is specified, the discrepancy applies to the inventory occurence as a whole

A decimal value.

Note Note

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.

ReasonCode Code

Identifies the reason for the discrepancy.

Base type for a Code of any kind

Type Type

This is an exception classification that codifies the general problem encountered during a business process, such as receiving goods

UserArea reference

ReceiptItem extends: SCEItem

Provides information about a specific quantity of goods inventory contained within a shipping unit. RECEIPTITM is used to provide a detailed breakdown of RECEIPTLN inventory for inventory discrepancies or compliance charges for a particular shipping unit

Structure:
Elements:
Name Type Description
InventoryDetail reference
PackingSlipQuantity Quantity

This is the quantity that is shown on the Packing Slip when goods are received from a supplier. THis information is obtained from the supplier's Advance Ship Notice (ASN) or manually entered on receipt

A decimal value.

ReceiptDiscrepancy reference
ReceivedQuantity Quantity

Is the quantity of items received as counted by receiving.

A decimal value.

UserArea reference

ReceiptLine

ReceiptLine represents the goods line item detail of the receipt document. THis can be used by itself for traditional receiving against Purchase Orders or other line-item oriented buisness documents, or in conjunction with the ReceiptUnit element to summarize ship unit item detail at line level

Structure:
Elements:
Name Type Description
ActualDeliveryDateTime DateTime

Is the actual delivery date and time.

Attachments reference
BackOrderedQuantity Quantity

Indicates the number of Items on back order.

A decimal value.

CatchWeightConversionFactor reference
CatchWeightQuantity reference
Charges reference
Description Description

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

DocumentReferences reference
FreightClass reference

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.

HazardousMaterial reference

Provides the Hazardous Material Code and description.

ImportLicenseRequired Indicator

Communicates the need for an import license on a good or service. Valid values are '0' for no license required, and '1' for license required.

Indicates if the semantic name is needed or not.

InventoryDetail reference
ItemDisposition reference
ItemIds reference
LineNumber LineNumber

Is the unique identifier of the ReciptLine.

Identifies the instance of a Line within a given document.

Lot reference
NetWeight reference
OpenQuantity Quantity

This is the current unfulfilled order quantity for ITEM

A decimal value.

OrderedQuantity Quantity

Is the number of items ordered.

A decimal value.

OriginationCountry Country

Indicates the country of origin for thie Item.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

OwnershipCode reference

Idenifies who owns the associated entity.

PackingMaterial PackingMaterial

Indentifies the Packing Material used to ship this line item.

PackingQuantity Quantity

This is the total quantity of ITEM shipped as listed on the packing list(s). It contains the supplier's shipment quantity as indicated by asociated paperwork if no ASN information was transmitted about the delivery

A decimal value.

ReceiptDiscrepancy reference
ReceiptDisposition reference
ReceiptQuantity Quantity

Indicates the total quantity of item received

A decimal value.

ReceiptValue Amounts

Indicates the value of the received line. The acutal provides the transactional amount the converted provides the functional amount in the currency of the organizations general ledger.

ReturnedQuantity Quantity

This is the quantity of the Item for which the customer refused delivery

A decimal value.

ShippedQuantity Quantity

Is the total number of items actually shipped as counted by the receiver.

A decimal value.

Site reference
UserArea reference

ReceiptUnit extends: SCEUnit

Provides information that identifies and describes a particular shipping unit being received. This information usually directly references a SHIPUNIT on an OAGIS SHIPMENT BOD or other shipping document. May also be used to provide context to adequately detail inventory discrepancies or compliance charges for a particular shipping unit

Structure:
Elements:
Name Type Description
ActualDeliveryDateTime DateTime

The Datetime of receipt of the shipment

DeclaredValueAmount Amount

Is the declared monetary value of the contents of a shipping unit or a delivery for insurance purposes.

Simple content with the currency as an attrbute

ImportLicenseRequired Indicator

Communicates the need for an import license on a good or service. Valid values are '0' for no license required, and '1' for license required.

Indicates if the semantic name is needed or not.

Parties reference
ReceiptDiscrepancy reference
ReceiptItem reference
ScheduledDeliveryDateTime DateTime

The Date on which the delivery was scheduled to be received

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

SupplyChainExecution.xsd schema

InventoryDetail type: LotSerial

Provides additional inventory attribute information for an inventory item, such as lot numbers, quality/disposition, serial numbers, or other characteristics that may not be specified on the order documentation.

ShipmentDocumentReference type: ShipmentDocumentReference

Is a reference to a Shipment.

OwnershipCode type: OwnershipCode

is used to identify who or which organization owns the item or part. The content of this Field is user defined based on a specific Customer or Supplier. SYNONYMS: Vendor Consignment ID, Supplier Consignment ID

Idenifies who owns the associated entity.

FreightClass type: FreightClass

Qualifies goods for purposes of freight cost calculation. An example would the qualifications used by National Motor Freight Carriers.

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.

CatchWeightQuantity type: Quantity

This is the actual weight of the ReceivedQuantity for the Item, if the NetWeightQuantity cannot be calculated precisely via arithmetic because the goods do not have a consistent per unit weight

A decimal value.

CatchWeightConversionFactor type: Factor

The catch weight conversion factor is a stock keeping conversion factor for inventory goods. This is a special conversion factor for when the units of measure can not be converted using arithmetic. This conversion factor is used with the CatchWeightQuantity. Examples of the use of this factor include: - Number of Chickens to a Box - Number of units of a chemical in a barrel

NetWeight type: Quantity

This is the total net weight of the ReceivedQuantity for the Item, if the ReceivedQuantity is not in weight units. This is the weight of the goods received, disregarding any container or shipping packaging

A decimal value.

OriginationCountry type: Country

Is the country in which the Shipment originated.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

ShipUnitReference type: ShipUnitReference

SCEHeader
Structure:
Elements:
Name Type Description
ActualFreightTotalCost Amount

Is used to report the total price charged to the customer for transporting the items or products being sold, produced or purchased. This amount is determined by the shipping partner and/or reported by the carrier partner upon shipment or delivery of the product.

Simple content with the currency as an attrbute

AlternateDocumentIds DocumentIds

Other document identifiers this document maybe known as. This provides a cross-reference to the other parties identifiers for this document.

Charges reference
Description Description

Is a free-form description of the transaction or any portion of the transaction.

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

DocumentDate DateTime

Is the timestamp that the document was created in the sending system.

DocumentId DocumentIdType

Is a general identifier of a document number.

EarliestShipDateTime DateTime

This identifies the earliest possible date at which a shipment can be made. This may be used in conjunction with the ShipPriorToDueDateInd which indicates that the item, shipping unit or delivery may be shipped early.

LastModificationDateTime DateTime

Is the date of the last update to this document.

OriginationCountry Country

Represents the identifier of the country of origin. The list of valid codes can be found in ISO Standard number 3166.

Standard values from ISO 3166-3:1999 Part 1

Codes for the representation of names of countries and their subdivisions - Part 1: Country codes

PartialShipmentInd Indicator

Identifies when a partial shipment to a customer is allowed. Valid values are '0' for partial shipment not allowed.

Indicates if the semantic name is needed or not.

Priority Priority

Priority of a document, task, or activity. Could be used for production orders, sales orders, purchase orders, etc.

ShipUnitQuantity Quantity

Contains the quantity of units or things shipped. This represents the container(s), not the product shipped. An example of this is "4 truck loads" or "2 wooden crates".

A decimal value.

TotalFreightCost Amount

MDV: How is this different to ActualFreightTotalAmount?

Simple content with the currency as an attrbute

Warehouse Warehouse

Is the storage facility for inventory.

SCEItem
Structure:
Elements:
Name Type Description
CatchWeightConversionFactor reference
CatchWeightQuantity reference
Charges reference
FreightClass reference

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.

HazardousMaterial reference

Provides the Hazardous Material Code and description.

Item reference
LotSerial reference
NetWeight reference
OriginationCountry reference
OwnershipCode reference

Idenifies who owns the associated entity.

RoutingDisposition reference

SCEUnit extends: Noun
Structure:
Elements:
Name Type Description
Charges reference
ContainerId Id

Is the identifier of a container.

Generic identifier type with open qualifyingAgency.

ContainerSealId Id

Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.

Generic identifier type with open qualifyingAgency.

ContainerType Type

Is a classification of containers.

Description Description

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

Disposition reference

Used to indicate that a particular shipping unit has been received

Determines the receipt routing of an item or part. Examples of values include: Customer consignment Inspection Vendor consignment Blocked Bonded User defined SYNONYMS Receipt Routing Material Status Material Condition Code

FreightItemNumber Code

Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.

Base type for a Code of any kind

ShippersCost AmountPerQuantity

Is used to describe the shipper's total cost of transporting the items or products being sold, produced or purchased, if it is different that the freight amount being charged to the customer. (Certain businesses may want to track the internal cost of a free shipping promotion or utilize their shipping operations as a profit center.) To report the total freight charge the customer is to pay, use FreightAmount.

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.

ShippingMaterial reference

Is an identifier is the part number of a shipping container or material.

ShippingTrackingId Id

Is a unique identifier for the purpose of tracking an individual package or shipment. Examples of valid TrackingIds are: - An express parcel tracking nmber at typicall assigned by UPS, DHL, Federal Express or other similar carriers. - A UCC (Uniform Code Council) Serialized Shipping Container (SCC-18) identifier, as assigned by the shipper. - A "Pro Number" (Progressive Number), as assigned by an LTL (less-than-truckload) freight carrier. Since the same Pro Number can be assigned to multiple shipping units within an LTL shipment the ShipUnitSequence and ShipUnitTotal identifiers may be used to identify the individual pieces. - The unique identifier of a motor freight trailer or railroad box or tank car, ocean freight container or other transportation vessel.

Generic identifier type with open qualifyingAgency.

ShipUnitSequence SequenceCode

In a set of similar shipping units for a delivery, ShipUnitSequenceId represents a particular unit out of the total set. When used in conjunction with ShipUnitTotalId and printed on a shipping unit label or packing list, the receiving partner can easily ascertain whether or not the delivery was complete.

ShipUnitTotalId Id

In a set of similar shipping units for a delivery, ShipUnitTotalId represents the total or final unit in the set. When used in conjunction with ShipUnitSequenceId and printed on a shipping unit label or packing list, the receiving partner can easily ascertain whether or not the delivery was complete.

Generic identifier type with open qualifyingAgency.

TotalVolume Quantity

Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.

A decimal value.

TotalWeight Quantity

Quantifies the weight, or heaviness, of an item, container or shipment.

A decimal value.

ShipmentDocumentReference extends: DocumentReference

Is a reference to a Shipment document.

Structure:
Elements:
Name Type Description
DocumentDate DateTimeAny

The Datetime of the referenced document.

DocumentIds reference
ShipUnitReference reference
UserArea reference

ShipUnitReference
Structure:
Elements:
Name Type Description
ContainerId Id

Is the identifier of a container.

Generic identifier type with open qualifyingAgency.

ContainerSealId Id

Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.

Generic identifier type with open qualifyingAgency.

ContainerType Type

Is a classification of containers.

FreightItemNumber Code

Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.

Base type for a Code of any kind

ShippingTrackingId Id

Is a unique identifier for the purpose of tracking an individual package or shipment.

Generic identifier type with open qualifyingAgency.

UserArea reference