X-Git-Url: http://wagnertech.de/gitweb/gitweb.cgi/mfinanz.git/blobdiff_plain/cb4847870dd086f46098ccd12dd03955766b2896..HEAD:/doc/html/ch03s03.html diff --git a/doc/html/ch03s03.html b/doc/html/ch03s03.html index 1dea2a90b..f18975a86 100644 --- a/doc/html/ch03s03.html +++ b/doc/html/ch03s03.html @@ -1,14 +1,13 @@ - 3.3. Dokumentenvorlagen und verfügbare Variablen

3.3. Dokumentenvorlagen und verfügbare Variablen

3.3.1. Einführung

Dies ist eine Auflistung der Standard-Dokumentenvorlagen und + 3.3. Dokumentenvorlagen und verfügbare Variablen

3.3. Dokumentenvorlagen und verfügbare Variablen

3.3.1. Einführung

Dies ist eine Auflistung der Standard-Dokumentenvorlagen und aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form <%variablenname%> verwendet wird. Für LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern - (siehe Anfang und Ende der Tags verändern).

Früher wurde hier nur über LaTeX gesprochen. Inzwischen - unterstützt kivitendo aber auch OpenDocument-Vorlagen. Sofern es nicht - ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für - alle Vorlagenarten.

Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen + (siehe Anfang und Ende der Tags verändern).

kivitendo unterstützt LaTeX-, HTML- und OpenDocument-Vorlagen. + Sofern es nicht ausdrücklich eingeschränkt wird, gilt das im Folgenden + gesagte für alle Vorlagenarten.

Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen verfügbar als hier aufgelistet werden. Die meisten davon können allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann @@ -121,8 +120,8 @@ template_meta.language.description

Beschreibung der verwendeten Sprache

template_meta.language.template_code -

Vorlagenürzel der verwendeten Sprache, identisch mit dem - Kürzel das im Dateinamen verwendetet wird.

+

Vorlagenkürzel der verwendeten Sprache, identisch mit + dem Kürzel das im Dateinamen verwendetet wird.

template_meta.language.output_numberformat

Zahlenformat der verwendeten Sprache in der Form "1.000,00". Experimentell! Nur @@ -209,6 +208,8 @@

Emailadresse

fax

Faxnummer

+ gln +

GLN (Globale Lokationsnummer)

greeting

Anrede

homepage @@ -220,6 +221,10 @@

Sprache

name

Firmenname

+ natural_person +

Flag "natürliche Person"; Siehe auch + Hinweise zur Anrede +

payment_description

Name der Zahlart

payment_terms @@ -235,10 +240,10 @@ shiptocountry

Land (Lieferadresse) *

- shiptodepartment1 + shiptodepartment_1

Abteilung 1 (Lieferadresse) *

- shiptodepartment2 + shiptodepartment_2

Abteilung 2 (Lieferadresse) *

shiptoemail @@ -246,6 +251,9 @@

shiptofax

Fax (Lieferadresse) * +

+ shiptogln +

GLN (Globale Lokationsnummer) (Lieferadresse) *

shiptoname

Firmenname (Lieferadresse) * @@ -342,7 +350,24 @@ delivery_term.description

Beschreibung der Lieferbedingung

delivery_term.description_long -

Langtext bzw. übersetzter Langtext der Lieferbedingung

3.3.8. Variablen in Rechnungen

3.3.8.1. Allgemeine Variablen

+

Langtext bzw. übersetzter Langtext der + Lieferbedingung

3.3.7.7. Informationen über abweichende Rechnungsadressen (nur Verkaufsbelege)

+ Abweichende Rechnungsadressen gibt es nur in Verkaufsbelegen. Die entsprechenden Variablen sind nur dann mit Inhalt gefüllt, + wenn im Beleg eine abweichende Rechnungsadresse ausgewählt wurde. Ob eine Adresse überhaupt ausgewählt wurde, kann über die + Variable billing_address_id getestet werden, die die Datenbank-ID der abweichenden Rechnungsadresse enthält, + wenn eine ausgewählt ist. +

