0% found this document useful (0 votes)
38 views91 pages

OIOUBL GUIDE KATALOG-en

This document provides guidelines for using an invoice in OIOUBL. It describes the structure of the document and how to fill out invoice instances. Key sections include an overview of the document structure, descriptions of invoice classes and their elements/sub-classes with definitions and business rules. The goal is to provide a normative description of an invoice and describe any deviations from the standard element definitions.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
38 views91 pages

OIOUBL GUIDE KATALOG-en

This document provides guidelines for using an invoice in OIOUBL. It describes the structure of the document and how to fill out invoice instances. Key sections include an overview of the document structure, descriptions of invoice classes and their elements/sub-classes with definitions and business rules. The goal is to provide a normative description of an invoice and describe any deviations from the standard element definitions.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 91

OIOUBL Guideline

OIOUBL Catalogue
UBL 2.0 Catalogue
G03

Version 1.1

This release is protected by Creative Commons License, Naming 2.5


Colophon

Contact:

National IT and Telecom Agency


E-mail: [email protected]

April 2007
Ministry of Science, Technology and Innovation
National IT and Telecom Agency

Data Standardization Office


Holsteinsgade 63
DK-2100 Copenhagen Ø
Phone +45 3545 0000
Fax +45 3545 0010
http://www.itst.dk
[email protected]

Copyrights for this release in accordance with Creative Common, Naming 2.5:

Permission is granted to:


• produce processed works based on this document
• reproduce and make the document available to the public
• use the document for commercial purposes
provided that the Danish National IT & Telecom Agency be clearly referenced as the source of this
release.

Further information about these rights is available at http://creativecommons.org/licenses/by/2.5/deed.da .


Contents

1. How to read this document............................................................................................................................................ 4


1.1 Structure of this document......................................................................................................................................... 4
1.2 Figure definitions ...................................................................................................................................................... 4
1.3 Term definitions ........................................................................................................................................................5
1.4 References..................................................................................................................................................................6
2. How to fill in OIOUBL document instances................................................................................................................ 7
2.1 Namespace................................................................................................................................................................. 7
2.2 Comments.................................................................................................................................................................. 7
2.3 Process instructions....................................................................................................................................................8
2.4 Relations to instances of other customizations.......................................................................................................... 8
2.5 Code example............................................................................................................................................................ 8
3. Catalogue......................................................................................................................................................................... 9
3.1. Catalogue................................................................................................................................................................ 10
3.2. Catalogue.ValidityPeriod........................................................................................................................................17
3.3. Catalogue.ReferencedContract............................................................................................................................... 19
3.3.1. Catalogue.ReferencedContract.ContractDocumentReference.............................................................................21
3.3.1.1. Catalogue.ReferencedContract.ContractDocumentReference.Attachment...................................................... 23
3.4. Catalogue.ProviderParty......................................................................................................................................... 25
3.5. Catalogue.ReceiverParty.........................................................................................................................................29
3.6. Catalogue.CatalogueLine........................................................................................................................................33
3.6.1. Catalogue.CatalogueLine.ItemComparison.........................................................................................................40
3.6.2. Catalogue.CatalogueLine.ComponentRelatedItem............................................................................................. 41
3.6.3. Catalogue.CatalogueLine.AccessoryRelatedItem............................................................................................... 43
3.6.4. Catalogue.CatalogueLine.RequiredRelatedItem................................................................................................. 45
3.6.5. Catalogue.CatalogueLine.ReplacementRelatedItem........................................................................................... 47
3.6.6. Catalogue.CatalogueLine.ComplementaryRelatedItem...................................................................................... 49
3.6.7. Catalogue.CatalogueLine.RequiredItemLocationQuantity................................................................................. 51
3.6.7.1. Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price..................................................................... 54
3.6.8. Catalogue.CatalogueLine.Item............................................................................................................................ 57
3.6.8.1. Catalogue.CatalogueLine.Item.BuyersItemIdentification................................................................................ 63
3.6.8.2. Catalogue.CatalogueLine.Item.SellersItemIdentification.................................................................................65
3.6.8.2.1. Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute.................................................67
3.6.8.2.2. Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension..................................... 69
3.6.8.3. Catalogue.CatalogueLine.Item.ManufacturersItemIdentification.................................................................... 71
3.6.8.4. Catalogue.CatalogueLine.Item.StandardItemIdentification............................................................................. 73
3.6.8.5. Catalogue.CatalogueLine.Item.CatalogueItemIdentification........................................................................... 75
3.6.8.6. Catalogue.CatalogueLine.Item.AdditionalItemIdentification.......................................................................... 77
3.6.8.7. Catalogue.CatalogueLine.Item.CatalogueDocumentReference....................................................................... 79
3.6.8.7.1. Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment.................................................81
3.6.8.8. Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference........................................................... 83
3.6.8.9. Catalogue.CatalogueLine.Item.CommodityClassification............................................................................... 86
3.6.8.10. Catalogue.CatalogueLine.Item.AdditionalItemProperty................................................................................ 88
3.6.8.10.1. Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup.............................................90
1. How to read this document

.1. How to read this document

This guideline covers the use of an invoice in OIOUBL. The guideline must be read in correlation with the
remaining documents included in the OIOUBL package.

1.1 Structure of this document


This document should be seen as the normative description of an invoice. In case of any conflict, the most
specific description will always apply. For example, the description on the lines of a specific element takes
precedence of the description at document level. Hence, the descriptions at document level are default values
for the lines. The examples in this document and related common guidelines should be seen as descriptive.
The guideline text takes precedence of the figures.
The document includes a reading instruction, a description of how to fill in document instances, as well as
the actual class specification. The actual specification is composed of:

● A figure showing the class elements that are included in OIOUBL.


● A text specification of the class.
● A list of the UBL elements that from a business perspective make no sense in the specific context.
● A list of the fields that are included in the class.
● A list of the sub-classes that are included in the class.
● A table of key data such as definitions, names, references, and business rules for each of the class
fields.
● A table of key data such as definitions, names, references, and business rules for the sub-classes of
the class.
● For each of the sub-classes that is used differently that described in the class library,
OIOUBL_GUIDE_LIBRARY (ref 30), a subsection contains a corresponding specification. Hence,
the sub-classes that have been included in the specification are not selected based on relevance, but
solely based on whether they deviate from the general definition of the library.

1.2 Figure definitions


In the class specifications, the class is shown as schema documentation.

OIOUBL Catalogue - UBL 2.0 Catalogue Side 4


1.2 Figure definitions

1.3 Term definitions


In this specification, the following terms will be used in the tables:
Term Explanation
UBL name The name that is found in the UBL 2.0 schemas
DK-name The name in Danish
Use Describes the cardinality, i.e. the rule describing how
may instances of the business information entity are
allowed:
[1] specifies that one and only one instance is
allowed.
[0..1] means that the business information entity is
optional.
[0..n] means that null to infinity instances may occur.
[1..n] means that no less than one instance to an
infinite number of instances may occur.
Alternative term Specifies a term which is also used to describe the
business information entity.
Used Determines whether the receiver should be expected
to be able to decode the described business
information, if it is attached. Information that is not
used may still, however, be used upon bilateral
agreement.
Business rule Describes the rules that are attached to the business
information entity. Business rules are normative, and
will be part of the validation of the document in
question.
Recommended Specifies that common practice requires the described
business information entity to be attached. This is a

OIOUBL Catalogue - UBL 2.0 Catalogue Side 5


1.3 Term definitions
non-normative guide to the use of the business
information entity.

Allowed values: Describes the value set that the business information
entity should conform with.
Codelist Refers to the codelist that the value set should be
found in.
Class A structure of coherent business information.

1.4 References
In this docuement reference is made to other documents within the OIOUBL package.

Filnavn Titel Ref


OIOUBL_GUIDE_INTRO Introduktion til OIOUBL Guidelines G01

Documentguidelines
OIOUBL_GUIDE_APPRESPONSE UBL 2.0 ApplicationResponse G02
OIOUBL_GUIDE_CATALOGUE UBL 2.0 Catalogue G03
OIOUBL_GUIDE_CATALOGUEREQUREST UBL 2.0 CatalogueRequest G04
OIOUBL_GUIDE_CATALOGUEDELETION UBL 2.0 CatalogueDeletion G05
OIOUBL_GUIDE_CATALOGUEITEMSPECIFI
UBL 2.0 CatalogueItemSpecificationUpdate G06
CATIONUPDATE
OIOUBL_GUIDE_CATALOGUEPRICINGUPDA
UBL 2.0 CataloguePricingUpdate G07
TE
OIOUBL_GUIDE_ORDER UBL 2.0 Order G08
OIOUBL_GUIDE_ORDERRESPONSE UBL 2.0 OrderResponse G09
OIOUBL_GUIDE_ORDRERESPONSESIMPLE UBL 2.0 OrdreResponseSimple G10
OIOUBL_GUIDE_ORDERCHANGE UBL 2.0 OrderChange G11
OIOUBL_GUIDE_ORDERCANCELLATION UBL 2.0 Ordercancellation G12
OIOUBL_GUIDE_CREDITNOTE UBL 2.0 CreditNote G13
OIOUBL_GUIDE_REMINDER UBL 2.0 Reminder G14
OIOUBL_GUIDE_STATEMENT UBL 2.0 Statement G15
OIOUBL_GUIDE_INVOICE UBL 2.0 Invoice G16

Common guidelines
OIOUBL_GUIDE_ALLOWANCECHARGE UBL 2.0 AllowanceCharge G17
OIOUBL_GUIDE_CURRENCYEXCHANGERA
UBL 2.0 CurrencyExchangeRates G18
TES
OIOUBL_GUIDE_DELIVERY UBL 2.0 Delivery and Delivery Party G19
OIOUBL_GUIDE_DELIVERYTERMS OIOUBL Leveringsbetingelser - UBL 2.0 Delivery Terms G20
OIOUBL_GUIDE_DOCUMENTREF OIOUBL Dokumentreference - UBL 2.0 Document Reference G21
OIOUBL_GUIDE_ENDPOINTS OIOUBL EndepunktID - UBL 2.0 Endpoints G22
OIOUBL_GUIDE_PARTY OIOUBL Part - UBL 2.0 Party G23
OIOUBL Betalingsmåder og betingelser - UBL 2.0 Payment means og
OIOUBL_GUIDE_BETALING G24
payment terms
OIOUBL_GUIDE_PRISER OIOUBL Priser - UBL 2.0 Prices G25
OIOUBL_GUIDE_PROFILER OIOUBL Profiler - UBL 2.0 Profiles G26
OIOUBL_GUIDE_SKAT OIOUBL Skat - UBL 2.0 Tax G27
OIOUBL_GUIDE_TOTALER OIOUBL Totaler - UBL 2.0 Totals G28
OIOUBL_GUIDE_DATATYPER OIOUBL Datatyper - UBL 2.0 Datatypes G29
OIOUBL_GUIDE_BIBLIOTEK OIOUBL Fælles klassebibliotek - UBL 2.0 CommonLibrary G30
OIOUBL_GUIDE_SIGNATUR OIOUBL Signatur - UBL 2.0 Signature G31
OIOUBL_GUIDE_UUID OIOUBL UUID - UBL 2.0 UUID G32
OIOUBL_GUIDE_UDVIDELSER OIOUBL Udvidelse - UBL 2.0 Extension G33

OIOUBL Catalogue - UBL 2.0 Catalogue Side 6


1.4 References
OIOUBL_GUIDE_KONTAKT OIOUBL Kontakt - UBL 2.0 Contact G34
OIOUBL_GUIDE_RESPONS OIOUBL Bekræftelse - UBL 2.0 Respons G35
OIOUBL_GUIDE_ADRESSER OIOUBL Adresser - UBL 2.0 Adress G36

Katalogspecifikke tværgående guidelines


OIOUBL_GUIDE_KATALOG_ID OIOUBL Identifikation, versionering og gyldighedsperioder i kataloger G37
OIOUBL_GUIDE_KATALOG_VAREBESKRIV OIOUBL Varebeskrivelser og kategorisering i kataloger G38
OIOUBL_GUIDE_KATALOG_PARTER OIOUBL Parter i kataloger G39
OIOUBL_GUIDE_KATALOG_PRISER OIOUBL Pris og mængde i kataloger G40

Scenarie pakker
OIOUBL_SCENARIE_INTRO Introduction to OIOUBL Procurement Scenarios S01
OIOUBL_SCENARIE_ADVORD OIOUBL ADVORD - Advanced Ordering Proucrement Cycle S02
OIOUBL_SCENARIE_BASPRO OIOUBL BASPRO - Basic procurement Cycle S03
OIOUBL_SCENARIE_CATEXE OIOUBL CATEXE - Catalogue Exchange S04
OIOUBL_SCENARIE_COMDEL OIOUBL COMDEL - Complex Delivery Procurement Cycle S05
OIOUBL_SCENARIE_COMORG OIOUBL COMORG - Complex Organisations Procurement Cycle S06
OIOUBL_SCENARIE_COMPAY OIOUBL COMPAY - Comlex Payment Cycle S07

