Docs

Profiles

Extended

Extension of EN16931 for complex processes and French business cases.

This profile constitutes an extension of EN16931 (Comfort) aimed at supporting complex business processes (i.e. invoices which are being invoiced across multiple deliveries or delivery locations, structured terms of payment, further details at item level to facilitate warehousing etc.), and any business case inventoried in France (gathered in a subset named EXTENDED B2B FR and its subset EXTENDED-CTC-FR, as referenced by the French Tax Administration and National Platform PPF – Portail Public de Facturation). This includes additional code lists values which are not part of the European Norm EN 16931 code lists.

Setup the Profile

invoicer.ts
//...
import { EXTENDED } from "node-zugferd/profile/extended"; 
 
export const invoicer = zugferd({
  profile: EXTENDED, 
});

Schema

Extends EN16931 (COMFORT)

testIndicator
Type:boolean
Required:

Test Indicator

The Indicator type may be used when implementing a new system in order to mark the invoice as „test invoice“.

To be used only in case of a test invoice, with Indicator = true

udt:Indicator
name
Type:string
Required:

Document name

Text is the actual wording of anything written or printed. This EN 16931_ Text. Type is based on the Text. Type as defined in ISO 15000-5:2014, Annex B. Line breaks in the text may be present.

ram:Name
copyIndicator
Type:boolean
Required:

Copy Indicator

Indicates if the invoice document is a copy of another invoice document.

With indicator = true, the document is a copy.

udt:Indicator
language
Type:string
Required:

Invoice language code

Indicates the language used in the invoice document.

Valid languages are registered with the ISO 639-2 "Codes for the representation of names of languages" Maintenance Agency.

ram:LanguageID
includedNote
Type:object[]
Required:
contentCode
Type:string
Required:

Free text on header level (qualifying the content)

A code to classify the content of the invoice note.

The code is bilaterally agreed on and must have the same meaning as BT-22.

ram:ContentCode
contractualDueDate
Type:date
Required:

Contractual due date of the invoice

Indication of the due date of the invoice if this differs from the payment.

Information only required if the contractual due date differs from due date of the payment (i.e. for SEPA direct debit).

udt:DateTimeString
transaction
Type:object
Required:
tradeAgreement
Type:object
Required:
seller
Type:object
Required:
typeCode
Type:string
Required:

Seller Role (code)

A code qualifying the role of the party

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:
postalAddress
Type:object
Required:

Seller legal address

Legal address of the seller in case the seller address is different

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
faxNumber
Type:string
Required:

Seller contact fax number

A fax number for the contact point.

ram:CompleteNumber
buyer
Type:object
Required:
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
description
Type:string
Required:

Buyer additional legal information

Additional legal information relevant for the buyer.

Such as share capital.

ram:Description
organization
Type:object
Required:
postalAddress
Type:object
Required:

Detailed information about the business address

Legal address of the buyerr in case the Buyer address is different

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
faxNumber
Type:string
Required:

Buyer contact fax number

A fax number for the contact point.

ram:CompleteNumber
salesAgent
Type:object
Required:

Detailed information about the sales agent

A group of business terms providing information about the Sales Agent

identifier
Type:string
Required:

Sales agent identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Sales agent global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Sales agent global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Sales agent identifier Name / Company Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Sales Agent Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Sales Agent Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

Legal address of the buyer in case the Sales Agent address is different

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information of the deviating end user

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
buyerTaxRepresentative
Type:object
Required:

Detailed information about the buyer tax representative

identifier
Type:string
Required:

Identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Identifier Name / Company Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information of the deviating end user

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
sellerTaxRepresentative
Type:object
Required:
identifier
Type:string
Required:

Identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Legal registration identifier

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Legal registration identifier

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

ram:PersonName
departmentName
Type:string
Required:

Department name

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
productEndUser
Type:object
Required:

Detailed information about the deviating end user

identifier
Type:string
Required:

Deviating end user identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Deviating end user global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating end user global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Deviating end user identifier Name / Company Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information of the deviating end user

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number, value

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address of the deviating end user

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
tradeDeliveryTerms
Type:object
Required:

Details of the delivery conditions

typeCode
Type:string
Required:

Delivery condition (Code)

