Skip to main content
Skip table of contents

Important information about changed processes (from i-effect 3.1.13 onwards)

There are a few changes to the process when using i-effect (from version 3.1.14 onwards).

New control fields in the header file

The fields described below in header file ZF23INVHT have been modified and/or added. When reading or writing these fields, please note the following information

Field

Sample content

Explanation

HTNAPPREF

ZUGFERD
XRECHNUNG
PEPPOL

This is interface data from or for the ZUGFeRD format.
This is interface data from or for the XRECHNUNG format.
This is interface data from or for the PEPPOL BIS billing format.

HTNAPPVER

2.3.2
2.3.3
2.1.1
3.0.2
3.0.1
2.3.1
2.2.0
2.1.1
3.0

ZUGFeRD Version 2.3.2
ZUGFeRD Version 2.3.3
ZUGFeRD Version 2.1.1
XRECHNUNG Version 3.0.2
XRECHNUNG Version 3.0.1
XRECHNUNG Version 2.3.1
XRECHNUNG Version 2.2.0
XRECHNUNG Version 2.1.1
PEPPOL Version 3.0

HTNAPPFMT

UBL
CII
COMFORT
EXTENDED
XRECHNUNG

Data originates from or is intended for the presentation of an XRECHNUNG invoice in Universal Business Language (UBL) format.
Data originates from or is intended for the presentation of an XRECHNUNG invoice in CII (Cross Industry Invoice) format.
Data originates from or is intended for the presentation of a ZUGFeRD invoice in COMFORT profile.
Data originates from or is intended for the presentation of a ZUGFeRD invoice in EXTENDED profile.
Data originates from or is intended for the display of a ZUGFeRD invoice in the XRECHNUNG profile.

HTNPROCESS

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

Identification

Type

urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended

ZUGFERD 2.3.3

urn:cen.eu:en16931:2017

ZUGFERD 2.3.3

urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0

XRECHNUNG CII / UBL 3.0.2

urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0#conformant#urn:xeinkauf.de:kosit:extension:xrechnung_3.0

XRECHNUNG CII / UBL 3.0.2

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.3

XRECHNUNG CII / UBL 2.3.1

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.3#conformant#urn:xoev-de:kosit:extension:xrechnung_2.3

XRECHNUNG CII / UBL 2.3.1

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.2

XRECHNUNG CII / UBL 2.2.0

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.2#conformant#urn:xoev-de:kosit:extension:xrechnung_2.2

XRECHNUNG CII / UBL 2.2.0

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.1

XRECHNUNG CII / UB L2.1.1

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.1#conformant#urn:xoev-de:kosit:extension:xrechnung_2.1

XRECHNUNG CII / UBL 2.1.1

urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0

PEPPOL UBL INVOICE 3.0
PEPPOL UBL CREDITNOTE 3.0

urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.0

XRECHNUNG CII / UBL 2.0.0

MANDANT

01

The field can be used to select or mark data records for different organisations.
When processing output data, only data records that correspond to the specified value in the transferred variable MANDANT are selected. If the parameter is omitted, all data records are selected.

CUSTOM1

DE

A field that can be assigned its own value when a message is received by specifying PARMS( (CUSTOM1 'DE')).

CUSTOM2

01735

A field that can be assigned its own value when a message is received by specifying PARMS( (CUSTOM2 '01735')).

CUSTOM3

A

A field that can be assigned its own value when a message is received by specifying PARMS( (CUSTOM3 'A')).

HTDIRECT

*OUT
*IN

Data for generating files
Imported data

HTSTATE

empty = to be processed (HTDIRECT='*OUT') or has been read in and not yet processed (HTDIRECT='*IN')
1 = successfully processed
2 = processing error

EXTERNAL_ORIGINATOR

Name of a different sender identification defined in the master data of i-effect and to be used for sending this data. See Send ZUGFeRD or xRechnung invoices with SNDFILE

EXTERNAL_RECIPIENT

Name of a different recipient identification defined in the master data of i-effect and to be used for sending this data. See Send ZUGFeRD or xRechnung invoices with SNDFILE

PDF template and existing PDF files

It is possible to create a PDF, which is combined with the generated XML during mapping, using a template or to use an existing PDF file for the ZUGFeRD PDF. Which method is chosen depends on the content of the database fields HTTEMPLDIR and HTPDF:

