EHF Catalogue 1.0

UBL VersionID
Identifies the UBL version on which the transaction instance is based.

Fixed value: 2.1

Customization identifier
Identifies the specification of content and rules that apply to the transaction.

Example value: urn:www.cenbii.eu:transaction:biitrns19:ver2.0:#urn:www.difi.no:ehf:katalog:ver0.99

Profile identifier
Identifies the BII profile or business process context in which the transaction appears.

Example value: urn:www.cenbii.eu:profile:bii01:ver2.0

Catalogue identifier
An catalogue instance must contain an identifier. The identifier enables positive referencing the document instance for various purposes including referencing between transactions that are part of the same process.

Example value: Cat-02

Catalogue action code
Identifies how a received catalogue should be used against existing catalogue lines sent in previous catalogues, so that no discrepancies occur between the suppliers and customers information. Describes how to treat existing items, not part of the received catalogue and those that are included (unchanged, changed or deleted). Default action is to fully replace the source catalogue. Legal values: Add, Update, Delete, Replace Add = New catalogue with all catalogue lines shall be established. If the catalogue allready exists, it must be rejected by the recipients system. Update=Update lines of an existing catalogue. Replace = Replacing the entire catalogue. Delete = Delete the entire catalogue

Example value: Add

Example value: ACTIONCODE:PEPPOL

Catalogue name
A name of the catalogue for general reference. E.g. "Christmas catalogue"

Example value: Spring Catalogue

Catalogue issue date
The date on which the catalogue instance was issued. Format: YYYY-MM-DD

Example value: 2013-04-01

Catalogue version
The version of the catalogue revision. The version ID is used to control how a Catalogue transaction acts on existing lines that are not stated in the transactions. Should they be left alone or deleted. If Catalogue transaction is "Replace" then action codes on the line have no relevance. All existing lines are deleted and the ones stated in the Catalogue transaction added. If Catalogue transaction is „Update“ then action codes on lines control each line.

Example value: v2

Validity period

Period start date
The date on which the period starts. The start date counts as part of the period.

Example value: 2013-04-01

Period end date
The date on which the period ends. The end date counts as part of the period.

Example value: 2013-08-01

Contract

Reference identifier
Positive identification of the reference such as a unique identifier.

Example value: Contract-01

Contract IssueDate
Date of referenced contract.

Example value: 2013-09-15

Reference type
The short description of what is reference such as contract type, document type , meter etc.

Example value: Framework agreement

Source catalogue reference

Source catalogue identifier
Identifies the existing, already received catalogue that this message should be acted upon, so that no discrepancies occur between the suppliers and customers information.

Example value: Cat-01

Provider party

Electronic address ID
A catalogue may contain the providing party electronic address. The address can be of any format and the format should be identified in the message. Organization number for norwegian parties

Example value: 123456789

Party identification

Party identifier
Use in the absence of or in addition to Party Name. Use an identifier known to the document recipient.

Example value: 7080000985698

Party name

Party name
Ise in the absence of or in addition to Party identifier.

Example value: Katalogutsteder AS

Postal address

Address line 1
The main address line in a postal address usually the street name and number.

Example value: Torggata 2

Address line 2
An additional address line in a postal address that can be used to give further details supplementing the main line. Common use are secondary house number in a complex or in a building

City
The common name of the city where the postal address is. The name is written in full rather than as a code.

Example value: Kristiansand

Post Code
The identifier for an addressable group of properties according to the relevant national postal service, such as a ZIP code or Post Code.

Example value: 4634

Country subdivision
For specifying a region, county, state, province etc. within a country by using text.

Country

Country code
The country where the address is. The country should always be given by using ISO code 3166 alpha 2.

Example value: NO

Legal entity

Registration name
The name under which the provider is legally registered

Example value: Aktøren ASA

Company ID
The supplying organisations legal organisation number. For norwegian suppliers: Attributes: schemeID="NO:ORGNR", schemeName="Foretaksregisteret" for companies AS, ASA and NUF, but is recommended for all companies registered in "Foretaksregisteret". schemeAgencyID="82"

Example value: 987654321

Address

City name
The name of the city where the provider is legally registered.

Example value: Oslo

Country

Country code
The country in which the provider is legally registered.

Example value: NO

Receiver party

Electronic address ID
A catalogue may contain the receiving party electronic address. The address can be of any format and the format should be identified in the message. Organization number for norwegian parties

Example value: 923654321

Party identification

