Docs

Profiles

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.

import { EXTENDED, type ProfileExtended } from "node-zugferd/profile/extended";

Basic Usage

Setup the Profile

First configure the zugferd instance (invoicer) to use the Extended profile. This defines the standard and complexity level of the invoice.

invoicer.ts
import { EXTENDED } from "node-zugferd/profile/extended"; 

export const invoicer = zugferd({
  profile: EXTENDED, 
});

Define Invoice Data

Now define the actual invoice content, including all required fields of the profile, using the ProfileExtended type for type safety.

import { ProfileExtended } from "node-zugferd/profile/extended";

const data: ProfileExtended = {
  number: "INV-001",
  // ...
};

Create Invoice

Use the previously created instance (invoicer) to generate the invoice from your data. You can either:

  • Generate standalone XML
  • Embed the XML inside a PDF/A-3b compliant file.
import fs from "fs";
import { invoicer } from "./invoicer";

const invoice = invoicer.create(data);

// Only generate xml
const xml = await invoice.toXML();

// Or embed xml in a PDF-A/3b
const pdf = fs.readFileSync("./your/invoice.pdf");
const pdfA = await invoicer.embedInPdf(pdf); 

🎉 That's it

Your invoice is now ready! You've successfully created a ZUGFeRD invoice using the Extended profile.

Schema

Extends EN16931 (COMFORT)

Type:string
Required:
Type:boolean
Required:
udt:Indicator

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

Type:string
Required:
ram:Name

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.

Type:boolean
Required:
udt:Indicator

Copy Indicator

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

With indicator = true, the document is a copy.

Type:string
Required:
ram:LanguageID

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.

Type:object[]
Required:
Type:string
Required:
ram:ContentCode

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.

Type:date
Required:
udt:DateTimeString

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

Type:object
Required:
Type:object
Required:
Type:object
Required:
Type:string
Required:
ram:RoleCode

Seller Role (code)

A code qualifying the role of the party

To be chosen from UNTDID 3035.

Type:object
Required:
Type:object
Required:

Seller legal address

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

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:
Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Seller contact fax number

A fax number for the contact point.

Type:object
Required:
Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:string
Required:
ram:Description

Buyer additional legal information

Additional legal information relevant for the buyer.

Such as share capital.

Type:object
Required:
Type:object
Required:

Detailed information about the business address

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

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:
Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Buyer contact fax number

A fax number for the contact point.

Type:object
Required:

Detailed information about the sales agent

A group of business terms providing information about the Sales Agent

Type:string
Required:
ram:ID

Sales agent identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Sales agent global identifier

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

Type:string
Required:
ram:GlobalID

Sales agent global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Sales agent identifier Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Sales Agent Registration Number

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

Type:string
Required:
ram:ID

Sales Agent Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

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

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information of the deviating end user

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Detailed information about the buyer tax representative

Type:string
Required:
ram:ID

Identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Global identifier

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

Type:string
Required:
ram:GlobalID

Global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Identifier Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information of the deviating end user

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:
Type:string
Required:
ram:ID

Identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Global identifier

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

Type:string
Required:
ram:GlobalID

Global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Legal registration identifier

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

Type:string
Required:
ram:ID

Legal registration identifier

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

Type:string
Required:
ram:DepartmentName

Department name

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information about the deviating end user

Type:string
Required:
ram:ID

Deviating end user identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Deviating end user global identifier

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

Type:string
Required:
ram:GlobalID

Deviating end user global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Deviating end user identifier Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

Scheme identifier

The identification scheme identifier of the Buyer legal registration identifier.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information of the deviating end user

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number, value

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address of the deviating end user

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Details of the delivery conditions

Type:string
Required:
ram:DeliveryTypeCode

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

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

Order confirmation date

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

Order Date

Type:object[]
Required:

Details on referenced quotation

Type:string
Required:
ram:IssuerAssignedID

Quotation number

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:string
Required:
ram:ReferenceTypeCode

Type of contract (code)

Use codes from UNTDID 1153

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

Type:date
Required:
qdt:DateTimeString

Contract Date

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

Document date

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

Document date

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

Document date

Type:object
Required:

Detailed information about the buyer agent

Type:string
Required:
ram:ID

Identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Global identifier

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

Type:string
Required:
ram:GlobalID

Global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

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.

Type:string
Required:
ram:ID

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.

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information of the deviating buyer agent

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object[]
Required:

