UDE Rental SALES005
Version: Process description SALES005 v1.0
1 The process
The trading process starts with the exchange of master data. In the DICO standard, we are familiar with the SALES005 product and item message. Within DICO, a product is defined as something that possesses use properties and an article as something that possesses trade properties. In this context, the item therefore knows the properties that indicate whether something is refurbished or reused, and the product describes the properties that are generic and thus also apply to a 'new' item such as dimensions. In addition, the condition message and the item relationship message also belong to DICO Data Messages.
Published extensions within RentalUDE:
- XML structure RentalUDE in the Pricat message
- XML structure RentalUDE in the Order message
- XML structure RentalUDE in the Order Response message
- XML structure RentalUDE in the Despatch message
- XML structure RentalUDE in the Invoice message
The RentalUDE is shown below in its whole.
<UserDefinedExtension xmlns:rental="https://ontology.ketenstandaard.nl/DICO/UDE/Rental/v1"
xsi:schemaLocation="https://ontology.ketenstandaard.nl/DICO/UDE/Rental/v1 RentalUDE.xsd">
<rental:RentalUDE>
<rental:Prices>
<rental:PricePerRentalTime>
<rental:Quantity> </rental:Quantity>
<rental:QuantityUoM> </rental:QuantityUoM>
<rental:MinimumOrderQuantity> </rental:MinimumOrderQuantity>
<rental:OrderMultiple> </rental:OrderMultiple>
<rental:Price> </rental:Price>
</rental:PricePerRentalTime>
</rental:Prices>
<rental:WeekendInvoicing> </rental:WeekendInvoicing>
<rental:ContinuesUse> </rental:ContinuesUse>
<rental:RentalPeriod>
<rental:FixedStartDateTime> </rental:FixedStartDateTime>
<rental:FixedFinishDateTime> </rental:FixedFinishDateTime>
</rental:RentalPeriod>
<rental:StartRentalPeriod> </rental:StartRentalPeriod>
</rental:RentalUDE>
</UserDefinedExtension>
Here, it is important to note that the extension should always be called by using the following tag:
<UserDefinedExtension xmlns:rental="https://ontology.ketenstandaard.nl/DICO/UDE/Rental/v1" xsi:schemaLocation="https://ontology.ketenstandaard.nl/DICO/UDE/Rental/v1 RentalUDE.xsd">
This way, the XSD of the extension is loaded which makes the extension validatable and is also the only correct way to officially use the extension.
The location of the extension in the relevant message subheadings is indicated in the relevant message.
2 UDE Structure
2.1 RentalUDE in the Pricat Message
The following parts of the extension may be used within the Pricat message:
<rental:RentalUDE>
<rental:Prices>
<rental:PricePerRentalTime>
<rental:Quantity> </rental:Quantity>
<rental:QuantityUoM> </rental:QuantityUoM>
<rental:MinimumOrderQuantity> </rental:MinimumOrderQuantity>
<rental:OrderMultiple> </rental:OrderMultiple>
<rental:Price> </rental:Price>
</rental:PricePerRentalTime>
</rental:Prices>
<rental:WeekendInvoicing> </rental:WeekendInvoicing>
<rental:ContinuesUse> </rental:ContinuesUse>
</rental:RentalUDE>
The location of the extension within the item message is on the line, xpath is:
PriceCatalogue/Grouping/TradeItemLine/UserDefinedExtension
2.2 RentalUDE in the Order message
The following extension components may be used within the order message:
<rental:RentalUDE>
<rental:RentalPeriod>
<rental:FixedStartDateTime> </rental:FixedStartDateTime>
<rental:FixedFinishDateTime> </rental:FixedFinishDateTime>
</rental:RentalPeriod>
</rental:RentalUDE>
The location of the extension within the order message is on the line, xpath is:
Order/OrderLine/UserDefinedExtension
2.3 RentalUDE in the Order Response
The following parts of the extension may be used within the order response:
<rental:RentalUDE>
<rental:Prices>
<rental:PricePerRentalTime>
<rental:Quantity> </rental:Quantity>
<rental:QuantityUoM> </rental:QuantityUoM>
<rental:MinimumOrderQuantity> </rental:MinimumOrderQuantity>
<rental:OrderMultiple> </rental:OrderMultiple>
<rental:Price> </rental:Price>
</rental:PricePerRentalTime>
</rental:Prices>
<rental:WeekendInvoicing> </rental:WeekendInvoicing>
<rental:RentalPeriod>
<rental:FixedStartDateTime> </rental:FixedStartDateTime>
<rental:FixedFinishDateTime> </rental:FixedFinishDateTime>
</rental:RentalPeriod>
</rental:RentalUDE>
The location of the extension within the order response line, xpath is:
OrderResponse/OrderResponseLine/UserDefinedExtension
2.4 RentalUDE in the Despatch Advice message
The following parts of the extension may be used within the Despatch Advice message:
<rental:RentalUDE>
<rental:RentalPeriod>
<rental:FixedStartDateTime> </rental:FixedStartDateTime>
<rental:FixedFinishDateTime> </rental:FixedFinishDateTime>
</rental:RentalPeriod>
</rental:RentalUDE>
The location of the extension within the Despatch message is on the line, xpath is:
DespatchAdvice/DespatchLine/ItemLevelDespatchAdvice/UserDefinedExtension.
2.5 RentalUDE in the Invoice message
The following extension components may be used within the Invoice message:
<rental:RentalUDE>
<rental:Prices>
<rental:PricePerRentalTime>
<rental:Quantity> </rental:Quantity>
<rental:QuantityUoM> </rental:QuantityUoM>
<rental:MinimumOrderQuantity> </rental:MinimumOrderQuantity>
<rental:OrderMultiple> </rental:OrderMultiple>
<rental:Price> </rental:Price>
</rental:PricePerRentalTime>
</rental:Prices>
<rental:WeekendInvoicing> </rental:WeekendInvoicing>
<rental:RentalPeriod>
<rental:FixedStartDateTime> </rental:FixedStartDateTime>
<rental:FixedFinishDateTime> </rental:FixedFinishDateTime>
</rental:RentalPeriod>
<rental:StartRentalPeriod> </rental:StartRentalPeriod>
</rental:RentalUDE>
In RentalPeriod, the invoice will include the period for which it is invoiced, i.e. not the entire rental period (unless it is equal to the entire rental period).
The location of the extension within the invoice message is on the line, xpath is:
Invoice/InvoiceLine/UserDefinedExtension