ZF23INVHT - Invoice header

HTKEY

required

VARCHAR(15)

Internal Pagination Number

Internal Page number

HTPDF

optional

VARCHAR(200)

PDF Name

Name of the generated PDF file (if HTNAPPREF = "ZUGFERD"). If the field is left blank, a default name is generated according to the pattern "ZUGFERD_<invoice number>_timestamp".

HTTEMPLDIR

optional

VARCHAR(100)

Template Directory Name

Name of the folder containing the templates for generating the PDF. If the field is left blank, the standard template included in the delivery will be used.

HTDIRECT

required

CHAR(4)

Direction of the ZUGFeRD

*IN oder *OUT

HTNTESTCH

optional

VARCHAR(5)

Test Indicator, value

“true” or empty

HTNPROCESS

required

VARCHAR(255)

Rule or standard

Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.

HTNBPROCESS

required

VARCHAR(255)

Business process type or data standard

HTNAPPFMT

required

VARCHAR(10)

Format

HTNAPPREF

required

VARCHAR(255)

Specification identifier

An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.

XRECHNUNG
ZUGFERD
PEPPOL

HTNAPPVER

required

VARCHAR(10)

Version

HTNDOCNR

required

VARCHAR(35)

Invoice number

A unique identification of the Invoice.

HTNDOCTC

required

VARCHAR(255)

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.

HTNDOCT

required

CHAR(3)

Invoice type code

A code specifying the functional type of the Invoice.

HTNDOCD

required

DATE '0001-01-01'

Invoice issue date

The date when the Invoice was issued.

HTNMSGFUNC

optional

CHAR(5)

Copy indicator, value

Only required if it is not a multiple item with identical content.

LALLNG

optional

CHAR(3)

Invoice language code

Indicates the language used in the invoice document.

HTNPAYD

required

DATE '0001-01-01'

Contractual due date of the invoice, value

HTGBYREF

optional

VARCHAR(46)

Buyer reference

An identifier assigned by the Buyer used for internal routing purposes.

HTGDPTERM

optional

VARCHAR(3)

Delivery condition (Code)

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

HTGORDERNR

required

VARCHAR(35)

Sales order reference

An identifier of a referenced sales order, issued by the Seller.

HTGORDERD

optional

DATE '0001-01-01'

Order confirmation date, value

Details regarding the order confirmation date

HTGCORDNR

required

VARCHAR(35)

Purchase order reference

An identifier of a referenced purchase order, issued by the Buyer.

HTGCORDD

optional

DATE '0001-01-01'

Order Date, value

HTGCONTRNR

required

VARCHAR(35)

Contract reference

The identification of a contract.

HTGCONTRD

optional

DATE '0001-01-01'

Contract date, value

HTSPPID

required

VARCHAR(1000)

Project reference

The identification of the project the invoice refers to.

HTSPPNA

required

VARCHAR(35)

Project name

The identification of the project the invoice refers to

HTLDTD

required

DATE '0001-01-01'

Actual delivery date

The date on which the supply of goods or services was made or completed.

HTLDANR

required

VARCHAR(25)

Despatch advice reference

An identifier of a referenced despatch advice.

HTLDALD

optional

DATE '0001-01-01'

Despatch advice date, value

HTLWDANR

required

VARCHAR(25)

Receiving advice reference

An identifier of a referenced receiving advice.

HTLWDALD

optional

DATE '0001-01-01'

Goods receipt date, value

HTLDLSNR

required

VARCHAR(35)

Delivery note reference

HTLDLSD

optional

DATE '0001-01-01'

Delivery note date, value

HTZGPCID

optional

VARCHAR(35)

Creditor ID, Bank assigned creditor identifier

Creditor identification
Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.

HTZGPZR

empfohlen

VARCHAR(200)

Remittance information

A textual value used to establish a link between the payment and the Invoice, issued by the Seller.

HTZGPTC

optional

VARCHAR(5)

VAT accounting currency code

The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.

HTZGPIC

required

VARCHAR(5)

Invoice currency code

The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.

HTZGPIRN

optional

INTEGER

Seller reference number

HTZITDREID

optional

VARCHAR(35)

Identifier of the Invoicing party Trade partner

Identifier

HTZITDGLN

optional

VARCHAR(35)

Global identifier of the Invoicing party Trade partner

Globaler Identifier

HTZITDGLNT

required wenn HTZITDGLN gefüllt ist.

CHAR(5)

Type of global Identifier

Type of global identification number

HTZTASC

required

CHAR(5)

Invoice currency

HTZTATC

required

CHAR(5)

Local currency

HTZTACR

required

DECIMAL(10, 5)

Exchange rate

HTZTACD

optional

DATE '0001-01-01'