Field

Contents

Function

HTTEMPLDIR

extended
comfort

The folder name of the template to be used to generate a PDF. The folder must be located under /home/ieffect/zugferd/templates. If the field is empty, the template folder matching the mapping is used automatically.

This parameter is used to access your own templates in a separate folder.

HTPDF

/home/ieffect/pdf/zugferd.pdf

zugferd.pdf

The path to an existing PDF file or the name of the PDF to be created.

If a complete path (with a leading / ) is specified, no PDF is created, but an attempt is made to use the specified PDF for combining XML and PDF.

If only a file name (including file extension) is specified, the PDF is created using a template and is given the specified name. The file is created in the output directory specified in the RUNMAP command.

If the field is empty, a name is automatically generated according to this pattern:
ZUGFeRD_<COMFORT|EXTENDED><DOCUMENT NUMBER><UNIQUE>.pdf
In this case, the file is created in the directory specified in the RUNMAP parameter.

Standardised call parameters for generating e-invoices

  • The special value %FILENAME% is now used for both XRechnungen and ZUGFeRD documents in the call to trigger the automatic generation of unique file names.

  • The names of the mappings have been standardised and the mappings adapted to the new database structure.

When using version 3.1.13 of i-effect, the appropriate mappings must be requested and imported. They are not included in the scope of delivery of i-effect.

Example:

To create invoices in ZUGFeRD format, version 2.3.3, EXTENDED profile, for all data records in the interface that have a '01' in the client field:

CODE 
RUNMAP 
  MAPID('ZUGFERD_2.3.3_EXTENDED_OUT') 
  FS(*NONE)
  TOPATH('/home/ieffect/data/out/%FILENAME%') 
  ERRPATH('/home/ieffect/data/out/error') 
  ARCPATH('/home/ieffect/data/out/archive') 
  PARMS((MANDANT '01'))

To create invoices in ZUGFeRD format, version 2.3.2, EXTENDED profile, for all data records in the interface that have a '01' in the client field:

CODE 
RUNMAP 
  MAPID('ZUGFERD_2.3.2_EXTENDED_OUT') 
  FS(*NONE)
  TOPATH('/home/ieffect/data/out/%FILENAME%') 
  ERRPATH('/home/ieffect/data/out/error') 
  ARCPATH('/home/ieffect/data/out/archive') 
  PARMS((MANDANT '01'))

To create invoices in ZUGFeRD format, version 2.3.3, COMFORT profile, for all data records in the interface that have a '01' in the client field:

CODE 
RUNMAP 
  MAPID('ZUGFERD_2.3.3_COMFORT_OUT') 
  FS(*NONE)
  TOPATH('/home/ieffect/data/out/%FILENAME%') 
  ERRPATH('/home/ieffect/data/out/error') 
  ARCPATH('/home/ieffect/data/out/archive') 
  PARMS((MANDANT '01'))

To create invoices in XRECHNUNG format, version 3.0.2, format CII, for all data records in the interface that have a '01' in the client field:

CODE 
RUNMAP 
  MAPID('XRECHNUNG_CII_3.0.2_OUT') 
  FS(*NONE)
  TOPATH('/home/ieffect/data/out/%FILENAME%') 
  ERRPATH('/home/ieffect/data/out/error') 
  ARCPATH('/home/ieffect/data/out/archive') 
  PARMS((MANDANT '01'))

To create invoices in XRECHNUNG format, version 3.0.2, UBL format, for all data records in the interface that have a '01' in the client field:

CODE 
RUNMAP 
  MAPID('XRECHNUNG_UBL_3.0.2_OUT') 
  FS(*NONE)
  TOPATH('/home/ieffect/data/out/%FILENAME%') 
  ERRPATH('/home/ieffect/data/out/error') 
  ARCPATH('/home/ieffect/data/out/archive') 
  PARMS((MANDANT '01'))

Available versions and mappings

The following list shows all currently available and supported versions. The corresponding mappings can be requested if required.

Format

Version

Direction

Mapping

ZUGFeRD COMFORT

2.3.3 (1)

*OUT

ZUGFeRD_2.3.3_COMFORT_OUT

ZUGFeRD EXTENDED

2.3.3 (1)

*OUT

ZUGFeRD_2.3.3_EXTENDED_OUT

ZUGFERD (EXTENDED/COMFORT)

