Difference between revisions of "Plugin: ZUGFeRDXInvoice"

Latest revision as of 12:27, 12 March 2026

Plugin ZUGFeRD

Status: Testing
Licence: GPLv2
Author: Patric Massing (Hans Auler GmbH - p.massing (at) auler.gmbh)
Date: 2022
Required environment: iDempiere 11 (PostgreSql)
Source :
Description: This plugin provides a process in iDempiere to create or view a ZUGFeRD/X-Invoice PDF-file, attached or stored in archive to an Invoice. If the invoice want stored as X-Invoice, we have the Businesspartner-Option to save this XML-File as CII - or UBL - Standard (UBL in Version 2.1 up to 2.4) .

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Documentation

Setup

Compile/Export the plugin from source and/or install the compiled plugin over the osgi-console.
The plugin creates a process and a toolbar button entry in window invoice(PO/SO)
Add your invoice print format to (Tenant) print form - invoice print format. If you using Jasper-Report, add this in your print format
Set the ZUGFERD_USE_PAYMENT_TERM_NAME system configurator. If it is set to Y, the xml will include the payment term name. If it is set to N (default), the description will be printed instead.
Set the UN/CEFACT code in the unit of measure window

  Example : 
 
     Each = Code C62
 
       km = Code KTM
 
        m = Code MTR

UOM UN/CEFACT

Businespartner Options

Reference No

This is the Routing ID (Leitweg-ID), it is mandatory for some cases, f.i. B2G invoices.

X-Rechnung

Save only the digital invoice XML-File (CII) as standard.

UBLX-Rechnung

If xRechnung is activated, the output standard can be choosed to UBL with version 2.1 up to 2.4 .

Using the Process

1. Open the Invoice

The Toolbarbutton to create or view a ZUGFeRD-Document is shown, if the DocBaseType is Invoice(SO/PO) or CreditMemo(SO/PO) and the invoce has the document status completed or closed.

2. Click the toolbar button to create a new or to view an already created ZUGFeRD-document.

ToolbarButton

Parameter

Parameter Create/View : Create or parse and view a already created ZUGFeRD-document.
Parameter Bank : The selected BankAccount is the as default selected own BankAccount for a new created ZUGFeRD-document.
Reference No: This is the Routing ID (Leitweg-ID), it is mandatory for some cases, f.i. B2G invoices. It is populated by default with the PAT_ReferenceNo field from Business Partner. The process will fail by default if the Reference No is not filled. You can change this with the System Configurator ZUGFERD_MANDATORY_REFERENCENO

4. By creation and if the process is sucessful the new ZUGFeRD-document is attached or archived to the current invoice based on the value of the ZUGFERD_FILEHANDLING_SYSCONFIGNAME System Configurator (it can be archive or attach). Documents to be added to the digital invoice (factur-x.xml) as standard, can be attached to the assigned document type in pdf format.

If a ZUGFeRD-document exists, a message is shown.

Invoice already created

If the process ran successfully, the message is shown

Invoice created

5. The pdf-file contains the xml-information as file

XML-File

6. If you get a ZUGFeRD-file or to verify the file you just created, use the process again with parameter view ZUGFeRD. If you get a ZUGFeRD-file, attach this file to your invoice.

View ZUGFeRD-dokument