The code specifying the type of delivery for these trade delivery terms.

To be chosen from the entries in UNTDID 4053 + INCOTERMS List

ram:DeliveryTypeCode
associatedOrderConfirmation
Type:object
Required:
date
Type:date
Required:

Order confirmation date

qdt:DateTimeString
associatedOrder
Type:object
Required:
date
Type:date
Required:

Order Date

qdt:DateTimeString
quotationReference
Type:object[]
Required:

Details on referenced quotation

issuerAssignedID
Type:string
Required:

Quotation number

ram:IssuerAssignedID
date
Type:date
Required:

Document date

qdt:DateTimeString
associatedContract
Type:object
Required:
typeCode
Type:string
Required:

Type of contract (code)

Use codes from UNTDID 1153

CHORUSPRO: To qualify a contract (CT) or a procurement contract "Marché" (BC)

ram:ReferenceTypeCode
date
Type:date
Required:

Contract Date

qdt:DateTimeString
supportingDocuments
Type:object[]
Required:
date
Type:date
Required:

Document date

qdt:DateTimeString
tenderOrLotReference
Type:object[]
Required:
date
Type:date
Required:

Document date

qdt:DateTimeString
objectIdentifier
Type:object[]
Required:
date
Type:date
Required:

Document date

qdt:DateTimeString
buyerAgent
Type:object
Required:

Detailed information about the buyer agent

identifier
Type:string
Required:

Identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Name / Company Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

The identification scheme identifier of the Buyer Agent legal registration identifier.

If the identification scheme is used, it must be selected from the entries in the list published by the ISO/IEC 6523 Maintenance Agency.

value
Type:string
Required:

Company Registration Number

The identification scheme identifier of the Buyer Agent legal registration identifier.

If the identification scheme is used, it must be selected from the entries in the list published by the ISO/IEC 6523 Maintenance Agency.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer Agent legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information of the deviating buyer agent

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
customerOrderReference
Type:object[]
Required:

Details on referenced customer order

issuerAssignedID
Type:string
Required:

Ultimate Customer Order number of the final customer

ram:IssuerAssignedID
date
Type:date
Required:

Document date

qdt:DateTimeString
tradeDelivery
Type:object
Required:
relatedConsignment
Type:object
Required:

Related SupplyChain Consignment

A consignment, at header level, related to this trade delivery.

transportMovement
Type:string
Required:

Specified Logistics Transport Movement

The code specifying the mode, such as air, sea, rail, road or inland waterway, for this logistics transport movement.

ram:SpecifiedLogisticsTransportMovement
deliveryMethod
Type:string
Required:

Delivery method (Code)

A logistics transport movement specified for this supply chain consignment.

ram:ModeCode
shipTo
Type:object
Required:
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035, for instance:

  • DL: Factor
  • DS: Distributor
  • MOP: Market operator
ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Legal registration identifier

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Legal registration identifier

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

ram:PersonName
departmentName
Type:string
Required:

Department name

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information of the goods recipient

identifier
Type:string
Required:

VAT identifier

ram:ID
finalShipTo
Type:object
Required:

Detailed information about the final recipient

identifier
Type:string
Required:

Final recipient identifier

ram:ID
globalIdentifier
Type:object
Required:

Final recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Final recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Final Recipient Name / Company Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address of the final recipient

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
shipFrom
Type:object
Required:

Identification of the deviating sender

identifier
Type:string
Required:

Deviating sender identifier

ram:ID
globalIdentifier
Type:object
Required:

Deviating sender global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating sender global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Deviating sender name / company name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address of the deviating sender

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
despatchAdvice
Type:object
Required:
date
Type:date
Required:

Despatch advice date

qdt:DateTimeString
associatedGoodsReceipt
Type:object
Required:
date
Type:date
Required:

Goods receipt date

qdt:DateTimeString
deliveryNote
Type:object[]
Required:

Detailed information about the corresponding delivery note

issuerAssignedID
Type:string
Required:

Delivery note reference

ram:IssuerAssignedID
date
Type:date
Required:

Delivery note date

qdt:DateTimeString
tradeSettlement
Type:object
Required:
issuerReference
Type:string
Required:

Seller reference number

