UN layout formatting specification for UBL Order instances

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


Contents

1. Purchase order 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. Purchase order number
3.3. Date
3.4. Seller’s reference (Quote no.)
3.5. Buyer’s reference
3.6. Other reference (Contract no.)
3.7. Consignee
3.8. 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.
8.4. Name of signatory
8.5. Place and date of issue
8.6. Signature
9. Continuation page
9.1. Item / References
9.2. Description
9.3. Country of origin
9.4. Commodity code
9.5. Quantity
9.6. Unit price
9.7. Amount

1.  Purchase order formatting specification

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

  • 220 Order: Document by means of which a buyer initiates a transaction with a seller involving the supply of goods as specified, according to conditions set out in an offer, or otherwise known to the buyer.

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:po="urn:oasis:names:specification:ubl:schema:xsd:Order-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

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

Box Label: "Seller"

Table 1. XPath information

XPath addresses
/​po:Order/​cac:SellerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CityName
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cac:CountrySubentityCode
/​po:Order/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​po:Order/​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

This field is intended to show the name and address of the sender of goods or the originator of the documents, as the case may be.

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

3.2. Purchase order number

Box Label: "Purchase order number"

Table 4. XPath information

XPath address
/​po:Order/​po:BuyersID

Table 5. Box Geometry

row1height2
column5width2

Table 6. Box Borders

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

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

3.3. Date

Box Label: "Date"

Table 7. XPath information

XPath address
/​po:Order/​cbc:IssueDate

Table 8. Box Geometry

row3height2
column5width2

Table 9. Box Borders

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

This field states the date of the order.

3.4. Seller’s reference (Quote no.)

Box Label: "Seller’s reference (Quote no.)"

Table 10. XPath information

XPath address
/​po:Order/​po:QuoteDocumentReference/​cac:ID

Table 11. Box Geometry

row3height2
column7width2

Table 12. Box Borders

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

This field provides a seller assigned reference to the order.

3.5. Buyer’s reference

Box Label: "Buyer’s reference"

Table 13. XPath information

XPath address
/​po:Order/​cac:BuyerParty/​cac:BuyerAssignedAccountID

Table 14. Box Geometry

row5height2
column5width2

Table 15. Box Borders

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

This field provides the buyer's reference to the order.

3.6. Other reference (Contract no.)

Box Label: "Other reference (Contract no.)"

Table 16. XPath information

XPath address
/​po:Order/​po:ContractDocumentReference/​cac:ID

Table 17. Box Geometry

row5height2
column7width2

Table 18. Box Borders

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

This field provides the contract reference if applicable.

3.7. Consignee

Box Label: "Consignee"

Table 19. XPath information

XPath addresses
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cbc:BuildingNumber
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cbc:StreetName
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cbc:CityName
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cbc:CountrySubentity
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cac:CountrySubentityCode
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cbc:PostalZone
/​po:Order/​cac:Delivery/​cac:DeliveryAddress/​cac:Country/​cbc:Name

Table 20. Box Geometry

row7height6
column1width4

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

3.8. Buyer

Box Label: "Buyer"

Table 22. XPath information

XPath addresses
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:BuildingNumber
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:CountrySubentityCode
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:Country/​cbc:Name

Table 23. Box Geometry

row7height6
column5width4

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

4.  Additional document and party information

4.1. Buyer bank

Box Label: "Buyer bank"

Table 25. Box Geometry

row13height2
column5width4

Table 26. Box Borders

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

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

4.2. Country of origin

Box Label: "Country of origin"

Table 27. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:OriginCountry/​cbc:Name

Table 28. Box Geometry

row15height2
column5width2

Table 29. Box Borders

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

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

4.3. Country of destination

Box Label: "Country of destination"

Table 30. XPath information

XPath address
/​po:Order/​po:DestinationCountry/​cbc:Name

Table 31. Box Geometry

row15height2
column7width2

Table 32. Box Borders

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

This fields provides the name of the destination country.

5. Delivery and transport

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

5.1. Mode of transport