.2. How to fill in OIOUBL document instances

An Invoice must follow the related UBL schema, and conform to the rules of this guideline. The instances
follow the W3C XML specifications, which means that, unless otherwise stated, the normal XML rules rules
apply. It is therefore recommended that an xml encoder is used for reading the documents.
2.1 Namespace
A Namespace is a semantic space in which names are unique and attached to a specific interpretation.
Namespaces often occur as libraries, and may be referenced via an alias-variable. The expression:
<… xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" …>
means that elements with the prefix “cac” (alias variable) belongs to the ”…
CommomAggregateComponents-2” namespace. The namespace that is referenced by the actual document is
indicated by ”xmlns =...”, i.e. without an alias variable. It is recommended to use the alias variables
that are specified in UBL, but this is not a requirement. For an OIOUBL document instance to be
validated the following namespaces must be specified:

Alias variable Namespace


urn:oasis:names:specification:ubl:schema:xsd:Invoice-2

cac urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2
ccts urn:oasis:names:specification:ubl:schema:xsd:CoreComponentParameters-2
cbc urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2
sdt urn:oasis:names:specification:ubl:schema:xsd:SpecializedDatatypes-2
udt urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2
ext urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2
xsi http://www.w3.org/2001/XMLSchema-instance

2.2 Comments
Comments may be used in document instances to facilitate any manual processing of the document. This is
particularly relevant during the introduction phase of new systems that use OIOUBL. For those who wish to
formalize these comments, we recommend the Dublin-Core metadata definitions, see ”

OIOUBL Catalogue - UBL 2.0 Catalogue Side 7


2.2 Comments
http://dublincore.org/documents/dcmi-terms/ ”. The following terms are used in the examples of the
scenario descriptions [S01-S07] :

DC-Term Description Example


Title Describes the title of the document instance BASPRO_01_01_00_Invoice_v2p0.xml
Replaces Reference to the preceding instance BASPRO_01_01_00_Invoice_v0p1.xml
Publisher Describes who is responsible for the document "IT og Telestyrelsen"
instance.
Creator Describes the person or the system that created the "OIOERP v 1.0.2 release 34"
instance.
Created Date (and possibly time) of the creation of the 2006-09-08
document.
Modified Date (and possibly time) when the document was last 2006-09-08
modified.
Issued Date (and possibly time) when it was issued. 2006-09-08
ConformsTo Description of the context that it belongs to. OIOUBL_ScenarioPackage_BASPRO
Description General description "This document is produced as part of the OIOUBL Basic
procurement scenario package"
Rights Any copyrights that apply to the instance. "It can be used following the Common Creative License"

Only use meta data that you consider applicable, and only enter valid data. From the above list we
particularly recommend using the "Creator" term, as this may ease the troubleshooting at the receiver's
system. Comments should be specified within the root element of the document.

2.3 Process instructions


Process instructions are instructions that are not covered by the OIOUBL standard, but which may be used
for controlling other logics. For example, when specifying that an instance is used for test purposes. A
process instruction is specified by ”<?navn ... ?>” and may contain attributes as shown
in the example below. Process instructions should be specified within the root element of the document.

<?TestInstance
ResponseTo="smtp:[email protected]"
description= "apply your comment here"
?>

2.4 Relations to instances of other customizations


An instance is specified as being OIOUBL by entering ”CustomizationID” as ”OIOUBL-2.0”. OIOUBL
instances are built upon UBL 2.0, and may therefore be interpreted directly by UBL 2.0 readers. Instances
from other UBL 2.0-customizations can be read directly by OIOUBL readers by changing the
"CustomizationID", provided the instance conforms to the requirements of this guideline.

2.5 Code example


Code examples are available in the scenario descriptions [S01-S07]

OIOUBL Catalogue - UBL 2.0 Catalogue Side 8


3. Catalogue

.3. Catalogue

OIOUBL Catalogue - UBL 2.0 Catalogue Side 9


3.1. Catalogue

3.1. Catalogue

OIOUBL Catalogue - UBL 2.0 Catalogue Side 10


3.1. Catalogue

Catalogue specification
Name Catalogue Alternative term
Definition OIOUBL-2.0 Catalogue is a document for the creation and maintenance of electronic catalogues. The
document is used for the creation of new catalogues as well as for additions, updates or deletions of
items in existing catalogues.

Five documents are used to implement and maintain catalogues. Catalogue can be used to create a
new catalogue or update entire lines. A catalogue can be exchanged between a supplier and a
customer, between a supplier and a third party, for example a purchase portal, between a third party
and a customer or between two third parties. As a result it is possible to specify the identity of the
customer and the supplier in both document and line level.

The Catalogue Request document is used to specify which types of catalogues the supplier requests,
for example a new catalogue or an update, and also which products are requested. As described, the
Catalogue document can be used for creating and adding, updating or deleting items in existing
catalogues. the Catalogue Item Specification Update document can be used when only the item
specification needs to be updated in an existing catalogue. The Catalogue Deletion document deletes
an entire catalogue. Catalogue documents differs from other document types in that sender and
receiver can be third parties. For example, the receiver can be an electronic marketplace in stead of
the customer himself.

But the catalogue documents must also be viewed in relation to the entire purchasing process running
from sourcing, ordering and invoicing to payment and the other OIOUBL 2.0 documents used for these
purposes. Implementation of a catalogue can be the first step in the purchasing process followed by an
order and an invoice.

The apparent advantages of the OIOUBL 2.0 documents is the standardization of business documents
for different purposes. The UBL 2.0 standard is a flexible standard that supports most of the business
needs. Because it also is an international standard the document can be used across national
boundaries. The Danish version is named OIOUBL 2.0 and is designed to meet Danish needs and
demands.

The advantage of OIOUBL-2.0 is the possibility of designing fully automated purchasing flows in which
the electronic documents can be validated and matched automatically, thereby saving resources
compared to manual processing.

Example
<Catalogue>
<cbc:UBLVersionID>2.0</cbc:UBLVersionID>
<cbc:CustomizationID>OIOUBL-2.01</cbc:CustomizationID>
<cbc:ProfileID schemeAgencyID="320" schemeID="urn:oioubl:id:profileid-1.1">Catalogue-CatAdv-
1.0</cbc:ProfileID>
<cbc:ID>CAT-EX-1</cbc:ID>
<cbc:UUID>9756b4d0-8815-1029-857a-e388fe63f399</cbc:UUID>
<cbc:Name>Mobile phone</cbc:Name>
<cbc:IssueDate>2006-05-30</cbc:IssueDate>
<cbc:IssueTime>12:00:00</cbc:IssueTime>
<cbc:RevisionDate>2006-05-01</cbc:RevisionDate>
<cbc:RevisionTime>09:30:47</cbc:RevisionTime>
<cbc:Description>Teleekspertens sells alle the best-known models in mobile phone and
accessories.</cbc:Description>
<cbc:VersionID>1.1</cbc:VersionID>
<cbc:PreviousVersionID>1.0</cbc:PreviousVersionID>
+ <cac:ValidityPeriod />
+ <cac:ReferencedContract />
+ <cac:ProviderParty />
+ <cac:ReceiverParty />
+ <cac:ContractorCustomerParty />
+ <cac:TradingTerms />
+ <cac:CatalogueLine />
+ <cac:CatalogueLine />
+ <cac:CatalogueLine />
+ <cac:CatalogueLine />
</Catalogue>

OIOUBL Catalogue - UBL 2.0 Catalogue Side 11


3.1. Catalogue

Fields
UBL-Name Name Datatype Usage Cardinality
UBLVersionID UBLVersionID Identifier Yes 1
CustomizationID CustomizationID Identifier Yes 1
ProfileID ProfileID Identifier Yes 1
ID ID Identifier Yes 1
UUID UUID Identifier Yes 0..1
Name Name Name Yes 0..1
IssueDate IssueDate Date Yes 1
IssueTime IssueTime Time Bilateral 0..1
RevisionDate RevisionDate Date Yes 0..1
RevisionTime RevisionTime Time Bilateral 0..1
Note Note Text Yes 0..n
Description Description Text Yes 0..n
VersionID VersionID Identifier Yes 1
PreviousVersionID PreviousVersionID Identifier Yes 0..1

Subclasses in class Catalogue


UBL-Name Name Usage Cardi Reference
nality
UBLExtensions UBLExtensions Bilateral 0..1 G22
ValidityPeriod ValidityPeriod Yes 1 3.2
ReferencedContract ReferencedContract Yes 0..1 3.3
Signature Signature Yes 0..n G30 3.96
ProviderParty ProviderParty Yes 1 3.4
ReceiverParty ReceiverParty Yes 1 3.5
SellerSupplierParty SellerSupplierParty Yes 1 G30 3.100
ContractorCustomerParty ContractorCustomerParty Yes 0..1 G30 3.27
TradingTerms TradingTerms Yes 0..n G30 3.106
CatalogueLine CatalogueLine Yes 1..n 3.6

OIOUBL Catalogue - UBL 2.0 Catalogue Side 12


3.1. Catalogue

Field specifications

UBLVersionID
Fieldname UBLVersionID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition The version of the UBL schema being used.
Legal values 2.0
Example 2.0

CustomizationID
Fieldname CustomizationID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition The identifier for a user defined subset of UBL.
Legal values OIOUBL-2.01

ProfileID
Fieldname ProfileID Alternative term OIOUBL_GUIDE_PROFILES
Cardinality 1 Usage Yes
Datatype Identifier
Definition The identifier for a user defined profile of the subset of UBL being used.
Id list urn:oioubl:id:profileid-1.1
See also OIOUBL_GUIDE_PROFILES ( OIO )
Example Catalogue-CatAdv-1.0

ID
Fieldname ID Alternative term OIOUBL_GUIDE_CATALOG
UE_ID
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for the Catalogue assigned by the Seller
Businessrules If the Catalogue document is used for an update, this ID identifies the Catalogue that should be
updated.
See also OIOUBL_GUIDE_CATALOGUE_ID ( OIO )

UUID
Fieldname UUID Alternative term OIOUBL_GUIDE_UUID
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition A computer-generated universally unique identifier (UUID) for the Catalogue instance
See also OIOUBL_GUIDE_UUID ( G32 )

Name
Fieldname Name Alternative term
Cardinality 0..1 Usage Yes
Datatype Name
Definition A name given to a catalogue

IssueDate
Fieldname IssueDate Alternative term
Cardinality 1 Usage Yes
Datatype Date
Definition The date when the catalogue was issued
Legal values yyyy-mm-dd
Example 2006-08-01

IssueTime

OIOUBL Catalogue - UBL 2.0 Catalogue Side 13


3.1. Catalogue
Fieldname IssueTime Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Time
Definition The time when the catalogue was issued
Legal values hh:mm:ss
Example 12:00:00

RevisionDate
Fieldname RevisionDate Alternative term
Cardinality 0..1 Usage Yes
Datatype Date
Definition The date (assigned by the Seller Party) at which the information in the catalogue was revised.
Legal values yyyy-mm-dd
Example 2006-08-01

RevisionTime
Fieldname RevisionTime Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Time
Definition The time (assigned by the Seller Party) at which the information in the catalogue was revised.
Legal values hh:mm:ss
Example 12:00:00

Note
Fieldname Note Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition Free form text applying to the Catalogue. This element may contain notes or any other similar
information that is not contained explicitly in another structure.
Recommendation Only one Note per language

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition A description of the catalogue
Recommendation Only one Description per language

VersionID
Fieldname VersionID Alternative term OIOUBL_GUIDE_CATALOG
UE_ID
Cardinality 1 Usage Yes
Datatype Identifier
Definition To indicate the current version of the catalogue
See also OIOUBL_GUIDE_CATALOGUE_ID ( OIO )
Example 2.0

PreviousVersionID
Fieldname PreviousVersionID Alternative term OIOUBL_GUIDE_CATALOG
UE_ID
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition Identifies the previous version of the Catalogue which is superceded by this version
See also OIOUBL_GUIDE_CATALOGUE_ID ( OIO )
Example 1.0

Class Specification

ValidityPeriod

OIOUBL Catalogue - UBL 2.0 Catalogue Side 14


3.1. Catalogue
Classname ValidityPeriod Alternative term OIOUBL_GUIDE_CATALOG
UE_ID
Cardinality 1 Usage Yes
Datatype Period
Definition The period assigned by the Seller during which the information in the Catalogue is effective. This may
be given as start and end dates or a duration.
See section 3.2
See also OIOUBL_GUIDE_CATALOGUE_ID ( OIO )