Alle Versionen

*IN

ZUGFeRD_2.3.3_IN

ZUGFeRD COMFORT

2.3.2

*OUT

ZUGFeRD_2.3.2_COMFORT_OUT

ZUGFeRD EXTENDED

2.3.2

*OUT

ZUGFeRD_2.3.2_EXTENDED_OUT

ZUGFERD (EXTENDED/COMFORT)

2.3.2

*IN

ZUGFeRD_2.3.2_IN

ZUGFeRD COMFORT

2.1.1 (2)

*OUT

ZUGFERD_2.3.3_COMFORT_OUT

ZUGFeRD EXTENDED

2.1.1 (2)

*OUT

ZUGFERD_2.3.3_EXTENDED_OUT

XRECHNUNG UBL

3.0.x

*IN

XRechnung_UBL_3.0.2_IN

XRECHNUNG UBL

3.0.2

*OUT

XRechnung_UBL_3.0.2_OUT

XRECHNUNG CII

3.0.x

*IN

XRechnung_CII_3.0.2_IN

XRECHNUNG CII

3.0.2

*OUT

XRechnung_CII_3.0.2_OUT

XRECHNUNG UBL

2.3.x

*IN

XRechnung_UBL_2.3.1_IN

XRECHNUNG UBL

2.3.1

*OUT

XRechnung_UBL_2.3.1_OUT

XRECHNUNG CII

2.3.x

*IN

XRechnung_CII_2.3.1_IN

XRECHNUNG CII

2.3.1

*OUT

XRechnung_CII_2.3.1_OUT

XRECHNUNG UBL

2.2.x

*IN

XRechnung_UBL_2.2.0_IN

XRECHNUNG UBL

2.2.0

*OUT

XRechnung_UBL_2.2.0_OUT

XRECHNUNG CII

2.2.x

*IN

XRechnung_CII_2.2.0_IN

XRECHNUNG CII

2.2.0

*OUT

XRechnung_CII_2.2.0_OUT

XRECHNUNG UBL

2.1.x

*IN

XRechnung_UBL_2.1.1_IN

XRECHNUNG UBL

2.1.1

*OUT

XRechnung_UBL_2.1.1_OUT

XRECHNUNG CII

2.1.x

*IN

XRechnung_CII_2.1.1_IN

XRECHNUNG CII

2.1.1

*OUT

XRechnung_CII_2.1.1_OUT

(Info) (1) The ZUGFerd mappings ZUGFERD_2.3.3_COMFORT_OUT and ZUGFERD_2.3.3_EXTENDED_OUT generate ZUGFeRD PDF files that are compatible with ZUGFeRD 2.2.x and 2.3.x.

(Info) (2) The ZUGFerd mappings ZUGFERD_2.1.1_COMFORT_OUT and ZUGFERD_2.1.1_EXTENDED_OUT generate ZUGFeRD PDF files that are compatible with ZUGFeRD 2.0.x and 2.1.x.

Simplified process for processing incoming e-invoices

With the new PRCEINVOIC processing command, all incoming e-invoice formats and versions can be processed automatically.
The format is recognised automatically and XML data is extracted from ZUGFeRD data. If desired, XRECHNUNGEN can be visualised and the recognised XML data can be imported into the i-effect interfaces.

CODE 
PRCEINVOIC 
  FRMIFSFILE('%IFSPATH%/%IFSFILE%')
  ERRORPATH('/home/ieffect/data/in/error')
  VISUALIZE('/home/ieffect/data/in/docs')
  MAP(*YES '/home/ieffect/data/in/error' '/home/ieffect/data/in/archive') 
  PARMS((MANDANT 'MANDANT') (CUSTOM1 'CUSTOM1') (CUSTOM2 'CUSTOM2') (CUSTOM3 'CUSTOM3'))

With the standardisation of the ZUGeRD and XRECHNUNG interfaces, it is now also possible to "reverse" a conversion. Data imported into the interface can be converted back to its original format by setting HTDIRECT='*OUT' and calling up the corresponding conversion (see above).

Additional mapping parameters

The parameters listed below can also be specified when calling a mapping

Variable

Description

REPORTPATH

Name of the output path for an xRechnung conversion, in which the generated audit report is stored. If the parameter is not specified, the audit report is stored in the same directory in which the .xml data is processed.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close