Box Label: "Mode of transport"

Table 33. Box Geometry

row17height2
column1width2

Table 34. Box Borders

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

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

5.2. Date of despatch

Box Label: "Date of despatch"

Table 35. Box Geometry

row17height2
column3width2

Table 36. Box Borders

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

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

5.3. Means of transport

Box Label: "Means of transport"

Table 37. Box Geometry

row19height2
column1width2

Table 38. Box Borders

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

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

5.4. Place of despatch

Box Label: "Place of despatch"

Table 39. Box Geometry

row19height2
column3width2

Table 40. Box Borders

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

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

5.5. Vessel/flight No.

Box Label: "Vessel/flight No."

Table 41. Box Geometry

row21height2
column1width2

Table 42. Box Borders

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

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

5.6. Port of loading

Box Label: "Port of loading"

Table 43. Box Geometry

row21height2
column3width2

Table 44. Box Borders

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

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

5.7. Port of discharge

Box Label: "Port of discharge"

Table 45. Box Geometry

row23height2
column1width2

Table 46. Box Borders

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

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

5.8. Place of delivery

Box Label: "Place of delivery"

Table 47. Box Geometry

row23height2
column3width2

Table 48. Box Borders

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

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

5.9. Terms of delivery

Box Label: "Terms of delivery"

Table 49. XPath information

XPath address
/​po:Order/​cac:DeliveryTerms/​cac:ID

Table 50. Box Geometry

row17height2
column5width2

Table 51. Box Borders

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

This fields provides the INCOTERM code for the terms of delivery.

5.10. Location

Box Label: "Location"

Table 52. XPath information

XPath address
/​po:Order/​cac:DeliveryTerms/​cbc:RelevantLocation

Table 53. Box Geometry

row17height2
column7width2

Table 54. Box Borders

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

This field provides the location name (if relevant) associated to the delivery terms.

5.11. Special terms

Box Label: "Special terms"

Table 55. XPath information

XPath address
/​po:Order/​cac:DeliveryTerms/​cbc:SpecialTerms

Table 56. Box Geometry

row19height2
column5width4

Table 57. Box Borders

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

This field provides free text description of special conditions relating to the delivery terms.

5.12. Terms of payment

Box Label: "Terms of payment"

Table 58. Box Geometry

row21height2
column5width2

Table 59. Box Borders

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

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

5.13. Currency of payment

Box Label: "Currency of payment"

Table 60. XPath information

XPath address
/​po:Order/​po:TransactionCurrencyCode

Table 61. Box Geometry

row21height2
column7width2

Table 62. Box Borders

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

This specifies the payment currency for the entire order.

6. Consignment information

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

6.1. Shipping marks; container number

Box Label: "Shipping marks; container number"

Table 63. Box Geometry

row25height8
column1width2

Table 64. Box Borders

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

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

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

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

Table 65. Box Geometry

row25height8
column3width4

Table 66. Box Borders

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

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

6.3. Total gross weight (kg)

Box Label: "Total gross weight (kg)"

Table 67. XPath information

XPath address
/​po:Order/​cbc:GrossWeightMeasure

Table 68. Box Geometry

row25height4
column7width1

Table 69. Box Borders

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

This field provides the gross weight of the order (not the shipment as it is not known at the order stage).

6.4. Total cube(m3)

Box Label: "Total cube(m3)"

Table 70. Box Geometry

row25height4
column8width1

Table 71. Box Borders

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

This field provides the gross volume of the order (not the shipment as it is not known at the order stage).

6.5. Total net weight (kg)

Box Label: "Total net weight (kg)"

Table 72. XPath information

XPath address
/​po:Order/​cbc:NetWeightMeasure

Table 73. Box Geometry

row29height4
column7width1

Table 74. Box Borders

line-before
line-aftertrue
line-start
line-end

This field provides the net weight of the order (not the shipment as it is not known at the order stage).

7. Line item information

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

7.1. Item / References

Box Label: "Item / References"

Table 75. XPath information

XPath addresses
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:BuyersID
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:SellersID