ReferencedContract
Classname ReferencedContract Alternative term
Cardinality 0..1 Usage Yes
Datatype Contract
Definition An association to a framework agreement or contract
See section 3.3

Signature
Classname Signature Alternative term
Cardinality 0..n Usage Yes
Datatype Signature
Definition An association to one or more signatures applied to the document
See section G30 3.96

ProviderParty
Classname ProviderParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 1 Usage Yes
Datatype Party
Definition An association to the Catalogue Provider Party
Businessrules The ProviderParty can be a Supplier or a third party catalogueadministrator
See section 3.4
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

ReceiverParty
Classname ReceiverParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 1 Usage Yes
Datatype Party
Definition An association to the Catalogue Receiver Party
Businessrules The ReceiverParty can be a buyer or a third party catalogueadministrator e.g. a marketplace or a
portal
See section 3.5
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

SellerSupplierParty
Classname SellerSupplierParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 1 Usage Yes
Datatype SupplierParty
Definition The Seller Party responsible for the contract to which the Catalogue relates.
Businessrules Is default value for CatalogueLine if the party is not specified on the line. Note that a
SellerSupplierParty on the line overrules the SellerSupplierParty on the header
See section G30 3.100
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

ContractorCustomerParty

OIOUBL Catalogue - UBL 2.0 Catalogue Side 15


3.1. Catalogue
Classname ContractorCustomerParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 0..1 Usage Yes
Datatype CustomerParty
Definition The Customer Party responsible for the contract to which the Catalogue relates.
Businessrules Only used when different from ReceiverParty. Is default value for CatalogueLine if the party is not
specified on the line.
See section G30 3.27
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

TradingTerms
Classname TradingTerms Alternative term
Cardinality 0..n Usage Yes
Datatype TradingTerms
Definition An association to trading terms
Businessrules Are the TradingTerms not specified here or in a contract, the TradingTherms on the Order are
applicable.
Recommendation If a response is needed whitin a specific periode, it can be stated as a trading term.
See section G30 3.106

CatalogueLine
Classname CatalogueLine Alternative term
Cardinality 1..n Usage Yes
Datatype CatalogueLine
Definition An association to one or more Catalogue Lines.
See section 3.6

Excluded classes and fields in Catalogue


Name Name Type
LineCountNumeric LineCountNumeric Field

OIOUBL Catalogue - UBL 2.0 Catalogue Side 16


3.2. Catalogue.ValidityPeriod

3.2. Catalogue.ValidityPeriod

ValidityPeriod (Catalogue.ValidityPeriod) specification


Name Catalogue.ValidityPeriod Alternative term
Definition Information about a Period of time

Example
<cac:ValidityPeriod>
<cbc:StartDate>2006-05-30</cbc:StartDate>
<cbc:EndDate>2007-05-30</cbc:EndDate>
</cac:ValidityPeriod>

Fields
UBL-Name Name Datatype Usage Cardinality
StartDate StartDate Date Yes 1
StartTime StartTime Time Bilateral 0..1
EndDate EndDate Date Yes 0..1
EndTime EndTime Time Bilateral 0..1
Description Description Text Yes 0..n

Subclasses in class ValidityPeriod (Catalogue.ValidityPeriod)


None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 17


3.2. Catalogue.ValidityPeriod

Field specifications

StartDate
Fieldname StartDate Alternative term
Cardinality 1 Usage Yes
Datatype Date
Definition The start date of the Period
Example 2007-01-01

StartTime
Fieldname StartTime Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Time
Definition The start time of the Period

EndDate
Fieldname EndDate Alternative term
Cardinality 0..1 Usage Yes
Datatype Date
Definition The end date of the Period
Dependency ../StartDate
Example 2007-02-01

EndTime
Fieldname EndTime Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Time
Definition The end time of the Period

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition A description of the Period
Recommendation Only one Description per language
Example En måned

Excluded classes and fields in ValidityPeriod (Catalogue.ValidityPeriod)


Name Name Type
DurationMeasure DurationMeasure Field
DescriptionCode DescriptionCode Field

OIOUBL Catalogue - UBL 2.0 Catalogue Side 18


3.3. Catalogue.ReferencedContract

3.3. Catalogue.ReferencedContract

ReferencedContract (Catalogue.ReferencedContract) specification


Name Catalogue.ReferencedContract Alternative term
Definition Information about a Contract
Businessrules Used for specification of a potential framework agreement

Example
<cac:ReferencedContract>
<cbc:ID>TELE-1</cbc:ID>
+ <cac:ContractDocumentReference />
</cac:ReferencedContract>

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
IssueDate IssueDate Date Bilateral 0..1
IssueTime IssueTime Time Bilateral 0..1
ContractTypeCode ContractTypeCode Code Bilateral 0..1
ContractType ContractType Text Yes 0..1

Subclasses in class ReferencedContract (Catalogue.ReferencedContract)


UBL-Name Name Usage Cardi Reference
nality
ValidityPeriod ValidityPeriod Bilateral 0..1 G30 3.78
ContractDocumentReference ContractDocumentReference Yes 0..1 3.3.1

OIOUBL Catalogue - UBL 2.0 Catalogue Side 19


3.3. Catalogue.ReferencedContract

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identification for Contract
Businessrules An identifier known by relevant parties

IssueDate
Fieldname IssueDate Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Date
Definition Issue date for Contract

IssueTime
Fieldname IssueTime Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Time
Definition Issue time for Contract

ContractTypeCode
Fieldname ContractTypeCode Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Code
Definition Specification of Contract Type expressed as a code
Businessrules A bilateral specified code if applicable.
Dependency ../ContractType

ContractType
Fieldname ContractType Alternative term
Cardinality 0..1 Usage Yes
Datatype Text
Definition Specification of Contract Type expressed as text
Businessrules Use if no code is applicable.
Dependency ../ContractTypeCode

Class Specification

ValidityPeriod
Classname ValidityPeriod Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Period
Definition An association to ValidityPeriod
See section G30 3.78

ContractDocumentReference
Classname ContractDocumentReference Alternative term
Cardinality 0..1 Usage Yes
Datatype DocumentReference
Definition An association to ContractDocumentReference
Recommendation Can be used to attach the actual contract
See section 3.3.1

Excluded classes and fields in ReferencedContract (Catalogue.ReferencedContract)


None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 20


3.3.1. Catalogue.ReferencedContract.ContractDocumentReference

3.3.1. Catalogue.ReferencedContract.ContractDocumentReference

ContractDocumentReference (Catalogue.ReferencedContract.ContractDocumentReference)
specification
Name Catalogue.ReferencedContract.ContractDoc Alternative term OIOUBL_GUIDE_DOCUME
umentReference NTREF
Definition Information about a Document referred to in another Document
See also OIOUBL_GUIDE_DOCUMENTREF ( OIO )

Example
<cac:ContractDocumentReference>
<cbc:ID>TELE-1-CON</cbc:ID>
+ <cac:Attachment />
</cac:ContractDocumentReference>

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
CopyIndicator CopyIndicator Indicator Bilateral 0..1
UUID UUID Identifier Yes 0..1
IssueDate IssueDate Date Yes 0..1
XPath XPath Text Yes 0..n

Subclasses in class ContractDocumentReference


(Catalogue.ReferencedContract.ContractDocumentReference)
UBL-Name Name Usage Cardi Reference
nality
Attachment Attachment Yes 0..1 3.3.1.1

OIOUBL Catalogue - UBL 2.0 Catalogue Side 21


3.3.1. Catalogue.ReferencedContract.ContractDocumentReference

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition The identifier for the Document being referred to
Example 428.34

CopyIndicator
Fieldname CopyIndicator Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Indicator
Definition Indicates whether the referenced Document is a copy (true) or the original (false)
Example false

UUID
Fieldname UUID Alternative term OIOUBL_GUIDE_UUID
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition A computer-generated universally unique identifier (UUID) for the referenced Document instance
See also OIOUBL_GUIDE_UUID ( G32 )

IssueDate
Fieldname IssueDate Alternative term
Cardinality 0..1 Usage Yes
Datatype Date
Definition The date assigned by the sender of the referenced Document on which the referenced Document was
issued
Example 2006-09-01

XPath
Fieldname XPath Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition Refers to another part of the same document instance
Example /DocumentReference[ID='428.22']

Class Specification

Attachment
Classname Attachment Alternative term
Cardinality 0..1 Usage Yes
Datatype Attachment
Definition An attached document, external refered to, refered in the MIME location or embedded.
See section 3.3.1.1

Excluded classes and fields in ContractDocumentReference


(Catalogue.ReferencedContract.ContractDocumentReference)
Name Name Type
DocumentTypeCode DocumentTypeCode Field
DocumentType DocumentType Field

OIOUBL Catalogue - UBL 2.0 Catalogue Side 22


3.3.1.1. Catalogue.ReferencedContract.ContractDocumentReference.Attachment

3.3.1.1.
Catalogue.ReferencedContract.ContractDocumentReference.Attachmen
t

Attachment (Catalogue.ReferencedContract.ContractDocumentReference.Attachment)
specification
Name Catalogue.ReferencedContract.ContractDoc Alternative term OIOUBL_GUIDE_ATTACHM
umentReference.Attachment ENT
Definition Information about an attached document. An attachment can be referred to externally (with the URI
element), internally (with the MIME reference element) or contained within the document itself (with the
EmbeddedDocument element).
See also OIOUBL_GUIDE_ATTACHMENT ( OIO )

Example
<cac:Attachment>
+ <cac:ExternalReference />
</cac:Attachment>

Fields
UBL-Name Name Datatype Usage Cardinality
EmbeddedDocumentBinaryObject EmbeddedDocumentBinaryObject Binary Object Bilateral 0..1

Subclasses in class Attachment


(Catalogue.ReferencedContract.ContractDocumentReference.Attachment)
UBL-Name Name Usage Cardi Reference
nality
ExternalReference ExternalReference Yes 0..1 G30 3.41

OIOUBL Catalogue - UBL 2.0 Catalogue Side 23


3.3.1.1. Catalogue.ReferencedContract.ContractDocumentReference.Attachment

Field specifications

EmbeddedDocumentBinaryObject
Fieldname EmbeddedDocumentBinaryObject Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Binary Object
Definition Contains an embedded document as a BLOB,
Businessrules Only allowed if no ExternalReference is specified and if bilateral agreed.
Dependency ../ExternalReference

Class Specification

ExternalReference
Classname ExternalReference Alternative term
Cardinality 0..1 Usage Yes
Datatype ExternalReference
Definition An attached document, external refered to, refered in the MIME location or embedded.
Businessrules Used if no EmbeddedDocumentBinaryObject specified
Dependency ../EmbeddedDocumentBinaryObject
See section G30 3.41

Excluded classes and fields in Attachment


(Catalogue.ReferencedContract.ContractDocumentReference.Attachment)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 24


3.4. Catalogue.ProviderParty

3.4. Catalogue.ProviderParty

ProviderParty (Catalogue.ProviderParty) specification


Name Catalogue.ProviderParty Alternative term
Definition Information about an organisation, sub-organisation or individual fulfilling a role in a business process

Example
<cac:ProviderParty>
<cbc:EndpointID schemeID="DK:CVR">DK45656787</cbc:EndpointID>
+ <cac:PartyIdentification />
+ <cac:PartyName />
+ <cac:PostalAddress />
+ <cac:PartyLegalEntity />
+ <cac:Contact />
+ <cac:Person />
</cac:ProviderParty>

Fields
UBL-Name Name Datatype Usage Cardinality
WebsiteURI WebsiteURI Identifier Bilateral 0..1
LogoReferenceID LogoReferenceID Identifier Bilateral 0..1
EndpointID EndpointID Identifier Yes 1

OIOUBL Catalogue - UBL 2.0 Catalogue Side 25


3.4. Catalogue.ProviderParty

Subclasses in class ProviderParty (Catalogue.ProviderParty)


UBL-Name Name Usage Cardi Reference
nality
PartyIdentification PartyIdentification Yes 0..n G30 3.71
PartyName PartyName Yes 0..n G30 3.73
Language Language Bilateral 0..1 G30 3.56
PostalAddress PostalAddress Yes 0..1 G30 3.1
PhysicalLocation PhysicalLocation Bilateral 0..1
PartyTaxScheme PartyTaxScheme Bilateral 0..n G30 3.74
PartyLegalEntity PartyLegalEntity Yes 1 G30 3.72
Contact Contact Yes 0..1 G30 3.21
Person Person Yes 0..1 G30 3.79

Field specifications

WebsiteURI
Fieldname WebsiteURI Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Identifier
Definition The Uniform Resource Identifier (URI) of the Party

LogoReferenceID
Fieldname LogoReferenceID Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Identifier
Definition A Party's logo