Details on referenced customer order

Type:string
Required:
ram:IssuerAssignedID

Ultimate Customer Order number of the final customer

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:object
Required:

Related SupplyChain Consignment

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

Type:string
Required:
ram:SpecifiedLogisticsTransportMovement

Specified Logistics Transport Movement

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

Type:string
Required:
ram:ModeCode

Delivery method (Code)

A logistics transport movement specified for this supply chain consignment.

Type:object
Required:
Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035, for instance:

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

Details about the organization

Type:object
Required:

Legal registration identifier

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

Type:string
Required:
ram:ID

Legal registration identifier

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

Type:string
Required:
ram:DepartmentName

Department name

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information of the goods recipient

Type:string
Required:
ram:ID

VAT identifier

Type:object
Required:

Detailed information about the final recipient

Type:string
Required:
ram:ID

Final recipient identifier

Type:object
Required:

Final recipient global identifier

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

Type:string
Required:
ram:GlobalID

Final recipient global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Final Recipient Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address of the final recipient

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Identification of the deviating sender

Type:string
Required:
ram:ID

Deviating sender identifier

Type:object
Required:

Deviating sender global identifier

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

Type:string
Required:
ram:GlobalID

Deviating sender global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Deviating sender name / company name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address of the deviating sender

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

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

Despatch advice date

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

Goods receipt date

Type:object[]
Required:

Detailed information about the corresponding delivery note

Type:string
Required:
ram:IssuerAssignedID

Delivery note reference

Type:date
Required:
qdt:DateTimeString

Delivery note date

Type:object
Required:
Type:string
Required:
ram:InvoiceIssuerReference

Seller reference number

Given seller reference number for routing purposes after biliteral agreement

Type:object
Required:

Deviating invoicing party

Type:string
Required:
ram:ID

Deviating invoicer identifier

Type:object
Required:

Deviating invoicer global identifier

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

Type:string
Required:
ram:GlobalID

Deviating invoicer global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Detailed information about the deviating invoice recipient

Type:string
Required:
ram:ID

Deviating invoice recipient identifier

Type:object
Required:

Deviating invoice recipient global identifier

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

Type:string
Required:
ram:GlobalID

Deviating invoice recipient global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Deviating invoice recipient name / company name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

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

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:
Type:string
Required:
ram:RoleCode

Payee role (code)

A code qualifying the role of the payee

To be chosen from UNTDID 3035, for instance:

  • DL: Factor
Type:object
Required:
Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

Type:string
Required:
ram:DepartmentName

Department name

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the payee postal address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed tax information

Type:string
Required:
ram:ID

VAT identifier

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

Type:string
Required:
ram:ID

Deviating invoice payer identifier

Type:object
Required:

Deviating invoice payer global identifier

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

Type:string
Required:
ram:GlobalID

Deviating invoice payer global identifier

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:Name

Name/company name of the deviating invoice payer

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Payer Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Specification of the invoice currency, local currency and exchange rate

Type:string
Required:
ram:SourceCurrencyCode

Invoice currency

Type:string
Required:
ram:TargetCurrencyCode

Local currency

Type:string | number
Required:
ram:ConversionRate

Exchange rate

Type:date
Required:
udt:DateTimeString

Exchange rate date

Type:object[]
Required:
Type:string | number
Required:
ram:LineTotalBasisAmount

Line Total Basis Amount

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

Type:string | number
Required:
ram:AllowanceChargeBasisAmount

Total amount of charges / allowances on document level

Type:object
Required:
Type:string
Required:
ram:Description

Invoicing period description (free text)

Type:object[]
Required:
Type:string | number
Required:
ram:SequenceNumeric

Calculation sequence

Type:object
Required:

Allowance / charge base quantity

Type:string | number
Required:
ram:BasisQuantity

Allowance / charge base quantity

Type:string
Required:
@unitCode

Unit code

Type:object[]
Required:
Type:string | number
Required:
ram:SequenceNumeric

Calculation sequence

Type:object
Required:

Allowance / charge base quantity

Type:string | number
Required:
ram:BasisQuantity

Allowance / charge base quantity

Type:string
Required:
@unitCode

Unit code

Type:object[]
Required:
Type:string
Required:
ram:Description

Service fee description

Type:string | number
Required:
ram:AppliedAmount

Service fee amount

Type:object
Required:

Detailed tax information

Type:string
Required:
ram:TypeCode

