Peppol Catalogue transaction 3.2 (T19)

Specification identification
Identifies the specification of content and rules that apply to the transaction.

Example value: urn:fdc:peppol.eu:poacc:trns:catalogue:3

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

Example value: urn:fdc:peppol.eu:poacc:bis:catalogue_wo_response:3

Catalogue identifier
A catalogue instance must contain an identifier which enables the document instance to be uniquely referenced 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.

Example value: Add

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: 2018-05-31

Catalogue version
The version of the catalogue revision. The version ID is used to controll 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 controll each line.

Example value: v2

Catalogue validity period
The period during which the content of the catalogue is valid and can be used for trade.

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

Example value: 2018-05-31

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

Example value: 2019-05-31

Contract reference
The identification of a contract.

Contract identifier
A reference that uniquely identifies a contract that relates to this transaction.

Example value: Contract-01

Source Catalogue reference
The identification of a source catalogue

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

Catalogue provider
The party that sends the catalogue. The seller or a catalogue repository.

Provider party electronic address
Identifies the provider party's electronic address

Example value: 7300010000001

Scheme identifier
Scheme identifier for the electronic address

Example value: 0088

Party Identification

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

Example value: 12345678

Scheme identifier
Scheme identifier of the Provider identification

Example value: 0184

Provider Postal Address
A group of business terms providing information about the address of the Catalogue Provider.

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

Example value: Main street 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.

Example value: Building 23

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: N12 W34

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

Address Line

Address line 3
An additional address line in an address that can be used to give further details supplementing the main line.

Example value: Use gate 34

Country

Catalogue Provider Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: DK

Party Legal Entity

Provider legal registration name
The name under which the provider is legally registered.

Example value: Povider Party name

Provider legal registration identifier
A catalogue may contain the identifier assigned to the party by the national company registrar.

Example value: 8346294

Provider legal registration identifier identification scheme identifier
The identification scheme identifier of the provider legal registration identifier.

Example value: 0002

Registration Address

Provider legal registration city
The name of the city where the provider is legally registered.

Example value: London

Country

Catalogue Provider Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: GB

Catalogue receiver
The party to which the catalogue is sent. Buyer or a catalogue repository on his behalf.

Reciever party electronic address
Identifies the receiver party's electronic address

Example value: 7300010000001

Scheme identifier
Scheme identifier for the electronic address

Example value: 0088

Party Identification

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

Example value: 45645678

Scheme identifier
Scheme identifier for Receiver identifier

Example value: 0184

Postal address

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

Example value: Hovedgaten 12

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.

Example value: 3rd floor

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: Copenhagen

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: 98798

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

Example value: Jylland

Address line

Address line 3
An additional address line in an address that can be used to give further details supplementing the main line.

Example value: Building 1

Country

Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: DK

Party legal entity

Receiver legal registration name
The name under which the receiver is legally registered.

Example value: Registration name

Receiver legal registration identifier
A catalogue may contain the identifier assigned to the party by the national company registrar.

Example value: 239478234

Provider legal registration identifier identification scheme identifier
The identification scheme identifier of the provider legal registration identifier.

Example value: 0002

Registration address

Receiver legal registration city
The name of the city where the receiver is legally registered.

Example value: Stockholm

Country

Receiver legal registration country
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: SE

Catalogue supplier
The party that provides the items specified in the catalogue.

Party

Supplier party electronic address
Identifies the supplier party's electronic address

Example value: 7300010000001

Scheme identifier
Scheme identifier for the electronic address

Example value: 0088

Party identification

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

Example value: 11223344

Scheme identifier
Scheme identifier for Catalogue supplier identifier

Example value: 0184

Party name

Catalogue supplier trading name
Use in the absence of or in addition to Party Identifier.

Example value: Supplier

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.

Address Line

Address line 3
An additional address line in an address that can be used to give further details supplementing the main line.

Example value: 3rd line

Country

Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: NO

Catalogue supplier contact

Contact person name
The name of the contact person.

Example value: Ole Olsen

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

Example value: 90123456

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

Catalogue customer
The party who may order from the catalogue.

Party

Customer party electronic address
Identifies the customer party's electronic address

Example value: 7300010000001

Scheme identifier
Scheme identifier for the electronic address

Example value: 0088

Party identification

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

Example value: DK93287241

Scheme identifier
Scheme identifier for Catalogue customer identifier