Given seller reference number for routing purposes after biliteral agreement

ram:InvoiceIssuerReference
invoicer
Type:object
Required:

Deviating invoicing party

identifier
Type:string
Required:

Deviating invoicer identifier

ram:ID
globalIdentifier
Type:object
Required:

Deviating invoicer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating invoicer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
invoicee
Type:object
Required:

Detailed information about the deviating invoice recipient

identifier
Type:string
Required:

Deviating invoice recipient identifier

ram:ID
globalIdentifier
Type:object
Required:

Deviating invoice recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating invoice recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Deviating invoice recipient name / company name

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code) * * The code specifying the type of trade contact * * To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
payee
Type:object
Required:
typeCode
Type:string
Required:

Payee role (code)

A code qualifying the role of the payee

To be chosen from UNTDID 3035, for instance:

  • DL: Factor
ram:RoleCode
organization
Type:object
Required:
tradingName
Type:string
Required:

Trading name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

ram:PersonName
departmentName
Type:string
Required:

Department name

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the payee postal address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed tax information

identifier
Type:string
Required:

VAT identifier

ram:ID
payer
Type:object
Required:

Detailed information about the deviating invoice payer

A group of business terms providing information about the Payer, i.e. the role that makes the payment.

The role of Payer may be fulfilled by another party than the Buyer, e.g. a third Party like a mother company

identifier
Type:string
Required:

Deviating invoice payer identifier

ram:ID
globalIdentifier
Type:object
Required:

Deviating invoice payer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating invoice payer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Payer identifier Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Name/company name of the deviating invoice payer

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Payer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
telephoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Payer Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
tradeCurrencyExchange
Type:object
Required:

Specification of the invoice currency, local currency and exchange rate

invoiceCurrency
Type:string
Required:

Invoice currency

ram:SourceCurrencyCode
localCurrency
Type:string
Required:

Local currency

ram:TargetCurrencyCode
exchangeRate
Type:string | number
Required:

Exchange rate

ram:ConversionRate
exchangeRateDate
Type:date
Required:

Exchange rate date

udt:DateTimeString
vatBreakdown
Type:object[]
Required:
lineTotalBasisAmount
Type:string | number
Required:

Line Total Basis Amount

A monetary value used as the line total basis on which this trade related tax, levy or duty is calculated

ram:LineTotalBasisAmount
allowanceChargeBasisAmount
Type:string | number
Required:

Total amount of charges / allowances on document level

ram:AllowanceChargeBasisAmount
invoicingPeriod
Type:object
Required:
description
Type:string
Required:

Invoicing period description (free text)

ram:Description
allowances
Type:object[]
Required:
calculationSequence
Type:string | number
Required:

Calculation sequence

ram:SequenceNumeric
basisQuantity
Type:object
Required:

Allowance / charge base quantity

value
Type:string | number
Required:

Allowance / charge base quantity

ram:BasisQuantity
unit
Type:string
Required:

Unit code

@unitCode
charges
Type:object[]
Required:
calculationSequence
Type:string | number
Required:

Calculation sequence

ram:SequenceNumeric
baseQuantity
Type:object
Required:

Allowance / charge base quantity

value
Type:string | number
Required:

Allowance / charge base quantity

ram:BasisQuantity
unit
Type:string
Required:

Unit code

@unitCode
logisticsServiceCharge
Type:object[]
Required:
description
Type:string
Required:

Service fee description

ram:Description
amount
Type:string | number
Required:

Service fee amount

ram:AppliedAmount
tradeTax
Type:object
Required:

Detailed tax information

typeCode
Type:string
Required:

Tax type (Code)

ram:TypeCode
categoryCode
Type:string
Required:

VAT category code

Coded identification of a VAT category.

ram:CategoryCode
rateApplicablePercent
Type:string | number
Required:

VAT category rate

ram:RateApplicablePercent
paymentTerms
Type:object
Required:
partialPaymentAmount
Type:string | number
Required:

Partial payment amount

ram:PartialPaymentAmount
penaltyTerms
Type:object[]
Required:

Detailed information about penalties

date
Type:date
Required:

Maturity Reference Date

udt:DateTimeString
datePeriodMeasure
Type:object
Required:

Due date period basis