Exchange rate date, value

HTZBILLPD

optional

VARCHAR(50)

Invoicing period description (free text)

HTZBILLBP

optional

VARCHAR(15)

Invoicing period start date

The date when the Invoice period starts.

HTZBILLBPF

required wenn HTZBILLBP gefüllt ist.

CHAR(3)

Date, format

HTZBILLEP

optional

VARCHAR(15)

Invoicing period end date

The date when the Invoice period ends.

HTZBILLEPF

required wenn HTZBILLEP gefüllt ist.

CHAR(3)

Date, format

HTZTSMSLT

required

DECIMAL(15, 2)

Sum of Invoice line net amount

Sum of all Invoice line net amounts in the Invoice.

HTZTSMSCT

optional

DECIMAL(15, 2)

Sum of charges on document level

Sum of all charges on document level in the Invoice.

HTZTSMSAT

optional

DECIMAL(15, 2)

Sum of allowances on document level

Sum of all allowances on document level in the Invoice.

HTZTSMSTB1

required

DECIMAL(15, 2)

Invoice total amount without VAT

The total amount of the Invoice without VAT.

HTZTSMSTB2

optional

DECIMAL(15, 2)

Tax basic amount 2

Total invoice amount excluding VAT 2

HTZTSMSTT1

required

DECIMAL(15, 2)

Invoice total VAT amount

The total VAT amount for the Invoice.

Invoice currency code

HTZTSMSTT2

optional

DECIMAL(15, 2)

Invoice total VAT amount in accounting currency

The VAT total amount expressed in the accounting currency accepted or required in the country of the Seller.

optional

VAT accounting currency code

HTZTSMSRA

optional

DECIMAL(15, 2)

Rounding amount

The amount to be added to the invoice total to round the amount to be paid.

HTZTSMSGT1

required

DECIMAL(15, 2)

Invoice total amount with VAT

The total amount of the Invoice with VAT.

HTZTSMSTPA

optional

DECIMAL(15, 2)

Paid amount

The sum of amounts which have been paid in advance.

HTZTSMSDPA

required

DECIMAL(15, 2)

Amount due for payment

The outstanding amount that is requested to be paid.

HTSTATE

VARCHAR(1)

State of Order

Status Column

HTSESSUM

DECIMAL(15, 0)

i-effect Session Number

i-effect session number

EXTERNAL_RECIPIENT

CHAR(255)

Externer Empfänger für SNDFILE

i-effect recipient from the partner master

EXTERNAL_ORIGINATOR

CHAR(255)

Externer Absender für SNDFILE

i-effect sender from the partner master

HTNTESTCH

/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:TestIndicator/udt:Indicator

BT-X-1

true / false

HTNPROCESS

/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:BusinessProcessSpecifiedDocumentContextParameter/ram:ID

BT-23

To be specifid by the Buyer.

HTNAPPREF

/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:GuidelineSpecifiedDocumentContextParameter/ram:ID

BT-24

This identifies compiance or conformance to this document. Conformant invoices specify: urn:cen.eu:en16931:2017. Invoices, compliant to a user specification may identify that user specification here. No identification scheme is to be used.

HTNDOCNR

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:ID

BT-1

The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller . It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.

HTNDOCTC

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:Name

BT-X-2

HTNDOCT

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:TypeCode

BT-3

Commercial invoices and credit notes are defined according the entries in UNTDID 1001 [6].
Other  entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.

HTNDOCD

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString

BT-2

HTNMSGFUNC

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:CopyIndicator/udt:Indicator

BT-X-3

true / false

LALLNG

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:LanguageID

BT-X-4

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

HTNPAYD

/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:EffectiveSpecifiedPeriod/ram:CompleteDateTime/udt:DateTimeString

BT-X-6

HTGBYREF

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerReference

BT-10

The identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.

HTGDPTERM

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:DeliveryTypeCode

BT-X-145

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

HTGORDERNR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerOrderReferencedDocument/ram:IssuerAssignedID

BT-14

HTGORDERD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerOrderReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-146

HTGCORDNR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerOrderReferencedDocument/ram:IssuerAssignedID

BT-13

HTGCORDD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerOrderReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-147

HTGCONTRNR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ContractReferencedDocument/ram:IssuerAssignedID

BT-12

The contract identifier should be unique in the context of the specific trading relationship and for a defined time period.

HTGCONTRD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ContractReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-148

HTSPPID

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:ID

BT-11

HTSPPNA

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:Name

BT-11-0

Default = "Project reference"

HTLDTD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString

BT-72

HTLDANR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:IssuerAssignedID

BT-16

HTLDALD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-200

HTLWDANR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ReceivingAdviceReferencedDocument/ram:IssuerAssignedID