EndpointID
Fieldname EndpointID Alternative term OIOUBL_GUIDE_ENDPOINT
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identifies the end point of the routing service, e.g. EAN Location Number, GLN
Id schemelist urn:oioubl:scheme:endpointid-1.1
See also OIOUBL_GUIDE_ENDPOINT ( OIO )

Class Specification

PartyIdentification
Classname PartyIdentification Alternative term
Cardinality 0..n Usage Yes
Datatype PartyIdentification
Definition An association to Party Identification
Businessrules PartyIdentification or PartyName must be specified.
See section G30 3.71

PartyName
Classname PartyName Alternative term
Cardinality 0..n Usage Yes
Datatype PartyName
Definition An association to Party Name. Party Name must be used where no Party Identification is used.
Businessrules Mandatory if PartyIdentification/ID is not used. Only one per Language
Recommendation At Header level PartyName should be supplied. Only one Name per language
Dependency ../PartyIdentification
See section G30 3.73

Language

OIOUBL Catalogue - UBL 2.0 Catalogue Side 26


3.4. Catalogue.ProviderParty
Classname Language Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Language
Definition An association to Language
See section G30 3.56

PostalAddress
Classname PostalAddress Alternative term
Cardinality 0..1 Usage Yes
Datatype Address
Definition The Party's postal address
Businessrules Use addresstype StructuredDK for addresses in Denmark
Recommendation At Header level Postaladdress should be supplied
See section G30 3.1

PhysicalLocation
Classname PhysicalLocation Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Location
Definition The Party's visiting address
Businessrules Only specified if different from PostalAddress
See section G30 3.

PartyTaxScheme
Classname PartyTaxScheme Alternative term
Cardinality 0..n Usage Bilateral
Datatype PartyTaxScheme
Definition An association to Party Tax Scheme
See section G30 3.74

PartyLegalEntity
Classname PartyLegalEntity Alternative term OIOUBL_GUIDE_PARTIES
Cardinality 1 Usage Yes
Datatype PartyLegalEntity
Definition An association to Party Legal Entity
See section G30 3.72
See also OIOUBL_GUIDE_PARTIES ( OIO )
Example DK12345678 (schemeName = CVR)

Contact
Classname Contact Alternative term
Cardinality 0..1 Usage Yes
Datatype Contact
Definition An association to Contact
Recommendation The Contact information for the party
See section G30 3.21

Person
Classname Person Alternative term
Cardinality 0..1 Usage Yes
Datatype Person
Definition An association to a Person.
Recommendation Supplementary information for Contact
See section G30 3.79

OIOUBL Catalogue - UBL 2.0 Catalogue Side 27


3.4. Catalogue.ProviderParty

Excluded classes and fields in ProviderParty (Catalogue.ProviderParty)


Name Name Type
MarkCareIndicator MarkCareIndicator Field
MarkAttentionIndicator MarkAttentionIndicator Field
AgentParty AgentParty Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 28


3.5. Catalogue.ReceiverParty

3.5. Catalogue.ReceiverParty

ReceiverParty (Catalogue.ReceiverParty) specification


Name Catalogue.ReceiverParty Alternative term
Definition Information about an organisation, sub-organisation or individual fulfilling a role in a business process

Example
<cac:ReceiverParty>
<cbc:EndpointID schemeID="DK:CVR">DK98879887</cbc:EndpointID>
+ <cac:PartyIdentification />
+ <cac:PartyName />
+ <cac:PostalAddress />
+ <cac:PartyLegalEntity />
+ <cac:Contact />
+ <cac:Person />
</cac:ReceiverParty>

Fields
UBL-Name Name Datatype Usage Cardinality
WebsiteURI WebsiteURI Identifier Bilateral 0..1
LogoReferenceID LogoReferenceID Identifier Bilateral 0..1
EndpointID EndpointID Identifier Yes 1

OIOUBL Catalogue - UBL 2.0 Catalogue Side 29


3.5. Catalogue.ReceiverParty

Subclasses in class ReceiverParty (Catalogue.ReceiverParty)


UBL-Name Name Usage Cardi Reference
nality
PartyIdentification PartyIdentification Yes 0..n G30 3.71
PartyName PartyName Yes 0..n G30 3.73
Language Language Bilateral 0..1 G30 3.56
PostalAddress PostalAddress Yes 0..1 G30 3.1
PhysicalLocation PhysicalLocation Bilateral 0..1
PartyTaxScheme PartyTaxScheme Bilateral 0..n G30 3.74
PartyLegalEntity PartyLegalEntity Yes 1 G30 3.72
Contact Contact Yes 0..1 G30 3.21
Person Person Yes 0..1 G30 3.79

Field specifications

WebsiteURI
Fieldname WebsiteURI Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Identifier
Definition The Uniform Resource Identifier (URI) of the Party

LogoReferenceID
Fieldname LogoReferenceID Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Identifier
Definition A Party's logo

EndpointID
Fieldname EndpointID Alternative term OIOUBL_GUIDE_ENDPOINT
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identifies the end point of the routing service, e.g. EAN Location Number, GLN
Id schemelist urn:oioubl:scheme:endpointid-1.1
See also OIOUBL_GUIDE_ENDPOINT ( OIO )

Class Specification

PartyIdentification
Classname PartyIdentification Alternative term
Cardinality 0..n Usage Yes
Datatype PartyIdentification
Definition An association to Party Identification
Businessrules PartyIdentification or PartyName must be specified.
See section G30 3.71

PartyName
Classname PartyName Alternative term
Cardinality 0..n Usage Yes
Datatype PartyName
Definition An association to Party Name. Party Name must be used where no Party Identification is used.
Businessrules Mandatory if PartyIdentification/ID is not used. Only one for each Language
Recommendation At Header level PartyName should be supplied. Only one Name per language
Dependency ../PartyIdentification
See section G30 3.73

Language

OIOUBL Catalogue - UBL 2.0 Catalogue Side 30


3.5. Catalogue.ReceiverParty
Classname Language Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Language
Definition An association to Language
See section G30 3.56

PostalAddress
Classname PostalAddress Alternative term
Cardinality 0..1 Usage Yes
Datatype Address
Definition The Party's postal address
Businessrules Use addresstype StructuredDK for addresses in Denmark
Recommendation At Header level Postaladdress should be supplied
See section G30 3.1

PhysicalLocation
Classname PhysicalLocation Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Location
Definition The Party's visiting address
Businessrules Only specified if different from PostalAddress
See section G30 3.

PartyTaxScheme
Classname PartyTaxScheme Alternative term
Cardinality 0..n Usage Bilateral
Datatype PartyTaxScheme
Definition An association to Party Tax Scheme
See section G30 3.74

PartyLegalEntity
Classname PartyLegalEntity Alternative term OIOUBL_GUIDE_PARTIES
Cardinality 1 Usage Yes
Datatype PartyLegalEntity
Definition An association to Party Legal Entity
See section G30 3.72
See also OIOUBL_GUIDE_PARTIES ( OIO )
Example DK12345678 (schemeName = CVR)

Contact
Classname Contact Alternative term
Cardinality 0..1 Usage Yes
Datatype Contact
Definition An association to Contact
Recommendation The Contact information for the party
See section G30 3.21

Person
Classname Person Alternative term
Cardinality 0..1 Usage Yes
Datatype Person
Definition An association to a Person.
Recommendation Supplementary information for Contact
See section G30 3.79

OIOUBL Catalogue - UBL 2.0 Catalogue Side 31


3.5. Catalogue.ReceiverParty

Excluded classes and fields in ReceiverParty (Catalogue.ReceiverParty)


Name Name Type
MarkCareIndicator MarkCareIndicator Field
MarkAttentionIndicator MarkAttentionIndicator Field
AgentParty AgentParty Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 32


3.6. Catalogue.CatalogueLine

3.6. Catalogue.CatalogueLine

OIOUBL Catalogue - UBL 2.0 Catalogue Side 33


3.6. Catalogue.CatalogueLine

CatalogueLine (Catalogue.CatalogueLine) specification


Name Catalogue.CatalogueLine Alternative term
Definition En kataloglinje er et katalogs grundlæggende element, dvs. noget, der kan købes. A catalogue line is
the basic element of a catalogue, i. e. an item

Example
<cac:CatalogueLine>
<cbc:ID>SUB-53478965</cbc:ID>
<cbc:ActionCode listAgencyID="320" listID="urn:oioubl:codelist:catalogueactioncode-
1.1">Update</cbc:ActionCode>
<cbc:OrderableIndicator>true</cbc:OrderableIndicator>
<cbc:OrderableUnit>EA</cbc:OrderableUnit>
<cbc:ContentUnitQuantity unitCode="EA">1</cbc:ContentUnitQuantity>
+ <cac:LineValidityPeriod />
+ <cac:RequiredItemLocationQuantity />
+ <cac:Item />
</cac:CatalogueLine>

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ActionCode ActionCode Code Yes 1
LifeCycleStatusCode LifeCycleStatusCode Code Yes 0..1
ContractSubdivision ContractSubdivision Text Yes 0..1
Note Note Text Yes 0..n
OrderableIndicator OrderableIndicator Indicator Yes 1
OrderableUnit OrderableUnit Text Yes 0..1
ContentUnitQuantity ContentUnitQuantity Quantity Yes 1
OrderQuantityIncrementNumeric OrderQuantityIncrementNumeric Numeric Yes 0..1
MinimumOrderQuantity MinimumOrderQuantity Quantity Yes 0..1
MaximumOrderQuantity MaximumOrderQuantity Quantity Yes 0..1
WarrantyInformation WarrantyInformation Text Bilateral 0..n
PackLevelCode PackLevelCode Code Bilateral 0..1

Subclasses in class CatalogueLine (Catalogue.CatalogueLine)


UBL-Name Name Usage Cardi Reference
nality
ContractorCustomerParty ContractorCustomerParty Yes 0..1 G30 3.27
SellerSupplierParty SellerSupplierParty Bilateral 0..1 G30 3.100
WarrantyParty WarrantyParty Bilateral 0..1 G30 3.70
WarrantyValidityPeriod WarrantyValidityPeriod Bilateral 0..1 G30 3.78
LineValidityPeriod LineValidityPeriod Yes 0..1 G30 3.78
ItemComparison ItemComparison Bilateral 0..1 3.6.1
ComponentRelatedItem ComponentRelatedItem Bilateral 0..n 3.6.2
AccessoryRelatedItem AccessoryRelatedItem Bilateral 0..n 3.6.3
RequiredRelatedItem RequiredRelatedItem Bilateral 0..n 3.6.4
ReplacementRelatedItem ReplacementRelatedItem Bilateral 0..n 3.6.5
ComplementaryRelatedItem ComplementaryRelatedItem Bilateral 0..n 3.6.6
RequiredItemLocationQuantity RequiredItemLocationQuantity Yes 0..n 3.6.7
Item Item Yes 1 3.6.8

OIOUBL Catalogue - UBL 2.0 Catalogue Side 34


3.6. Catalogue.CatalogueLine

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition Unique instanceID for the line in this catalogue document
Businessrules This ID is used to identify the the CatalogueLine that should be updated.
Example 11223344-1234

ActionCode
Fieldname ActionCode Alternative term
Cardinality 1 Usage Yes
Datatype Code
Definition Code specifying the action necessary for synchronizing this element with external databases
Businessrules Note that the whole CatalogueLine is updated or deleted when the ActionCode "update" or "delete" is
used
Codelist urn:oioubl:codelist:catalogueactioncode-1.1
Example Add, Delete, Update

LifeCycleStatusCode
Fieldname LifeCycleStatusCode Alternative term
Cardinality 0..1 Usage Yes
Datatype Code
Definition Code specifying if this line is accessible
Codelist urn:oioubl:codelist:lifecyclestatuscode-1.1

ContractSubdivision
Fieldname ContractSubdivision Alternative term
Cardinality 0..1 Usage Yes
Datatype Text
Definition Specifies how a contract or an offer is subdivided

Note
Fieldname Note Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition Freetext note for unstructered information about the line in the specific catalogue document (human
readable)
Recommendation Only one Note per language
Example 6 bottles per case

OrderableIndicator
Fieldname OrderableIndicator Alternative term
Cardinality 1 Usage Yes
Datatype Indicator
Definition Specifies if the line can be ordered (i.e. it is not just used for information)
Businessrules Default value is true, which means that the product can be ordered. Can be used e.g., if a product is
temporarily out of stock
Legal values true, false

OrderableUnit

OIOUBL Catalogue - UBL 2.0 Catalogue Side 35


3.6. Catalogue.CatalogueLine
Fieldname OrderableUnit Alternative term OIOUBL_GUIDE_CATALOG
UE_PRICES
Cardinality 0..1 Usage Yes
Datatype Text
Definition The unit in which the order can be placed
Businessrules OrderableUnit is mandatory if OrderableIndicator is "true", and must contain a valid UOM code.
OrderableUnit must be seen in relation to BaseQuantity and OrderableUnitFactorRate (BaseQuantity *
OrderableUnitFactorRate = the unit in OrderableUnit).
Codelist UN/ECE rec 20
Dependency ../RequiredItemLocationQuantity/Price/OrderableUnitFactorRate and ../OrderableIndicator
See also OIOUBL_GUIDE_CATALOGUE_PRICES ( OIO )
Example PK