The period for the due date, e.g. as a number of days (15 days)

value
Type:string | number
Required:

Due date period basis

The period for the due date, e.g. as a number of days (15 days)

ram:BasisPeriodMeasure
unit
Type:string
Required:

Maturity Period, Unit code

@unitCode
basisAmount
Type:string | number
Required:

Payment penalty base amount

ram:BasisAmount
calculationPercent
Type:string | number
Required:

Payment penalty percentage

ram:CalculationPercent
penaltyAmount
Type:string | number
Required:

Payment penalty amount

ram:ActualPenaltyAmount
discountTerms
Type:object[]
Required:

Detailed information about payment discounts

date
Type:date
Required:

Maturity Reference Date

udt:DateTimeString
datePeriodMeasure
Type:object
Required:

Due date period basis

The period for the due date, e.g. as a number of days (15 days)

value
Type:string | number
Required:

Due date period basis

The period for the due date, e.g. as a number of days (15 days)

ram:BasisPeriodMeasure
unit
Type:string
Required:

Maturity Period, Unit code

@unitCode
basisAmount
Type:string | number
Required:

Payment discount base amount

ram:BasisAmount
calculationPercent
Type:string | number
Required:

Payment discount percentage

ram:CalculationPercent
discountAmount
Type:string | number
Required:

Payment discount amount

ram:ActualDiscountAmount
payee
Type:object
Required:

Deviating payee per payment

Group of business terms providing information about the payee, i.e. the role that receives the payment, IN CASE OF MULTIPLE PAYEES

The role of beneficiary may be filled by a party other than the seller, e.g. a factoring service. THIS GROUP IS ONLY USED WHEN THERE ARE MULTIPLE BENEFICIARIES (e.g. withholding tax or split payment).

identifier
Type:string
Required:

Deviating invoice payee identifier

ram:ID
globalIdentifier
Type:object
Required:

Deviating invoice payer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Deviating invoice payer global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Payee scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Name/company name of Payee

The name of the Payee.

Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

ram:Name
typeCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Payee legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
tradingName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
postalAddress
Type:object
Required:

Detailed information about the business address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
tradeContact
Type:object
Required:

Detailed contact information

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
phoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information

identifier
Type:string
Required:

VAT ID

ram:ID
precendingInvoices
Type:object[]
Required:
typeCode
Type:string
Required:

Preceding incoive type code

The same rules apply as for BT-3

ram:TypeCode
buyerAccountant
Type:object
Required:
typeCode
Type:string
Required:

Accounting reference type (Code)

ram:TypeCode
advancePayment
Type:object[]
Required:

Included tax for advanced payment

paidAmount
Type:string | number
Required:

Advanced payment, value

ram:PaidAmount
date
Type:date
Required:

Date of advanced payment

qdt:DateTimeString
tradeTax
Type:object[]
Required:

Tax information on advanced payments

calculatedAmount
Type:string | number
Required:

Included tax

ram:CalculatedAmount
exemptionReason
Type:string
Required:

VAT exemption reason text

A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

ram:ExemptionReason
exemptionReasonCode
Type:string
Required:

VAT exemption reason code

A coded statement of the reason for why the amount is exempted from VAT.

Code list issued and maintained by the Connecting Europe Facility.

ram:ExemptionReasonCode
categoryCode
Type:string
Required:

VAT category code

Coded identification of a VAT category.

The following entries of UNTDID 5305 [6] are used (further clarification between brackets):

  • Standard rate (Liable for VAT in a standard way)
  • Zero rated goods (Liable for VAT with a percentage rate of zero)
  • Exempt from tax (VAT/IGIC/IPSI)
  • VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)
  • VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)
  • Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)
  • Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)
  • Canary Islands General Indirect Tax (Liable for IGIC tax)
  • Liable for IPSI (Ceuta/Melilla tax)
ram:CategoryCode
rateApplicablePercent
Type:string
Required:

VAT category rate

The VAT rate, represented as percentage that applies for the relevant VAT category.

The VAT category code and the VAT category rate shall be consistent.

ram:RateApplicablePercent
precendingInvoice
Type:object
Required:

Precending invoice reference for advance payment