BT-15

HTLWDALD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ReceivingAdviceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-201

HTLDLSNR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:DeliveryNoteReferencedDocument/ram:IssuerAssignedID

BT-X-202

HTLDLSD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:DeliveryNoteReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

BT-X-203

HTZGPCID

CreditorReferenceID

BG19

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceID

BT-90

Used in order to pre-notify the Buyer of a SEPA direct debit.

HTZGPZR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReference

BT-83

Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. When specifying the textual value, which is commonly the invoice number of the invoice being paid, but may be another seller reference, the buyer should indicate this reference in his payment order when executing the payment. In a payment transaction this reference is transferred back to the Seller as Remittance Information.

In order to allow for automatic processing of cross-border SEPA payments, only Latin characters should be used in this field, with a maximum of 140 characters. Referencesection 1.4 of the SEPA credit transfer and SEPA direct debit scheme implementation guides [13] and [14] for details of the allowed characters. Other rules may apply for SEPA payments within national borders.

If remittance information is structured according to the ISO 11649:2009 standard [16] for Structured RF Creditor Reference, it shall be mapped to the Structured Remittance Information Creditor Reference field in SEPA payments messages.
If remittance information is structured according to the EACT standard for automated reconciliation [17], it shall be mapped to the Unstructured Remittance Information field in SEPA payments messages.”

If remittance information is to be mapped to the End To End Identification field or to the Structured Remittance Information Creditor Reference field in SEPA payments messages, then in addition to the Latin character set restriction, the content shall not start or end with a '/' and the content shall not contain '//'s. See reference [15].

HTZGPTC

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxCurrencyCode

BT-6

Shall be used in combination with the Total VAT amount in accounting currency (BT-111) when the VAT accounting currency code differs from the Invoice currency code.
The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds". Please refer to Article 230 of the Council Directive 2006/112/EC [2] for more information.

HTZGPIC

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCode

BT-5

Only one currency shall be used in the Invoice, except for the Total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT.
The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds".

HTZGPIRN

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceIssuerReference

BT-X-204

Given seller reference number for routing purposes after biliteral agreement

HTZITDREID

ID

HTZITDGLN

GlobalID

HTZITDGLNT

schemeID

HTZTASC

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:SourceCurrencyCode

BT-X-258

HTZTATC

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:TargetCurrencyCode

BT-X-259

HTZTACR

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRate

BT-X-260

HTZTACD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRateDateTime/udt:DateTimeString

BT-X-261

HTZBILLPD

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:Description

BT-X-264

HTZBILLBP

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString

BT-73

The initial date of delivery of goods or services.

HTZBILLBPF

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString/@format

BT-73-0

Only value "102"

HTZBILLEP

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString

BT-74

The date on which the delivery of goods or services was completed.

HTZBILLEPF

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString/@format

BT-74-0

Only value "102"

HTZTSMSLT

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:LineTotalAmount

BT-106

HTZTSMSCT

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:ChargeTotalAmount

BT-108

Charges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

HTZTSMSAT

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:AllowanceTotalAmount

BT-107

Allowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

HTZTSMSTB1

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxBasisTotalAmount

BT-109

The Invoice total amount without VAT is the Sum of Invoice line net amount minus Sum of allowances on document level plus Sum of charges on document level.

HTZTSMSTB2

HTZTSMSTT1

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount[@currencyID=../../ram:InvoiceCurrencyCode]

BT-110

The Invoice total VAT amount is the sum of all VAT category tax amounts.

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount[@currencyID=../../ram:InvoiceCurrencyCode]/@currencyID

BT-110-0

HTZTSMSTT2

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount[@currencyID=../../ram:TaxCurrencyCode]

BT-111

To be used when the VAT accounting currency (BT-6) differs from the Invoice currency code (BT-5) in accordance with article 230 of Directive 2006/112 / EC on VAT. The VAT amount in accounting currency is not used in the calculation of the Invoice totals.

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount[@currencyID=../../ram:TaxCurrencyCode]/@currencyID

BT-111-0

HTZTSMSRA

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:RoundingAmount

BT-114

HTZTSMSGT1

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:GrandTotalAmount

BT-112

The Invoice total amount with VAT is the Invoice total amount without VAT plus the Invoice total VAT amount.

HTZTSMSTPA

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TotalPrepaidAmount

BT-113

This amount is subtracted from the invoice total amount with VAT to calculate the amount due for payment.

HTZTSMSDPA

/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:DuePayableAmount

BT-115

This amount is the Invoice total amount with VAT minus the paid amount that has been paid in advance. The amount is zero in case of a fully paid Invoice. The amount may be negative; in that case the Seller owes the amount to the Buyer.