Party identifier
Use in the absence of or in addition to Party Name. Use an identifier known to the document recipient.

Example value: 7080000374200

Party name

Party name
Ise in the absence of or in addition to Party identifier.

Example value: Oslo kommune

Postal address

Address line 1
The main address line in a postal address usually the street name and number.

Example value: Mainstreet 13B

Address line 2
An additional address line in a postal address that can be used to give further details supplementing the main line. Common use are secondary house number in a complex or in a building

City
The common name of the city where the postal address is. The name is written in full rather than as a code.

Example value: London

Post Code
The identifier for an addressable group of properties according to the relevant national postal service, such as a ZIP code or Post Code.

Example value: N8 7DY

Country subdivision
For specifying a region, county, state, province etc. within a country by using text.

Country

Country code
The country where the address is. The country should always be given by using ISO code 3166 alpha 2.

Example value: GB

Legal entity

Registration name
The name under which the provider is legally registered

Example value: Aktøren ASA

Company ID
The supplying organisations legal organisation number. For norwegian suppliers: Attributes: schemeID="NO:ORGNR", schemeName="Foretaksregisteret" for companies AS, ASA and NUF, but is recommended for all companies registered in "Foretaksregisteret". schemeAgencyID="82"

Example value: 987654321

Address

City name
The name of the city where the provider is legally registered.

Example value: Oslo

Country

Country code
The country in which the provider is legally registered.

Example value: NO

Supplier

Party

Electronic address ID
A catalogue may contain the receiving party electronic address. The address can be of any format and the format should be identified in the message. Organization number for norwegian parties

Example value: 123456789

Party identification

Party identifier
Use in the absence of or in addition to Party Name. Use an identifier known to the document recipient.

Example value: 7080000985134

Party name

Party name
Use in the absence of or in addition to Party identifier.

Example value: Leverandør AS

Postal address

Address line 1
The main address line in a postal address usually the street name and number.

Example value: Storgata 1

Address line 2
An additional address line in a postal address that can be used to give further details supplementing the main line. Common use are secondary house number in a complex or in a building

City
The common name of the city where the postal address is. The name is written in full rather than as a code.

Example value: Oslo

Post Code
The identifier for an addressable group of properties according to the relevant national postal service, such as a ZIP code or Post Code.

Example value: 0612

Country subdivision
For specifying a region, county, state, province etc. within a country by using text.

Country

Country code
The country where the address is. The country should always be given by using ISO code 3166 alpha 2.

Example value: NO

Contact

Contact person name
The name of the contact person.

Example value: Ole Olsen

Contact telephone name
A phone number for the contact person. If the person has a direct number, this is that number.

Example value: 90123456

Contact fax name
A fax number for the contact persons.

Example value: 90123457

Contact email address
The e-mail address for the contact person. If the person has a direct e-mail this is that email.

Example value: ole.olsen@supplier.no

Supplier

Party

Electronic address ID
A catalogue may contain the receiving party electronic address. The address can be of any format and the format should be identified in the message. Organization number for norwegian parties

Example value: 999888777

Party identification

Party identifier
Use in the absence of or in addition to Party Name. Use an identifier known to the document recipient.

Example value: 7080000374764

Party name

Party name
Use in the absence of or in addition to Party identifier.

Contact

Kjøpers referanse
Name or identifier specifying the customers reference (Eg employee number)

Example value: 1234abc

Contact person name
The name of the contact person.

Example value: Ole Olsen

Contact telephone name
A phone number for the contact person. If the person has a direct number, this is that number.

Contact fax name
A fax number for the contact persons.

Contact email address
The e-mail address for the contact person. If the person has a direct e-mail this is that email.

Trading terms

General payment conditions
Description of general payment conditions.

Catalogue line

Line identifier
Each line must have an identifier that is unique within the document to make it possible to positively reference the line. For example, from other documents.

Example value: ND-19245

Line action code
Used to instruct the catalogue receier on what action should be taken on the identified line when revising a catalogue. See rule on catalogue version ID. When using Update or Delete codes, the entire Catalogue Line is updated or deleted. Legal values: Add, Update, Delete. If Update or Delete are used, this applies to the enitre catalogue line.

Example value: Update

Example value: ACTIONCODE:BII2

Contract subdivision
Reference to subsection of contract

Orderable indicator
Default value is True i.e. Item on the Catalogue Line can be ordered. Can be used to indicate if an Item is temporarily out of stock (via a Catalogue Update).

Example value: True