+ Die Variablennamen starten alle mit dem Präfix billing_address_ und heißen anschließend so, wie ihre Pendants + aus der Standard-Rechnungsadresse des Kunden. Beispiel: die Postleitzahl, die in der normalen Rechnungsadresse in + zipcode steht, steht für die abweichende Rechnungsadresse in billing_address_zipcode. +

+ Die folgenden Variablen stehen so zur Verfügung: billing_address_name, + billing_address_department_1, billing_address_department_2, + billing_address_contact, billing_address_street, + billing_address_zipcode, billing_address_city, billing_address_country, + billing_address_gln, billing_address_email, billing_address_phone und + billing_address_fax. +

3.3.8. Variablen in Rechnungen

3.3.8.1. Allgemeine Variablen

creditremaining

Verbleibender Kredit

currency @@ -380,6 +405,9 @@

Angebotsdatum

quonumber

Angebotsnummer

+ rounding +

Betrag, um den invtotal gerundet + wurde (kann positiv oder negativ sein)

shippingpoint

Versandort

shipvia @@ -393,19 +421,36 @@

Vorgangsbezeichnung

transdate

Auftragsdatum wenn die Rechnung aus einem Auftrag - erstellt wurde

3.3.8.2. Variablen für jeden Posten auf der Rechnung

+ erstellt wurde

3.3.8.2. Variablen für die schweizer QR-Rechnung

Diese Variablen können mit dem LaTeX Modul qrbill verwendet + werden: https://ctan.org/pkg/qrbill?lang=de +

Für die Erstellung von QR-Rechnungen mit OpenDocument Vorlagen + siehe: Abschnitt 2.15, „OpenDocument-Vorlagen“ +

qrbill_iban

IBAN/QR-IBAN des Rechnungsstellers, aus System + → Bankkonten +

qrbill_biller_countrycode

Länderkürzel des Rechnungsstellers gem. ISO 3166, aus + Mandantenkonfiguration → Firmenname und + -adresse +

qrbill_customer_countrycode

Länderkürzel des Rechnungsempfängers gem. ISO 3166, aus + der jeweiligen Rechnung

qrbill_amount

Betrag für die QR-Rechnung (Zahl ohne + Tausendertrennzeichen mit zwei Nachkommastellen), entsprechend + total

qr_reference

QR-Referenz der jeweiligen Rechnung, sofern in der + Mandantenkonfiguration → Features → Variante QR-IBAN + mit QR-Referenz erzeugen aktiviert ist

3.3.8.3. Variablen für jeden Posten auf der Rechnung

bin

Stellage

description

Artikelbeschreibung

cusordnumber_oe -

Bestellnummer des Kunden aus dem Auftrag, aus dem der Posten ursprünglich stammt (nur Verkauf)

+

Bestellnummer des Kunden aus dem Auftrag, aus dem der + Posten ursprünglich stammt (nur Verkauf)

discount

Rabatt als Betrag

discount_sub

Zwischensumme mit Rabatt

donumber_do -

Lieferscheinnummer des Lieferscheins, aus dem die Position ursprünglich stammt, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein erstellt wurde.

+

Lieferscheinnummer des Lieferscheins, aus dem die + Position ursprünglich stammt, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein erstellt wurde.

drawing

Zeichnung

ean @@ -415,11 +460,19 @@ linetotal

Zeilensumme (Anzahl * Einzelpreis)

longdescription -

Langtext

+

Langtext, vorbelegt mit dem Feld Bemerkungen der entsprechenden Ware

microfiche

Mikrofilm

netprice -

Alternative zu sellprice, aber netprice entspricht dem effektiven Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. netprice wird rückgerechnet aus Zeilensumme / Menge. Diese Variable ist nützlich, wenn man den gewährten Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. netprice hat nichts mit Netto/Brutto im Sinne von Steuern zu tun.