@@ Line 7: / Line 7: @@
 *'''Required environment:''' iDempiere 11 (PostgreSql)
 *  [https://github.com/pmassing/auler.gmbh.zugferdxinvoice'''Source : ''']
-*'''Description:''' This plugin provides a process in iDempiere to create or View a ZUGFeRD/X-Invoice PDF-file
+*'''Description:''' This plugin provides a process in iDempiere to create or view a ZUGFeRD/X-Invoice PDF-file, attached or stored in archive to an Invoice. If the invoice want stored as X-Invoice, we have the Businesspartner-Option to save this XML-File as CII - or UBL - Standard (UBL in Version 2.1 up to 2.4) .
-attached or archived to an Invoice.
 This program is distributed in the hope that it will be useful,
@@ Line 16: / Line 18: @@
-== Documentation ==
+==Documentation==
+===Setup===
-=== Setup ===
+#Compile/Export the plugin from source and/or install the compiled plugin over the osgi-console.
-# Compile/Export the plugin from source and/or install the compiled plugin over the osgi-console.
+#The plugin creates a process and a toolbar button entry in window invoice(PO/SO)
-# The plugin creates a process and a toolbar button entry in window invoice(PO/SO)
+#Add your invoice print format to (Tenant) print form - invoice print format. If you using Jasper-Report, add this in your print format
-# Add your invoice print format to (Tenant) print form - invoice print format. If you using Jasper-Report, add this in your print format
+#Set the '''ZUGFERD_USE_PAYMENT_TERM_NAME''' system configurator. If it is set to Y, the xml will include the payment term name. If it is set to N (default), the description will be printed instead.
-# Set the UN/CEFACT code in the unit of measure window
+#Set the UN/CEFACT code in the unit of measure window
@@ Line 40: / Line 41: @@
-=== Using the Process ===
+===Businespartner Options ===
+====Reference No====
+This is the Routing ID (Leitweg-ID), it is mandatory for some cases, f.i. B2G invoices.
+[[File:Plugin ZUGFeRD BP-Routing ID.png|left|thumb|568x568px]]
+====X-Rechnung====
+Save only the digital invoice XML-File (CII) as standard.
+[[File:Plugin ZUGFeRD BP-X-Rechnung.png|left|frame]]
+====UBLX-Rechnung====
+If xRechnung is activated, the output standard can be choosed to UBL with version 2.1 up to 2.4 .
+[[File:Plugin ZUGFeRD BP-UBL-X-Rechnung.png|1024px|left|frame]]
+=== Using the Process===
@@ Line 53: / Line 109: @@
 [[File:ZUGFeRDXInvoice ToolbarButton 2024-09-12 11-23-40.png|800px|thumb|none|ToolbarButton]]
 [[File:ZUGFeRDXInvoice SelectBox2024-10-31 10-25-40.png|alt=|none|thumb|298x298px|Parameter]]
-# Parameter Create/View : Create or parse and view a already created ZUGFeRD-document.
+#Parameter Create/View : Create or parse and view a already created ZUGFeRD-document.
 # Parameter Bank : The selected BankAccount is the as default selected own BankAccount for a new created ZUGFeRD-document.
-# Reference No: This is the Routing ID (Leitweg-ID), it is mandatory for some cases, f.i. B2G invoices. It is populated by default with the PAT_ReferenceNo field from Business Partner. The process will fail by default if the Reference No is not filled. You can change this with the System Configurator '''ZUGFERD_MANDATORY_REFERENCENO'''
+#Reference No: This is the Routing ID (Leitweg-ID), it is mandatory for some cases, f.i. B2G invoices. It is populated by default with the PAT_ReferenceNo field from Business Partner. The process will fail by default if the Reference No is not filled. You can change this with the System Configurator '''ZUGFERD_MANDATORY_REFERENCENO'''
-. By creation and if the process is sucessful the new ZUGFeRD-document is attached or archived to the current invoice based on the value of the '''ZUGFERD_FILEHANDLING_SYSCONFIGNAME''' System Configurator (it can be archive or attach).
+. By creation and if the process is sucessful the new ZUGFeRD-document is attached or archived to the current invoice based on the value of the '''ZUGFERD_FILEHANDLING_SYSCONFIGNAME''' System Configurator (it can be archive or attach). '''Documents to be added''' to the digital invoice (factur-x.xml) as standard, can be attached to the assigned document type in pdf format.
 If a ZUGFeRD-document exists, a message is shown.[[File:ZUGFeRDXInvoice Already Created 2024-09-12 14-00-52.png|500px|thumb|none|Invoice already created]]
@@ Line 79: / Line 135: @@
 [[File:ZUGFeRDXInvoice InvoiceView 2024-09-12 11-23-40.png|800px|thumb|none|View ZUGFeRD-dokument]]
+[[Category:Available Plugins]]
-[[Category:Available_Plugins]]