Tax type (Code)

Type:string
Required:
ram:CategoryCode

VAT category code

Coded identification of a VAT category.

Type:string | number
Required:
ram:RateApplicablePercent

VAT category rate

Type:object
Required:
Type:string | number
Required:
ram:PartialPaymentAmount

Partial payment amount

Type:object[]
Required:

Detailed information about penalties

Type:date
Required:
udt:DateTimeString

Maturity Reference Date

Type:object
Required:

Due date period basis

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

Type:string | number
Required:
ram:BasisPeriodMeasure

Due date period basis

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

Type:string
Required:
@unitCode

Maturity Period, Unit code

Type:string | number
Required:
ram:BasisAmount

Payment penalty base amount

Type:string | number
Required:
ram:CalculationPercent

Payment penalty percentage

Type:string | number
Required:
ram:ActualPenaltyAmount

Payment penalty amount

Type:object[]
Required:

Detailed information about payment discounts

Type:date
Required:
udt:DateTimeString

Maturity Reference Date

Type:object
Required:

Due date period basis

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

Type:string | number
Required:
ram:BasisPeriodMeasure

Due date period basis

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

Type:string
Required:
@unitCode

Maturity Period, Unit code

Type:string | number
Required:
ram:BasisAmount

Payment discount base amount

Type:string | number
Required:
ram:CalculationPercent

Payment discount percentage

Type:string | number
Required:
ram:ActualDiscountAmount

Payment discount amount

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

Type:string
Required:
ram:ID

Deviating invoice payee identifier

Type:object
Required:

Deviating invoice payer global identifier

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

Type:string
Required:
ram:GlobalID

Deviating invoice payer global identifier

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:Name

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.

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed information about the business address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Detailed contact information

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information

Type:string
Required:
ram:ID

VAT ID

Type:object[]
Required:
Type:string
Required:
ram:TypeCode

Preceding incoive type code

The same rules apply as for BT-3

Type:object
Required:
Type:string
Required:
ram:TypeCode

Accounting reference type (Code)

Type:object[]
Required:

Included tax for advanced payment

Type:string | number
Required:
ram:PaidAmount

Advanced payment, value

Type:date
Required:
qdt:DateTimeString

Date of advanced payment

Type:object[]
Required:

Tax information on advanced payments

Type:string | number
Required:
ram:CalculatedAmount

Included tax

Type:string
Required:
ram:ExemptionReason

VAT exemption reason text

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

Type:string
Required:
ram:ExemptionReasonCode

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.

Type:string
Required:
ram:CategoryCode

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)
Type:string
Required:
ram:RateApplicablePercent

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.

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
Type:string
Required:
ram:IssuerAssignedID

Preceding Invoice reference

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

Type:string
Required:
ram:TypeCode

Preceding incoive type code

The same rules apply as for BT-3

Type:date
Required:
qdt:DateTimeString

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.

Type:object[]
Required:
Type:string
Required:
ram:ParentLineID

Parent line ID

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

Type:string
Required:
ram:LineStatusCode

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

Type:string
Required:
ram:LineStatusReasonCode

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

Type:string
Required:
ram:ContentCode

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.

Type:string
Required:
ram:SubjectCode

Invoice line note subject code

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

Type:object
Required:
Type:string
Required:
ram:ID

Product identifier

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

Type:string
Required:
ram:IndustryAssignedID

Industry assigned product identifier

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

Type:string
Required:
ram:ModelID

Model identification of the item

A unique model identifier for this item.

Type:string
Required:
ram:BatchID

Batch (lot) identification of the item

A batch identifier for this item.

Type:string
Required:
ram:BrandName

Item brand name

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

Type:string
Required:
ram:ModelName

Item model name

Type:object[]
Required:
Type:string
Required:
ram:TypeCode

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.

Type:string | number
Required:
ram:ValueMeasure

Item Attribute Value (numerical measurand)

Type:string
Required:
@unitCode

Unit of measure

Type:object
Required:
Type:string
Required:
ram:ClassName

Classification name

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

Type:object[]
Required:

Item (Trade Product) Instances

Type:string
Required:
ram:BatchID

Item (Trade Product) Instances Batch ID

The unique batch identifier for this trade product instance

Type:string
Required:
ram:SupplierAssignedSerialID

Item (Trade Product) Instances Supplier Serial ID

The unique supplier assigned serial identifier for this trade product instance