+

Alternative zu sellprice, aber + netprice entspricht dem effektiven + Einzelpreis und beinhaltet Zeilenrabatt und Preisfaktor. + netprice wird rückgerechnet aus Zeilensumme + / Menge. Diese Variable ist nützlich, wenn man den gewährten + Rabatt in der Druckvorlage nicht anzeigen möchte, aber Menge * + Einzelpreis trotzdem die angezeigte Zeilensumme ergeben soll. + netprice hat nichts mit Netto/Brutto im + Sinne von Steuern zu tun.

nodiscount_linetotal

Zeilensumme ohne Rabatt

nodiscount_sub @@ -427,7 +480,12 @@ number

Artikelnummer

ordnumber_oe -

Auftragsnummer des Originalauftrags, aus dem der Posten ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In letzterem Fall wird die unsprüngliche Auftragsnummer angezeigt.

+

Auftragsnummer des Originalauftrags, aus dem der Posten + ursprünglich stammt. Nützlich, wenn die Rechnung aus mehreren + Lieferscheinen zusammengefasst wurde, oder wenn zwischendurch + eine Sammelauftrag aus mehreren Aufträgen erstellt wurde. In + letzterem Fall wird die unsprüngliche Auftragsnummer + angezeigt.

p_discount

Rabatt in Prozent

partnotes @@ -457,23 +515,60 @@ tax_rate

Steuersatz

transdate_do -

Datum des Lieferscheins, wenn die Rechnung im Rahmen des Workflows aus einem Lieferschein stammte.

+

Datum des Lieferscheins, wenn die Rechnung im Rahmen des + Workflows aus einem Lieferschein stammte.

transdate_oe -

Datum des Auftrags, wenn die Rechnung im Rahmen des Workflows aus einem Auftrag erstellt wurde. Wenn es Sammelaufträge gab wird das Datum des ursprünglichen Auftrags genommen.

+

Datum des Auftrags, wenn die Rechnung im Rahmen des + Workflows aus einem Auftrag erstellt wurde. Wenn es + Sammelaufträge gab wird das Datum des ursprünglichen Auftrags + genommen.

transdate_quo -

Datum des Angebots, wenn die Position im Rahmen des Workflows aus einem Angebot stammte.

+

Datum des Angebots, wenn die Position im Rahmen des + Workflows aus einem Angebot stammte.

unit

Einheit

weight

Gewicht

Für jeden Posten gibt es ein Unterarray mit den Informationen - über Lieferanten und Lieferantenartikelnummer. Diese müssen mit + über Lieferanten und Lieferantenartikelnummer, Kunde und Kundenartikelnummer + und Kunden- bzw. Lieferantentyp und zugehöriger Artikelnummer mit Beschreibung + und Langtext. Diese müssen jeweils mit einer foreach-Schleife ausgegeben werden, da - für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein + für jeden Artikel mehrere Lieferanten- und Kundeninformationen bzw. + kunden- bzw. lieferantenspezifische Informationen hinterlegt sein können. Die Variablen dafür lauten:

make

Lieferant

model -

Lieferantenartikelnummer

3.3.8.3. Variablen für die einzelnen Zahlungseingänge

+

Lieferantenartikelnummer

+ mm_part_description +

Lieferantenartikelbeschreibung

+ mm_part_longdescription +

Lieferantenartikelbeschreibung (Langtext)

+ customer_make +

Kunde

+ customer_model +

Kundenartikelnummer

+ cm_part_description +

Kundenartikelbeschreibung

+ cm_part_longdescription +

Kundenartikelbeschreibung (Langtext)

+ business_make +

Kunden-/Lieferantentyp

+ business_model +

Kunden-/Lieferantentyp-spezifische Artikelnummer

+ bm_part_description +

