GetDeliveryReceipt schema, example, validation rules, validation stylesheet |
GetDeliveryReceipt type: GetDeliveryReceipt | |
The GetDeliveryReceipt may be used to request information about a specific expected (unreceived) or previously received goods delivery. The response to the GetDeliveryReceipt request is ShowDeliveryReceipt. 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. 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. |
GetDeliveryReceipt extends: BusinessObjectDocument | |||||||
Structure: |
![]() |
||||||
Elements: |
|
GetDeliveryReceiptDataArea extends: DataArea | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
GetDeliveryReceipt 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: |
|
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: |
|
DeliveryReceiptHeader extends: SCEHeader | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Provides general information about the DeliveryReceipt document that is used to receive a specific quantity of material goods |
||||||||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
ReceiptDiscrepancy | ||||||||||||||||||||||
This identifies discrepancy information for the receipt |
||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||
Elements: |
|
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: |
|
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: |
|
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: |
|
Verb Common Files |
Verb.xsd schema |
AcknowledgableVerb extends: ConfirmableVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
AcknowledgementType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
ConfirmableVerb extends: Verb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
ConfirmType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
Expression restricts: xs:string | |
ExpressionCriteria | |||||||||
Structure: |
![]() |
||||||||
Elements: |
|
||||||||
Attributes: |
|
RequestVerb extends: ConfirmableVerb | |||||||
Structure: |
![]() |
||||||
Elements: |
|
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: |
|
SCEItem | |||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||||||||||||||
Elements: |
|
SCEUnit extends: Noun | ||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
ShipmentDocumentReference extends: DocumentReference | ||||||||||||||||
Is a reference to a Shipment document. |
||||||||||||||||
Structure: |
![]() |
|||||||||||||||
Elements: |
|
ShipUnitReference | ||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||
Elements: |
|