UN layout formatting specification for UBL Order Change instances

$Date: 2004/09/09 01:30:40 $(UTC)


Contents

1. Order change formatting specification
1.1. Status
1.2. Example rendering
1.3. Layout order and information
1.4. Namespaces
2. Main document and party information
2.1. Seller
2.2. Order Change number
2.3. Order reference (Buyer’s)
2.4. Date
2.5. Order issue date
2.6. Change sequence number
2.7. Order reference (Seller’s)
2.8. Consignee
2.9. Buyer
3. Additional document and party information
3.1. Buyer bank
3.2. Country of origin
3.3. Country of destination
4. Delivery and transport
4.1. Mode of transport
4.2. Date of despatch
4.3. Means of transport
4.4. Place of despatch
4.5. Vessel/flight No.
4.6. Port of loading
4.7. Port of discharge
4.8. Place of delivery
4.9. Terms of delivery
4.10. Location
4.11. Special terms
4.12. Terms of payment
4.13. Currency of payment
5. Consignment information
5.1. Shipping marks; container number
5.2. No. and kind of packages; description of goods
5.3. Total gross weight (kg)
5.4. Total cube (m3)
5.5. Total net weight (kg)
6. Line item information
6.1. Item / References
6.2. Description
6.3. Country of origin
6.4. Commodity code
6.5. Quantity
6.6. Unit price
6.7. Amount
7. Summary information
7.1. Notes
7.2. Total amount
7.3.
7.4. Name of signatory
7.5. Place and date of issue
7.6. Signature
8. Continuation page
8.1. Item / References
8.2. Description
8.3. Country of origin
8.4. Commodity code
8.5. Quantity
8.6. Unit price
8.7. Amount

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. Main document and party information

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

2.1. Seller

Box Label: "Seller"

Table 1. 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/​cac:CountrySubentityCode
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​co:OrderChange/​cac:SellerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

Table 2. Box Geometry

row1height6
column1width4

Table 3. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

2.2. Order Change number

Box Label: "Order Change number"

Table 4. Box Geometry

row1height2
column5width2

Table 5. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

2.3. Order reference (Buyer’s)

Box Label: "Order reference (Buyer’s)"

Table 6. XPath information

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

Table 7. Box Geometry

row1height2
column7width2

Table 8. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This number is the reference number of the original order.

2.4. Date

Box Label: "Date"

Table 9. XPath information

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

Table 10. Box Geometry

row3height2
column5width2

Table 11. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This field states the date of the order change.

2.5. Order issue date

Box Label: "Order issue date"

Table 12. XPath information

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

Table 13. Box Geometry

row3height2
column7width2

Table 14. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This fields provides the date of the original order.

2.6. Change sequence number

Box Label: "Change sequence number"

Table 15. XPath information

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

Table 16. Box Geometry

row5height2
column5width2

Table 17. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

2.7. Order reference (Seller’s)

Box Label: "Order reference (Seller’s)"

Table 18. XPath information

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

Table 19. Box Geometry

row5height2
column7width2

Table 20. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

2.8. Consignee

Box Label: "Consignee"

Table 21. 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/​cac:CountrySubentityCode
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cbc:PostalZone
/​co:OrderChange/​cac:Delivery/​cac:DeliveryAddress/​cac:Country/​cbc:Name

Table 22. Box Geometry

row7height6
column1width4

Table 23. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

2.9. Buyer

Box Label: "Buyer"

Table 24. 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/​cac:CountrySubentityCode
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​co:OrderChange/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

Table 25. Box Geometry

row7height6
column5width4

Table 26. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

3.  Additional document and party information

3.1. Buyer bank

Box Label: "Buyer bank"

Table 27. Box Geometry

row13height2
column5width4

Table 28. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

3.2. Country of origin

Box Label: "Country of origin"

Table 29. XPath information

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

Table 30. Box Geometry

row15height2
column5width2

Table 31. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

3.3. Country of destination

Box Label: "Country of destination"

Table 32. Box Geometry

row15height2
column7width2

Table 33. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4. Delivery and transport

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

4.1. Mode of transport

Box Label: "Mode of transport"

Table 34. Box Geometry

row17height2
column1width2

Table 35. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.2. Date of despatch

Box Label: "Date of despatch"

Table 36. Box Geometry

row17height2
column3width2

Table 37. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.3. Means of transport

Box Label: "Means of transport"

Table 38. Box Geometry

row19height2
column1width2

Table 39. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.4. Place of despatch

Box Label: "Place of despatch"

Table 40. Box Geometry

row19height2
column3width2

Table 41. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.5. Vessel/flight No.

Box Label: "Vessel/flight No."

Table 42. Box Geometry

row21height2
column1width2

Table 43. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.6. Port of loading

Box Label: "Port of loading"

Table 44. Box Geometry

row21height2
column3width2

Table 45. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.7. Port of discharge

Box Label: "Port of discharge"

Table 46. Box Geometry

row23height2
column1width2

Table 47. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.8. Place of delivery

Box Label: "Place of delivery"

Table 48. Box Geometry

row23height2
column3width2

Table 49. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

4.9. Terms of delivery

Box Label: "Terms of delivery"

Table 50. Box Geometry

row17height2
column5width2

Table 51. Box Borders

line-beforetrue
line-after
line-starttrue
line-end

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

4.10. Location

Box Label: "Location"

Table 52. Box Geometry

row17height2
column7width2

Table 53. Box Borders