Table 76. Box Geometry

row33height16
column1width1

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

7.2. Description

Box Label: "Description"

Table 78. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cbc:Description

Table 79. Box Geometry

row33height16
column2width2

Table 80. Box Borders

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

This provides a free text description of the line item.

7.3. Country of origin

Box Label: "Country of origin"

Table 81. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:OriginCountry/​cbc:Name

Table 82. Box Geometry

row15height2
column5width2

Table 83. Box Borders

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

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

7.4. Commodity code

Box Label: "Commodity code"

Table 84. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:CommodityClassification/​cac:CommodityCode

Table 85. Box Geometry

row33height16
column5width1

Table 86. Box Borders

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

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

7.5. Quantity

Box Label: "Quantity"

Table 87. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cbc:Quantity

Table 88. Box Geometry

row33height16
column6width1

Table 89. Box Borders

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

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

7.6. Unit price

Box Label: "Unit price"

Table 90. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount

Table 91. Box Geometry

row33height16
column7width1

Table 92. Box Borders

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

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

7.7. Amount

Box Label: "Amount"

Table 93. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cbc:LineExtensionAmount

Table 94. Box Geometry

row33height16
column8width1

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

8. Summary information

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

8.1. Notes

Box Label: "Notes"

Table 96. XPath information

XPath address
/​po:Order/​cbc:Note

Table 97. Box Geometry

row49height10
column1width5

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

8.2. Total amount

Box Label: "Total amount"

Table 99. XPath information

XPath addresses
/​po:Order/​po:TransactionCurrencyCode
/​po:Order/​cbc:LineExtensionTotalAmount

Table 100. Box Geometry

row49height2
column7width1

Table 101. Box Borders

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

Two data fields populate 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. 

Box Label: ""

Table 102. Box Geometry

row49height2
column8width1

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

8.4. Name of signatory

Box Label: "Name of signatory"

Table 104. XPath information

XPath address
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Contact/​cbc:Name

Table 105. Box Geometry

row59height2
column1width3

Table 106. Box Borders

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

This fields identified the name of the signatory.

8.5. Place and date of issue

Box Label: "Place and date of issue"

Table 107. XPath information

XPath addresses
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity
/​po:Order/​cac:BuyerParty/​cac:Party/​cac:Address/​cac:CountrySubentityCode
/​po:Order/​cbc:IssueDate

Table 108. Box Geometry

row61height2
column1width3

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

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

8.6. Signature

Box Label: "Signature"

Table 110. Box Geometry

row63height2
column1width3

Table 111. Box Borders

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

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.1, “Item / References”. Alternative box representations are described below:

9.1. Item / References

Box Label: "Item / References"

Table 112. XPath information

XPath addresses
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:BuyersID
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:SellersID

Table 113. Box Geometry

row13height52
column1width1

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

9.2. Description

Box Label: "Description"

Table 115. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cbc:Description

Table 116. Box Geometry

row13height52
column2width2

Table 117. Box Borders

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

This provides a free text description of the line item.

9.3. Country of origin

Box Label: "Country of origin"

Table 118. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:OriginCountry/​cbc:Name

Table 119. Box Geometry

row13height52
column4width1

Table 120. Box Borders

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

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

9.4. Commodity code

Box Label: "Commodity code"

Table 121. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:CommodityClassification/​cac:CommodityCode

Table 122. Box Geometry

row13height52
column5width1

Table 123. Box Borders

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

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

9.5. Quantity

Box Label: "Quantity"

Table 124. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cbc:Quantity

Table 125. Box Geometry

row13height52
column6width1

Table 126. Box Borders

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

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

9.6. Unit price

Box Label: "Unit price"

Table 127. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount

Table 128. Box Geometry

row13height52
column7width1

Table 129. Box Borders

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

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

9.7. Amount

Box Label: "Amount"

Table 130. XPath information

XPath address
/​po:Order/​cac:OrderLine/​cac:LineItem/​cbc:LineExtensionAmount

Table 131. Box Geometry

row13height52
column8width1

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