ContentUnitQuantity
Fieldname ContentUnitQuantity Alternative term OIOUBL_GUIDE_CATALOG
UE_PRICES
Cardinality 1 Usage Yes
Datatype Quantity
Definition The line quantity in the measuring unit of the order
Dependency ../OrderableUnit
See also OIOUBL_GUIDE_CATALOGUE_PRICES ( OIO )
Example 6 (unitCode = 'BO')

OrderQuantityIncrementNumeric
Fieldname OrderQuantityIncrementNumeric Alternative term OIOUBL_GUIDE_CATALOG
UE_PRICES
Cardinality 0..1 Usage Yes
Datatype Numeric
Definition The number of items that can specify increases in the number of orders
Businessrules Can be dependent on MinimumOrderQuantity. If MinimumOrderQuantity is "24" and
OrderQuantityIncrementNumeric is "12", only 24, 36, 48 etc. units can be ordered.
Legal values >0
Dependency ../OrderableUnit
See also OIOUBL_GUIDE_CATALOGUE_PRICES ( OIO )
Example 12 (unitCode = 'BO')

MinimumOrderQuantity
Fieldname MinimumOrderQuantity Alternative term OIOUBL_GUIDE_CATALOG
UE_PRICES
Cardinality 0..1 Usage Yes
Datatype Quantity
Definition The minimum number of orderable items
Legal values >0
Dependency ../OrderableUnit
See also OIOUBL_GUIDE_CATALOGUE_PRICES ( OIO )
Example 60 (unitCode = 'BO')

MaximumOrderQuantity
Fieldname MaximumOrderQuantity Alternative term OIOUBL_GUIDE_CATALOG
UE_PRICES
Cardinality 0..1 Usage Yes
Datatype Quantity
Definition The maximum number of orderable items
Legal values >0
Dependency ../OrderableUnit
See also OIOUBL_GUIDE_CATALOGUE_PRICES ( OIO )

WarrantyInformation
Fieldname WarrantyInformation Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition The text in the warranty from SellerParty
Recommendation Only one per language

OIOUBL Catalogue - UBL 2.0 Catalogue Side 36


3.6. Catalogue.CatalogueLine

PackLevelCode
Fieldname PackLevelCode Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Code
Definition Specification of the packaging level

Class Specification

ContractorCustomerParty
Classname ContractorCustomerParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 0..1 Usage Yes
Datatype CustomerParty
Definition The CustomerParty responsible for the contract relating to the catalogue
Businessrules If the ContractorCustomorParty is specified on the catalogue line the line is only valid for that
customer. This makes it possible to specify products for different customers in the same catalogue
document e.g. for a marketplace. Not used in NES.
See section G30 3.27
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

SellerSupplierParty
Classname SellerSupplierParty Alternative term OIOUBL_GUIDE_CATALOG
UE_PARTIES
Cardinality 0..1 Usage Bilateral
Datatype SupplierParty
Definition An association regarding the Seller of the item
Businessrules The SellerSupplierParty on the CatalogueLine makes it possible to hold products from different
suppliers in the same Catalogue document. Note that a SellerSupplierParty on the line overrules the
SellerSupplierParty on the header
Recommendation Not applicable for NES.
See section G30 3.100
See also OIOUBL_GUIDE_CATALOGUE_PARTIES ( OIO )

WarrantyParty
Classname WarrantyParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition The Party responsible for Warranty
See section G30 3.70

WarrantyValidityPeriod
Classname WarrantyValidityPeriod Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Period
Definition The validity period for Warranty
See section G30 3.78

LineValidityPeriod
Classname LineValidityPeriod Alternative term
Cardinality 0..1 Usage Yes
Datatype Period
Definition The validity period for CatalogueLine
Recommendation Recommended way to stop ordering after validity period is to send catalogue line update with
ActionCode = Delete
See section G30 3.78

ItemComparison

OIOUBL Catalogue - UBL 2.0 Catalogue Side 37


3.6. Catalogue.CatalogueLine
Classname ItemComparison Alternative term
Cardinality 0..1 Usage Bilateral
Datatype ItemComparison
Definition An association to comparable information for this item
See section 3.6.1

ComponentRelatedItem
Classname ComponentRelatedItem Alternative term
Cardinality 0..n Usage Bilateral
Datatype RelatedItem
Definition Information describing possible catalogue items constituting components of this item
See section 3.6.2

AccessoryRelatedItem
Classname AccessoryRelatedItem Alternative term
Cardinality 0..n Usage Bilateral
Datatype RelatedItem
Definition Information describing possible catalogue items constituting optional accessory for this item
See section 3.6.3

RequiredRelatedItem
Classname RequiredRelatedItem Alternative term
Cardinality 0..n Usage Bilateral
Datatype RelatedItem
Definition Information describing possible catalogue items required as accessory for this item
See section 3.6.4

ReplacementRelatedItem
Classname ReplacementRelatedItem Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..n Usage Bilateral
Datatype RelatedItem
Definition Information describing possible catalogue items that can replace this item
See section 3.6.5
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

ComplementaryRelatedItem
Classname ComplementaryRelatedItem Alternative term
Cardinality 0..n Usage Bilateral
Datatype RelatedItem
Definition Information describing possible catalogue items that can be used in conjunction with this item
See section 3.6.6

RequiredItemLocationQuantity
Classname RequiredItemLocationQuantity Alternative term
Cardinality 0..n Usage Yes
Datatype ItemLocationQuantity
Definition Information regarding the description of properties relating to the locations and quantities of the item
See section 3.6.7

Item
Classname Item Alternative term
Cardinality 1 Usage Yes
Datatype Item
Definition An association to the Item in question
See section 3.6.8

Excluded classes and fields in CatalogueLine (Catalogue.CatalogueLine)


Name Name Type
DocumentReference DocumentReference Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 38


3.6. Catalogue.CatalogueLine

OIOUBL Catalogue - UBL 2.0 Catalogue Side 39


3.6.1. Catalogue.CatalogueLine.ItemComparison

3.6.1. Catalogue.CatalogueLine.ItemComparison

ItemComparison (Catalogue.CatalogueLine.ItemComparison) specification


Name Catalogue.CatalogueLine.ItemComparison Alternative term
Definition ItemComparison is used for comparising different items based on price, quantity or measurement

Fields
UBL-Name Name Datatype Usage Cardinality
PriceAmount PriceAmount Amount Bilateral 1
Quantity Quantity Quantity Bilateral 1

Subclasses in class ItemComparison (Catalogue.CatalogueLine.ItemComparison)


None

Field specifications

PriceAmount
Fieldname PriceAmount Alternative term
Cardinality 1 Usage Bilateral
Datatype Amount
Definition The price for the compared quantity of the item

Quantity
Fieldname Quantity Alternative term
Cardinality 1 Usage Bilateral
Datatype Quantity
Definition The quantity used for the comparison of price to other items

Excluded classes and fields in ItemComparison (Catalogue.CatalogueLine.ItemComparison)


None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 40


3.6.2. Catalogue.CatalogueLine.ComponentRelatedItem

3.6.2. Catalogue.CatalogueLine.ComponentRelatedItem

ComponentRelatedItem (Catalogue.CatalogueLine.ComponentRelatedItem) specification


Name Catalogue.CatalogueLine.ComponentRelate Alternative term OIOUBL_GUIDE_CATALOG
dItem UE_ITEMDESCR
Definition Information about the relation between two units
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Bilateral 1
Quantity Quantity Quantity Bilateral 0..1
Description Description Text Bilateral 0..n

Subclasses in class ComponentRelatedItem