A group of business terms providing information on the advance payment related preceding invoice. The individual invoide shall be stated so that combined payments need to be split per invoice.

To be used in case:

  • preceding partial invoices are refered to from a final invoice
  • preceding pre-payment invoices are refered to from a final invoice
issuerAssignedID
Type:string
Required:

Preceding Invoice reference

The identification of an Invoice that was previously sent by the Seller.

ram:IssuerAssignedID
typeCode
Type:string
Required:

Preceding incoive type code

The same rules apply as for BT-3

ram:TypeCode
date
Type:date
Required:

Preceding Invoice issue date

The date when the Preceding Invoice was issued.

The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.

qdt:DateTimeString
line
Type:object[]
Required:
parentIdentifier
Type:string
Required:

Parent line ID

The value given here refers to the superior line. In this way, a hierarchy tree of invoice items can be mapped.

ram:ParentLineID
typeCode
Type:string
Required:

Type of the inovice line item (Code)

Indicating whether an item includes the prices which must be taken into account when calculating the invoice amount, or whether it only contains information.

Use codes from codelist UNTDID 1229. The following code should be applied per default: 39

ram:LineStatusCode
subTypeCode
Type:string
Required:

Subtype of the invoice line item

Complements the type to clarify whether the invoice item is one of the following:

  • Detail (default positioning)
  • Subtotal
  • Solely information

If the LineStatusCode element is used, the LineStatusReasonCode must be filled in: DETAIL, GROUP, INFORMATION

ram:LineStatusReasonCode
noteContentCode
Type:string
Required:

Free text on line level (code)

A code to classify the content of the invoice note.

The code is agreed bilaterally and must have the same meaning as BT-127.

ram:ContentCode
noteSubjectCode
Type:string
Required:

Invoice line note subject code

To be chosen from the entries in UNTDID 4451 [6].

ram:SubjectCode
tradeProduct
Type:object
Required:
identifier
Type:string
Required:

Product identifier

This identifier can be additionally specified to be interoperable with Order-X.

ram:ID
industryIdentifier
Type:string
Required:

Industry assigned product identifier

An identifier, assigned by the Industry, for the item.

ram:IndustryAssignedID
modelIdentifier
Type:string
Required:

Model identification of the item

A unique model identifier for this item.

ram:ModelID
batchIdentifier
Type:string
Required:

Batch (lot) identification of the item

A batch identifier for this item.

ram:BatchID
brandName
Type:string
Required:

Item brand name

The brand name, expressed as text, for this item.

ram:BrandName
modelName
Type:string
Required:

Item model name

ram:ModelName
attributes
Type:object[]
Required:
typeCode
Type:string
Required:

Item Attribute Type (Code)

To ensure automated processing of the article attributes without bilateral reconciliation, only values from the code list UNTDED 6313+Factur-X-Extension should be used.

ram:TypeCode
measureValue
Type:string | number
Required:

Item Attribute Value (numerical measurand)

ram:ValueMeasure
measureUnit
Type:string
Required:

Unit of measure

@unitCode
classification
Type:object
Required:
name
Type:string
Required:

Classification name

Name used to classify an item according to its type or nature.

ram:ClassName
instances
Type:object[]
Required:

Item (Trade Product) Instances

batchIdentifier
Type:string
Required:

Item (Trade Product) Instances Batch ID

The unique batch identifier for this trade product instance

ram:BatchID
supplierSerialIdentifier
Type:string
Required:

Item (Trade Product) Instances Supplier Serial ID

The unique supplier assigned serial identifier for this trade product instance

ram:SupplierAssignedSerialID
referencedProduct
Type:object[]
Required:

An included product referenced from this trade product.

identifier
Type:string
Required:

ID of Included Referenced Product

Article identifier for interoperability with Order-X

ram:ID
globalIdentifier
Type:object
Required:

Global ID of Included Referenced Product

An item identifier based on a registered scheme.

value
Type:string
Required:

Global ID of Included Referenced Product

An item identifier based on a registered scheme.

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Item standard identifier

The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
sellerAssignedID
Type:string
Required:

SellerAssignedID of Included Referenced Product

An identifier, assigned by the Seller, for the item.

ram:SellerAssignedID
buyerAssignedID
Type:string
Required:

BuyerAssignedID of Included Referenced Product

An identifier, assigned by the Buyer, for the item.

ram:BuyerAssignedID
industryAssignedID
Type:string
Required:

IndustryAssignedID of Included Referenced Product

Article identifier for interoperability with Order-X

ram:IndustryAssignedID
name
Type:string
Required:

Name of Included Referenced Product

ram:Name
description
Type:string
Required:

Description of Included Referenced Product

A description for an item.

The Item description allows for describing the item and its features in more detail than the Item name.

ram:Description
measureValue
Type:string | number
Required:

UnitQuantity of Included Referenced Product

ram:UnitQuantity
measureUnit
Type:string
Required:

Measurement unit

@unitCode
tradeAgreement
Type:object
Required:
sellerOrderReference
Type:object
Required:

Details of an seller order document reference

issuerAssignedID
Type:string | number
Required:

Document number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Referenced position

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
buyerOrderReference
Type:object
Required:
issuerAssignedID
Type:string
Required:

Order Id

ram:IssuerAssignedID
date
Type:date
Required:

Order date

qdt:DateTimeString
quotationReference
Type:object
Required:

Details of an quotation document reference

issuerAssignedID
Type:string
Required:

Document number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Referenced position

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
contractReference
Type:object
Required:

Detailed information on the associated contract

issuerAssignedID
Type:string
Required:

Contract number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Contract position

ram:LineID
date
Type:date
Required:

Contract Date

qdt:DateTimeString
additionalDocument
Type:object[]
Required:

Details of an additional document reference

issuerAssignedID
Type:string
Required:

Document number

ram:IssuerAssignedID
externalLocation
Type:string
Required:

External document location

The URL (Uniform Resource Locator) that identifies where the external document is located.

A means of locating the resource including its primary access mechanism, e.g. http:// or ftp://. External document location shall be used if the Buyer requires additional information to support the Invoice. External documents do not form part of the invoice. Risks can be involved when accessing external documents.

ram:URIID
lineID
Type:string | number
Required:

Referenced position

ram:LineID
typeCode
Type:string
Required:

Type of the document (code)

ram:TypeCode
description
Type:string
Required:

Document description

ram:Name
content
Type:string
Required:

Attached document

An attached document embedded as binary object or sent together with the invoice.

Attached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.

ram:AttachmentBinaryObject
mimeCode
Type:string
Required:

Attached document Mime code

The mime code of the attached document.

@mimeCode
filename
Type:string
Required:

Attached document Filename

The file name of the attached document

@filename
referenceTypeCode
Type:string
Required:

Type of the document reference (code)

ram:ReferenceTypeCode
date
Type:date
Required:

Document date

qdt:DateTimeString
grossTradePrice
Type:object
Required:
discounts
Type:object
Required:
calculationPercent
Type:string | number
Required:

Discount in percent

ram:CalculationPercent
basisAmount
Type:string | number
Required:

Discount base amount

ram:BasisAmount
reasonCode
Type:string
Required:

Reason for the discount (code)

Use entries of the UNTDID 5189 code list [6]. The Invoice line level allowance reason code and the Invoice line level allowance reason shall indicate the same allowance reason.

ram:ReasonCode
reason
Type:string
Required:

Reason for the discount (free text)

ram:Reason
surcharges
Type:object[]
Required:

Price-related surcharges

calculationPercent
Type:string | number
Required:

Charge in percent

ram:CalculationPercent
basisAmount
Type:string | number
Required:

Charge base amount

ram:BasisAmount
actualAmount
Type:string | number
Required:

Charge amount

The surcharge added to the gross price to calculate the net price

Only applies if the surcharge is given per unit and is not included in the gross price.

ram:ActualAmount
reasonCode
Type:string
Required:

Reason for the charge (code)

Use entries of the UNTDID 7161 code list [6]. The Invoice line charge reason code and the Invoice line charge reason shall indicate the same charge reason.

ram:ReasonCode
reason
Type:string
Required:

Reason for the charge (free text)

ram:Reason
netTradePrice
Type:object
Required:
tradeTax
Type:object
Required:

Included tax for B2C

calculatedAmount
Type:string | number
Required:

Included tax for B2C