Type:object[]
Required:

An included product referenced from this trade product.

Type:string
Required:
ram:ID

ID of Included Referenced Product

Article identifier for interoperability with Order-X

Type:object
Required:

Global ID of Included Referenced Product

An item identifier based on a registered scheme.

Type:string
Required:
ram:GlobalID

Global ID of Included Referenced Product

An item identifier based on a registered scheme.

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:SellerAssignedID

SellerAssignedID of Included Referenced Product

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

Type:string
Required:
ram:BuyerAssignedID

BuyerAssignedID of Included Referenced Product

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

Type:string
Required:
ram:IndustryAssignedID

IndustryAssignedID of Included Referenced Product

Article identifier for interoperability with Order-X

Type:string
Required:
ram:Name

Name of Included Referenced Product

Type:string
Required:
ram:Description

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.

Type:string | number
Required:
ram:UnitQuantity

UnitQuantity of Included Referenced Product

Type:string
Required:
@unitCode

Measurement unit

Type:object
Required:
Type:object
Required:

Details of an seller order document reference

Type:string | number
Required:
ram:IssuerAssignedID

Document number

Type:string | number
Required:
ram:LineID

Referenced position

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:string
Required:
ram:IssuerAssignedID

Order Id

Type:date
Required:
qdt:DateTimeString

Order date

Type:object
Required:

Details of an quotation document reference

Type:string
Required:
ram:IssuerAssignedID

Document number

Type:string | number
Required:
ram:LineID

Referenced position

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:

Detailed information on the associated contract

Type:string
Required:
ram:IssuerAssignedID

Contract number

Type:string | number
Required:
ram:LineID

Contract position

Type:date
Required:
qdt:DateTimeString

Contract Date

Type:object[]
Required:

Details of an additional document reference

Type:string
Required:
ram:IssuerAssignedID

Document number

Type:string
Required:
ram:URIID

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.

Type:string | number
Required:
ram:LineID

Referenced position

Type:string
Required:
ram:TypeCode

Type of the document (code)

Type:string
Required:
ram:Name

Document description

Type:string
Required:
ram:AttachmentBinaryObject

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.

Type:string
Required:
@mimeCode

Attached document Mime code

The mime code of the attached document.

Type:string
Required:
@filename

Attached document Filename

The file name of the attached document

Type:string
Required:
ram:ReferenceTypeCode

Type of the document reference (code)

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:object
Required:
Type:string | number
Required:
ram:CalculationPercent

Discount in percent

Type:string | number
Required:
ram:BasisAmount

Discount base amount

Type:string
Required:
ram:ReasonCode

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.

Type:string
Required:
ram:Reason

Reason for the discount (free text)

Type:object[]
Required:

Price-related surcharges

Type:string | number
Required:
ram:CalculationPercent

Charge in percent

Type:string | number
Required:
ram:BasisAmount

Charge base amount

Type:string | number
Required:
ram:ActualAmount

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.

Type:string
Required:
ram:ReasonCode

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.

Type:string
Required:
ram:Reason

Reason for the charge (free text)

Type:object
Required:
Type:object
Required:

Included tax for B2C

Type:string | number
Required:
ram:CalculatedAmount

Included tax for B2C

Type:string
Required:
ram:ExemptionReason

VAT exemption reason text

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

Type:string
Required:
ram:ExemptionReasonCode

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.

Type:string
Required:
ram:CategoryCode

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)
Type:string | number
Required:
ram:RateApplicablePercent

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.

Type:object[]
Required:

Details on referenced customer order

Type:string
Required:
ram:IssuerAssignedID

Order number of the final customer

Type:string | number
Required:
ram:LineID

Order item (ultimate customer)

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:object
Required:

Quantity, without charge

Type:string | number
Required:
ram:ChargeFreeQuantity

Quantity, without charge

Type:string
Required:
@unitCode

Unit of measure

Type:object
Required:

Package quantity

Type:string | number
Required:
ram:PackageQuantity

Package quantity

Type:string
Required:
@unitCode

Unit of measure

Type:object
Required:

Detailed information on the deviating goods recipient

Type:string
Required:
ram:ID

Goods recipient identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Goods recipient global identifier

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

Type:string
Required:
ram:GlobalID

Goods recipient global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

ShipTo name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

ShipTo details about the organization

Type:object
Required:

ShipTo Legal ID

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

Type:string
Required:
ram:ID

