Dokumentation: Variablennamen für periodisch erzeugte Rechnungen dokumentiert
[kivitendo-erp.git] / doc / html / ch03.html
index aa5ba8c..16b8828 100644 (file)
         Konfiguriert wird dies in der <a class="link" href="ch02s04.html#config.config-file.sections-parameters" title="2.4.2. Abschnitte und Parameter">Konfigurationsdatei</a>
         
                <code class="filename">config/kivitendo.conf</code> im Abschnitt
-        <code class="varname">[periodic_invoices]</code>.</p></div><div class="sect2" title="3.1.3. Auflisten"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.reports"></a>3.1.3. Auflisten</h3></div></div></div><p>Unter Verkauf-&gt;Berichte-&gt;Aufträge finden sich zwei neue
+        <code class="varname">[periodic_invoices]</code>.</p></div><div class="sect2" title="3.1.3. Spezielle Variablen"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.variables"></a>3.1.3. Spezielle Variablen</h3></div></div></div><p>
+          Um die erzeugten Rechnungen individualisieren zu können, werden beim Umwandeln des Auftrags in eine Rechnung einige speziell
+          formatierte Variablen durch für die jeweils aktuelle Abrechnungsperiode gültigen Werte ersetzt. Damit ist es möglich, z.B. den
+          Abrechnungszeitraum explizit auszuweisen. Eine Variable hat dabei die Syntax <code class="literal">&lt;%variablenname%&gt;</code>.
+        </p><p>
+          Diese Variablen werden in den folgenden Elementen des Auftrags ersetzt:
+        </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Bemerkungen</p></li><li class="listitem"><p>Interne Bemerkungen</p></li><li class="listitem"><p>Vorgangsbezeichnung</p></li><li class="listitem"><p>In den Beschreibungs- und Langtextfeldern aller Positionen</p></li></ul></div><p>Die zur Verfügung stehenden Variablen sind die Folgenden:</p><div class="variablelist"><dl><dt><span class="term">
+                     <code class="varname">&lt;%current_quarter%&gt;</code>, <code class="varname">&lt;%previous_quarter%&gt;</code>, <code class="varname">&lt;%next_quarter%&gt;</code>
+                  </span></dt><dd><p>
+                Aktuelles, vorheriges und nächstes Quartal als Zahl zwischen <code class="literal">1</code> und <code class="literal">4</code>.
+              </p></dd><dt><span class="term">
+                     <code class="varname">&lt;%current_month%&gt;</code>, <code class="varname">&lt;%previous_month%&gt;</code>, <code class="varname">&lt;%next_month%&gt;</code>
+                  </span></dt><dd><p>
+                Aktueller, vorheriger und nächster Monat als Zahl zwischen <code class="literal">1</code> und <code class="literal">12</code>.
+              </p></dd><dt><span class="term">
+                     <code class="varname">&lt;%current_month_long%&gt;</code>, <code class="varname">&lt;%previous_month_long%&gt;</code>, <code class="varname">&lt;%next_month_long%&gt;</code>
+                  </span></dt><dd><p>
+                Aktueller, vorheriger und nächster Monat als Name (<code class="literal">Januar</code>, <code class="literal">Februar</code> etc.).
+              </p></dd><dt><span class="term">
+                     <code class="varname">&lt;%current_year%&gt;</code>, <code class="varname">&lt;%previous_year%&gt;</code>, <code class="varname">&lt;%next_year%&gt;</code>
+                  </span></dt><dd><p>
+                Aktuelles, vorheriges und nächstes Jahr als vierstellige Jahreszahl (<code class="literal">2013</code> etc.).
+              </p></dd><dt><span class="term">
+                     <code class="varname">&lt;%period_start_date%&gt;</code>, <code class="varname">&lt;%period_end_date%&gt;</code>
+                  </span></dt><dd><p>
+                Formatiertes Datum des ersten und letzten Tages im Abrechnungszeitraum (z.B. bei quartalsweiser Abrechnung und im ersten
+                Quartal von 2013 wären dies der <code class="literal">01.01.2013</code> und <code class="literal">31.03.2013</code>).
+              </p></dd></dl></div></div><div class="sect2" title="3.1.4. Auflisten"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.reports"></a>3.1.4. Auflisten</h3></div></div></div><p>Unter Verkauf-&gt;Berichte-&gt;Aufträge finden sich zwei neue
         Checkboxen, "Wiederkehrende Rechnungen aktiv" und "Wiederkehrende
         Rechnungen inaktiv", mit denen man sich einen Überglick über die
-        wiederkehrenden Rechnungen verschaffen kann.</p></div><div class="sect2" title="3.1.4. Erzeugung der eigentlichen Rechnungen"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.task-server"></a>3.1.4. Erzeugung der eigentlichen Rechnungen</h3></div></div></div><p>Die zeitliche und periodische Überprüfung, ob eine
+        wiederkehrenden Rechnungen verschaffen kann.</p></div><div class="sect2" title="3.1.5. Erzeugung der eigentlichen Rechnungen"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.task-server"></a>3.1.5. Erzeugung der eigentlichen Rechnungen</h3></div></div></div><p>Die zeitliche und periodische Überprüfung, ob eine
         wiederkehrende Rechnung automatisch erstellt werden soll, geschieht
         durch den <a class="link" href="ch02s07.html" title="2.7. Der Task-Server">Taskserver</a>, einen
         externen Dienst, der automatisch beim Start des Servers gestartet
-        werden sollte.</p></div><div class="sect2" title="3.1.5. Erste Rechnung für aktuellen Monat erstellen"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.create-for-current-month"></a>3.1.5. Erste Rechnung für aktuellen Monat erstellen</h3></div></div></div><p>Will man im laufenden Monat eine monatlich wiederkehrende
+        werden sollte.</p></div><div class="sect2" title="3.1.6. Erste Rechnung für aktuellen Monat erstellen"><div class="titlepage"><div><div><h3 class="title"><a name="features.periodic-invoices.create-for-current-month"></a>3.1.6. Erste Rechnung für aktuellen Monat erstellen</h3></div></div></div><p>Will man im laufenden Monat eine monatlich wiederkehrende
         Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum
         auf den Monatsanfang und wartet ein paar Minuten, bis der Taskserver
         den neu konfigurieren Auftrag erkennt und daraus eine Rechnung