Office-oriented formatting specification for UBL Order instances

$Date: 2003/11/18 15:40:30 $(UTC)


Table of Contents

1. Purchase order formatting specification
1.1. Status
1.2. Example renderings and implementations
1.3. Layout order and information
1.4. Namespaces
2. Miscellaneous information
2.1. Document header information
3. Header information
3.1. Order No.
3.2. Issue Date
3.3. Seller
3.4. Buyer
3.5. Contact
3.6. Order Contact
3.7. Delivery address
3.8. Requested Delivery Date
3.9. Delivery Terms
4. Line item information
4.1. Line no.
4.2. Part number
4.3. Description
4.4. Quantity U/M
4.5. Unit price
4.6. Extended Amount
5. Summary information
5.1. Total amount

1.  Purchase order formatting specification

This formatting specification describes a rendering of an instance of the UBL Order document model according to a conceptual office-oriented layout.

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 renderings and implementations

Example renderings:

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.

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:

  • cat = "urn:oasis:names:tc:ubl:CommonAggregateTypes:1:0-beta"

    po = "urn:oasis:names:tc:ubl:Order:1:0-beta"

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
/​po:Order/​cat:BuyersID
/​po:Order/​cat: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. Header information

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

3.1. Order No.

Table 2. XPath information

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

The reference number is a number or designation preferably common throughout each set of documents.

3.2. Issue Date

Table 3. XPath information

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

If not otherwise specified, "date" means the date of issue of the document in which it appears.

3.3. Seller

Table 4. XPath information

XPath addresses
/​po:Order/​cat:SellerParty/​cat:Party/​cat:PartyName/​cat:Name
/​po:Order/​cat:SellerParty/​cat:Party/​cat:Address/​cat:StreetName
/​po:Order/​cat:SellerParty/​cat:Party/​cat:Address/​cat:CityName
/​po:Order/​cat:SellerParty/​cat:Party/​cat:Address/​cat:PostalZone
/​po:Order/​cat:SellerParty/​cat:Party/​cat:Address/​cat:CountrySubentityCode

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.

3.4. Buyer

Table 5. XPath information

XPath addresses
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:PartyName/​cat:Name
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:StreetName
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CityName
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:PostalZone
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CountrySubentityCode

The field for the name and address to which documents are sent (buyer).

3.5. Contact

Table 6. XPath information

XPath address
/​po:Order/​cat:BuyerParty/​cat:Party/​cat:Contact/​cat:Name

The buyer's contact for the order

3.6. Order Contact

This field is not filled in at this time

3.7.  Delivery address

Table 7. XPath information

XPath addresses
/​po:Order/​cat:Delivery/​cat:DeliverToAddress/​cat:StreetName
/​po:Order/​cat:Delivery/​cat:DeliverToAddress/​cat:CityName
/​po:Order/​cat:Delivery/​cat:DeliverToAddress/​cat:PostalZone
/​po:Order/​cat:Delivery/​cat:DeliverToAddress/​cat:CountrySubentityCode

The address where the order is being delivered.

3.8.  Requested Delivery Date

Table 8. XPath information

XPath address
/​po:Order/​cat:Delivery/​cat:RequestedDeliveryDateTime

3.9.  Delivery Terms

Table 9. XPath information

XPath address
/​po:Order/​cat:DeliveryTerms/​cat:SpecialTerms

4. Line item information

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

4.1. Line no.

Table 10. XPath information

XPath address
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:BuyersID

This is the reference to the Order line.

4.2.  Part number

Table 11. XPath information

XPath address
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Item/​cat:SellersItemIdentification/​cat:ID

4.3. Description

Table 12. XPath information

XPath address
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Item/​cat:Description

One of these exists for each Line item.

4.4. Quantity U/M

Table 13. XPath information

XPath addresses
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Quantity
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Quantity/​@unitCode

One of these exists for each line item.

4.5. Unit price

Table 14. XPath information

XPath addresses
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Item/​cat:BasePrice/​cat:PriceAmount/​@currencyID
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:Item/​cat:BasePrice/​cat:PriceAmount

One of these exists for each line item.

4.6. Extended Amount

Table 15. XPath information

XPath addresses
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:LineExtensionAmount/​@currencyID
/​po:Order/​cat:OrderLine/​cat:LineItem/​cat:LineExtensionAmount

This is not calculated - it is transmitted

5. Summary information

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

5.1. Total amount

Table 16. XPath information

XPath addresses
/​po:Order/​cat:LineExtensionTotalAmount/​@currencyID
/​po:Order/​cat:LineExtensionTotalAmount

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