ShipTo Legal ID

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

Trading Business Name

This may be used if different from the party name.

Type:object
Required:

Detailed contact information of the goods recipient

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address of the goods recipient

Type:string | number
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CityName

City

The common name of the city, town or village.

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information of the goods recipient

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Detailed information on the deviating final recipient

Type:string
Required:
ram:ID

Final recipient identifier

A previously exchanged assigned identifier of the business partner.

Type:object
Required:

Final recipient global identifier

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

Type:string
Required:
ram:GlobalID

Final recipient global identifier

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

Type:string
Required:
@schemeID

Scheme identifier

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

Type:string
Required:
ram:Name

Final Recipient Name / Company Name

Type:string
Required:
ram:RoleCode

Role (code)

A code qualifying the role

To be chosen from UNTDID 3035.

Type:object
Required:

Details about the organization

Type:object
Required:

Company Registration Number

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

Type:string
Required:
ram:ID

Company Registration Number

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

Type:string
Required:
@schemeID

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.

Type:string
Required:
ram:TradingBusinessName

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.

Type:object
Required:

Detailed contact information of the final goods recipient

Type:string
Required:
ram:PersonName

Name of the contact

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

Type:string
Required:
ram:DepartmentName

Department name

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

Type:string
Required:
ram:TypeCode

Type of contact (code)

The code specifying the type of trade contact

To be chosen from the entries of UNTDID 3139

Type:string
Required:
ram:CompleteNumber

Contact telephone number

A phone number for the contact point.

Type:string
Required:
ram:CompleteNumber

Contact point fax number

Type:string
Required:
ram:URIID

Contact email address

An e-mail address for the contact point.

Type:object
Required:

Detailed information about the address of the final goods recipient

Type:string
Required:
ram:PostcodeCode

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.

Type:string
Required:
ram:LineOne

Address line 1

The main address line in an address.

Usually the street name and number or post office box.

Type:string
Required:
ram:LineTwo

Address line 2

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

Type:string
Required:
ram:LineThree

Address line 3

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

Type:string
Required:
ram:CountryID

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

Type:string
Required:
ram:CountrySubDivisionName

Country subdivision

The subdivision of a country.

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

Type:object
Required:

Details about the electronic address

Type:string
Required:
ram:URIID

Electronic address

Type:string
Required:
@schemeID

Scheme identifier

Type:object
Required:

Detailed information on tax information of the final goods recipient

Type:string
Required:
ram:ID

VAT ID

Type:object
Required:

Detailed information about the actual delivery

Type:date
Required:
udt:DateTimeString

Actual delivery date for this line

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

Type:object
Required:

Detailed information on the corresponding despatch advice

Type:string
Required:
ram:IssuerAssignedID

Despatch advice number

Type:string | number
Required:
ram:LineID

Despatch advice item

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:

Detailed information on the corresponding goods receipt

Type:string
Required:
ram:IssuerAssignedID

Goods receipt number

Type:string | number
Required:
ram:LineID

Goods receipt item

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:

Detailed information about the corresponding delivery note

Type:string
Required:
ram:IssuerAssignedID

Delivery note number

Type:string | number
Required:
ram:LineID

Delivery note item

Type:date
Required:
qdt:DateTimeString

Document date

Type:object
Required:
Type:object
Required:
Type:string | number
Required:
ram:CalculatedAmount

Tax amount

Specification only for taxes that are not VAT

Type:string
Required:
ram:ExemptionReason

VAT exemption reason text

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

Type:string
Required:
ram:ExemptionReasonCode

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.

Type:object
Required:
Type:string | number
Required:
ram:ChargeTotalAmount

Total amount of line item charges

Type:string | number
Required:
ram:AllowanceTotalAmount

Total amount of line item allowances

Type:string | number
Required:
ram:TaxTotalAmount

Total amount of line item taxes

Type:string | number
Required:
ram:GrandTotalAmount

Total line item gross amount

Type:string | number
Required:
ram:TotalAllowanceChargeAmount

Total amount of allowances / charges

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
Type:string
Required:
ram:IssuerAssignedID

Preceding Invoice reference

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

Type:string | number
Required:
ram:LineID

Referenced position

Type:string
Required:
ram:TypeCode

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.

Type:date
Required:
qdt:DateTimeString

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.

Type:object
Required:
Type:string
Required:
ram:TypeCode

Accounting reference (Code)