Example value: 0184

Party name

Catalogue customer trading name
Use in the absence of or in addition to Party Identifier.

Example value: Customer

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.

Address Line

Address line 3
An additional address line in an address that can be used to give further details supplementing the main line.

Example value: 3rd line

Country

Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: NO

Contact

Contact person name
The name of the contact person.

Example value: Jens Olesen

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

Example value: 29347213412

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: jens.olesen@test.dk

Trading terms

General payment conditions
Information about the general payment conditions

Example value: Net within 30 days

Catalogue line
Catalogue line content

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: 1

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.

Example value: Update

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 unit
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: 10

Item net quantity unit of measure
The unit of measure that applies to the item net quantity

Example value: C62

Order quantity increment
The increment of Orderable units that can be ordered.

Example value: 1

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: 1

Minimum order quantity unit of measure
The unit of measure that applies to the minimum order quantity

Example value: C62

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: 100

Maximum order quantity unit of measure
The unit of measure that applies to the maximum order quantity

Example value: C62

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

Packaging level
The packing level of the catalogue line.

Example value: TU

Catalogue line validity period
The period during which the information in the catalogue line is valid. An orderable catalogue item is no longer orderable after the validity period expires. Used for example for promotional items or prices.

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

Example value: 2018-05-31

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

Example value: 2019-05-31

Item comparison

Standardized unit price
The item price based on a standarized unit. E.g. Price of each liter.

Currency identifier
Mandatory attribute

Example value: EUR

Standard unit quantity
The quantity of standard units that are in each consumable unit.

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.

Item quantity
The quantity that applies to the relationship.

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 XCS for case.

Example value: XCS

Accessory related item

Item identifier
The sellers identifier for the related item.

Item quantity
The quantity that applies to the relationship.

Related item unit
The packaging unit for related items. The value shoud be a valid UOM code like XCS for case.

Example value: XCS

Required related item

Item identifier
The sellers identifier for the related item.

Item quantity
The quantity that applies to the relationship.

Required item units
The packaging unit for required related items. The value shoud be a valid UOM code like XCS for case.

Example value: XCS

Replaced related item

Item identifier
The sellers identifier for the related item.

Item quantity
The quantity that applies to the relationship.

Replaced item units
The packaging unit for replaced items. The value shoud be a valid UOM code like XCS for case.

Example value: XCS

Required Item Location Quantity

Price lead time
The time from when the order is placed until the item is available for delivery from the sellers' premises or at the applicable address specified for the price.

Lead time units
The lead time units for price lead time. The value shoud be a valid UOM code like DAY for days.

Example value: XCS

Quantity threshold
Used to indicate the threshold quantity for the given price

Quantity threshold units
The quantity units for minimum quantity. The value shoud be a valid UOM code like XCS for case.

Example value: XCS

Quantity ceiling
Used to indicate maximum quantity for given price.

Quantity ceiling units
The quantity units for ceiling quantity. The value shoud be a valid UOM code like XCS for case.

Example value: XCS

Applicable terriroty address
Used to give location information related to the price

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.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.For specifying a region, county, state, province etc. within a country by using text.

Address Line

Address line 3
An additional address line in an address that can be used to give further details supplementing the main line.

Country

Country code
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: DK

Price

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

Mandatory attribute

Example value: EUR

Item price base quantity
The number of item units to which the price applies

Example value: 1

Item price base quantity unit of measure code
The unit of measure that applies to the Item price base quantity.

Example value: XCS

Price type
The type of the item price. The type may be given by using codes from UN/CEFACT code list 5387. When prices are temporary the validity period for the price should be defined by stating the price validity period.

OrderableUnit FactorRate
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

Price validity period

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

Example value: 2018-05-31

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

Example value: 2019-05-31

Item information

Item description
Free-form field that can be used to give a text description of the item. A detailed description of the item.

Example value: Office chair by John Doe.

Packed 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

Packed quantity unit of measure code
The unit of measure that applies to the packed quantity.

Example value: XCS

Consumable unit quantity
Specifies the number of consumable units that are in each orderable unit.

Item name
A short name for an item.

Example value: Office chair

Item key words
Used to specify searchable keywords and/or synonyms for the Item. E.g. Item Name = Colgate or Total / Keyword =Toothpaste

Example value: Toothpaste

Brand name
A Brand name for the item