ram:CalculatedAmount
exemptionReason
Type:string
Required:

VAT exemption reason text

A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

ram:ExemptionReason
exemptionReasonCode
Type:string
Required:

VAT exemption reason code

A coded statement of the reason for why the amount is exempted from VAT.

Code list issued and maintained by the Connecting Europe Facility.

ram:ExemptionReasonCode
categoryCode
Type:string
Required:

VAT category code

Coded identification of a VAT category.

The following entries of UNTDID 5305 [6] are used (further clarification between brackets):

  • Standard rate (Liable for VAT in a standard way)
  • Zero rated goods (Liable for VAT with a percentage rate of zero)
  • Exempt from tax (VAT/IGIC/IPSI)
  • VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)
  • VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)
  • Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)
  • Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)
  • Canary Islands General Indirect Tax (Liable for IGIC tax)
  • Liable for IPSI (Ceuta/Melilla tax)
ram:CategoryCode
rateApplicablePercent
Type:string | number
Required:

VAT category rate

The VAT rate, represented as percentage that applies for the relevant VAT category.

The VAT category code and the VAT category rate shall be consistent.

ram:RateApplicablePercent
customerOrderReference
Type:object[]
Required:

Details on referenced customer order

issuerAssignedID
Type:string
Required:

Order number of the final customer

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Order item (ultimate customer)

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
tradeDelivery
Type:object
Required:
chargeFreeQuantity
Type:object
Required:

Quantity, without charge

value
Type:string | number
Required:

Quantity, without charge

ram:ChargeFreeQuantity
unit
Type:string
Required:

Unit of measure

@unitCode
packageQuantity
Type:object
Required:

Package quantity

value
Type:string | number
Required:

Package quantity

ram:PackageQuantity
unit
Type:string
Required:

Unit of measure

@unitCode
shipTo
Type:object
Required:

Detailed information on the deviating goods recipient

identifier
Type:string
Required:

Goods recipient identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Goods recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Goods recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

ShipTo name

ram:Name
roleCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

ShipTo details about the organization

identifier
Type:object
Required:

ShipTo Legal ID

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

ShipTo Legal ID

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
businessName
Type:string
Required:

Trading Business Name

This may be used if different from the party name.

ram:TradingBusinessName
tradeContact
Type:object
Required:

Detailed contact information of the goods recipient

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
telephoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address of the goods recipient

postCode
Type:string | number
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
city
Type:string
Required:

City

The common name of the city, town or village.

ram:CityName
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information of the goods recipient

identifier
Type:string
Required:

VAT ID

ram:ID
deviatingShipTo
Type:object
Required:

Detailed information on the deviating final recipient

identifier
Type:string
Required:

Final recipient identifier

A previously exchanged assigned identifier of the business partner.

ram:ID
globalIdentifier
Type:object
Required:

Final recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

value
Type:string
Required:

Final recipient global identifier

GlobalID, if a global identifier exists and can be determined in the @schemeID, otherwise use ID

ram:GlobalID
schemeIdentifier
Type:string
Required:

Scheme identifier

If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

@schemeID
name
Type:string
Required:

Final Recipient Name / Company Name

ram:Name
roleCode
Type:string
Required:

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

ram:RoleCode
organization
Type:object
Required:

Details about the organization

identifier
Type:object
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

value
Type:string
Required:

Company Registration Number

An identifier issued by an official registrar that identifies the party as a legal entity or person.

ram:ID
schemeIdentifier
Type:string
Required:

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.

@schemeID
businessName
Type:string
Required:

Trading Business Name

A name by which the party is known, other than party name (also known as business name).

This may be used if different from the party name.

ram:TradingBusinessName
tradeContact
Type:object
Required:

Detailed contact information of the final goods recipient

name
Type:string
Required:

Name of the contact

If a contact person is indicated, either the name or the department is to be transmitted.

ram:PersonName
departmentName
Type:string
Required:

Department name

If a contact person is indicated, either the name or the department is to be transmitted.

ram:DepartmentName
typeCode
Type:string
Required:

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

ram:TypeCode
telephoneNumber
Type:string
Required:

Contact telephone number

A phone number for the contact point.

ram:CompleteNumber
faxNumber
Type:string
Required:

