% \iffalse meta-comment % % Copyright (C) 2021–2024 Marei Peischl % --------------------------------------------------------- % % This file may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3c % of this license or (at your option) any later version. % The latest version of this license is in: % % http://www.latex-project.org/lppl.txt % % and version 1.3c or later is part of all distributions of LaTeX % version 2008-05-04 or later. % % \fi % \iffalse %<*driver> \ProvidesFile{zugferd.dtx}[2024-09-11 v0.8 ZUGFerd Invoice and Faktur-X] % %\NeedsTeXFormat{LaTeX2e}[2023-11-01] %\ProvidesExplPackage{zugferd}{2024-09-11}{0.8}{Create ZUGFerd invoices using LaTeX} %<*driver> \DocumentMetadata{pdfstandard=a-3b,lang=en} \documentclass[lm-default=false,cs-break-nohyphen]{l3doc} \usepackage{zugferd}[2024-09-11] \EnableCrossrefs %\CodelineIndex \RecordChanges \usepackage{biblatex} \usepackage{shellesc} \ifnum\ShellEscapeStatus=1\relax\else \PassOptionsToPackage{draft}{minted} \fi \usepackage{minted} \newcounter{codelist} \newenvironment{examplecode}{% \VerbatimEnvironment% \fvset{gobble=0}% \begin{VerbatimOut}[tabsize=3,gobble=1]{minted.doc.out}% }{% \end{VerbatimOut}% \inputminted[autogobble, escapeinside=||]{latex}{minted.doc.out}% } \usepackage{accsupp} \setminted{breaksymbol={\BeginAccSupp{method=escape,ActualText={}}\tiny\ensuremath{\hookrightarrow}\EndAccSupp{}},breaklines} \ExplSyntaxOn \makeatletter \tl_new:N \l__ptxtools_doc_values_tl \newcommand*{\codefamily}{\MacroFont} \DeclareTextFontCommand{\codefont}{\codefamily} \providecommand{\option}[1]{\codefont{#1}} \cs_new:Npn \__ptxctools_parse_key_option:w #1 #2 #3 #4 = #5 \q_stop { \begingroup \let\PrintDescribeOption\PrintDescribeKeyOption \tl_set:Nn \l__ptxtools_doc_values_tl {\small\IfBooleanTF{#3}{\textsf{#5}}{\textsf{(\codefont{#5})}}} \noindent\DescribeOption{#4}\hfill \small \tl_if_blank:nTF {#2} {\meta{\textrm{initially~unset}}} { \IfBooleanTF{#1} {#2} {(default:~\codefont{#2})} }\strut\par \endgroup } \newcommand*{\PrintDescribeKeyOption}[1]{ {\MacroFont #1=}\rlap{\hskip\marginparsep\l__ptxtools_doc_values_tl} } \bool_new:N \l_ptxtools_last_was_describe_bool \NewDocumentCommand{\DescribeKeyOption}{smms}{ \bool_if:NTF \l_ptxtools_last_was_describe_bool { \vskip -\lastskip }{ \par \dim_compare:nNnF {\parskip} > {\c_zero_dim} {\medskip} } \__ptxctools_parse_key_option:w #1 {#3} #4 #2 \q_stop \bool_set_true:N \l_ptxtools_last_was_describe_bool \AddToHookNext{para/begin}{ \bool_set_false:N \l_ptxtools_last_was_describe_bool \OmitIndent } \smallskip } \newenvironment{valuelist}{ \list{}{ \labelwidth0pt \itemindent0pt \leftmargin0pt \let\makelabel\valuelistlabel } }{ \endlist } \newcommand*\valuelistlabel[1]{ \llap{ \normalfont\codefamily\color_select:n {black!60} \begin{tabular}[t]{@{}r@{}} \clist_use:nn {#1} {\\} \end{tabular} } } \newcommand*{\accessTaxExemptionReason}[1]{ \keys_set:nn {zugferd / tax } {category=#1} Exemption~reason:~\tl_if_empty:NTF \l__zugferd_tax_exemption_reason_tl {\meta{empty}} {\l__zugferd_tax_exemption_reason_tl};~ Exemption~reason~code:~\tl_if_empty:NTF \l__zugferd_tax_exemption_code_tl {\meta{empty}} {\l__zugferd_tax_exemption_code_tl} } % to support small layout adjustments for the texdoc version \newcommand*{\IfOnlyDocumentation}[1]{ \bool_if_exist:NT \g__codedoc_typeset_implementation_bool { \bool_if:NF \g__codedoc_typeset_implementation_bool {#1} } } %add a subtitle \def\@maketitle{% \newpage \null \vskip 2em% \begin{center}% \let \footnote \thanks {\LARGE \@title \par}% \vskip 1.5em% {\large \@subtitle \par}% \vskip 1em% {\large \lineskip .5em% \begin{tabular}[t]{c}% \@author \end{tabular}\par}% \vskip 1em% {\large \@date}% \end{center}% \par \vskip 1.5em} \newcommand{\subtitle}[1]{\def\@subtitle{#1}} \subtitle{} \makeatother \ExplSyntaxOff \usepackage{underscore-ltx} \begin{filecontents}{zugferd.bib} @online{x-rechnung, url={https://xeinkauf.de/dokumente/}, urldate={2024-08-20} } @online{spec-xrechnung, url={https://xeinkauf.de/app/uploads/2024/07/302-XRechnung-2024-06-20.pdf}, author={{Koodinierungsstelle für IT-Standards}}, title={Spezifikation Standard XRechnung}, subtitle={CIUS und Extension}, edition={Version XRechnung 3.0.2}, date={2024-06-20}, urldate={2024-08-20}, langid={german} } @online{mustang-project, title={Mustangproject}, url={https://github.com/ZUGFeRD/mustangproject}, urldate={2024-08-20} } @online{country-codes, title={ECE/TRADE/201}, subtitle={ISO COUNTRY CODE for Representation of Names of Countries}, url={https://unece.org/trade/documents/iso-country-code-representation-names-countries}, urldate={2024-08-20}, } @online{unit-codes, title={Rec 20 – Codes for Units of Measure Used in International Trade}, url={https://unece.org/sites/default/files/2023-10/rec20_Rev17e-2021.xlsx}, urldate={2024-08-20}, note={Link directly to xlsx. \cite[see][for all revisions]{cl-recommendations}.} } @online{cl-recommendations, author={United Nations Economic Commission for Europe (UNECE)}, title={Code List Recommendations}, url={https://unece.org/trade/uncefact/cl-recommendations}, urldate={2024-08-20} } @online{VAT-exemption-codes, title={VAT exemption reason code list}, url={https://www.xrepository.de/details/urn:xoev-de:kosit:codeliste:vatex_1}, urldate={2024-08-20} } @online{zugferd-download, title={ZUGFeRD 2.2}, subtitle={Download page}, url={https://ferd-net.de/standards/zugferd-2.2/zugferd-2.2.html}, urldate={2024-09-02}, } @manual{scrletter, title = {The scrletter package}, subtitle = {Letter extension to KOMA-Script classes}, author = {Kohm, Markus}, url = {https://komascript.de/}, urldate = {2024-09-03}, documentation = {ctan://macros/latex/contrib/koma-script/doc/scrguide-en.pdf}, date = {2023-07-07}, version = {3.41}, } @online{leitweg-id, title={Xeinkauf FAQ}, subtitle={Leitweg ID}, author={{Koordinierungsstelle für IT Standards (KoSIT)}}, url={https://xeinkauf.de/faq/xrechnung#leitweg-id}, urldate={2024-09-04} } \end{filecontents} \addbibresource{zugferd.bib} \nocite{cl-recommendations} \usepackage{xspace} \newcommand*{\XML}{XML\xspace} \newcommand*{\XMLfile}{\XML file} \begin{document} \EnableDocumentation\DisableImplementation \DocInput{zugferd.dtx} %\DisableDocumentation\EnableImplementation %\DocInputAgain \PrintChanges \printbibliography \PrintIndex \end{document} % % \fi % % \changes{v0.8}{2024-09-11}{First CTAN version} % % \GetFileInfo{zugferd.dtx} % % \DoNotIndex{\newcommand,\newenvironment} % \begin{documentation} % \title{The \textsf{zugferd} package\thanks{This document % corresponds to \textsf{zugferd}~\fileversion, dated \filedate.}} % \subtitle{Creating electronic and hybrid invoices using \LaTeX} % \author{Marei Peischl \\ \texttt{marei@peitex.de}} % % \maketitle % % \begin{abstract} % Invoicing is getting more and more automated. % Starting with public sector, within Germany there already is a requirement to stick to the Faktur-X Standard. % First Invoices based on this implementation here have been created back in 2021. % And this is now the trial to create a more universal and public package to support the current Version of ZUGFeRD and therefore also X-Rechung and Faktur-X. % % \indent The fundamental idea of this package was to use the calculation within \LaTeX{} as well. So it also creates the \XMLfile for the attachment on the fly. % To match typical setups there is a wrapper package which usually would also hold the personal Invoicing layout configuration. % \end{abstract} % % \IfOnlyDocumentation{\vfill} % \section*{Sponsors \& Supporters} % Most of this package has been created within my free time and for my personal use. At start, it was not a paid project at all. % Since it is addressing business users it would be great if we could keep this actively maintained. % If you are able to support this either financially for the maintenance effort, a custom extension, I'd love to hear from you. % % Tthis project was financially supported by: % \begin{itemize} % \item Pengutronix e.K., \url{https://pengutronix.de}\newline % Special thanks to them, as they also sponsored the minimal portable \TeX{} Live setup. % \end{itemize} % % \IfOnlyDocumentation{\clearpage} % % \tableofcontents % % \IfOnlyDocumentation{\clearpage} % % \section{Quick start} % This package is still in development and does not provide any validation. % To ensure your invoice is created correctly you should also validate the output files. % There are tools like the \citeauthor{mustang-project} \cite{mustang-project} providing an easy-to-use interface for the validation. % In the appendix I will add some notes on my setup and how I use it within pipelines. % % The Bundle provides an example file called \file{DEMO-rechnung-zugferd.tex}. % This includes a basic setup for a valid X-Rechnung currently matching Version 3.0.1 of the standard. % Details on the requirements can be found in the documentation at \cite{x-rechnung}. % % \subsection{Disclaimer concerning the \pkg{zugferd-invoice} Package} % The included package \pkg{zugferd-invoice} is an example project which might match your own invoicing structure. % It holds all the layout information which is static across all the invoices. % This package is an example implementation and should not be used in production. % It is published as a part of the documentation. % % The idea is to create your own version of this package to use your own layout and internally load the \pkg {zugferd} package that way. % Of course, it's possible to use a copy of this package within your personal setup. % But the syntax used in the DEMO file may change, so you have to ensure yourself to be compatible with updates. % % The interfaces for \pkg{zugferd} will hopefully stay the same. % At least changes will be announced and build compatible during a deprecation period. % % \end{documentation} % \iffalse % \begin{macrocode} %<*package> %<@@=zugferd> % \end{macrocode} % Workaround to replace module name without having a visible <@@=zugferd> in the documentation % \fi % % \ExplSyntaxOn % \tl_gset:Nn \g__codedoc_module_name_tl {zugferd} % \ExplSyntaxOff % \iffalse %<*!package> % \fi % \begin{documentation} \ExplSyntaxOn \tl_gset:Nn \g__codedoc_module_name_tl {zugferd} \ExplSyntaxOff % \end{documentation} % \iffalse % %<*package> % \fi % \begin{implementation} % \section{Implementation} % \begin{variable}{\l_@@_tmp_tl,\g_@@_format_str,\g_@@_businessProcessId_str,\g_@@_writeTradeContact_bool,\g_@@_writePaymentMeans_bool,\g_@@_conformance_level_str} % \begin{macrocode} \tl_new:N \l_@@_tmp_tl \str_new:N \g_@@_format_str \str_new:N \g_@@_businessProcessId_str \bool_new:N \g_@@_writeTradeContact_bool \bool_new:N \g_@@_writePaymentMeans_bool \str_new:N \g_@@_conformance_level_str % \end{macrocode} % \end{variable} % \end{implementation} % \begin{documentation} % \section{Package Options}\label{sec:package-options} % The package supports a few fundamental settings. % These have to be set when the package is loaded as they are used internally to setup the scheme or activate the \XML mechanism. % % \DescribeKeyOption{format=xrechnung/xrechnung3.0/xrechnung2.3/basic}{xrechunng} % \option{format} selects the scheme to be used for the zugferd invoice. % Currently xrechnung3.0, xrechnung2.3 and the basic scheme are supported. % % The value \option{xrechnung} is set as an alias to |xrechnung3.0| and will always use the latest version supported by \pkg{zugferd}. % % \DescribeKeyOption{zugferd=\meta{boolean}}{true}* % This option can be used to deactivate the \XML embedding. % It would also disable the the \option{write-xml} option. % This can be used to create a package which can use the same structure to also create invoices without \XML attachment. % It can also be used with older \LaTeX{} releases than this package requires. % There will be a warning, but the visible part should be okay. % % \DescribeKeyOption{write-xml=\meta{boolean}}{true}* % Disable the \XML output. % This can be used if you want to create the \XML attachment with different software than this package. % % In that case you can either rename your file to \meta{\cs[no-index]{jobname}\_zugferd.xml} or also adjust the \option{xml-file} option. % % \DescribeKeyOption{xml-file=\meta{filename}}{\cs[no-index]{jobname}_zugferd.xml}* % Adjust the file name of the created or loaded \XMLfile. % % The option \option{xrechnung} is only used internally to set the global parameters for all |xrechnung| variants. % % \DescribeKeyOption{auto-exemption=\meta{boolean}}{true} % \pkg{zugferd} tries to automatically add an exemption-reason for the most common VAT categories. % In case a more specific reason is required this setting can be disabled and everything should be configured manually. % See \autoref{sec:tax-category} for more explanation of this feature and the categories this applies to. % % \end{documentation} % \begin{implementation} % \begin{optionenv}{format,xrechnung,write-xml,zugferd,xml-file,auto-exemption} % \changes{v0.7}{2024-09-10}{Added auto-exemption option} % \begin{macrocode} \char_set_catcode_other:N \#% \keys_define:nn {zugferd} { xrechnung .code:n = { \bool_gset_true:N \g_@@_writeTradeContact_bool \bool_gset_true:N \g_@@_writePaymentMeans_bool \str_gset:Nn \g_@@_conformance_level_str {XRECHNUNG} }, format .choice:, format / xrechnung3.0 .code:n = { \str_gset:Nx \g_@@_format_str { urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0 } \str_gset:Nx \g_@@_businessProcessId_str { urn:fdc:peppol.eu:2017:poacc:billing:01:1.0 } \keys_set:nn {zugferd}{xrechnung} }, format / xrechnung2.3 .code:n = { \str_gset:Nx \g_@@_format_str { urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.3 } \keys_set:nn {zugferd}{xrechnung} }, format / basic .code:n = { \str_gset:Nx \g_@@_format_str { urn:cen.eu:en16931:2017#compliant#urn:factur-x.eu:1p0:basic } \bool_gset_false:N \g_@@_writeTradeContact_bool \bool_gset_false:N \g_@@_writePaymentMeans_bool \str_gset:Nn \g_@@_conformance_level_str {BASIC} }, format / xrechnung .meta:n = { format = xrechnung3.0 }, format .initial:n = xrechnung, format .usage:n = load, write-xml .bool_gset:N = \g_@@_write_xml_bool, write-xml .initial:n = true, write-xml .usage:n = load, zugferd .bool_gset:N = \g_@@_active_bool, zugferd .initial:n = true, zugferd .default:n = true, zugferd .usage:n = load, ZUGFerD .meta:n = {zugferd = #1}, xml-file .tl_gset:N = \g_@@_xml_file_tl, xml-file .initial:n = \jobname _zugferd.xml, xml-file .usage:n = load, auto-exemption .bool_gset:N = \g_@@_auto_exemption_bool, auto-exemption .initial:n = true, auto-exemption .default:n = true, auto-exemption .usage:n =load, } \char_set_catcode_parameter:N \#% \ProcessKeyOptions[zugferd] % \end{macrocode} % \end{optionenv} % \subsection{Preparation to write the \file{.xml} file} % \begin{variable}{\_@@_xml_writer_iow} % \begin{macrocode} \iow_new:N \_@@_xml_writer_iow % \end{macrocode} % \end{variable} % To adjust the metadata it is necessary to use the \pkg{pdfmanagement-testphase} by \citeauthor{pdfmanagement-testphase}. % She had prepared some experiment files for the PDF attachment in the experiments of the repository. % We use these to embed the \XML file. % % This part prepares the XMP metadata according to the required scheme. % \begin{macrocode} \bool_if:NT \g_@@_active_bool { \cs_if_exist:NF \pdfmeta_xmp_xmlns_new:nn { \msg_new:nnnn {zugferd} {PDFmanagement-not-active} { The~\LaTeX~PDF~management~is~not~active.\\ Activate~it~using~\string\DocumentMetadata. } { See~ZUGFeRD~or~PDFmanagement~documentation~for~more~information. } \msg_error:nn{zugferd} {PDFmanagement-not-active} } %% based on experiments for l3pdfmeta by Ulrike Fischer \pdfmeta_xmp_xmlns_new:nn {fx}{ urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0\c_hash_str } \cs_generate_variant:Nn \__pdfmeta_xmp_schema_new:nnn {nne} \__pdfmeta_xmp_schema_new:nne {Factur-X~PDFA~Extension~Schema} {fx} {urn:factur-x:pdfa:CrossIndustryDocument:invoice:1p0\c_hash_str} \__pdfmeta_xmp_property_new:nnnnn {fx} {DocumentFileName} {Text} {external} {name~of~the~embedded~XML~invoice~file} \__pdfmeta_xmp_property_new:nnnnn {fx} {DocumentType} {Text} {external} {INVOICE} \__pdfmeta_xmp_property_new:nnnnn {fx} {Version} {Text} {external} {The~actual~version~of~the~factur-x~schema} \__pdfmeta_xmp_property_new:nnnnn {fx} {ConformanceLevel} {Text} {external} {The~conformance~level~of~the~factur-x~data} \exp_args:Ne \pdfmeta_xmp_add:n { % fix INVOICE INVOICE\iow_newline: % fix factur-x.xml factur-x.xml\iow_newline: % fix schema version 1.0\iow_newline: % zulässige Werte MINIMUM, BASIC WL, BASIC, EN 16931, EXTENDED, XRECHNUNG \g_@@_conformance_level_str% \iow_newline: % } } % \end{macrocode} % \end{implementation} % \begin{documentation} % \section{User Commands} % The end user is only asked to set or access the data to be used by \pkg{zugferd}. % % \begin{syntax} % \cs[no-index]{SetZUGFeRDData}*\marg{key value list} % \end{syntax} % \DescribeMacro{\SetZUGFeRDData} % \DescribeMacro[noindex]{\SetZugferdData} % The two modes of \cs[no-index]{SetZUGFeRDData} control if the argument is expanded before the fields are set. % Depending on the source of the data this might be necessary. % Fields which are involved in the calculation will be expanded anyway, but the text fields will not, to support special characters. % % \end{documentation} % \begin{implementation} % \begin{function}{\SetZUGFeRDData} % \begin{macrocode} \NewDocumentCommand{\SetZUGFeRDData}{sm}{ \IfBooleanTF{#1} {\keys_set:ne} {\keys_set:nn} {zugferd} {#2} } \let\SetZugferdData\SetZUGFeRDData % \end{macrocode} % \end{function} % \end{implementation} % \begin{documentation} % % \DescribeMacro{\InsertZUGFeRDData} % \DescribeMacro[noindex]{\InsertZugferdData} % \begin{syntax} % \cs[no-index]{InsertZugferdData}\oarg{special mode option}\marg{data-selection} % \end{syntax} % ZUGFerd uses the same data as the \XMLfile inside the PDF. % To simplify the reuse of data this command is designed to simplify the access to data fields, for example: % % \begin{examplecode} % \InsertZUGFeRDData{id} % {\InsertZUGFeRDData[set-today]{date}\today} % \InsertZUGFeRDData[AddressData]{seller} % \end{examplecode} % As special modes the command currently supports the following: % % By default \pkg{zugferd} tries to find the variable holding the data itself. % First a token list is tried, afterwards a string. % Global variables are prefered over local ones. % % As the variable names may container underscores and the option usually prefers dashes, dashes are converted to underscores for the detection. % % \DescribeOption{AddressData} Allows |seller| or |buyer| for the data selection. % Will print the address, to be used in letters. % % \DescribeOption{set-today} % For dates there also exists the variant which will not print the variable but parse the variable to be used as \cs{today}. % Using this the date format can be controlled easier using the language setting of the document. % Here you should take care to use it within a group to restore the real value of \cs[no-index]{today} afterwards. % % \end{documentation} % \begin{implementation} % \begin{function}{\InsertZUGFeRDData,\InsertZugferdData} % To simplify the usage in letters we also add fields to be able to use the zugferd data within \LaTeX{} output. % Country is still missing. % \begin{macrocode} \NewDocumentCommand{\InsertZUGFeRDData}{om}{ \str_case:nnF {#1} { % \end{macrocode} % \begin{macrocode} {AddressData} { \clist_map_inline:nn {name, lineone, linetwo} { \prop_if_in:cnT {g_@@_#2_AddressData_prop } {##1} { \prop_item:cn {g_@@_#2_AddressData_prop } {##1}\\ } } \prop_item:cn {g_@@_#2_AddressData_prop } {postcode} \space \prop_item:cn {g_@@_#2_AddressData_prop } {city} } % \end{macrocode} % \begin{macrocode} {set-today} { \_@@_set_today:v {g_@@_#2_tl} } } { % \end{macrocode} % Try to find the variable automatially. % \begin{itemize} % \item replace dashes by underscores % \item try if a tokenlist or a string % \item prefer global over local % \item take the first existing variable and break the loop % \end{itemize} % \begin{macrocode} \str_set:Ne \l_tmpa_str {#2} \str_replace_all:Nnn \l_tmpa_str {-} {_} \str_replace_all:Nnn \l_tmpa_str {/} {_} \bool_set_true:N \g_tmpa_bool \clist_map_inline:nn {tl, str} { \clist_map_inline:nn {g, l} { \use:c {##1 _if_exist:cT} {####1_@@_ \l_tmpa_str _##1} { \use:c {####1_@@_ \l_tmpa_str _##1} \bool_gset_false:N \g_tmpa_bool } \bool_if:NF \g_tmpa_bool {\clist_map_break:} } \bool_if:NF \g_tmpa_bool {\clist_map_break:} } } } \providecommand{\InsertZugferdData}{\InsertZUGFeRDData} \providecommand{\insertZugferdData}{\InsertZUGFeRDData} % \end{macrocode} % \end{function} % \begin{function}{\_@@_set_today:c} % Auxiliary function to use a date variable within the current group to be used as \cs[no-index]{today}. % \begin{macrocode} \cs_new:Nn \_@@_set_today:n { \_@@_set_today_aux:w #1 \q_stop } \cs_generate_variant:Nn \_@@_set_today:n {v} \cs_new:Npn \_@@_set_today_aux:w #1 #2 #3 #4 #5 #6 #7 #8 \q_stop{ \int_set:Nn \year {#1#2#3#4} \int_set:Nn \month {#5#6} \int_set:Nn \day {#7#8} } % \end{macrocode} % \end{function} % \end{implementation} % \begin{documentation} % \section{Commands for template authors} % % \DescribeEnv{ZUGFeRD} % To simplify the structure of the wrapper package, \pkg{zugferd} provides an environment for the \XML mechanism and does the attachment to the PDF file (of course only, if enabled, see \autoref{sec:package-options}). % This provides the public interface bundling some steps together to reduce maintenance effort for any template maintainer using this package. % It also avoids the use of internal commands. % % This environment opens the \XML file using \cs{startWritingZUGFeRDxml} and afterwards writes the \XML header including the File and Scheme information, the |ExchangedDocumentContext| and information of the |ExchangedDocument|. % Notes will also be written within this step. % Afterwards the environment should include all the mechanisms to write the invoice positions as well as summation. % % At the end of the environment the footer is inserted, before the output stream is closed using \cs{stopWritingZUGFeRDxml}. Which also attaches the \XMLfile to the PDF. % % % \end{documentation} % \begin{implementation} % \begin{macrocode} \NewDocumentEnvironment{ZUGFeRD}{o}{ \IfNoValueF{#1}{ \SetZUGFeRDData{#1} } \zugferd_enable_XML_interfaces: \startWritingZUGFeRDxml \zugferd_write_Header: \ignorespaces }{ \zugferd_enable_XML_interfaces: \zugferd_write_Footer: \stopWritingZUGFeRDxml \zugferd_disable_XML_interfaces: } % \end{macrocode} % \end{implementation} % \begin{documentation} % \DescribeMacro{\startWritingZUGFeRDxml} % \cs[no-index]{startWritingZUGFeRDxml} is opening the output stream for the \XMLfile. % It also adjusts the indentation. % If \option{write-xml} is false, this option only opens a group to achieve the same structure in both modes. % % \DescribeMacro{\stopWritingZUGFeRDxml} % Here the output stream is closed and the \XMLfile is attached. % In case \option{write-xml} is not active, the attachment will be made if that's not deactivated separately using \option{zugferd}. % It also ends the group started by \cs[no-index]{startWritingZUGFeRDxml}. % \end{documentation} % \begin{implementation} % \begin{macrocode} \newcommand*{\startWritingZUGFeRDxml}{ \begingroup \bool_if:NTF \g_@@_write_xml_bool { \char_set_active_eq:nN {13} \_@@_xml_newline_indent: \iow_open:Nn \_@@_xml_writer_iow {\g_@@_xml_file_tl} }{ \msg_info:nn {zugferd} {no-xml-write} } } \msg_new:nnn {zugferd} {no-xml-write} { The~option~write-xml=false~was~set.\\ Writing~of~XML~file~is~deactivated. } % \end{macrocode} % The PDF attachment is done after the writing stream is closed. % \begin{macrocode} %% The metadata elements are taken by Ulrike Fischer's faktur-x experiments %% https://github.com/latex3/pdfresources/tree/main/experiments/factur-x-bills \newcommand*{\stopWritingZUGFeRDxml}{% \bool_if:NT \g_@@_write_xml_bool {\iow_close:N \_@@_xml_writer_iow}% \endgroup \bool_if:NT \g_@@_active_bool { \group_begin: \pdfdict_put:nnn {l_pdffile/Filespec} {AFRelationship}{/Alternative} %or /Source in some cases \pdfdict_put:nnn {l_pdffile/Filespec} {Desc}{(Factur-X/ZUGFeRD-Rechnung)} \pdffile_embed_file:nnn {\g_@@_xml_file_tl}{factur-x.xml} {zugferd/rechnung} \group_end: \pdfmanagement_add:nnx {Catalog/Names} {EmbeddedFiles} {\pdf_object_ref:n{zugferd/rechnung}} % steht in der docu ist aber pdf 2.0 .... \pdfmanagement_add:nnx{Catalog}{AF}{\pdf_object_ref:n{zugferd/rechnung}} } } % \end{macrocode} % \end{implementation} % \begin{documentation} % \subsection{Interfaces to write the \XML contents} % \changes{v0.6}{2024-09-05}{Provide public interfaces and first version of the documentation.} % \label{sec:xml-interfaces} % In case you are using |write-xml=true| (which is the default) You need to ensure to call the \XML writing functions in the correct order. % For example after setting the global invoice data, like it's done in the example file. % The minimal example below would create a valid XML. % The interface commands are described afterwards. % % \begin{examplecode} % \begin{ZUGFeRD} % \zugferd_write_Item:nnnnnn {1} {} {Plushie \TeX{} lion} {31.98} {2} {63.78} % \zugferd_startInvoiceSums: % \zugferd_write_TaxEntry:nnnn {S} {19} {63.78} {12.12} % \zugferd_write_Summation:nnnnnnnn {63.78} {0} {0} {63.78} {12.12} {75.90} {0} {75.90} % \zugferd_stopInvoiceSums: % \end{ZUGFeRD} % \end{examplecode} % % \DescribeMacro{\zugferd_write_Item:nnnnnn} % This command is the interface to write invoice items to the \XMLfile. % If the \XML interface is enabled this is a reference to the internal command \cs{_@@_insert_TradeLineItem:nnnnnn}. % \begin{syntax} % \cs[no-index]{zugferd_write_Item:nnnnn} % \marg{LineID}\marg{optional: item id (\enquote{SellerAssignedID})}\marg{item name} % \marg{NetPriceProductTradePrice} % \marg{BilledQuantity} % \marg{LineTotalAmount} % \end{syntax} % Within the product name macros are disabled using \cs[no-index]{zugferd_disable_macros:}, see \autoref{sec:disable_macros}. % % This command is using the local values of tax information as well as the unit code. % If you want to overwrite them, adjust them locally using the corresponding options, e.g.: % \begin{examplecode} % \begingroup % \keys_set:nn {zugferd}{tax/rate=19, tax/category=S} % \zugferd_write_Item:nnnnnn {1} {} {Plushie \TeX{} lion} {31.98} {2} {63.78} % % Code using the data for visible representation % \endgroup % \end{examplecode} % This will set the tax rate to 19\,\% unregarding the global setting. % % \DescribeMacro{\zugferd_startInvoiceSums:} % \DescribeMacro{\zugferd_stopInvoiceSums:} % There is some global data which is placed in the \XMLfile after the invoice items have been placed. % Typically, in \LaTeX{} this block is started after the items have been printed and will enclose the summation block. % % The starting includes the so called \enquote{ApplicableHeaderTradeAgreement} which contains the address data of both trade parties, see \autoref{sec:TradeParties} % And this will also print the \enquote{SpecifiedTradeSettlementPaymentMeans}, see \autoref{sec:PaymentMeans}. % % \DescribeMacro{\zugferd_write_TaxEntry:nnnn} % This command is writing the sum over a tax rate. This command has to be used once per rate applied to the items. % \begin{syntax} % \cs[no-index]{zugferd_write_TaxEntry:nnnn} \marg{tax category code} \marg{tax rate in \%} \marg{basis amount the tax applies to} \marg{tax amount} % \end{syntax} % The tax amount could of course be calculated internally. % In the example package this is done automatically, but the interface needs to support manual input as a lot of use cases for \LaTeX{} invoicing use it only to create the output file. % % \DescribeMacro{\zugferd_write_Summation:nnnnnnnn}\par % \noindent The total values are all collected with a single macro. % \begin{syntax} % \cs[no-index]{zugferd_write_Summation:nnnnnnnn} % \marg{LineTotalAmount}\marg{ChargeTotalAmount}\marg{AllowanceTotalAmount} % \marg{TaxBasisTotalAmount}\marg{TaxTotalAmount} % \marg{GrandTotalAmount}\marg{TotalPrepaidAmount}\marg{DuePayableAmount} % \end{syntax} % This commnd is also writing the payment terms to the \XMLfile. % Please be aware that it's in general not possible to calculate the tax values in here, as there might be multiple tax rates applied. % This is only taking the sums over all tax entries. % % In case you are using some specials like category \enquote{E} the exemption reason will also be written at that point. % For that it is referencing the current value of the setting. % % \subsection{Commands to temporary disable/re-enable the \XML writing interfaces} % \DescribeMacro{\zugferd_enable_XML_interfaces:} % \DescribeMacro{\zugferd_disable_XML_interfaces:} % \par\bigskip % As there are a lot of usecases where code is processed multiple times, it's necessary to provide an interface to temporary disable the \XML writing mechanism. % A lot of these situations appear within table structures whereas a local adjustment would not be helpful. % Therefore these adjustments have to be done globally. % % The example package \pkg{zugferd-invoice} provides an example for this to ensure the \XML data is not written multiple times. % The \env{ZUGFeRD} environment has been constructed that way, that it would automatically enable the interface when it begins and also when it ends, to write the data. So you should ensure this environment is only processed once or use the lower level interfaces directly. % \end{documentation} % \begin{implementation} % Provide public interfaces and the ZUGFeRD environment. % \begin{function}{\zugferd_enable_XML_interfaces:,\zugferd_disable_XML_interfaces:} % \begin{macrocode} \cs_new:Nn \zugferd_enable_XML_interfaces: { \bool_if:NT \g_@@_write_xml_bool { \cs_gset:Nn \zugferd_write_Header: { \_@@_insert_Header: \_@@_insert_FrontMatter: } \cs_gset:Nn \zugferd_write_Footer: { \_@@_insert_Footer: } \cs_gset_eq:NN \zugferd_write_Item:nnnnnn \_@@_insert_TradeLineItem:nnnnnn \cs_gset:Nn \zugferd_startInvoiceSums: { \_@@_ApplicableHeaderTradeAgreement: \_@@_ApplicableHeaderTradeSettlement_start: \_@@_SpecifiedTradeSettlementPaymentMeans: } \cs_gset:Nn \zugferd_stopInvoiceSums: { \_@@_ApplicableHeaderTradeSettlement_stop: } \cs_gset_eq:NN \zugferd_write_TaxEntry:nnnn \_@@_ApplicableTradeTax:nnnn \cs_gset:Nn \zugferd_write_Summation:nnnnnnnn { \_@@_SpecifiedTradePaymentTerms: \_@@_SpecifiedTradeSettlementHeaderMonetarySummation:nnnnnnnn {##1} {##2} {##3} {##4} {##5} {##6} {##7} {##8} } } } \cs_new:Nn \zugferd_disable_XML_interfaces: { \cs_gset_eq:NN \zugferd_write_Header: \prg_do_nothing: \cs_gset_eq:NN \zugferd_write_Footer: \prg_do_nothing: \cs_gset_eq:NN \zugferd_write_Item:nnnnnn \use_none:nnnnnn \cs_gset_eq:NN \zugferd_startInvoiceSums: \prg_do_nothing: \cs_gset_eq:NN \zugferd_stopInvoiceSums: \prg_do_nothing: \cs_gset_eq:NN \zugferd_write_TaxEntry:nnnn \use_none:nnnn \cs_gset_eq:NN \zugferd_write_Summation:nnnnnnnn \use_none:nnnnnnnn } \bool_if:NTF \g_@@_write_xml_bool { \zugferd_enable_XML_interfaces: }{ \zugferd_disable_XML_interfaces: } % \end{macrocode} % \end{function} % \begin{function}{\_@@_write_xml:n,\_@@_define_xml_writer:Nn,\_@@_define_xml_content:Nn} % These commands are used to toggle the writing of the \XMLfile. This corresponds to the option \option{write-xml}. % \begin{macrocode} \bool_if:NTF \g_@@_write_xml_bool { \cs_new:Nn \_@@_write_xml:n { \iow_now:Ne \_@@_xml_writer_iow {\_@@_xml_auto_indent: #1} } \cs_new_eq:NN \_@@_define_xml_writer:Nn \cs_new:Nn \cs_new_eq:NN \_@@_define_xml_content:Nn \cs_new:Nn } { \cs_set_eq:NN \_@@_write_xml:n \use_none:n \cs_set:Nn \_@@_define_xml_writer:Nn {\cs_new:Nn #1 {}} \cs_set:Nn \_@@_define_xml_content:Nn {\cs_new:Nn #1 {}} } \cs_generate_variant:Nn \_@@_write_xml:n {e} % \end{macrocode} % \end{function} % \subsection{Number rounding} % As \pkg{siunitx} is implementing this, we use it instead of building our own mechanism. % \begin{macrocode} \RequirePackage{siunitx} % \end{macrocode} % \begin{function}{\_@@_number_format:nNn,\_@@_number_format:nNe} % \begin{macrocode} \cs_new:Nn \_@@_number_format:nNn { \sisetup{ parse-numbers=true, round-mode=places, round-precision=#1, round-pad = false, group-digits=false, minimum-decimal-digits=#1, output-decimal-marker=. } \siunitx_number_format:nN {#3} #2 } \cs_generate_variant:Nn \_@@_number_format:nNn {nNe} % \end{macrocode} % \end{function} % \begin{function}{\_@@_write_rounded:nnnn,\_@@_write_rounded:nnn} % \begin{macrocode} \cs_new:Nn \_@@_write_rounded:nnnn { \_@@_number_format:nNe {#1} \l_@@_tmp_tl {#4} \_@@_write_xml:e {\l_@@_tmp_tl} } \cs_new:Nn \_@@_write_rounded:nnn { \_@@_write_rounded:nnnn {#1} {#2} {} {#3} } % \end{macrocode} % \end{function} % \subsection{XML indentation} % The indentation of the \XML does not really matter. % For debugging, it's a lot simpler to have it included and this also helped to maintain the structure of the code during development, so I decided to keep it. % The indentation is created using s bunch of auxiliary commands and variables which are defined here. % \begin{variable}{\g_@@_indent_int} % \begin{macrocode} \int_new:N \g_@@_indent_int % \end{macrocode} % \end{variable} % \begin{function}{\_@@_indent:,\_@@_xml_auto_indent:,\_@@_xml_newline_indent: } % \begin{macrocode} \cs_new:Nn \_@@_indent: { \space\space } \cs_new:Nn \_@@_indent:n { \prg_replicate:nn {#1} {\_@@_indent:} } \cs_new:Nn \_@@_xml_auto_indent: { \_@@_indent:n {\g_@@_indent_int} } % \end{macrocode} % \end{function} % The idea was to redefine the \cs[no-index]{newlinechar} to automatically indent the following line. % \begin{macrocode} \cs_new:Nn \_@@_xml_newline_indent: { \iow_newline: \_@@_xml_auto_indent: } % \end{macrocode} % \end{implementation} % Setting up the catcodes to simplify the \XML indentation. % \iffalse % \begin{macrocode} \cctab_new:N \g_@@_xml_cctab \begingroup% \endlinechar=13% \char_set_catcode:nn {13}{13}% \cctab_gsave_current:N \g_@@_xml_cctab% \endgroup % \end{macrocode} % \fi % \begin{documentation} % \subsection{Escaping macros inside \XML data} % \label{sec:disable_macros} % \DescribeMacro{\zugferd_disable_macros:} % Since we allow the use of \LaTeX{} code in some fields there has to be a mechanism to disable macros inside the \XML output. % The mechanism is created similar to the one by \pkg{hyperref}, and we also use some definitions from there to use those as a starting point. % To have a detailed list of the redefinition, please have a look at the implementation of this command. % % There exists a hook to extend or overwrite these definitions |zugferd/disable-macros|. % You can add own redefinitions using this. For example if you want to overwrite the setting mapping a \cs[no-index]{newline} to a new line char instead of space, you could add the following to your setup: % \begin{examplecode} % \hook_gput_code:nnn {zugferd/disable-macros} % {newline-to-LF} % {\def\newline{\iow_newline:}} % \end{examplecode} % \end{documentation} % \begin{implementation} % \begin{function}{\zugferd_disable_macros:} % The definition was mostly taken from \pkg{hyperref} \cite{hyperref}. % Most likely not all of these are required, but it's probably easier to take this as a reasonable choice instead of creating an own collection. % \iffalse % \begin{macrocode} %% modified list taken from hyperref.sty v7.01i %% Copyright %% 1995-2001 Sebastian Rahtz, with portions written by David Carlisle and Heiko Oberdiek %% 2001-2015 Heiko Oberdiek %% 2016-2019 Oberdiek Package Support Group %% 2019-2024 LaTeX Project %% modifications have been made to support the mechanism if hyperref is not loaded % \end{macrocode} % \fi % \begin{macrocode} \cs_new:Nn \zugferd_disable_macros: { \let\{\textbraceleft \let\}\textbraceright \let\\\textbackslash \let\#\textnumbersign \let\$\textdollar % \end{macrocode} % This only is a part of the list. % There is no real use of printing the whole list, it's inside \file{zugferd.sty} anyway. % \comment % \begin{macrocode} \let\%\textpercent \let\&\textampersand \let\_\textunderscore \let\P\textparagraph \let\ldots\textellipsis \let\dots\textellipsis \def\\{\space}% \def\newline{\space}% \def\TeX{TeX}% \def\LaTeX{La\TeX}% \def\LaTeXe{\LaTeX2e}% \def\eTeX{e-\TeX}% \def\SliTeX{Sli\TeX}% \def\MF{Metafont}% \def\MP{Metapost}% \let\fontencoding\@gobble \let\fontfamily\@gobble \let\fontseries\@gobble \let\fontshape\@gobble \let\fontsize\@gobbletwo \let\selectfont\@empty \let\usefont\@gobblefour \let\emph\@firstofone \let\textnormal\@firstofone \let\textrm\@firstofone \let\textsf\@firstofone \let\texttt\@firstofone \let\textbf\@firstofone \let\textmd\@firstofone \let\textit\@firstofone \let\textsc\@firstofone \let\textsl\@firstofone \let\textup\@firstofone \let\normalfont\@empty \let\rmfamily\@empty \let\sffamily\@empty \let\ttfamily\@empty \let\bfseries\@empty \let\mdseries\@empty \let\itshape\@empty \let\scshape\@empty \let\slshape\@empty \let\upshape\@empty \let\em\@empty \let\rm\@empty \let\Huge\@empty \let\LARGE\@empty \let\Large\@empty \let\footnotesize\@empty \let\huge\@empty \let\large\@empty \let\normalsize\@empty \let\scriptsize\@empty \let\small\@empty \let\tiny\@empty \let\mathversion\@gobble \let\phantom\@gobble \let\vphantom\@gobble \let\hphantom\@gobble \let\ding\HyPsd@ding \let\Cube\HyPsd@DieFace \def\begin##1{\csname##1\endcsname}% \def\end##1{\csname end##1\endcsname}% \def\textcolor##1##{\@secondoftwo}% \def\TextOrMath{\ifmmode\expandafter\@secondoftwo\else\expandafter\@firstoftwo\fi}% \let\foreignlanguage\@secondoftwo \let\textlatin\@firstofone \let\cyr\relax \let\glqq\textglqq \let\grqq\textgrqq \let\glq\textglq \let\grq\textgrq \let\flqq\textflqq \let\frqq\textfrqq \let\flq\textflq \let\frq\textfrq \let\if@mid@expandable\@firstoftwo \let\hspace\@gobble \let\label\@gobble \let\index\@gobble \let\glossary\@gobble \let\@mkboth\@gobbletwo \let\leavevmode\@empty \let\mbox\@empty \def\halign{\@gobble}% \let\Hy@SectionAnchorHref\@gobble \let\ref\@gobble \let\href\@gobble \let\pageref\@gobble \let\nameref\@gobble \let\autoref\@gobble \let\ignorespaces\relax \let\ensuremath\@firstofone \hook_use:n {zugferd/disable-macros} % \end{macrocode} % \endcomment % \begin{macrocode} } % \end{macrocode} % To provide a possibility to extend or overwrite the macro list a hook is added. % \begin{macrocode} \hook_new:n {zugferd/disable-macros} % \end{macrocode} % \end{function} % \end{implementation} % \begin{documentation} % \section{Adding data to the XML} % All data which does not directly depend on amounts or specific items is provided using a key-value interface. % For some fields there is the option to define a global preset but locally overwrite it for a specific item. % This only applies to data fields used by the writing interfaces described in \autoref{sec:xml-interfaces}. % % This package is using the UN/CEFACT Cross Industry Invoice Syntax for the data. % Currently it is not planned to implement the UBL syntax as well, but generally this would be possible. % % In most cases this functionality will be used to change the tax setting or unit for a single item. % \autoref{sec:xml-interfaces} also provided an example for this. % % This section will now take all data which can be set using \cs{SetZUGFeRDData}. % % \end{documentation} % \begin{implementation} % \begin{variable}{\g_@@_notes_seq,\g_@@_id_tl,\g_@@_date_tl,\g_@@_subject_tl,\g_@@_fromaddress_tl,\g_@@_DocumentTypeCode_tl} % \begin{macrocode} \seq_new:N \g_@@_notes_seq \tl_new:N \g_@@_id_tl \tl_new:N \g_@@_date_tl \tl_new:N \g_@@_delivery_date_tl \tl_new:N \g_@@_subject_tl \tl_new:N \g_@@_fromaddress_tl \tl_new:N \g_@@_DocumentTypeCode_tl \tl_new:N \l_@@_currency_tl % \end{macrocode} % \end{variable} % \end{implementation} % \begin{documentation} % \subsection{General Invoicing Data} % Some of the general data currently supports only one value, which is alreay selected by default. % The interface already exists and may be extended later. % % \end{documentation} % \begin{implementation} % \begin{macrocode} \keys_define:nn { zugferd } { %TODO define others % \end{macrocode} % \end{implementation} % \begin{documentation} % \DescribeKeyOption{document-type=commercial-invoice}{commercial-invoice} % Select the document type. The only supported value currently is |commercial-invoice|. This will select the corresponding type code, which is 380. % \end{documentation} % \begin{implementation} % \begin{optionenv}{id, document-type} % \begin{macrocode} document-type .choice:, document-type / commercial-invoice .code:n = \tl_gset:Nn \g_@@_DocumentTypeCode_tl {380}, document-type .initial:n = commercial-invoice, % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsubsection{Invoice number/document ID} % \DescribeKeyOption*{id=komavar/\meta{document ID/invoice number}}{} % This has to be set. Leaving it empty will lead to an invalid \XMLfile. % % The value |komavar| would reference the data provided the KOMA-Script letter variabe |invoice|. In case you don't use \pkg{scrletter} you should not use this setting. % More information can be found in the documentation \cite{scrletter}. % \end{documentation} % \begin{implementation} % \begin{macrocode} id .choice:, id / komavar .code:n = \tl_gset:Nf \g_@@_id_tl {\scr@invoice@var}, id / unknown .code:n = \tl_gset:Nn \g_@@_id_tl {#1}, % \end{macrocode} % \end{implementation} % \begin{documentation} % \subsubsection{Currency} % \DescribeKeyOption{currency=EUR/USD/CHF/€}{EUR} % Currently \pkg{zugferd} only supports one currency for an invoice. This might be extended later. % The currency is pre-configured to use Euro. % \end{documentation} % \begin{implementation} % \begin{macrocode} currency .choices:nn = {EUR, USD, CHF} { \tl_set_eq:NN \l_@@_currency_tl \l_keys_choice_tl }, currency / € .meta:n = {currency = EUR}, currency / unknown .code:n = { \exp_args:Nnnx \keys_if_choice_exist:nnnTF {zugferd} {unit} { \str_uppercase:f {#1} } {\keys_set:nx { zugferd } {unit= {\str_uppercase:f {#1}}}} { \msg_warning:nnn { zugferd } {unknown-value} {currency} {#1} \tl_set:Ne \l_@@_currency_tl {\str_uppercase:f {#1}} } }, currency .initial:n = EUR, % \end{macrocode} % \end{implementation} % \begin{documentation} % \subsubsection{Dates} % \DescribeKeyOption{date=auto/\meta{date formatted as YYYYMMDD}}{auto} % \DescribeKeyOption{delivery-date=auto/\meta{date formatted as YYYYMMDD}}{auto} % \DescribeKeyOption*{due-date=\meta{date formatted as YYYYMMDD}}{}* % Currently there are three kinds of dates implemented. % The XML-Standard requires them to use the structure \meta{YYYYMMDD}. % For the day this document was compiled this would be: \enquote{\InsertZUGFeRDData{date}} (\today). % % Instead of providing a date value directly it's also possible to use \cs[no-index]{today}. % This is done using the \value{auto} which is the default setting for \option{date} and \option{delivery-date}. % Please be aware, that this would change if you rebuild the document later. So you might want to use an actual value here. % \end{documentation} % % \begin{implementation} % \begin{optionenv}{date,delivery-date} % \begin{macrocode} date .choice:, date / auto .code:n = \tl_gset:Ne \g_@@_date_tl { \the\year \int_compare:nNnT {\month} < {10} {0} \the\month \int_compare:nNnT {\day} < {10} {0}\the\day }, date / unknown .code:n = \tl_gset:Nn \g_@@_date_tl {#1}, date .initial:n = auto, delivery-date .choice:, delivery-date / auto .code:n = \tl_gset:Ne \g_@@_delivery_date_tl { \the\year \int_compare:nNnT {\month} < {10} {0} \the\month \int_compare:nNnT {\day} < {10} {0}\the\day }, delivery-date / unknown .code:n = { \tl_gset:Nn \g_@@_delivery_date_tl {#1} }, delivery-date .initial:n = auto, due-date .tl_gset:N = \_@@_due_date_tl, due-date .initial:n =, % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsubsection{Payment terms} % \DescribeKeyOption{payment-terms=\meta{string}}{} % One option to set payment terms is the \option{due-date} mentioned before. % If this is not set or the setting is more complex one can use \option{payment-terms} to add more information. % % This setting is a string. In case there is expansion required this has to be done before. % \end{documentation} % \begin{implementation} % \begin{optionenv}{payment-terms} % \begin{macrocode} payment-terms .str_gset:N = \_@@_payment_terms_str, payment-terms .initial:n =, % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsubsection{Notes: Adding additional information} % \DescribeKeyOption{subject=komavar/\meta{Tokenlist}}{} % \DescribeKeyOption{fromaddress=komavar/\meta{Tokenlist}}{} % \DescribeKeyOption{add-note=\meta{Tokenlist}}{}* % The ZUGFeRD example files\cite{zugferd-download} use all visible data to add them to the \XML as a note. % \option{subject} and \option{fromaddress} are used to support this. % The data should not be too relevant but \pkg{zugferd} want's to support adding additional data to the \XML using the note element. % So these fields can be left out but in case they are not empty, they will also be written to the \XML. % % The \value{komavar} corresponds to the mechanism provided by \pkg{scrletter}. % It accesses the variable expands it to be used directly. % If you don't use this package, you can ignore this setting or add content manually. % \end{documentation} % \begin{implementation} % \begin{optionenv}{subject,fromaddress,add-note} % \begin{macrocode} subject .choice:, subject / komavar .code:n = { \tl_gset:Nf \g_@@_subject_tl {\scr@subject@var} }, subject / unknown .code:n = \tl_gset:Nn \g_@@_subject_tl {#1}, fromaddress .choice:, fromaddress / komavar .code:n = \tl_gset:Nf \g_@@_fromaddress_tl {\scr@fromaddress@var}, fromaddress / unknown .code:n = \tl_gset:Nn \g_@@_fromaddress_tl {#1}, add-note .code:n = \seq_gput_right:Nn \g_@@_notes_seq {#1}, } \msg_new:nnnn {zugferd} {unknown-value} { You~selected~a~#1~which~was~not~predefined.\\ I~will~directly~use~your~selection~'#1=#2'. Please~ensure~the~selection~is~valid! } { For~more~information~see~the~zugferd~documentation. } % \end{macrocode} % \end{optionenv} % Macro to write notes % \begin{macrocode} \cs_new:Nn \_@@_note_if_not_empty:N {% \tl_if_empty:NF #1 {% \_@@_write_note:n {#1}% }% }% % \end{macrocode} % \end{implementation} % \begin{documentation} % \subsection{Trade parties} % \label{sec:TradeParties} % The \XML scheme knows 6 different Trade Parties: % \begin{itemize} % \item Seller % \item Buyer % \item Payee % \item ShipTo % \item SellerTaxRepresentative % \end{itemize} % % \noindent Currently \pkg{zugferd} supports only Buyer, Seller and ShipTo, but can be easily extended to support the others as well. % The data for each party follows the same structure, except the \enquote{BuyerReference} which is described later in this section. % % Some of the data is optional for specific parties. % As this also depends on the selected scheme and version we will not list the details. % All fields for a trade party can be set using the \enquote{group} named by the party. % For example setting all the seller data is done in the following listing: % \begin{examplecode} % \SetZUGFeRDData{ % seller/name = {peiTeX (Marei Peischl)}, % seller/email = {invoicing@peitex.de}, % seller/vatid = {DE123456789}, % seller/contact= {Marei\\+4900000000\\marei@peitex.de}, % seller/address = {Address Line 1\\Address Line 2}, % seller/postcode = {20253}, % seller/city ={Hamburg}, % seller/country = {DE}, % } % \end{examplecode} % \noindent All this data is saved within a property list, which is internally called \cs[no-index]{g_@@_\meta{seller/buyer/shipto}_prop}. % By default this property list is empty. % The users themselves have to ensure to add the required data. % % The outer braces are not required, if the data does not container an equal sign or a comma. % In case the final data is unknown, it's recommended to use them anyway. % % \DescribeKeyOption*{\meta{party}/name=\meta{name}}{}* % \DescribeKeyOption*{\meta{party}/email=\meta{email address}}{}* % \DescribeKeyOption*{\meta{party}/vatid=\meta{VAT ID}}{}* % % \DescribeKeyOption*{\meta{party}/address=\meta{address}}{}* % As shown in the example \option{address} can use two lines separted by |\\|. % It's possble to set all fields for all trade contacts, but e.\,g. for the |shipto|-party email and vatid will not be used in the \XML. % % Alternatively it's also possible to use \option{\meta{party}/lineone} and \option{\meta{party/linetwo}} separately. % This may be helpful if you use a custom input format. In any way you should ensure that all macros used within the data either are expandable or disabled using \cs[no-index]{zugferd_disable_macros:}. % % \DescribeKeyOption*{\meta{party}/postcode=\meta{postal code}}{}* % \DescribeKeyOption*{\meta{party}/city=\meta{city}}{}* % \DescribeKeyOption*{\meta{party}/country=\meta{country code}}{}* % The two letter country codes allowed here can be found in \cite{country-codes}. % % % \DescribeKeyOption*{\meta{party}/contact=\meta{Combined contact data}}{}* % The contact person can either be set using the combined structure similar to \option{\meta{party}/address}. % It either consists of 3 or 4 entries, depending on if a department should be used or not. % % \begin{examplecode} % \SetZUGFeRDData{ % seller/contact = { % |\meta{contact-name}|\\ % |\meta{contact-phone}|\\ % |\meta{contact-email}| % }, % seller/contact = { % |\meta{contact-name}|\\ % |\meta{contact-department}|\\ % |\meta{contact-phone}|\\ % |\meta{contact-email}| % } % } % \end{examplecode} % \noindent As for \option{seller/address} it's also possible to set the keys directly: % \begin{examplecode} % \SetZUGFeRDData{ % seller/contact-name= {|\meta{contact-name}|}, % seller/contact-department = {|\meta{contact-department}|}, % seller/cotact-phone ={|\meta{contact-phone}|}, % seller/contact-email= {|\meta{contact-email}|} % } % \end{examplecode} % \end{documentation} % \begin{implementation} % ApplicableHeaderTradeAgreement % % Contains information on seller and buyer trade party: % \begin{itemize} % \item BuyerReference % \item SellerTradeParty % \item BuyerTradeParty % \end{itemize} % % \begin{optionenv}{\meta{party}/address} % \begin{variable}{\g_@@_seller_AddressData_prop,\g_@@_buyer_AddressData_prop,\g_@@_shipto_AddressData_prop} % Seller and Buyer are specified the same way. % \begin{macrocode} \clist_map_inline:nn {seller,buyer,shipto} { \prop_new:c {g_@@_#1_AddressData_prop} \keys_define:nn {zugferd / #1} { address .code:n = { \seq_set_split:Nnn \l_tmpa_seq {\\} {##1} %TODO error if more than 2 lines or only 1 \keys_set:nx {zugferd / #1} { lineone=\seq_item:Nn \l_tmpa_seq {1}, linetwo=\seq_item:Nn \l_tmpa_seq {2} } }, contact .code:n = { \seq_set_split:Nnn \l_tmpa_seq {\\} {##1} \int_compare:nNnTF {\seq_count:N \l_tmpa_seq} > {3} { \keys_set:ne {zugferd/#1} { contact-name = \seq_item:Nn \l_tmpa_seq {1}, contact-department = \seq_item:Nn \l_tmpa_seq {2}, contact-phone = \seq_item:Nn \l_tmpa_seq {3}, contact-email= \seq_item:Nn \l_tmpa_seq {4} } }{ \keys_set:ne {zugferd/#1} { contact-name = \seq_item:Nn \l_tmpa_seq {1}, contact-phone = \seq_item:Nn \l_tmpa_seq {2}, contact-email= \seq_item:Nn \l_tmpa_seq {3} } } }, unknown .code:n = \tl_if_blank:nF {##1} { \prop_gput:cVe {g_@@_#1_AddressData_prop} \l_keys_key_tl {\tl_trim_spaces:n {##1}} } } } % \end{macrocode} % \end{variable} % \end{optionenv} % \begin{function}{\_@@_PostalTradeAddress:N,\_@@_DefinedTradeContact:N} % Wrappers to map the property list items to the writing macro. % \begin{macrocode} \cs_new:Nn \_@@_PostalTradeAddress_short:N { \exp_args:Ne \tl_if_blank:nF {\prop_item:Nn #1 {name}} {\prop_item:Nn #1 {name}\iow_newline:\_@@_xml_auto_indent:} \_@@_PostalTradeAddress:eeeee {\prop_item:Nn #1 {postcode}} {\prop_item:Nn #1 {lineone}} {\prop_item:Nn #1 {linetwo}} {\prop_item:Nn #1 {city}} {\prop_item:Nn #1 {country}} } \cs_new:Nn \_@@_PostalTradeAddress:N {% \_@@_PostalTradeAddress:eeeeeee {\prop_item:Nn #1 {postcode}} {\prop_item:Nn #1 {lineone}} {\prop_item:Nn #1 {linetwo}} {\prop_item:Nn #1 {city}} {\prop_item:Nn #1 {country}} {\prop_item:Nn #1 {email}} {\prop_item:Nn #1 {vatid}} }% \cs_new:Nn \_@@_DefinedTradeContact:N {% \_@@_DefinedTradeContact:eeee {\prop_item:Nn #1 {contact-name}} {\prop_item:Nn #1 {contact-department}} {\prop_item:Nn #1 {contact-phone}} {\prop_item:Nn #1 {contact-email}} }% % \end{macrocode} % \end{function} % \begin{macrocode} \cctab_begin:N \g_@@_xml_cctab% % \end{macrocode} % \iffalse % \_@@_PostalTradeAddress:nnnnnnn Name/Firma PLZ Zeile1 Zeile2 Ort Ländercode Email UID % \fi % \begin{macrocode} \_@@_define_xml_content:Nn \_@@_PostalTradeAddress:nnnnn {% \_@@_indent: #1 \tl_if_blank:nF {#2} {% \_@@_indent: #2 }% \tl_if_blank:nF {#3} {% \_@@_indent: #3 }% \_@@_indent: #4 \_@@_indent: #5 % } \_@@_define_xml_content:Nn \_@@_PostalTradeAddress:nnnnnnn {% \_@@_PostalTradeAddress:nnnnn {#1} {#2} {#3} {#4} {#5} \tl_if_empty:nF {#6} {% \_@@_indent: #6 % }% % TODO add support local tax id: schemaID="FC" \tl_if_empty:nF {#7} { \_@@_indent: #7 % }% }% % % Contact data phone/email to a specific contact person \_@@_define_xml_content:Nn \_@@_DefinedTradeContact:nnnn {% % Do not print if name is empty \tl_if_blank:nT {#1} {\use_none:nnn} % \bool_if:NT \g_@@_writeTradeContact_bool {% \_@@_indent: #1 \tl_if_blank:nF {#2} {% \_@@_indent: #2 }% \tl_if_blank:nF {#3} {% \_@@_indent: \_@@_indent:n {2} #3 \_@@_indent: }% \tl_if_blank:nF {#4} {% \_@@_indent: \_@@_indent:n {2} #4 \_@@_indent: }% % }% }% % \_@@_define_xml_writer:Nn \_@@_ApplicableHeaderTradeAgreement: {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \g_@@_buyer_reference_tl % }% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \prop_item:Nn \g_@@_seller_AddressData_prop {name} \_@@_DefinedTradeContact:N \g_@@_seller_AddressData_prop% \_@@_PostalTradeAddress:N \g_@@_seller_AddressData_prop% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:e {% % }% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \prop_item:Nn \g_@@_buyer_AddressData_prop {name} \_@@_DefinedTradeContact:N \g_@@_buyer_AddressData_prop% \_@@_PostalTradeAddress:N \g_@@_buyer_AddressData_prop% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {} \_@@_ApplicableHeaderTradeDelivery:V \g_@@_delivery_date_tl% }% % % % delivery date \_@@_define_xml_content:Nn \_@@_ApplicableHeaderTradeDelivery:n {% \bool_lazy_and:nnF {\prop_if_empty_p:N \g_@@_shipto_AddressData_prop}% {\tl_if_blank_p:n {#1}}% {% \_@@_write_xml:n {}% \prop_if_empty:NF \g_@@_shipto_AddressData_prop {% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \_@@_PostalTradeAddress_short:N \g_@@_shipto_AddressData_prop% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% \int_gdecr:N \g_@@_indent_int% }% \tl_if_blank:nF {#1} {% \_@@_write_xml:n {% \_@@_indent: \_@@_indent:n {2} \_@@_indent:n {3}#1 \_@@_indent:n {2} \_@@_indent: % }% }% \_@@_write_xml:n {}% }% }% % \cctab_end: \cs_generate_variant:Nn \_@@_DefinedTradeContact:nnnn {eeee} \cs_generate_variant:Nn \_@@_PostalTradeAddress:nnnnn {eeeee}% \cs_generate_variant:Nn \_@@_PostalTradeAddress:nnnnnnn {eeeeeee} \cs_generate_variant:Nn \_@@_ApplicableHeaderTradeDelivery:n {V} % \end{macrocode} % \end{implementation} % \begin{documentation} % \subsubsection{Buyer Reference} % \DescribeKeyOption*{buyer/reference=komavar/\meta{Reference}}{} % The reference field only exists for the |buyer| trade party. % Depending on the process it's required to use some unique identifier referring to the |buyer|. % Within Germany these numbers are called \enquote{Leitweg-ID}\cite{leitweg-id}. % % In any way the |buyer| may choose what is used here. Also may be some PO number or similar reference. % % As defined for other variables the \option{reference} can also use the \value{komavar} value to refer to the value of komavar |yourref|\cite{scrletter}. % \end{documentation} % \begin{implementation} % \begin{optionenv}{buyer/reference} % \begin{macrocode} \tl_new:N \g_@@_buyer_reference_tl \keys_define:nn {zugferd/buyer} { reference .choice:, reference / komavar .code:n = { \tl_gset:Nf \g_@@_buyer_reference_tl {\scr@yourref@var} }, reference / unknown .code:n = { \tl_gset:Nn \g_@@_buyer_reference_tl {#1} } } % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsubsection{Payment Means} % \label{sec:PaymentMeans} % The payment means are selected by numeric codes. % Currently we support: % \begin{itemize} % \UseName{exp_args:Nnnc} \UseName{exp_args:co} {clist_map_inline:nn} {zugferd@paymentMeans@english} {\item #1} % \end{itemize} % Others may be added in the future but it's not planned to include a full list. % % The codes will automatically add the corresponding string inside the \enquote{Information} field. % The initial version only included German strings, but currently they are also included in English. % It's possible to overwrite them using the same structure: % % \begin{examplecode} % \setupZUGFeRDStrings{payment-means}{ % 10 = Bargeld, % 58 = Zahlung per SEPA Überweisung., % } % \end{examplecode} % The language selection is done using at hook executed at |\begin{document}| and will try to use the document's language. % If this is not defined English will be used. % % Internally the commands are predefined as a key-value list like the argument in the example above. % They macros are called \cs[no-index]{zugferd@paymentMeans@\meta{languagename}}. % Currently \pkg{zugferd} defines these for |english| and |german| (also |ngerman| as an compatibility alias). % \end{documentation} % \begin{implementation} % \begin{optionenv}{payment-means} % \begin{macrocode} \ExplSyntaxOff \providecommand*{\zugferd@paymentMeans@german}{ 1 = Keine Zahlungsart definiert, 10 = Bargeld, 30 = Überweisung, 42 = Zahlung an Bankkonto, 48 = Kartenzahlung, 49 = Lastschriftverfahren, 57 = Dauerauftrag, 58 = Zahlung per SEPA Überweisung., 59 = SEPA Lastschrift, 97 = Ausgleich zwischen Partnern } \def\zugferd@paymentMeans@ngerman{\zugferd@paymentMeans@german} \providecommand*{\zugferd@paymentMeans@english}{ 1 = Instrument not defined, 10 = In cash, 30 = Credit Transfer, 31 = Debit Transfer, 42 = Payment to bank account, 48 = Bank card, 49 = Direct Debit, 57 = Standing agreement, 58 = SEPA credit transfer, 59 = SEPA direct debit, 97 = Clearing between partners } \ExplSyntaxOn \tl_new:N \g_@@_payment_means_tl \keys_define:nn {zugferd} { payment-means / type .choices:nn = {1,10,30,42,48,49,57,58,59,97} { \tl_gset_eq:NN \g_@@_payment_means_tl \l_keys_choice_tl }, payment-means / unknown .code:n = { \msg_warning:nnn { zugferd } {unknown-value} {payment-means} {#1} \tl_gset:Nn \g_@@_payment_means_tl {\int_eval:n {#1}} } } \clist_map_inline:nn {iban,account-holder,bic} { \keys_define:nn {zugferd/payment-means} { #1 .tl_gset:c = {g_@@_payment_#1_tl} } } \prop_new:c {g_@@_payment-means_names_prop} \newcommand*{\setupZUGFeRDStrings}[2]{ \prop_gset_from_keyval:cn {g_@@_#1_names_prop} { #2 } } \hook_gput_code:nnn {begindocument/end}{zugferd/payment-means}{ \prop_if_empty:cT {g_@@_payment-means_names_prop} { \exp_args:Nne \setupZUGFeRDStrings{payment-means}{ \use:c {zugferd@paymentMeans@ \cs_if_exist:cTF {zugferd@paymentMeans@\languagename} {\languagename} {english} } } } } % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsection{Variables which may be changed per invoice item} % Some settings may have the same value for all invoice items. % These are defined to take some preset but are set locally. % So it's possible to adjust them for a single invoice item if necessary. % An example is shown in \autoref{sec:xml-interfaces}. % \subsubsection{Units} % \DescribeKeyOption*{unit=hour/day/one/piece/\meta{unit code}}{} % The Faktur-X standard requires the unit to be selected. % These are called \enquote{/UN/CEFACT Common Codes} and can be found withtin \cite{unit-codes}. % % Currently \pkg{zugferd} supports |hour| (|HUR|), |day| (|DAY|), |one| (C62) and |piece| (H87). % For these the corresponding codes have been implemented within the package. % Other units can be selected using the codes listed in \cite{unit-codes}. % % This option is not case sensitive % The value is automatically converted to uppercase. % If the selected option is different from the predefined ones, there will be a warning, as \pkg{zugferd} does not know if the selection is valid or not. % \begin{NOTE} % additional source: http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_Rev9e_2014.xls % \end{NOTE} % \end{documentation} % \begin{implementation} % \begin{optionenv}{unit} % \begin{macrocode} \keys_define:nn { zugferd } { unit .choices:nn = {HUR,DAY,C62,H87} { \tl_set_eq:NN \l_@@_unit_code_tl \l_keys_choice_tl }, unit / hour .meta:n = {unit=HUR}, unit / day .meta:n = {unit=DAY}, unit / one .meta:n= {unit= C62}, unit / piece .meta:n = {unit=H87}, % \end{macrocode} % If unknown, the value is converted to uppercase and we use the selection directly. % There is a warning in that case % \begin{macrocode} unit / unknown .code:n = { \tl_set:Nx \l_tmpa_tl {\str_uppercase:f {#1}} \exp_args:NnnV \keys_if_choice_exist:nnnTF {zugferd} {unit} \l_tmpa_tl { \keys_set:ne { zugferd } {unit= {\l_tmpa_tl}} } { \msg_warning:nnn { zugferd } {unknown-unit} {#1} \tl_set_eq:NN \l_@@_unit_code_tl \l_tmpa_tl } }, unit .usage:n = general, } \msg_new:nnnn {zugferd} {unknown-unit} { You~selected~a~unit~which~was~not~predefined.\\ I~~will~directly~use~your~selection~'unit=#1'~as~Common~Code. Please~ensure~the~selection~is~valid! } { For~more~information~see~the~zugferd~documentation\\ and~the~/UN/CEFACT~Common~Code~list. } % \end{macrocode} % \end{optionenv} % \end{implementation} % \begin{documentation} % \subsubsection{Tax category and rate} % \label{sec:tax-category} % \DescribeKeyOption{tax/category=\meta{category code/alias}}{standard}* % The Tax data requires a category code. For details have a look at the Specification \cite[e.\,g. at][]{spec-xrechnung}. % \pkg{zugferd} implements all of those, but the user has to take care to select the correct one for each invoice item. % The example file includes 2 different VAT values using the same category. % % The labels have been chosen to simplify the usage. It's also possible to enter the codes directly. % This option is not case sensitive. % \begin{valuelist} % \item[standard] Standard rate and reduced rate item, |category=S| % \item[zero] Zero rated sale, |category=Z| % \item[exempt] Exempted from VAT. This requires a reason via \option{exemption-reason},|category=E| % \item[reverse-charge] Reverse Charge, |category=AE| % \item[intra-community\\\textnormal{or} EEA] Intra-Community Supply, |category=K| % \item[export] Free export item, tax not charged, |category=G| % \item[O] Services outside scope of tax % \item[canary-islands] Canary Islands general indirect tax, |category=L| % \item[ceuta\\\textnormal{or} melilla] Ceuta and Melilla, |category=M| % \end{valuelist} % % \end{documentation} % \begin{implementation} % \optionenv{category, exemption-reason,rate} % \begin{macrocode} \msg_new:nnnn {zugferd} {unknown-tax-category} { You~selected~an~unknown~tax~category.\\ I~~will~directly~use~your~selection~'category=#1'~as~Code.\\ Please~ensure~the~selection~is~valid! } { For~more~information~see~the~zugferd~documentation\\ and~the~corresponding~code~list. } \msg_new:nnnn {zugferd} {no-auto-exemption} { You~selected~tax/category=#1~together~with~the~auto-exemption~option.\\ I~don't~have~any~pre-configured~exemption~setting~for~category=#1.\\ Please~make~sure~you~add~a~valid~setting~yourself. } { For~more~information~see~the~zugferd~documentation. } \keys_define:nn { zugferd / tax } { category .choices:nn = {S,Z,E,AE,K,G,O,L,M} { \tl_set_eq:NN \l_@@_tax_category_code_tl \l_keys_choice_tl \bool_if:NT \g_@@_auto_exemption_bool { \keys_if_choice_exist:nnnTF {zugferd/tax} {exemption-reason-auto} {#1} { \keys_set:nn {zugferd/tax} {exemption-reason-auto=#1} } { \msg_warning:nnn { zugferd } {no-auto-exemption} {#1} } } }, % \end{macrocode} % \end{implementation} % \begin{documentation} % \DescribeKeyOption*{tax/exemption-reason=\meta{Text}}{}* % \DescribeKeyOption*{tax/exemption-reason-code=\meta{exemption reason code}}{}* % Add Reasons for a tax exempt, as required by |category=E,K,AE,G,O|. % This can either be added using a text (|exemption-reason|) or a predefined code (|exemption-reason-code|). % The codes are listed at \cite{VAT-exemption-codes}. % % In most common cases \pkg{zugferd} tries to automatically match them if the package option \option{auto-exemption} is enabled, which is the default. % In that case the following settings would apply: % % \begin{valuelist} % \item[S] \accessTaxExemptionReason{S} % \item[Z] Not configured. % \item[E] Not configured, as there are too many options. % \item[AE] \accessTaxExemptionReason{AE} % \item[K] \accessTaxExemptionReason{K} % \item[G] \accessTaxExemptionReason{G} % \item[O] \accessTaxExemptionReason{O} % \end{valuelist} % % In case there is no pre-configured selection \pkg{zugferd} will create a warning to remind the user to add a selection themselves. % % \end{documentation} % \begin{implementation} % \begin{macrocode} exemption-reason .tl_set:N = \l_@@_tax_exemption_reason_tl, exemption-reason .initial:V = \c_empty_tl, exemption-reason .usage:n = general, exemption-reason-code .tl_set:N = \l_@@_tax_exemption_code_tl, exemption-reason-code .initial:V = \c_empty_tl, exemption-reason .usage:n = general, % \end{macrocode} % \changes{v0.7}{2024-09-10}{Added exemption-reason-auto key for pre-configured exemption-reasons.} % \begin{macrocode} exemption-reason-auto .choice:, exemption-reason-auto / S .code:n = { \keys_set:nn {zugferd/tax} {exemption-reason=,exemption-reason-code=} }, exemption-reason-auto / K .code:n = { \keys_set:nn {zugferd/tax} { exemption-reason= Intra-Community~Supply, exemption-reason-code={vatex-eu-ic} } }, exemption-reason-auto / AE .code:n = { \keys_set:nn {zugferd/tax}{ exemption-reason=Reverse~Charge, exemption-reason-code={vatex-eu-ae} } }, exemption-reason-auto / G .code:n = { \keys_set:nn {zugferd/tax}{ exemption-reason=Export~outside~the~EU, exemption-reason-code={vatex-eu-g} } }, exemption-reason-auto / O .code:n = { \keys_set:nn {zugferd/tax}{ exemption-reason=No~subject~to~VAT, exemption-reason-code={vatex-eu-o} } }, standard .meta:n = {category=S}, zero .meta:n = {category=Z}, exempt .meta:n = {category=E}, reverse-charge .meta:n = {category=AE}, intra-community .meta:n = {category=K}, EEA .meta:n = {category=K}, export .meta:n = {category=G}, canary-islands .meta:n = {category=L}, ceuta .meta:n = {category=M}, melilla .meta:n = {category=M}, category / unknown .code:n = { \exp_args:Nnnx \keys_if_choice_exist:nnnTF {zugferd} {category} {\str_uppercase:f {#1}} { \keys_set:nx { zugferd } {category= {\str_uppercase:f {#1}}} } { \msg_warning:nnn { zugferd } {unknown-tax-category} {#1} } }, category .initial:n = S, category .usage:n = general, % \end{macrocode} % \end{implementation} % \begin{documentation} % \DescribeKeyOption{tax/rate=\meta{floating point}}{19}* % The value given will be used for tax calculation. % By default it's configured to |19| to match the German standard VAT rate. % % \end{documentation} % \begin{implementation} % \begin{macrocode} rate .fp_set:N = \l_@@_tax_rate_fp, rate .initial:n = 19, rate .usage:n = general, } % \end{macrocode} % \endoptionenv % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_write_inline:nn { \tl_if_blank:nF {#2} { <#1>#2 } } \cs_generate_variant:Nn \_@@_write_inline:nn {ne} \_@@_define_xml_writer:Nn \_@@_write_inline_i:nn { \_@@_indent: \_@@_write_inline:nn {#1} {#2} } \cctab_begin:N \g_@@_xml_cctab% % \_@@_define_xml_writer:Nn \_@@_write_note:n {% \begingroup% \let\\\iow_newline:% \_@@_write_xml:e {% \_@@_indent: #1 \_@@_indent: % }% \endgroup% }% % % \begingroup% \char_set_catcode_other:N \#% \char_set_catcode:nn {32}{10}% \_@@_define_xml_writer:Nn \_@@_insert_Header: {% \_@@_write_xml:e {% % }% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \str_if_empty:NF \g_@@_businessProcessId_str {% \_@@_indent: \g_@@_businessProcessId_str }% \_@@_indent: \g_@@_format_str % }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% \endgroup% \_@@_define_xml_writer:Nn \_@@_insert_FrontMatter: {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \g_@@_id_tl \g_@@_DocumentTypeCode_tl % space required! \_@@_indent:\g_@@_date_tl % }% \_@@_note_if_not_empty:N \g_@@_subject_tl% \_@@_note_if_not_empty:N \g_@@_fromaddress_tl% \seq_map_inline:Nn \g_@@_notes_seq {% \_@@_write_note:n {##1}% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:e {% % }% \int_gincr:N \g_@@_indent_int% }% % % footer \_@@_define_xml_writer:Nn \_@@_insert_Footer: {% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% \cctab_end: % \end{macrocode} % % \subsection{Invoice Items} % Each item consists of 5 parts: % \begin{itemize} % \item AssociatedDocumentLineDocument % \item SpecifiedTradeProduct % \item SpecifiedLineTradeAgreement % \item SpecifiedLineTradeDelivery % \item SpecifiedLineTradeSettlement % \end{itemize} % These are implemented as separate commands to be more flexible. % The wrapper command is called \cs[no-index]{@@_insert_TradeLineItem:nnnnnn} and is created to be used in your own invoicing package- % \begin{macrocode} \cctab_begin:N \g_@@_xml_cctab% % \end{macrocode} % \begin{function}{\_@@_AssociatedDocumentLineDocument:n} % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_AssociatedDocumentLineDocument:n {% \_@@_indent: #1 % }% % \end{macrocode} % \end{function} % \begin{function}{\_@@_SpecifiedTradeProduct:nn} % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_SpecifiedTradeProduct:nn {% \tl_if_empty:nF {#1} {% \_@@_indent: #1 }% \_@@_indent: #2 % }% % \end{macrocode} % \end{function} % \begin{function}{\_@@_ProductTradePrice:nn} % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_ProductTradePrice:nn {% \_@@_indent: #2 % }% % \end{macrocode} % \end{function} % \begin{function}{\_@@_SpecifiedLineTradeAgreement:nn} % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_SpecifiedLineTradeAgreement:nn {% \_@@_indent: \_@@_indent:n {2} #1 \_@@_indent: \_@@_indent: \_@@_indent:n {2} #2 \_@@_indent: }% % \end{macrocode} % \end{function} %%%\subsubsection{SpecifiedLineTradeDelivery}%:nn % \begin{function}{\_@@_SpecifiedLineTradeDelivery:nn} % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_SpecifiedLineTradeDelivery:nn {% % SPACE! \_@@_indent: #2 }% % \end{macrocode} % \end{function} % \begin{function}{\_@@_SpecifiedLineTradeSettlement:nnn,\_@@_SpecifiedLineTradeSettlement:Vnn} % \begin{macrocode} \_@@_define_xml_content:Nn \_@@_SpecifiedLineTradeSettlement:nnn {% \_@@_indent: %BT-151 \_@@_indent:n {2} VAT %BT-151 \_@@_indent:n {2} #1 %BT-152 \_@@_indent:n {2} #2 \_@@_indent: \_@@_indent: % BT-131 \_@@_indent:n {2} #3 \_@@_indent: % }% % \end{macrocode} % \begin{macrocode} \cctab_end: \cs_generate_variant:Nn \_@@_SpecifiedLineTradeSettlement:nnn {Vnn} % \end{macrocode} % \end{function} % The exemption reason was placed wrong with the pre-CTAN release. % This was fixed in August 2024. % The old macro will be kept for a bit longer but will be removed soon. % Please update your own implementations accordingly. % \changes{v0.4}{2024-08-22}{Deprecate old syntax and add public interfaces.} % \begin{macrocode} \cs_new:Nn \_@@_SpecifiedLineTradeSettlement:nnnn { \msg_warning:nnnn {zugferd} {macro-deprecated} { \_@@_SpecifiedLineTradeSettlement:nnnn } { \_@@_SpecifiedLineTradeSettlement:nnn } \_@@_SpecifiedLineTradeSettlement:nnn {#2} {#3} {#4} } \cs_generate_variant:Nn \_@@_SpecifiedLineTradeSettlement:nnnn {VVnn} % \end{macrocode} % \end{implementation} % \begin{implementation} % \begin{function}{ \_@@_insert_TradeLineItem:nnnnnn,\@@_write_TradeLineItem:nnnnnn} % Writing an invoice item using the helper commands defined before, to the \XMLfile. % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_insert_TradeLineItem:nnnnnn { \_@@_write_xml:n {} \int_gincr:N \g_@@_indent_int \_@@_write_xml:e {\_@@_AssociatedDocumentLineDocument:n {#1}}% \begingroup \zugferd_disable_macros: \_@@_write_xml:e {\_@@_SpecifiedTradeProduct:nn {#2} {#3}} \endgroup \_@@_write_xml:n {} \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {\_@@_ProductTradePrice:nn {net} {#4}} \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {} \_@@_write_xml:e {% \_@@_SpecifiedLineTradeDelivery:nn { \l_@@_unit_code_tl } {#5} \_@@_SpecifiedLineTradeSettlement:Vnn \l_@@_tax_category_code_tl % { \fp_use:N \l_@@_tax_rate_fp} {#6} }% \int_gdecr:N \g_@@_indent_int \_@@_write_xml:n {} } % \end{macrocode} % \end{function} % \end{implementation} % \begin{implementation} % ApplicableHeaderTradeSettlement % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_SpecifiedTradeSettlementHeaderMonetarySummation:nnnnnnnn {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_rounded:nnn {2} {LineTotalAmount} {#1} \_@@_write_rounded:nnn {2} {ChargeTotalAmount} {#2} \_@@_write_rounded:nnn {2} {AllowanceTotalAmount} {#3} \_@@_write_rounded:nnn {2} {TaxBasisTotalAmount} {#4} \_@@_write_rounded:nnnn {2} {TaxTotalAmount} {~currencyID="\l_@@_currency_tl "} {#5} \_@@_write_rounded:nnn {2} {GrandTotalAmount} {#6} \_@@_write_rounded:nnn {2} {TotalPrepaidAmount} {#7} \_@@_write_rounded:nnn {2} {DuePayableAmount} {#8} \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% % ApplicableTradeTax CategoryCode Rate BaseAmount Result \_@@_define_xml_writer:Nn \_@@_ApplicableTradeTax:nnnn {% \_@@_write_xml:n {} \int_gincr:N \g_@@_indent_int% \_@@_write_rounded:nnn {2} {CalculatedAmount} {#4}%BT117 \_@@_write_xml:n {VAT}%BT118 \tl_if_blank:VF \l_@@_tax_exemption_reason_tl {%BT-120 \_@@_write_xml:e { \l_@@_tax_exemption_reason_tl } } {{\_@@_write_rounded:nnn {2} {BasisAmount} {#3}}}%BT-116 \_@@_write_xml:e {#1}%BT-118 \tl_if_blank:VF \l_@@_tax_exemption_code_tl {%BT121 \_@@_write_xml:e { \l_@@_tax_exemption_code_tl } } \_@@_write_xml:n {#2}%BT-119 \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {} }% % \cctab_begin:N \g_@@_xml_cctab% % ApplicableHeaderTradeSettlement \_@@_define_xml_writer:Nn \_@@_ApplicableHeaderTradeSettlement:nnnnnnnn {% }% % \end{macrocode} % ApplicableHeaderTradeSettlement needs to be splitted to be used in separate parts of the tabular. % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_ApplicableHeaderTradeSettlement_start: {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {\l_@@_currency_tl}% }% \_@@_define_xml_writer:Nn \_@@_ApplicableHeaderTradeSettlement_stop: {% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% % \end{macrocode} % SpecifiedTradePaymentTerms % \begin{macrocode} \_@@_define_xml_writer:Nn \_@@_SpecifiedTradePaymentTerms:nn {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \tl_if_blank:nF {#1} {% #1% }% \tl_if_blank:nF {#2} {% \_@@_indent: #2 % }% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% % % % sums \_@@_define_xml_writer:Nn \_@@_SpecifiedTradeSettlementPaymentMeans:nnn {% \bool_if:NT \g_@@_writePaymentMeans_bool {% \_@@_write_xml:n {}% \int_gincr:N \g_@@_indent_int% \_@@_write_xml:e {% \g_@@_payment_means_tl \_@@_write_inline:ne {ram:Information} {\prop_item:cV {g_@@_payment-means_names_prop} \g_@@_payment_means_tl}% \tl_if_blank:nF {#1#2} {% \_@@_write_inline_i:nn {ram:IBANID} {#2} \_@@_write_inline_i:nn {ram:AccountName} {#1} }% \tl_if_blank:nF {#3} {% \_@@_write_inline_i:nn {ram:BICID} {#3} % }% }% \int_gdecr:N \g_@@_indent_int% \_@@_write_xml:n {}% }% }% \cctab_end: \cs_generate_variant:Nn \_@@_SpecifiedTradePaymentTerms:nn {VV} \_@@_define_xml_writer:Nn \_@@_SpecifiedTradePaymentTerms: { \_@@_SpecifiedTradePaymentTerms:VV \_@@_payment_terms_str \_@@_due_date_tl } % \end{macrocode} % \begin{function}{\_@@_SpecifiedTradeSettlementPaymentMeans:} % \begin{macrocode} \cs_generate_variant:Nn \_@@_SpecifiedTradeSettlementPaymentMeans:nnn {vvv} \_@@_define_xml_writer:Nn \_@@_SpecifiedTradeSettlementPaymentMeans: { \tl_if_blank:VF \g_@@_payment_means_tl { \_@@_SpecifiedTradeSettlementPaymentMeans:vvv {g_@@_payment_account-holder_tl} {g_@@_payment_iban_tl} {g_@@_payment_bic_tl} } } % \end{macrocode} % \end{function} % \end{implementation} % \begin{implementation} % \begin{macrocode} \msg_new:nnn {zugferd} {macro-deprecated} { The~function~#1~is~deprecated.\\ It~was~replaced~by~#2.\\ Please~adjust~your~mechanism~to~use~the~new~version. } % \end{macrocode} % \end{implementation} % \iffalse % \begin{macrocode} % % \end{macrocode} % \fi % \Finale \endinput