Buyer item identification

Buyers item identifier
An identifier, assigned by the buyer, for the item. Associates the item with its identification according to the buyer's system.

Example value: 111111

Sellers item identification

The Sellers item identifier
An identifier, assigned by the seller, for the item. Associates the item with its identification according to the seller's system.

Example value: 3249834

Manufacturer item identification

Manufacturers item identifer
The manufacturers identifier for the item.

Example value: Prod-01

Standard item identification

Item standard identifier
An item identifier based on a registered scheme. Associates the item with its identification according to a standard system.

Example value: 05704066204093

Item standard identifier identification scheme identifier
The identification scheme identifier of the Item standard identifier

Example value: 0160

Item specification document reference

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

Example value: 12

External Item Specifications Type
A functional description of the attachment/image expressed as code

Attached item description
A short description of the document type.

Attachment

Attached object
The attached document embeded as binary object, coded as Base64. The binary object has two supplementary components: a Mime Code, which specifies the Mime type of the attachment and a Filename that is provided by (or on behalf of) the sender of the document

Example value: QklTIE9yZGVyIEFncmVlbWVudCAtIDQyQQ==

Attached object Mime code
The mime code of the attached document

Example value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Attached document Filename
The file name of the attached document

Example value: Hours-spent.xls

External reference

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

Example value: http://www.test.no/image.jpg

Origin country

Item origin country
A code that identifies the country.The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions". Codes must be according to the alpha-2 representation.

Example value: DK

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.

Item classification identifier identification scheme identifier
The identification scheme identifier of the Item classification identifier

Example value: MP

Item classification identifier version identification scheme identifier
The identification scheme version identifier of the Item classification identifier

Example value: 20.0601

Clear text name equivalent of classification code
The textual equivalent of the code value

Example value: Office furniture

Contracted item

Contracted item indicator
The code CT indicates that the item is offered in accordance to the referenced contract.

Fixed value: CT

Hazardous Item

Hazardous item UNDG code
The identifier assigned to transportable hazardous goods by the United Nations, expressed as a code.

Haszardous hazard class Identifier
Identifies a hazard class applicable to dangerous goods as defined by the relevant regulation authority, such as the IMDG Class Number of the SOLAS Convention of IMO and the ADR/RID Class Number for the road/rail environment.

Classified tax category

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

Example value: S

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

Example value: 25

Tax scheme information

Tax scheme. E.g. “VAT” or “GST”

Example value: VAT or GST

Additional item property
A group of business terms providing information about properties of the goods and services invoiced.

Item 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.

Example value: Size

Item property code
Code for the item property according to a property code system.

Name code list id.
An identifier for the code list used for the Name code, this is bilaterally agreed

Item property value
The value of the item property.

Example value: XXL

Item 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: 5

Value quantity unit of measure
The unit of measure that applies to the value quantity.

Example value: XCS

Property classification
Standardized and predefined classification of items properties.

Example value: Allergen

Manufacturer party

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: 2018-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

Item label information
Information about the items environmental, social, ethical and quality type of labelling.

Item label name
The name of the product label.

Example value: EU EcoLabel

Certificate type code
The UBL structure used for item labeling requires this elements, use the value NA.

Fixed value: NA

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

Example value: Environmental

Item label value
The label value that applies to the item.

Example value: Svanemerket

Issuer party information

Party name

Issuer name
The UBL structure used for item labeling requires this elements, use the value NA.

Example value: NA

Label document

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

Example value: http://www.label.eu/test/

Dimension

Attribute Id
Height - The vertical height of the orderable unit. Length - The horizontal measure of the longer site of the orderable unit. Width - The horizontal measure of the shorter side of the orderable unit. Weight - The weight of the orderable unit incuding its packaging. Package Net weight approximately. Package Net weight exact. Package volume.

Example value: LN

Measure
The measure for the dimension attribute

Measure unit code
The unit code of the measurement

Example value: CMT

Dimension description
Used for differentiating between measures with same attributeID

Minimum storage temperature or minimum Storage Humidity
The lower margin of the recommended storage temerature range for the item.

Measure unit code
The unit code of the minimum storage humidity or temperature

Example value: CMT

Maximum storage temperature or maximum Storage Humidity
The upper margin of the recommended storage temerature range for the item.

Measure unit code
The unit code of the maximum storage humidity or temperature

Example value: CMT