Orderable indicator
The unit in which the item described in this catalogue line can be ordered. The same item can be described in more than one catalogue line with different orderble units. E.g. catalogue line 1 describes item X that can be ordered in boxes at a given price. Line 2 may describe the same item X as orderable in pallets where the price is lower.

Example value: EA

Item net quantity
The net quantity of the item that is contained in each consumable unit, excluding any packaging materials.

Example value: 250

Order quantity increment
The increment of Orderable units that can be ordered. Default vaule = 1. If orderable unit is box, and order quantity increment is set to 6, this product can only be ordered in 6, 12, 18 etc boxes.

Example value: 12

Minimum order quantity
The minimum number of orderable units that can be ordered according to details provided in the catalogue line, such as price.

Example value: 12

Maximum order quantity
The maximum number of orderable units that can be ordered according to details provided in the catalogue line, such as price.

Example value: 1200

Line warranty information
Warranty information that applies to the catalogue line item.

Packing level
The packing level of the catalogue line.

Example value: GS17009:PEPPOL

Validity period

Period start date
The date on which the period starts. The start dates counts as part of the period. Format: YYYY-MM-DD

Example value: 2013-04-01

Period start date
The date on which the period ends. The end date counts as part of the period. Format: YYYY-MM-DD

Example value: 2013-08-01

Item comparison

Standardized unit price
The item price based on a standarized unit. E.g. Price of each liter. See guideline on Items and packing units in a catalogue.

Standardized unit quantity
The quantity of standard units that are in each consumable unit. E.g. if consumable units are bottles and each bottle contains 0,333 liters the standard unit quantity is 0,333 See guideline on Items and packing units in a catalogue.

Standard unit of measure
The standard unit of measure used to enable comparison of item price to other items. See guideline on Items and packing units in a catalogue.

Component related item

Item identifier
The sellers identifier for the related item.

Example value: dn-1234

Item quantity
The quantity that applies to the relationship.

Example value: CS

Packed units
The prepacking the article is available in inside the orderable unit (next lower level packing), and which contains the number of unit described in PackSizeNumeric. Unit desciption to PackQuantity. The value shoud be a valid UOM code like CS for case.

Accessory related item

Item identifier
The sellers identifier for the related item.

Example value: dn-9876

Item quantity
The quantity that applies to the relationship.

Required related item

Item identifier
The sellers identifier for the related item.

Item quantity
The quantity that applies to the relationship.

Replaced related item

Item identifier
The sellers identifier for the related item.

Item quantity
The quantity that applies to the relationship.

Required item location quantity

Price lead time
The order lead time for the particular location.

Example value: 1

Quantity threshold
Minimum quantity for the given price.

Quantity ceiling
Max quantity for the given price.

Applicable territory address

Address line 1
The main address line in a postal address usually the street name and number.

Address line 2
An additional address line in a postal address that can be used to give further details supplementing the main line. Common use are secondary house number in a complex or in a building.

City
The common name of the city where the postal address is. The name is written in full rather than as a code.

Post Code
The identifier for an addressable group of properties according to the relevant national postal service, such as a ZIP code or Post Code.

Country subdivision
For specifying a region, county, state, province etc. within a country by using text.

Country

Country code
The country where the address is. The country should always be given by using ISO code 3166 alpha 2.

Price

Item net price
The price for the item at the specified locations. The price is given for each orderable unit.

Example value: 200,00

Base quantity
The number of quantity units for which the price is stated.

Example value: 10

Price type
The type of the price so that the receiver knows if the price may be changed, is indicative. When prices are temporary the validity period for the price should be defined by stating the price validity period.

Orderable unit factor rate
The factor used to convert the Base Quantity to an Orderable Unit. Must be specified if the Orderable Unit differs from the Base Quantity. If not present, assumed value is 1.

Validity period

Period start date
The date on which the period starts. The start date counts as part of the period.

Example value: 2013-04-01

Period end date
The date on which the period ends. The end date counts as part of the period.

Example value: 2013-08-01

Item

Item description
A detailed description of the item. Use one description pr. language

Example value: Adhesive Loctite 480 20 g. Black rubber enforced adhesive for gluing of metal to metal or metal to rubber. Especially suitable for applications where the joining is put under cleavage or chock stress. Go to http://www.yoursite.com/pagename.html target=_blank for tips on general usage of this product.

Pack quantity
The number of packed units that are in the orderable unit. E.g. if the orderable unit is a pallet that contains 30 boxes then the packed units are BOX and the packed quantity is 30.