Kunden-/Lieferantentyp-spezifische Artikelbeschreibung

+ bm_part_longdescription +

Kunden-/Lieferantentyp-spezifische Artikelbeschreibung (Langtext)

3.3.8.4. Benutzerdefinierte Variablen für jeden Posten auf der Rechnung

+ Für jeden Posten stehen auch die benutzerdefinierten Variablen zum + Artikel zur Verfügung. Ihre Namen bestehen aus dem Präfix + ic_cvar_ und dem vom Benutzer festgelegten + Variablennamen. +

+ Ebenso stehen die benutzerdefinierten Variablen zum positionsbezogenen + Projekt unter dem Namen mit dem Präfix project_cvar_ + und dem vom Benutzer festgelegten Variablennamen zur Verfügung. +

3.3.8.5. Variablen für die einzelnen Zahlungseingänge

payment

Betrag

paymentaccount @@ -483,7 +578,7 @@ paymentmemo

Memo

paymentsource -

Beleg

3.3.8.4. Benutzerdefinierte Kunden- und Lieferantenvariablen

Die vom Benutzer definierten Variablen für Kunden und +

Beleg

3.3.8.6. Benutzerdefinierte Kunden- und Lieferantenvariablen

Die vom Benutzer definierten Variablen für Kunden und Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix vc_cvar_ und dem vom Benutzer festgelegten @@ -491,20 +586,32 @@ number_of_employees definiert, die die Anzahl der Mitarbeiter des Unternehmens enthält. Diese Variable steht dann unter dem Namen vc_cvar_number_of_employees zur - Verfügung.

3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren

3.3.9.1. Namen der Vorlagen

Die Namen der Vorlagen werden im System-Menü vom Benutzer + Verfügung.

Die benutzerdefinierten Variablen der Lieferadressen stehen + unter einem ähnlichen Namensschema zur Verfügung. Hier lautet der + Präfix shiptocvar_.

Analog stehen die benutzerdefinierten Variablen für + Ansprechpersonen mit dem Namenspräfix cp_cvar_ + zur Verfügung.

Auch für das globale Projekt des Belegs stehen die + benutzerdefinierten Variablen mit dem Namenspräfix + project_cvar_ zur Verfügung.

3.3.9. Variablen in Mahnungen und Rechnungen über Mahngebühren

3.3.9.1. Namen der Vorlagen

Die Namen der Vorlagen werden im System-Menü vom Benutzer eingegeben. Wird für ein Mahnlevel die Option zur automatischen Erstellung einer Rechnung über die Mahngebühren und Zinsen aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem Vorlagenname für diese Mahnstufe mit dem Zusatz _invoice gebildet. Weiterhin werden die Kürzel für die ausgewählte Sprache und den ausgewählten Drucker - angehängt.

3.3.9.2. Allgemeine Variablen in Mahnungen

Die Variablen des Verkäufers stehen wie gewohnt als - employee_... zur Verfügung. Die Adressdaten des - Kunden stehen als Variablen name, - street, zipcode, - city, country, - department_1, department_2, - und email zur Verfügung.

Weitere Variablen beinhalten:

+ angehängt.

3.3.9.2. Allgemeine Variablen in Mahnungen

Die Variablen des Bearbeiters, bzw. Verkäufers stehen wie + gewohnt als employee_... bzw. + salesman_... zur Verfügung. Werden mehrere + Rechnungen in einer Mahnung zusammengefasst, so werden die Metadaten + (Bearbeiter, Abteilung, etc) der ersten angemahnten Rechnung im + Ausdruck genommen.

Die Adressdaten des Kunden stehen als Variablen + name, street, + zipcode, city, + country, department_1, + department_2, und email zur + Verfügung. Der Ansprechpartner cp_... steht auch + zu Verfügung, wird allerdings auch nur von der ersten angemahnten + Rechnung (s.o.) genommen.