line-beforetrue
line-after
line-start
line-endtrue

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

4.11. Special terms

Box Label: "Special terms"

Table 54. Box Geometry

row19height2
column5width4

Table 55. Box Borders

line-before
line-after
line-starttrue
line-endtrue

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

4.12. Terms of payment

Box Label: "Terms of payment"

Table 56. Box Geometry

row21height2
column5width2

Table 57. Box Borders

line-before
line-after
line-starttrue
line-end

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

4.13. Currency of payment

Box Label: "Currency of payment"

Table 58. Box Geometry

row21height2
column7width2

Table 59. Box Borders

line-before
line-after
line-start
line-endtrue

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

5. Consignment information

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

5.1. Shipping marks; container number

Box Label: "Shipping marks; container number"

Table 60. Box Geometry

row25height8
column1width2

Table 61. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

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

Box Label: "No. and kind of packages; description of goods"

Table 62. Box Geometry

row25height8
column3width4

Table 63. Box Borders

line-beforetrue
line-aftertrue
line-start
line-end

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

5.3. Total gross weight (kg)

Box Label: "Total gross weight (kg)"

Table 64. Box Geometry

row25height4
column7width1

Table 65. Box Borders

line-beforetrue
line-aftertrue
line-start
line-end

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

5.4. Total cube (m3)

Box Label: "Total cube (m3)"

Table 66. Box Geometry

row25height4
column8width1

Table 67. Box Borders

line-beforetrue
line-after
line-start
line-endtrue

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

5.5. Total net weight (kg)

Box Label: "Total net weight (kg)"

Table 68. Box Geometry

row29height4
column7width1

Table 69. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

6. Line item information

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

6.1. Item / References

Box Label: "Item / References"

Table 70. XPath information

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

Table 71. Box Geometry

row33height16
column1width1

Table 72. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

6.2. Description

Box Label: "Description"

Table 73. XPath information

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

Table 74. Box Geometry

row33height16
column2width2

Table 75. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This provides a free text description of the line item.

6.3. Country of origin

Box Label: "Country of origin"

Table 76. XPath information

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

Table 77. Box Geometry

row15height2
column5width2

Table 78. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

6.4. Commodity code

Box Label: "Commodity code"

Table 79. XPath information

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

Table 80. Box Geometry

row33height16
column5width1

Table 81. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

6.5. Quantity

Box Label: "Quantity"

Table 82. XPath information

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

Table 83. Box Geometry

row33height16
column6width1

Table 84. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

6.6. Unit price

Box Label: "Unit price"

Table 85. XPath information

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

Table 86. Box Geometry

row33height16
column7width1

Table 87. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

6.7. Amount

Box Label: "Amount"

Table 88. XPath information

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

Table 89. Box Geometry

row33height16
column8width1

Table 90. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

7. Summary information

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

7.1. Notes

Box Label: "Notes"

Table 91. XPath information

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

Table 92. Box Geometry

row49height10
column1width5

Table 93. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

7.2. Total amount

Box Label: "Total amount"

Table 94. XPath information

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

Table 95. Box Geometry

row49height2
column7width1

Table 96. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-end

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

7.3. 

Box Label: ""

Table 97. Box Geometry

row49height2
column8width1

Table 98. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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.

7.4. Name of signatory

Box Label: "Name of signatory"

Table 99. XPath information

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

Table 100. Box Geometry

row59height2
column1width3

Table 101. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This fields identified the name of the signatory.

7.5. Place and date of issue

Box Label: "Place and date of issue"

Table 102. 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/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:CountrySubentityCode
/​co:OrderChange/​cbc:IssueDate

Table 103. Box Geometry

row61height2
column1width3

Table 104. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

Note that only one of cbc:CountrySubentity and cac:CountrySubentityCode need be used, with preference to cbc:CountrySubentity if it exists.

7.6. Signature

Box Label: "Signature"

Table 105. Box Geometry

row63height2
column1width3

Table 106. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.  Continuation page

The continuation page comprises only a copy of the document identification information described in Section 2, “Main document and party information” and room for additional line item entries described in Section 6, “Line item information”. Alternative box representations are described below:

8.1. Item / References

Box Label: "Item / References"

Table 107. XPath information

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

Table 108. Box Geometry

row13height52
column1width1

Table 109. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.

8.2. Description

Box Label: "Description"

Table 110. XPath information

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

Table 111. Box Geometry

row13height52
column2width2

Table 112. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

This provides a free text description of the line item.

8.3. Country of origin

Box Label: "Country of origin"

Table 113. XPath information

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

Table 114. Box Geometry

row13height52
column4width1

Table 115. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

8.4. Commodity code

Box Label: "Commodity code"

Table 116. XPath information

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

Table 117. Box Geometry

row13height52
column5width1

Table 118. Box Borders

line-beforetrue
line-aftertrue
line-start
line-endtrue

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

8.5. Quantity

Box Label: "Quantity"

Table 119. XPath information

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

Table 120. Box Geometry

row13height52
column6width1

Table 121. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.6. Unit price

Box Label: "Unit price"

Table 122. XPath information

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

Table 123. Box Geometry

row13height52
column7width1

Table 124. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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

8.7. Amount

Box Label: "Amount"

Table 125. XPath information

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

Table 126. Box Geometry

row13height52
column8width1

Table 127. Box Borders

line-beforetrue
line-aftertrue
line-starttrue
line-endtrue

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.