UN layout formatting specification for UBL Order Change instances

$Date: 2004/09/05 15:15:15 $(UTC)


Table of Contents

1. Order change formatting specification
1.1. Status
1.2. Example rendering
1.3. Layout order and information
1.4. Namespaces
2. Miscellaneous information
2.1. Document header information
3. Main document and party information
3.1. Seller
3.2. Order change number
3.3. Order reference (Buyer's)
3.4. Date
3.5. Order issue date
3.6. Change sequence number
3.7. Order reference (Seller's)
3.8. Consignee
3.9. Buyer
4. Additional document and party information
4.1. Buyer bank
4.2. Country of origin
4.3. Country of destination
5. Delivery and transport
5.1. Mode of transport
5.2. Date of despatch
5.3. Means of transport
5.4. Place of despatch
5.5. Vessel/flight no.
5.6. Port of loading
5.7. Port of discharge
5.8. Place of delivery
5.9. Terms of delivery
5.10. Location
5.11. Special terms
5.12. Terms of payment
5.13. Currency of payment
6. Consignment information
6.1. Shipping marks; container number
6.2. No. and kind of packages; description of goods
6.3. Total gross weight (kg)
6.4. Total cube (m3)
6.5. Total net weight (kg)
7. Line item information
7.1. Item / References
7.2. Description
7.3. Country of origin
7.4. Commodity code
7.5. Quantity
7.6. Unit price
7.7. Amount
8. Summary information
8.1. Notes
8.2. Total amount
8.3. Name of signatory
8.4. Place and date of issue
8.5. Signature
9. Continuation page

1.  Order change formatting specification

This formatting specification describes a rendering of the UBL Order Change document model numbered according to the United Nations Layout Key for Trade Documents guidelines for application for the 230 Order Change form.

For a list of all formatting specifications and an overview of the documentation conventions, please visit the formatting specification home page.

1.1.  Status

This specification has no formal status at this time. It should not be considered a reference interpretation of UBL documents. Feedback is sought from users of stylesheets that implement this formatting specification regarding suggestions for change for consideration by the OASIS UBL committees for incorporation into these formatting specifications.

Presentational semantics may never be formalized or normative in the UBL project due to differing international requirements and conventions for the presentation of information found in business documents. This document contains only examples from a few of what will probably be many available UBL stylesheet libraries.

1.2.  Example rendering

The following is an example rendering that illustrates the position and decoration of the information items found in an instance of the document type:

1.3.  Layout order and information

Items in this formatting specification are ordered roughly from the laid out fields on the form in the order left-to-right, top to bottom.

Certain descriptions are verbatim quotes from the United Nations guidelines document.

Important: the rendering of a number of fields is very simplified, reflecting a Western European interpretation of a subset of fields (as in names and addresses). User requirements need to be better understood for the level of granularity in these formatting specifications.

1.4.  Namespaces

The following namespaces are mapped to the prefixes in the expressions below:

  • xmlns:co="urn:oasis:names:specification:ubl:schema:xsd:OrderChange-1.0"

  • xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0"

  • xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0"

2.  Miscellaneous information

The following information is unrelated to the visible fields of the form.

2.1.  Document header information

Table 1. XPath information

XPath addresses
/​co:OrderChange/​co:BuyersID
/​co:OrderChange/​cbc:IssueDate

This information shows up in the window-title bar of the HTML browser, and in the document title supported by some XSL-FO processors.

3. Main document and party information

Header information is associated with the form as a whole, not to the individual items of goods.

3.1. Seller

Table 2. XPath information

XPath addresses
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CityName
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

These fields are used to provide the name and address of the sender of the goods.

3.2. Order change number

Table 3. XPath information

XPath address
/​co:OrderChange/​co:BuyersID

This number is a unique number assigned to the order change by the buyer.

3.3. Order reference (Buyer's)

Table 4. XPath information

XPath address
/​co:OrderChange/​cac:OrderReference/​cac:BuyersID

This number is the reference number of the original order.

3.4. Date

Table 5. XPath information

XPath address
/​co:OrderChange/​cbc:IssueDate

This field states the date of the order change.

3.5. Order issue date

Table 6. XPath information

XPath address
/​co:OrderChange/​cac:OrderReference/​cbc:IssueDate

This fields provides the date of the original order.

3.6. Change sequence number

Table 7. XPath information

XPath address
/​co:OrderChange/​co:SequenceNumberID

The Order Change Sequence Number is a unique number assigned to ensure the proper sequencing of the change requests.

3.7. Order reference (Seller's)

Table 8. XPath information

XPath address
/​co:OrderChange/​cac:OrderReference/​cac:SellersID

This field provides a seller assigned reference to the original order.

3.8. Consignee

Table 9. XPath information

XPath addresses
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:BuildingNumber
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:StreetName
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:CityName
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:CountrySubentity
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:PostalZone
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cac:Country/​cbc:Name

These fields are used to provide the name and address of the receiver of the goods involved in the transaction.

3.9. Buyer

Table 10. XPath information

XPath addresses
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

These fields are used to provide the name and address of the buyer of the goods involved in the transaction.

4.  Additional document and party information

4.1. Buyer bank

At this time this field is not being used in the order change.

4.2. Country of origin

At this time this field is not being used in the order change.

4.3. Country of destination

At this time this field is not being used in the order change.

5. Delivery and transport

Transportation fields are header-like and applicable to the entire order change.

5.1. Mode of transport

At this time this field is not being used in the order change.

5.2. Date of despatch

At this time this field is not being used in the order change.

5.3. Means of transport

At this time this field is not being used in the order change.

5.4. Place of despatch

At this time this field is not being used in the order change.

5.5. Vessel/flight no.

At this time this field is not being used in the order change.

5.6. Port of loading

At this time this field is not being used in the order change.

5.7. Port of discharge

At this time this field is not being used in the order change.

5.8. Place of delivery

At this time this field is not being used in the order change.

5.9. Terms of delivery

At this time this field is not being used in the order change.

5.10. Location

At this time this field is not being used in the order change.

5.11. Special terms

At this time this field is not being used in the order change.

5.12. Terms of payment

At this time this field is not being used in the order change.

5.13. Currency of payment

At this time this field is not being used in the order change.

6. Consignment information

The consignment information holds generic details and totals relating to all the goods items in the order change.

6.1. Shipping marks; container number

At this time this field is not being used in the order change.

6.2. No. and kind of packages; description of goods

At this time this field is not being used in the order change.

6.3. Total gross weight (kg)

At this time this field is not being used in the order change.

6.4. Total cube (m3)

At this time this field is not being used in the order change.

6.5. Total net weight (kg)

At this time this field is not being used in the order change.

7. Line item information

Line item information is associated with the individual item of goods in the order change.

7.1. Item / References

Table 11. XPath information

XPath addresses
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:BuyersID
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:SellersID

The first reference is the buyer's assigned reference to the line item.

The second reference is the seller's assigned reference to the line item.

7.2. Description

Table 12. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:Item/​cbc:Description

This provides a free text description of the line item.

7.3. Country of origin

Table 13. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:OriginCountry/​cbc:Name

This field is used to provide to country of origin for the line item.

7.4. Commodity code

Table 14. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:CommodityClassification/​cac:CommodityCode

This field is used to provide the commodity code for the line item.

7.5. Quantity

Table 15. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cbc:Quantity

This field states the number of order change items ordered for the line item.

7.6. Unit price

Table 16. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount

This field is used to specify the unit price of the line item.

7.7. Amount

Table 17. XPath information

XPath address
/​co:OrderChange/​cac:OrderLine/​cac:LineItem/​cbc:LineExtensionAmount

This field states the actual line item amount which will be quantity multiplied by the unit price, the result is not calculated it will be transmitted.

8. Summary information

Summary information is associated to the entire order change and not to any individual line item.

8.1. Notes

Table 18. XPath information

XPath address
/​co:OrderChange/​cbc:Note

This notes field is used for any free text information that relates to the entire order change.

8.2. Total amount

Table 19. XPath information

XPath addresses
/​co:OrderChange/​co:TransactionCurrencyCode
/​co:OrderChange/​cbc:LineExtensionTotalAmount

Two data fields populate this one form field: the currency and the total amount.

The total amount is the total of all the individual line items and is not calculated it will be transmitted.

8.3. Name of signatory

Table 20. XPath information

XPath address
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Contact/​cbc:Name

This fields identified the name of the signatory.

8.4. Place and date of issue

Table 21. XPath information

XPath addresses
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​co:OrderChange/​cbc:IssueDate

The above fields provide information relating to the date and place of issue of the order change.

8.5. Signature

This field is not currently being filled automatically as it is a manual entry.

9.  Continuation page

The continuation page comprises only a copy of the document identification information described in Section 3, “Main document and party information” and room for additional line item entries described in Section 7, “Line item information”.