Weitere Variablen beinhalten:

dunning_date

Datum der Mahnung

dunning_duedate @@ -512,7 +619,7 @@ dunning_id

Mahnungsnummer

fee -

Kummulative Mahngebühren

+

Kumulative Mahngebühren

interest_rate

Zinssatz per anno in Prozent

total_amount @@ -574,7 +681,7 @@ invdate

Rechnungsdatum

invnumber -

Rechnungsnummer

3.3.10. Variablen in anderen Vorlagen

3.3.10.1. Einführung

Die Variablen in anderen Vorlagen sind ähnlich wie in der +

Rechnungsnummer

3.3.10. Variablen in anderen Vorlagen

3.3.10.1. Einführung

Die Variablen in anderen Vorlagen sind ähnlich wie in der Rechnung. Allerdings heißen die Variablen, die mit inv beginnen, jetzt anders. Bei den Angeboten fangen sie mit quo für "quotation" an: @@ -678,10 +785,13 @@ ... <%end%>

Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if" und dem "end" werden nur ausgegeben, wenn die Variable - variablenname gesetzt und ungleich 0 ist.

Handelt es sich bei der benannten Variable um ein Array, also um einen Variablennamen, über den man mit - <%foreach variablenname%> iteriert, so wird mit diesem Konstrukt darauf getestet, ob das Array Elemente - enthält. Somit würde im folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt ihrer Überschrift "Zahlungseingänge" - ausgegeben, wenn tatsächlich welche getätigt wurden:

<%if payment%>
+          variablenname gesetzt und ungleich 0 ist.

Handelt es sich bei der benannten Variable um ein Array, also + um einen Variablennamen, über den man mit <%foreach + variablenname%> iteriert, so wird mit diesem Konstrukt + darauf getestet, ob das Array Elemente enthält. Somit würde im + folgenden Beispiel nur dann eine Liste von Zahlungseingängen samt + ihrer Überschrift "Zahlungseingänge" ausgegeben, wenn tatsächlich + welche getätigt wurden:

<%if payment%>
 Zahlungseingänge:
  <%foreach payment%>
    Am <%paymentdate%>: <%payment%> €
@@ -716,7 +826,7 @@ Zahlungseingänge:
           wie das Perl-Array der Variablen variablenname
           Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
           Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
-          benutzt. In jedem Durchlauf werden die zeilenbezogenen
+          benutzt. In jedem Durchlauf werden die zeilenbezogenen
           Variablen jeweils auf den Wert für die aktuelle Position
           gesetzt.

Die Syntax sieht normalerweise wie folgt aus:

<%foreach number%>
 Position: <%runningnumber%>
@@ -740,4 +850,12 @@ Beschreibung: <%description%>
         (HTML oder PDF über LaTeX) umgesetzt.

Die unterstützen Formatierungen sind:

<b>Text</b>

Text wird in Fettdruck gesetzt.

<i>Text</i>

Text wird kursiv gesetzt.

<u>Text</u>

Text wird unterstrichen.

<s>Text</s>

Text wird durchgestrichen. Diese Formatierung ist nicht bei der Ausgabe als PDF über LaTeX verfügbar.

<bullet>

Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe unten).

Der Befehl <bullet> funktioniert - momentan auch nur in Latex-Vorlagen.

\ No newline at end of file + momentan auch nur in Latex-Vorlagen.

3.3.13. Hinweise zur Anrede

Das Flag "natürliche Person" + (natural_person) aus den Kunden- oder + Lieferantenstammdaten kann in den Druckvorlagen zusammen mit + dem Feld "Anrede" (greeting) z.B. dafür + verwendet werden, die Anrede zwischen einer allgemeinen und + einer persönlichen Anrede zu unterscheiden. +

<%if natural_person%><%greeting%> <%name%><%else%>Sehr geehrte Damen und Herren<%end if%>

+ +

\ No newline at end of file