Contact point fax number

ram:CompleteNumber
emailAddress
Type:string
Required:

Contact email address

An e-mail address for the contact point.

ram:URIID
postalAddress
Type:object
Required:

Detailed information about the address of the final goods recipient

postCode
Type:string
Required:

Post code

The identifier for an addressable group of properties according to the relevant postal service.

Such as a ZIP code or a post code.

ram:PostcodeCode
line1
Type:string
Required:

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

ram:LineOne
line2
Type:string
Required:

Address line 2

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

ram:LineTwo
line3
Type:string
Required:

Address line 3

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

ram:LineThree
countryCode
Type:string
Required:

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

ram:CountryID
countrySubdivision
Type:string
Required:

Country subdivision

The subdivision of a country.

Such as a region, a county, a state, a province, etc.

ram:CountrySubDivisionName
electronicAddress
Type:object
Required:

Details about the electronic address

value
Type:string
Required:

Electronic address

ram:URIID
schemeIdentifier
Type:string
Required:

Scheme identifier

@schemeID
taxRegistration
Type:object
Required:

Detailed information on tax information of the final goods recipient

identifier
Type:string
Required:

VAT ID

ram:ID
information
Type:object
Required:

Detailed information about the actual delivery

deliveryDate
Type:date
Required:

Actual delivery date for this line

The VAT relevant date of delivery and achievement must be specified on the level of document.

udt:DateTimeString
despatchAdvice
Type:object
Required:

Detailed information on the corresponding despatch advice

issuerAssignedID
Type:string
Required:

Despatch advice number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Despatch advice item

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
receivingAdvice
Type:object
Required:

Detailed information on the corresponding goods receipt

issuerAssignedID
Type:string
Required:

Goods receipt number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Goods receipt item

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
deliveryNote
Type:object
Required:

Detailed information about the corresponding delivery note

issuerAssignedID
Type:string
Required:

Delivery note number

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Delivery note item

ram:LineID
date
Type:date
Required:

Document date

qdt:DateTimeString
tradeSettlement
Type:object
Required:
tradeTax
Type:object
Required:
calculatedAmount
Type:string | number
Required:

Tax amount

Specification only for taxes that are not VAT

ram:CalculatedAmount
exemptionReason
Type:string
Required:

VAT exemption reason text

A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

ram:ExemptionReason
exemptionReasonCode
Type:string
Required:

VAT exemption reason code

A coded statement of the reason for why the amount is exempted from VAT.

Code list issued and maintained by the Connecting Europe Facility.

ram:ExemptionReasonCode
monetarySummation
Type:object
Required:
chargeTotalAmount
Type:string | number
Required:

Total amount of line item charges

ram:ChargeTotalAmount
allowanceTotalAmount
Type:string | number
Required:

Total amount of line item allowances

ram:AllowanceTotalAmount
taxTotalAmount
Type:string | number
Required:

Total amount of line item taxes

ram:TaxTotalAmount
grandTotalAmount
Type:string | number
Required:

Total line item gross amount

ram:GrandTotalAmount
totalAllowanceChargeAmount
Type:string | number
Required:

Total amount of allowances / charges

ram:TotalAllowanceChargeAmount
precendingInvoices
Type:object[]
Required:

Precending invoice reference

A group of business terms providing information on one or more preceding Invoices.

To be used in case:

  • a preceding invoice is corrected
  • preceding partial invoices are refered to from a final invoice
  • preceding pre-payment invoices are refered to from a final invoice
issuerAssignedID
Type:string
Required:

Preceding Invoice reference

The identification of an Invoice that was previously sent by the Seller.

ram:IssuerAssignedID
lineID
Type:string | number
Required:

Referenced position

ram:LineID
typeCode
Type:string
Required:

Preceding incoive type code

Can be used in case of final invoive after prepaid invoice, in order to refernce the previous prepaid invoices. Codelist UNCL 1001 restricted like BT-3.

ram:TypeCode
date
Type:date
Required:

Preceding Invoice issue date

The date on which the preceding Invoice was issued.

The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.

qdt:DateTimeString
buyerAccountant
Type:object
Required:
typeCode
Type:string
Required:

Accounting reference (Code)

ram:TypeCode

On this page