Example value: 30

Consumable unit quantity
Specifies the number of consumable units that are in each orderable unit. See guideline on Items and packing units in a catalogue.

Example value: 12 stk

Item name
A short name for an item. Item name should be a unique name that clearly identifies the product.

Example value: Adhesive Loctite 480 20 g

Item key words
Used to specify searchable keywords and/or synonyms for the Item. E.g. Item Name = Colgate or Total / Keyword =Toothpaste Note that key words should not be too generic, and words allready existing in item name or item description should not be repeated in the key words. If more than one key word is used in the same element, we recommend to use "%" as separator, but this should be agreed with the recipient of the catalogue.

Example value: glue%instant

Brand name
Brand name for the product.

Seller item identification

Seller item identifier
The sellers identifier for the item. A product must be identified with either the sellers item identifier or the standard item identifier, or both.

Example value: 222222

Manufactures item identification

Manufacturers item identifier
The manufacturers identifier for the item.

Example value: Prod-01

Standard item identification

Item standard identifier
A item identifier based on a registered schema. A product must be identified with either the sellers item identifier or the standard item identifier, or both.

Example value: 7330869106661

Document reference

Attachment ID
A positive identification of the relevant document, such as an unique identifier..

External item specifications type
Code for document type

Attachment description
A short description of the document type

Attachment

Attached object
The attached document embedded as binary object.

External reference

URI
URI reference to external item information or specifications. E.g. web address

Example value: http://www.supplierweb.se/123_46.jpg

Country of origin

Item origin country
Used to provide the country from which the item has it's origin. Commonly used in cross border trade for statistical and customs purposes. Based on ISO 3166-1.

Example value: NO

Commodity classification

Item classification code
A classification code used to classify the type or nature of the Item. More than one classifications can be used including UNSPSC code and CPV code.

Example value: 43212105

Transaction conditions

Transaction conditions identifier
When ActionCode = CT, the product is under contract.

Contracted item indicator
Indicates that an the item is offered in accordance to an existing contract.

Example value: True

Hazardous item

Hazardous UNDG code
Provides detail of the classification and nature of a hazardous item. A link to a HMS safety sheet must be provided if there is a hazardous item.

Example value: ABC

Hazard class identifier
Provides detail of the classification and nature of a hazardous item.

Example value: 1234

Classified tax category

Item VAT category code
The VAT code that indicates what VAT details apply to the item.

Example value: S

Item VAT percentage
The VAT percentage rate that applies to the item unless specific trade reasons apply such as exemptions.

Example value: 25

Tax scheme

Tax scheme ID
Tax Scheme ID =VAT

Example value: VAT

Additional item property

Property name
The name of the property. The name must be sufficiently descriptive to define the value. The definition may be supplemented with the property unit of measure when relevant. E.g. Size, Color, Year.

Example value: Size

Property value
The value of the item property. E.g. XXL, Blue, 2007.

Example value: XXL

Property unit of measure
The unit of measure in which the property value is stated, if relevant. May not be relevant when properties are descriptive.

Example value: KG

Property classification
Standardized and predefined classification of items properties.

Example value: Allergen

Manufacturer

Party name

Manufacturer party name
The name of the manufacturer of the item.

Example value: Manufacturer

Item instance

Item best before date
Used to express the best before date of the item or items in the line instance.

Example value: 2013-08-01

Lot identification

Item batch identifier
Identifies the production batch that the item(s) listed in the catalogue line were part of.

Example value: B-10

Certificate

Label name
The name of the product label.

Example value: NEO

Certificate type code
The code type for the label.

Example value: EEL

Certificate type
The label type such environmental, quality, social etc.

Example value: EEL

Label value
The label value that applies to the item.

Example value: Svanemerket

Issuer

Party name

Issuer name
Name of Label issuer.

Example value: Svanemerket

Document reference

Label reference
A reference to where the label specification can be found, e.g. a URI.

Dimension

Dimension ID
Possible values: Weight, Height, Length, Width, Minimum Storage Temperature, Maximum Storage Temperature.

Example value: Weight

Measure (height, length, width, weight)
The vertical height of the orderable unit. The horizontal measure of the longer site of the orderable unit. The horizontal measure of the shorter side of the orderable unit. The weight of the orderable unit incuding its packaging.

Description

Minimum storage temperature
The lower margin of the recommended storage temerature range for the item.

Maximum storage temperature
The upper margin of the recommended storage temerature range for the item.