(Catalogue.CatalogueLine.ComponentRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 41


3.6.2. Catalogue.CatalogueLine.ComponentRelatedItem

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Bilateral
Datatype Identifier
Definition Identification for the relation
Example 11223344-2345

Quantity
Fieldname Quantity Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Quantity
Definition The quantity applying to the relation
Example 1 (unitCode = 'EA')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the relation
Recommendation Only one per Language
Example Bicycle wheel

Excluded classes and fields in ComponentRelatedItem


(Catalogue.CatalogueLine.ComponentRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 42


3.6.3. Catalogue.CatalogueLine.AccessoryRelatedItem

3.6.3. Catalogue.CatalogueLine.AccessoryRelatedItem

AccessoryRelatedItem (Catalogue.CatalogueLine.AccessoryRelatedItem) specification


Name Catalogue.CatalogueLine.AccessoryRelatedI Alternative term OIOUBL_GUIDE_CATALOG
tem UE_ITEMDESCR
Definition Information about the relation between two units
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Bilateral 1
Quantity Quantity Quantity Bilateral 0..1
Description Description Text Bilateral 0..n

Subclasses in class AccessoryRelatedItem


(Catalogue.CatalogueLine.AccessoryRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 43


3.6.3. Catalogue.CatalogueLine.AccessoryRelatedItem

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Bilateral
Datatype Identifier
Definition Identification for the relation
Example 11223344-3456

Quantity
Fieldname Quantity Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Quantity
Definition The quantity applying to the relation
Example 1 (unitCode = 'EA')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the relation
Recommendation Only one per Language
Example Headphone

Excluded classes and fields in AccessoryRelatedItem


(Catalogue.CatalogueLine.AccessoryRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 44


3.6.4. Catalogue.CatalogueLine.RequiredRelatedItem

3.6.4. Catalogue.CatalogueLine.RequiredRelatedItem

RequiredRelatedItem (Catalogue.CatalogueLine.RequiredRelatedItem) specification


Name Catalogue.CatalogueLine.RequiredRelatedIt Alternative term OIOUBL_GUIDE_CATALOG
em UE_ITEMDESCR
Definition Information about the relation between two units
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Bilateral 1
Quantity Quantity Quantity Bilateral 0..1
Description Description Text Bilateral 0..n

Subclasses in class RequiredRelatedItem (Catalogue.CatalogueLine.RequiredRelatedItem)


None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 45


3.6.4. Catalogue.CatalogueLine.RequiredRelatedItem

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Bilateral
Datatype Identifier
Definition Identification for the relation
Example 11223344-4567

Quantity
Fieldname Quantity Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Quantity
Definition The quantity applying to the relation
Example 6 (unitCode = 'MON')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the relation
Recommendation Only one per Language
Example Telephone subscription

Excluded classes and fields in RequiredRelatedItem


(Catalogue.CatalogueLine.RequiredRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 46


3.6.5. Catalogue.CatalogueLine.ReplacementRelatedItem

3.6.5. Catalogue.CatalogueLine.ReplacementRelatedItem

ReplacementRelatedItem (Catalogue.CatalogueLine.ReplacementRelatedItem) specification


Name Catalogue.CatalogueLine.ReplacementRelat Alternative term OIOUBL_GUIDE_CATALOG
edItem UE_ITEMDESCR
Definition Information about the relation between two units
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Bilateral 1
Quantity Quantity Quantity Bilateral 0..1
Description Description Text Bilateral 0..n

Subclasses in class ReplacementRelatedItem


(Catalogue.CatalogueLine.ReplacementRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 47


3.6.5. Catalogue.CatalogueLine.ReplacementRelatedItem

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Bilateral
Datatype Identifier
Definition Identification for the relation
Example 11223344-5678

Quantity
Fieldname Quantity Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Quantity
Definition The quantity applying to the relation
Example 1 (unitCode = 'BO')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the relation
Recommendation Only one per Language
Example Ketchup, Heinz

Excluded classes and fields in ReplacementRelatedItem


(Catalogue.CatalogueLine.ReplacementRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 48


3.6.6. Catalogue.CatalogueLine.ComplementaryRelatedItem

3.6.6. Catalogue.CatalogueLine.ComplementaryRelatedItem

ComplementaryRelatedItem (Catalogue.CatalogueLine.ComplementaryRelatedItem)
specification
Name Catalogue.CatalogueLine.ComplementaryRe Alternative term OIOUBL_GUIDE_CATALOG
latedItem UE_ITEMDESCR
Definition Information about the relation between two units
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Bilateral 1
Quantity Quantity Quantity Bilateral 0..1
Description Description Text Bilateral 0..n

Subclasses in class ComplementaryRelatedItem


(Catalogue.CatalogueLine.ComplementaryRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 49


3.6.6. Catalogue.CatalogueLine.ComplementaryRelatedItem

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Bilateral
Datatype Identifier
Definition Identification for the relation
Example 11223344-6789

Quantity
Fieldname Quantity Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Quantity
Definition The quantity applying to the relation
Example 1 (unitCode = 'SA')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the relation
Recommendation Only one per Language
Example Charcoal

Excluded classes and fields in ComplementaryRelatedItem


(Catalogue.CatalogueLine.ComplementaryRelatedItem)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 50


3.6.7. Catalogue.CatalogueLine.RequiredItemLocationQuantity

3.6.7. Catalogue.CatalogueLine.RequiredItemLocationQuantity

RequiredItemLocationQuantity (Catalogue.CatalogueLine.RequiredItemLocationQuantity)
specification
Name Catalogue.CatalogueLine.RequiredItemLocat Alternative term OIOUBL_GUIDE_CATALOG
ionQuantity UE_ITEMDESCR
Definition Information about the properties of an item in relation to specific numbers and/or specific locations
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Example
<cac:RequiredItemLocationQuantity>
+ <cac:Price />
+ <cac:ApplicableTaxCategory />
</cac:RequiredItemLocationQuantity>

Fields
UBL-Name Name Datatype Usage Cardinality
LeadTimeMeasure LeadTimeMeasure Measure Yes 0..1
MinimumQuantity MinimumQuantity Quantity Yes 0..1
MaximumQuantity MaximumQuantity Quantity Yes 0..1
HazardousRiskIndicator HazardousRiskIndicator Indicator Bilateral 0..1
TradingRestrictions TradingRestrictions Text Yes 0..1

Subclasses in class RequiredItemLocationQuantity


(Catalogue.CatalogueLine.RequiredItemLocationQuantity)
UBL-Name Name Usage Cardi Reference
nality
ApplicableTerritoryAddress ApplicableTerritoryAddress Yes 0..n G30 3.1
Price Price Yes 0..1 3.6.7.1
DeliveryUnit DeliveryUnit Yes 0..n G30 3.31
ApplicableTaxCategory ApplicableTaxCategory Yes 0..n G30 3.101

OIOUBL Catalogue - UBL 2.0 Catalogue Side 51


3.6.7. Catalogue.CatalogueLine.RequiredItemLocationQuantity

Field specifications

LeadTimeMeasure
Fieldname LeadTimeMeasure Alternative term
Cardinality 0..1 Usage Yes
Datatype Measure
Definition The time between the ordering and the delivery of the item
Recommendation Should be used
Example 1 (unitCode = 'DAY')

MinimumQuantity
Fieldname MinimumQuantity Alternative term
Cardinality 0..1 Usage Yes
Datatype Quantity
Definition The minimum orderable quantity (to obtain a certain price)
Example 6 (unitCode = 'BO')

MaximumQuantity
Fieldname MaximumQuantity Alternative term
Cardinality 0..1 Usage Yes
Datatype Quantity
Definition The maximum orderable quantity (to obtain a certain price)
Example 60 (unitCode = 'BO')

HazardousRiskIndicator
Fieldname HazardousRiskIndicator Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Indicator
Definition Specifies if an item is hazardous in the condition in which it is delivered
Legal values true, false

TradingRestrictions
Fieldname TradingRestrictions Alternative term
Cardinality 0..1 Usage Yes
Datatype Text
Definition A description of the trading restricitions applying to the item or quantities of the item

Class Specification

ApplicableTerritoryAddress
Classname ApplicableTerritoryAddress Alternative term
Cardinality 0..n Usage Yes
Datatype Address
Definition An asssociation to Terrirtory (Address)
See section G30 3.1

Price
Classname Price Alternative term
Cardinality 0..1 Usage Yes
Datatype Price
Definition An association to Price
See section 3.6.7.1

DeliveryUnit

OIOUBL Catalogue - UBL 2.0 Catalogue Side 52


3.6.7. Catalogue.CatalogueLine.RequiredItemLocationQuantity
Classname DeliveryUnit Alternative term
Cardinality 0..n Usage Yes
Datatype DeliveryUnit
Definition An association to DeliveryUnit
See section G30 3.31

ApplicableTaxCategory
Classname ApplicableTaxCategory Alternative term
Cardinality 0..n Usage Yes
Datatype TaxCategory
Definition An association to TaxCategory
Businessrules It can be specified if the item is StandardRated or ZeroRated. Other taxes can be specified.
See section G30 3.101

Excluded classes and fields in RequiredItemLocationQuantity


(Catalogue.CatalogueLine.RequiredItemLocationQuantity)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 53


3.6.7.1. Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price

3.6.7.1. Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price

Price (Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price) specification


Name Catalogue.CatalogueLine.RequiredItemLocat Alternative term OIOUBL_GUIDE_CATALOG
ionQuantity.Price UE_ITEMDESCR
Definition Information about price
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

Example
<cac:Price>
<cbc:PriceAmount currencyID="DKK">500</cbc:PriceAmount>
<cbc:BaseQuantity unitCode="EA">1</cbc:BaseQuantity>
<cbc:OrderableUnitFactorRate>1</cbc:OrderableUnitFactorRate>
+ <cac:ValidityPeriod />
</cac:Price>

Fields
UBL-Name Name Datatype Usage Cardinality
PriceAmount PriceAmount Amount Yes 1
BaseQuantity BaseQuantity Quantity Yes 1
PriceChangeReason PriceChangeReason Text Bilateral 0..1
PriceTypeCode PriceTypeCode Code Bilateral 0..1
PriceType PriceType Text Bilateral 0..1
OrderableUnitFactorRate OrderableUnitFactorRate Rate Yes 1

Subclasses in class Price (Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price)


UBL-Name Name Usage Cardi Reference
nality
ValidityPeriod ValidityPeriod Yes 0..1 G30 3.78
PriceList PriceList Bilateral 0..1 G30 3.82
AllowanceCharge AllowanceCharge Yes 0..n G30 3.4

OIOUBL Catalogue - UBL 2.0 Catalogue Side 54


3.6.7.1. Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price

Field specifications

PriceAmount
Fieldname PriceAmount Alternative term
Cardinality 1 Usage Yes
Datatype Amount
Definition The amount of Price
Businessrules The specified PriceAmount is always the price for the specified BaseQuantity
Dependency ../BaseQuantity
Example 65.00 (unitCode ='DKK')

BaseQuantity
Fieldname BaseQuantity Alternative term
Cardinality 1 Usage Yes
Datatype Quantity
Definition The actual quantity applying to the price
Businessrules BaseQuantity and BasePrice is inter-dependent
Dependency ../PriceAmount
Example 1 (unitCode ='BO')

PriceChangeReason
Fieldname PriceChangeReason Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Text
Definition The reason for the price change specified as a text
Recommendation Only one per Language

PriceTypeCode
Fieldname PriceTypeCode Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Code
Definition The PriceType specified as a code
Codelist UN/ECE 5387

PriceType
Fieldname PriceType Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Text
Definition The PriceType specified as a text

OrderableUnitFactorRate
Fieldname OrderableUnitFactorRate Alternative term
Cardinality 1 Usage Yes
Datatype Rate
Definition The factor used to convert the basic price unit into the order unit
Businessrules Default value is 1, and applies if no other value is provided
Legal values >0
Dependency ../BaseQuantity and ../../../OrderableUnit
Example 6

Class Specification

ValidityPeriod
Classname ValidityPeriod Alternative term OIOUBL_GUIDE_CATALOG
UE_ID
Cardinality 0..1 Usage Yes
Datatype Period
Definition An association to ValidityPeriod
See section G30 3.78
See also OIOUBL_GUIDE_CATALOGUE_ID ( OIO )

OIOUBL Catalogue - UBL 2.0 Catalogue Side 55


3.6.7.1. Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price

PriceList
Classname PriceList Alternative term
Cardinality 0..1 Usage Bilateral
Datatype PriceList
Definition A reference to a PriceList
See section G30 3.82

AllowanceCharge
Classname AllowanceCharge Alternative term
Cardinality 0..n Usage Yes
Datatype AllowanceCharge
Definition An association to AllowanceCharge
See section G30 3.4

Excluded classes and fields in Price


(Catalogue.CatalogueLine.RequiredItemLocationQuantity.Price)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 56


3.6.8. Catalogue.CatalogueLine.Item

3.6.8. Catalogue.CatalogueLine.Item

OIOUBL Catalogue - UBL 2.0 Catalogue Side 57


3.6.8. Catalogue.CatalogueLine.Item

Item (Catalogue.CatalogueLine.Item) specification


Name Catalogue.CatalogueLine.Item Alternative term
Definition Information directly relating to an item

Example
<cac:Item>
<cbc:Description>Subscription C - 6 months sold with mobile phone</cbc:Description>
<cbc:Name>Subscription 6 months</cbc:Name>
<cbc:BrandName>TeleDanmark</cbc:BrandName>
<cbc:ModelName>Subscription C</cbc:ModelName>
+ <cac:SellersItemIdentification />
+ <cac:CommodityClassification />
</cac:Item>

Fields
UBL-Name Name Datatype Usage Cardinality
Description Description Text Yes 0..n
PackQuantity PackQuantity Quantity Yes 0..1
PackSizeNumeric PackSizeNumeric Numeric Yes 0..1
Name Name Name Yes 1
HazardousRiskIndicator HazardousRiskIndicator Indicator Bilateral 0..1
AdditionalInformation AdditionalInformation Text Yes 0..1
Keyword Keyword Text Yes 0..n
BrandName BrandName Name Yes 0..n
ModelName ModelName Name Yes 0..n

Subclasses in class Item (Catalogue.CatalogueLine.Item)


UBL-Name Name Usage Cardi Reference
nality
BuyersItemIdentification BuyersItemIdentification Yes 0..1 3.6.8.1
SellersItemIdentification SellersItemIdentification Yes 1 3.6.8.2
ManufacturersItemIdentification ManufacturersItemIdentification Yes 0..1 3.6.8.3
StandardItemIdentification StandardItemIdentification Yes 0..1 3.6.8.4
CatalogueItemIdentification CatalogueItemIdentification Yes 0..1 3.6.8.5
AdditionalItemIdentification AdditionalItemIdentification Yes 0..1 3.6.8.6
CatalogueDocumentReference CatalogueDocumentReference Yes 0..1 3.6.8.7
ItemSpecificationDocumentReference ItemSpecificationDocumentReference Yes 0..n 3.6.8.8
CommodityClassification CommodityClassification Yes 1..n 3.6.8.9
TransactionConditions TransactionConditions Bilateral 0..n G30 3.107
HazardousItem HazardousItem Bilateral 0..n G30 3.47
AdditionalItemProperty AdditionalItemProperty Yes 0..n 3.6.8.10
ManufacturerParty ManufacturerParty Yes 0..1 G30 3.70
InformationContentProviderParty InformationContentProviderParty Bilateral 0..1 G30 3.70
OriginAddress OriginAddress Yes 0..1 G30 3.1
ItemInstance ItemInstance Yes 0..n G30 3.52

OIOUBL Catalogue - UBL 2.0 Catalogue Side 58


3.6.8. Catalogue.CatalogueLine.Item

Field specifications

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition A free form text field that can be used to give a text description of the item.
Recommendation Only one per Language

PackQuantity
Fieldname PackQuantity Alternative term
Cardinality 0..1 Usage Yes
Datatype Quantity
Definition The unit packaging quantity.
Example 1 (unitCode ='CS')

PackSizeNumeric
Fieldname PackSizeNumeric Alternative term
Cardinality 0..1 Usage Yes
Datatype Numeric
Definition The number of items in a package.
Example 12

Name
Fieldname Name Alternative term
Cardinality 1 Usage Yes
Datatype Name
Definition A shortname (optionally) given to an item, such as a name from a catalogue, as distinct to a
description
Recommendation Should not exceed 40 characters
Example "Colgate Total", "Batteries AA 12V"

HazardousRiskIndicator
Fieldname HazardousRiskIndicator Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Indicator
Definition An indicator as to whether the item as delivered is hazardous
Legal values true, false

AdditionalInformation
Fieldname AdditionalInformation Alternative term
Cardinality 0..1 Usage Yes
Datatype Text
Definition To provide more details of the item (eg URL of a relevant web page).

Keyword
Fieldname Keyword Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition A Seller Party-defined search string for the item. Could also be synonyms.
Recommendation Should be used in catalogues to optimize the search for items by specifying known synonyms for the
item. If Name is "Colgate Total" and the customer search for "toothpaste" the customer will not find the
item.
Example Toothpaste

BrandName
Fieldname BrandName Alternative term
Cardinality 0..n Usage Yes
Datatype Name
Definition The brand name for the item.

OIOUBL Catalogue - UBL 2.0 Catalogue Side 59


3.6.8. Catalogue.CatalogueLine.Item
ModelName
Fieldname ModelName Alternative term
Cardinality 0..n Usage Yes
Datatype Name
Definition Model name for the item

Class Specification

BuyersItemIdentification
Classname BuyersItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with its identification according to the buyers system.
See section 3.6.8.1
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

SellersItemIdentification
Classname SellersItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with its identification according to the sellers system.
See section 3.6.8.2
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

ManufacturersItemIdentification
Classname ManufacturersItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with its identification according to the manufacturers system.
See section 3.6.8.3
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

StandardItemIdentification
Classname StandardItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with its identification according to a standard system.
See section 3.6.8.4
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

CatalogueItemIdentification
Classname CatalogueItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with its identification according to a cataloging system.
See section 3.6.8.5
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

AdditionalItemIdentification
Classname AdditionalItemIdentification Alternative term OIOUBL_GUIDE_CATALOG
UE_ITEMDESCR
Cardinality 0..1 Usage Yes
Datatype ItemIdentification
Definition Associates the item with other identification means
See section 3.6.8.6
See also OIOUBL_GUIDE_CATALOGUE_ITEMDESCR ( OIO )

OIOUBL Catalogue - UBL 2.0 Catalogue Side 60


3.6.8. Catalogue.CatalogueLine.Item
CatalogueDocumentReference
Classname CatalogueDocumentReference Alternative term
Cardinality 0..1 Usage Yes
Datatype DocumentReference
Definition Associates the item with the catalogue from which the item was selected.
See section 3.6.8.7

ItemSpecificationDocumentReference
Classname ItemSpecificationDocumentReference Alternative term
Cardinality 0..n Usage Yes
Datatype DocumentReference
Definition An association to item specification
See section 3.6.8.8

CommodityClassification
Classname CommodityClassification Alternative term
Cardinality 1..n Usage Yes
Datatype CommodityClassification
Definition Associates the item with its classification(s) according to a commodity classifying system.
Businessrules At least one UNSPSC classification (in the same version) must be specified
See section 3.6.8.9

TransactionConditions
Classname TransactionConditions Alternative term
Cardinality 0..n Usage Bilateral
Datatype TransactionConditions
Definition Associates the item with sales conditions appertaining to it.
See section G30 3.107

HazardousItem
Classname HazardousItem Alternative term
Cardinality 0..n Usage Bilateral
Datatype HazardousItem
Definition Associates the item with its hazardous item information.
See section G30 3.47

AdditionalItemProperty
Classname AdditionalItemProperty Alternative term
Cardinality 0..n Usage Yes
Datatype ItemProperty
Definition Associates the item with a set of additional properties
Recommendation E.g. used to specify environmental codes etc.
See section 3.6.8.10

ManufacturerParty
Classname ManufacturerParty Alternative term
Cardinality 0..1 Usage Yes
Datatype Party
Definition An association to the manufacturer of the item.
See section G30 3.70

InformationContentProviderParty
Classname InformationContentProviderParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition Associates the item with the party responsible for the technical specifications of the item.
See section G30 3.70

OriginAddress

OIOUBL Catalogue - UBL 2.0 Catalogue Side 61


3.6.8. Catalogue.CatalogueLine.Item
Classname OriginAddress Alternative term
Cardinality 0..1 Usage Yes
Datatype Address
Definition Associates the item with the region of origin (ie not the country)
See section G30 3.1

ItemInstance
Classname ItemInstance Alternative term
Cardinality 0..n Usage Yes
Datatype ItemInstance
Definition An association to Item Instance
See section G30 3.52

Excluded classes and fields in Item (Catalogue.CatalogueLine.Item)


Name Name Type
CatalogueIndicator CatalogueIndicator Field
OriginCountry OriginCountry Class
ClassifiedTaxCategory ClassifiedTaxCategory Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 62


3.6.8.1. Catalogue.CatalogueLine.Item.BuyersItemIdentification

3.6.8.1. Catalogue.CatalogueLine.Item.BuyersItemIdentification

BuyersItemIdentification (Catalogue.CatalogueLine.Item.BuyersItemIdentification)
specification
Name Catalogue.CatalogueLine.Item.BuyersItemId Alternative term
entification
Definition Information about Item identification

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class BuyersItemIdentification


(Catalogue.CatalogueLine.Item.BuyersItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

OIOUBL Catalogue - UBL 2.0 Catalogue Side 63


3.6.8.1. Catalogue.CatalogueLine.Item.BuyersItemIdentification

Class Specification

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in BuyersItemIdentification


(Catalogue.CatalogueLine.Item.BuyersItemIdentification)
Name Name Type
PhysicalAttribute PhysicalAttribute Class
MeasurementDimension MeasurementDimension Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 64


3.6.8.2. Catalogue.CatalogueLine.Item.SellersItemIdentification

3.6.8.2. Catalogue.CatalogueLine.Item.SellersItemIdentification

SellersItemIdentification (Catalogue.CatalogueLine.Item.SellersItemIdentification)
specification
Name Catalogue.CatalogueLine.Item.SellersItemId Alternative term
entification
Definition Information about Item identification

Example
<cac:SellersItemIdentification>
<cbc:ID>SUB-C</cbc:ID>
</cac:SellersItemIdentification>

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class SellersItemIdentification


(Catalogue.CatalogueLine.Item.SellersItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
PhysicalAttribute PhysicalAttribute Yes 0..n 3.6.8.2.1
MeasurementDimension MeasurementDimension Yes 0..n 3.6.8.2.2
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

OIOUBL Catalogue - UBL 2.0 Catalogue Side 65


3.6.8.2. Catalogue.CatalogueLine.Item.SellersItemIdentification

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

Class Specification

PhysicalAttribute
Classname PhysicalAttribute Alternative term
Cardinality 0..n Usage Yes
Datatype PhysicalAttribute
Definition An association to Physical Attributes
See section 3.6.8.2.1

MeasurementDimension
Classname MeasurementDimension Alternative term
Cardinality 0..n Usage Yes
Datatype Dimension
Definition An association to Measurement Dimension
See section 3.6.8.2.2

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in SellersItemIdentification


(Catalogue.CatalogueLine.Item.SellersItemIdentification)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 66


3.6.8.2.1. Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute

3.6.8.2.1.
Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribut
e

PhysicalAttribute (Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute)
specification
Name Catalogue.CatalogueLine.Item.SellersItemId Alternative term
entification.PhysicalAttribute
Definition Information about Physical Attributes

Example
<cac:PhysicalAttribute>
<cbc:AttributeID>CAM</cbc:AttributeID>
<cbc:Description>3.1 megapixel camera with 20x digital zoom</cbc:Description>
</cac:PhysicalAttribute>

Fields
UBL-Name Name Datatype Usage Cardinality
AttributeID AttributeID Identifier Yes 1
Description Description Text Yes 1..n

Subclasses in class PhysicalAttribute


(Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 67


3.6.8.2.1. Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute

Field specifications

AttributeID
Fieldname AttributeID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identification for PhysicalAttribute

Description
Fieldname Description Alternative term
Cardinality 1..n Usage Yes
Datatype Text
Definition The description of PhysicalAttribute specified as text

Excluded classes and fields in PhysicalAttribute


(Catalogue.CatalogueLine.Item.SellersItemIdentification.PhysicalAttribute)
Name Name Type
PositionCode PositionCode Field
DescriptionCode DescriptionCode Field

OIOUBL Catalogue - UBL 2.0 Catalogue Side 68


3.6.8.2.2. Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension

3.6.8.2.2.
Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDi
mension

MeasurementDimension
(Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension)
specification
Name Catalogue.CatalogueLine.Item.SellersItemId Alternative term
entification.MeasurementDimension
Definition Information about a measurable dimension for an Item

Example
<cac:MeasurementDimension>
<cbc:AttributeID>WT</cbc:AttributeID>
<cbc:Measure unitCode="GRM">17</cbc:Measure>
</cac:MeasurementDimension>

Fields
UBL-Name Name Datatype Usage Cardinality
AttributeID AttributeID Identifier Yes 1
Measure Measure Measure Yes 0..1
Description Description Text Bilateral 0..n
MinimumMeasure MinimumMeasure Measure Yes 0..1
MaximumMeasure MaximumMeasure Measure Yes 0..1

Subclasses in class MeasurementDimension


(Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 69


3.6.8.2.2. Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension

Field specifications

AttributeID
Fieldname AttributeID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identification for the Attribute the measurement applies to
Example Weight

Measure
Fieldname Measure Alternative term
Cardinality 0..1 Usage Yes
Datatype Measure
Definition The value of the measurement
Recommendation Measure should be specified if MinimumMeasure and MinimumMeasure is not used
Example 20 (unitCode ='GRM')

Description
Fieldname Description Alternative term
Cardinality 0..n Usage Bilateral
Datatype Text
Definition A description of the Attribute or the measurement of the Attribute
Recommendation Only one per Language

MinimumMeasure
Fieldname MinimumMeasure Alternative term
Cardinality 0..1 Usage Yes
Datatype Measure
Definition The minimum value in a measurement interval.

MaximumMeasure
Fieldname MaximumMeasure Alternative term
Cardinality 0..1 Usage Yes
Datatype Measure
Definition The maximum value in a measurement interval.

Excluded classes and fields in MeasurementDimension


(Catalogue.CatalogueLine.Item.SellersItemIdentification.MeasurementDimension)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 70


3.6.8.3. Catalogue.CatalogueLine.Item.ManufacturersItemIdentification

3.6.8.3. Catalogue.CatalogueLine.Item.ManufacturersItemIdentification

ManufacturersItemIdentification
(Catalogue.CatalogueLine.Item.ManufacturersItemIdentification) specification
Name Catalogue.CatalogueLine.Item.Manufacturer Alternative term
sItemIdentification
Definition Information about Item identification

Example
<cac:ManufacturersItemIdentification>
<cbc:ID>B2-750i</cbc:ID>
</cac:ManufacturersItemIdentification>

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class ManufacturersItemIdentification


(Catalogue.CatalogueLine.Item.ManufacturersItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

OIOUBL Catalogue - UBL 2.0 Catalogue Side 71


3.6.8.3. Catalogue.CatalogueLine.Item.ManufacturersItemIdentification

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

Class Specification

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in ManufacturersItemIdentification


(Catalogue.CatalogueLine.Item.ManufacturersItemIdentification)
Name Name Type
PhysicalAttribute PhysicalAttribute Class
MeasurementDimension MeasurementDimension Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 72


3.6.8.4. Catalogue.CatalogueLine.Item.StandardItemIdentification

3.6.8.4. Catalogue.CatalogueLine.Item.StandardItemIdentification

StandardItemIdentification (Catalogue.CatalogueLine.Item.StandardItemIdentification)
specification
Name Catalogue.CatalogueLine.Item.StandardItem Alternative term
Identification
Definition Information about Item identification

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class StandardItemIdentification


(Catalogue.CatalogueLine.Item.StandardItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

OIOUBL Catalogue - UBL 2.0 Catalogue Side 73


3.6.8.4. Catalogue.CatalogueLine.Item.StandardItemIdentification

Class Specification

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in StandardItemIdentification


(Catalogue.CatalogueLine.Item.StandardItemIdentification)
Name Name Type
PhysicalAttribute PhysicalAttribute Class
MeasurementDimension MeasurementDimension Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 74


3.6.8.5. Catalogue.CatalogueLine.Item.CatalogueItemIdentification

3.6.8.5. Catalogue.CatalogueLine.Item.CatalogueItemIdentification

CatalogueItemIdentification (Catalogue.CatalogueLine.Item.CatalogueItemIdentification)
specification
Name Catalogue.CatalogueLine.Item.CatalogueIte Alternative term
mIdentification
Definition Information about Item identification

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class CatalogueItemIdentification


(Catalogue.CatalogueLine.Item.CatalogueItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

OIOUBL Catalogue - UBL 2.0 Catalogue Side 75


3.6.8.5. Catalogue.CatalogueLine.Item.CatalogueItemIdentification

Class Specification

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in CatalogueItemIdentification


(Catalogue.CatalogueLine.Item.CatalogueItemIdentification)
Name Name Type
PhysicalAttribute PhysicalAttribute Class
MeasurementDimension MeasurementDimension Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 76


3.6.8.6. Catalogue.CatalogueLine.Item.AdditionalItemIdentification

3.6.8.6. Catalogue.CatalogueLine.Item.AdditionalItemIdentification

AdditionalItemIdentification (Catalogue.CatalogueLine.Item.AdditionalItemIdentification)
specification
Name Catalogue.CatalogueLine.Item.AdditionalIte Alternative term
mIdentification
Definition Information about Item identification

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
ExtendedID ExtendedID Identifier Yes 0..1

Subclasses in class AdditionalItemIdentification


(Catalogue.CatalogueLine.Item.AdditionalItemIdentification)
UBL-Name Name Usage Cardi Reference
nality
IssuerParty IssuerParty Bilateral 0..1 G30 3.70

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identifier for an Item

ExtendedID
Fieldname ExtendedID Alternative term
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition An extended identifier for the item which identifies the item with specific properties e.g. Item 123 =
Chair / Item 123 Ext 45 = Brown chair

OIOUBL Catalogue - UBL 2.0 Catalogue Side 77


3.6.8.6. Catalogue.CatalogueLine.Item.AdditionalItemIdentification

Class Specification

IssuerParty
Classname IssuerParty Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Party
Definition An association to Issuer Party i.e. the Party that issued the Item Identification
See section G30 3.70

Excluded classes and fields in AdditionalItemIdentification


(Catalogue.CatalogueLine.Item.AdditionalItemIdentification)
Name Name Type
PhysicalAttribute PhysicalAttribute Class
MeasurementDimension MeasurementDimension Class

OIOUBL Catalogue - UBL 2.0 Catalogue Side 78


3.6.8.7. Catalogue.CatalogueLine.Item.CatalogueDocumentReference

3.6.8.7. Catalogue.CatalogueLine.Item.CatalogueDocumentReference

CatalogueDocumentReference
(Catalogue.CatalogueLine.Item.CatalogueDocumentReference) specification
Name Catalogue.CatalogueLine.Item.CatalogueDo Alternative term OIOUBL_GUIDE_DOCUME
cumentReference NTREF
Definition Information about a Document referred to in another Document
See also OIOUBL_GUIDE_DOCUMENTREF ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
CopyIndicator CopyIndicator Indicator Bilateral 0..1
UUID UUID Identifier Yes 0..1
IssueDate IssueDate Date Yes 0..1
XPath XPath Text Yes 0..n

Subclasses in class CatalogueDocumentReference


(Catalogue.CatalogueLine.Item.CatalogueDocumentReference)
UBL-Name Name Usage Cardi Reference
nality
Attachment Attachment Yes 0..1 3.6.8.7.1

OIOUBL Catalogue - UBL 2.0 Catalogue Side 79


3.6.8.7. Catalogue.CatalogueLine.Item.CatalogueDocumentReference

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition The identifier for the Document being referred to
Example 428.34

CopyIndicator
Fieldname CopyIndicator Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Indicator
Definition Indicates whether the referenced Document is a copy (true) or the original (false)
Example false

UUID
Fieldname UUID Alternative term OIOUBL_GUIDE_UUID
Cardinality 0..1 Usage Yes
Datatype Identifier
Definition A computer-generated universally unique identifier (UUID) for the referenced Document instance
See also OIOUBL_GUIDE_UUID ( G32 )

IssueDate
Fieldname IssueDate Alternative term
Cardinality 0..1 Usage Yes
Datatype Date
Definition The date assigned by the sender of the referenced Document on which the referenced Document was
issued
Example 2006-09-01

XPath
Fieldname XPath Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition Refers to another part of the same document instance
Example /DocumentReference[ID='428.22']

Class Specification

Attachment
Classname Attachment Alternative term
Cardinality 0..1 Usage Yes
Datatype Attachment
Definition An attached document, external refered to, refered in the MIME location or embedded.
See section 3.6.8.7.1

Excluded classes and fields in CatalogueDocumentReference


(Catalogue.CatalogueLine.Item.CatalogueDocumentReference)
Name Name Type
DocumentTypeCode DocumentTypeCode Field
DocumentType DocumentType Field

OIOUBL Catalogue - UBL 2.0 Catalogue Side 80


3.6.8.7.1. Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment

3.6.8.7.1.
Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachme
nt

Attachment (Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment)
specification
Name Catalogue.CatalogueLine.Item.CatalogueDo Alternative term OIOUBL_GUIDE_ATTACHM
cumentReference.Attachment ENT
Definition Information about an attached document. An attachment can be referred to externally (with the URI
element), internally (with the MIME reference element) or contained within the document itself (with the
EmbeddedDocument element).
See also OIOUBL_GUIDE_ATTACHMENT ( OIO )

Fields
UBL-Name Name Datatype Usage Cardinality
EmbeddedDocumentBinaryObject EmbeddedDocumentBinaryObject Binary Object Bilateral 0..1

Subclasses in class Attachment


(Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment)
UBL-Name Name Usage Cardi Reference
nality
ExternalReference ExternalReference Yes 0..1 G30 3.41

Field specifications

EmbeddedDocumentBinaryObject
Fieldname EmbeddedDocumentBinaryObject Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Binary Object
Definition Contains an embedded document as a BLOB,
Businessrules Only allowed if no ExternalReference is specified and if bilateral agreed.
Dependency ../ExternalReference

OIOUBL Catalogue - UBL 2.0 Catalogue Side 81


3.6.8.7.1. Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment

Class Specification

ExternalReference
Classname ExternalReference Alternative term
Cardinality 0..1 Usage Yes
Datatype ExternalReference
Definition An attached document, external refered to, refered in the MIME location or embedded.
Businessrules Used if no EmbeddedDocumentBinaryObject specified
Dependency ../EmbeddedDocumentBinaryObject
See section G30 3.41

Excluded classes and fields in Attachment


(Catalogue.CatalogueLine.Item.CatalogueDocumentReference.Attachment)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 82


3.6.8.8. Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference

3.6.8.8.
Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference

ItemSpecificationDocumentReference
(Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference) specification
Name Catalogue.CatalogueLine.Item.ItemSpecifica Alternative term
tionDocumentReference
Definition Information about a document referred to i another document

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
CopyIndicator CopyIndicator Indicator Bilateral 0..1
UUID UUID Identifier Bilateral 0..1
IssueDate IssueDate Date Yes 0..1
DocumentTypeCode DocumentTypeCode Code Yes 0..1
DocumentType DocumentType Text Yes 0..1
XPath XPath Text Yes 0..n

Subclasses in class ItemSpecificationDocumentReference


(Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference)
UBL-Name Name Usage Cardi Reference
nality
Attachment Attachment Yes 0..1 G30 3.5

OIOUBL Catalogue - UBL 2.0 Catalogue Side 83


3.6.8.8. Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition Identification for the document being referred to

CopyIndicator
Fieldname CopyIndicator Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Indicator
Definition Specifies if the referred document is a copy (true) or the original (false)

UUID
Fieldname UUID Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Identifier
Definition Computer-generated universally unique ID (UUID) for the document instance being referred to

IssueDate
Fieldname IssueDate Alternative term
Cardinality 0..1 Usage Yes
Datatype Date
Definition The issue date for the reference document specified by the sender of the reference document

DocumentTypeCode
Fieldname DocumentTypeCode Alternative term
Cardinality 0..1 Usage Yes
Datatype Code
Definition The document type specified as a code
Businessrules Mandatory if DocumentType is not specified.
Codelist urn:oioubl:codelist:cataloguedocumenttypecode-1.1

DocumentType
Fieldname DocumentType Alternative term
Cardinality 0..1 Usage Yes
Datatype Text
Definition The document type specified as a text
Businessrules Mandatory if DocumentTypecode is not specified.

XPath
Fieldname XPath Alternative term
Cardinality 0..n Usage Yes
Datatype Text
Definition Refers to another part of the same document instance
Businessrules Can only be used if there are no Attached documents
Dependency ../Attachment

Class Specification

Attachment
Classname Attachment Alternative term
Cardinality 0..1 Usage Yes
Datatype Attachment
Definition An externally referred attachment, referred on the MIME-location or embedded
Businessrules Can only be used if no XPath is specified
Dependency ../XPath
See section G30 3.5

OIOUBL Catalogue - UBL 2.0 Catalogue Side 84


3.6.8.8. Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference

Excluded classes and fields in ItemSpecificationDocumentReference


(Catalogue.CatalogueLine.Item.ItemSpecificationDocumentReference)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 85


3.6.8.9. Catalogue.CatalogueLine.Item.CommodityClassification

3.6.8.9. Catalogue.CatalogueLine.Item.CommodityClassification

CommodityClassification (Catalogue.CatalogueLine.Item.CommodityClassification)
specification
Name Catalogue.CatalogueLine.Item.CommodityCl Alternative term
assification
Definition Information about Commodity Classification

Example
<cac:CommodityClassification>
<cbc:ItemClassificationCode listID="UNSPSC" listAgencyID="113"
listVersionID="7.0401">87654321</cbc:ItemClassificationCode>
</cac:CommodityClassification>

Fields
UBL-Name Name Datatype Usage Cardinality
NatureCode NatureCode Code Bilateral 0..1
CargoTypeCode CargoTypeCode Code Bilateral 0..1
CommodityCode CommodityCode Code Yes 0..1
ItemClassificationCode ItemClassificationCode Code Yes 1

Subclasses in class CommodityClassification


(Catalogue.CatalogueLine.Item.CommodityClassification)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 86


3.6.8.9. Catalogue.CatalogueLine.Item.CommodityClassification

Field specifications

NatureCode
Fieldname NatureCode Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Code
Definition The high level nature of Classification issued by a specific maintenance agency expressed as a code

CargoTypeCode
Fieldname CargoTypeCode Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Code
Definition The type of cargo expressed as a code

CommodityCode
Fieldname CommodityCode Alternative term
Cardinality 0..1 Usage Yes
Datatype Code
Definition The harmonized international commodity code for regulatory (customs and trade statistics) purposes.

ItemClassificationCode
Fieldname ItemClassificationCode Alternative term
Cardinality 1 Usage Yes
Datatype Code
Definition The trade commodity classification expressed as a code
Businessrules The same classification must be used for all the Items in a document. UNSPSC version 7.0401 is
recommended
Recommendation UNSPSC version 7.0401 is recommended. For latest version see http://www.gs1.dk/unspscdk3.

Excluded classes and fields in CommodityClassification


(Catalogue.CatalogueLine.Item.CommodityClassification)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 87


3.6.8.10. Catalogue.CatalogueLine.Item.AdditionalItemProperty

3.6.8.10. Catalogue.CatalogueLine.Item.AdditionalItemProperty

AdditionalItemProperty (Catalogue.CatalogueLine.Item.AdditionalItemProperty) specification


Name Catalogue.CatalogueLine.Item.AdditionalIte Alternative term
mProperty
Definition Information about specific ItemProperties.

Fields
UBL-Name Name Datatype Usage Cardinality
Name Name Name Yes 1
Value Value Text Yes 1

Subclasses in class AdditionalItemProperty


(Catalogue.CatalogueLine.Item.AdditionalItemProperty)
UBL-Name Name Usage Cardi Reference
nality
UsabilityPeriod UsabilityPeriod Bilateral 0..1 G30 3.78
ItemPropertyGroup ItemPropertyGroup Yes 0..n 3.6.8.10.1

Field specifications

Name
Fieldname Name Alternative term
Cardinality 1 Usage Yes
Datatype Name
Definition The Name of the ItemProperty
Example Size, Year

Value
Fieldname Value Alternative term
Cardinality 1 Usage Yes
Datatype Text
Definition The value of the ItemProperty
Example XS, 2006

OIOUBL Catalogue - UBL 2.0 Catalogue Side 88


3.6.8.10. Catalogue.CatalogueLine.Item.AdditionalItemProperty

Class Specification

UsabilityPeriod
Classname UsabilityPeriod Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Period
Definition The period in which the ItemProperty is valid
See section G30 3.78

ItemPropertyGroup
Classname ItemPropertyGroup Alternative term
Cardinality 0..n Usage Yes
Datatype ItemPropertyGroup
Definition Information about ItemPropertyGroup
Businessrules Used to specify if a AdditionalItemProperty (attribute) is common or specific to a category. If not
specified the attribute is considered common
See section 3.6.8.10.1

Excluded classes and fields in AdditionalItemProperty


(Catalogue.CatalogueLine.Item.AdditionalItemProperty)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 89


3.6.8.10.1. Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup

3.6.8.10.1.
Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGro
up

ItemPropertyGroup
(Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup) specification
Name Catalogue.CatalogueLine.Item.AdditionalIte Alternative term
mProperty.ItemPropertyGroup
Definition Information about classifications (or groups) of ItemProperties

Fields
UBL-Name Name Datatype Usage Cardinality
ID ID Identifier Yes 1
Name Name Name Bilateral 0..1

Subclasses in class ItemPropertyGroup


(Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 90


3.6.8.10.1. Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup

Field specifications

ID
Fieldname ID Alternative term
Cardinality 1 Usage Yes
Datatype Identifier
Definition An identification for ItemPropertyGroup
Businessrules If the attribute is common to all products the value should be ROOT. If the the attribute only applies to
a distinct category, the value must be the category ID e.g. a UNSPSC code. The ID attributes can be
used to specify the type of ID e.g. schemeName="UNSPSC", schemeVersionID="7.0401" etc.
Example ROOT, 50202203

Name
Fieldname Name Alternative term
Cardinality 0..1 Usage Bilateral
Datatype Name
Definition The Name of the ItemPropertyGroup
Example Wine

Excluded classes and fields in ItemPropertyGroup


(Catalogue.CatalogueLine.Item.AdditionalItemProperty.ItemPropertyGroup)
None

OIOUBL Catalogue - UBL 2.0 Catalogue Side 91

You might also like