Variablen für dynamische Dokumente

Ahoi bietet für die Dokumentenerstellung einige Variablen, die das Dokument einfach persönlicher werden lassen. Nicht alle Variablen stehen in jedem Kontext zur Verfügung.

Wir empfehlen die Verwendung Version mit Dollarzeichen {$var}. Die Version mit *|VAR|* werden nicht weiterentwickelt.

Allgemein

Variable	Bedeutung	Beispiel
`$date_today`	Heutiges Datum	16.05.2022

Personendaten

Variable	Bedeutung	Beispiel
`$first_name`	Vorname	Kim
`$last_name`	Nachname	Mustermensch
`$middle_name`	Weitere Vornamen	Mika Ulli
`$gender`	Geschlechtskürzel (m;w;n)	n
`$gender_txt`	Geschlecht (männlich;weiblich;inter/divers)	inter/divers
`$birthday`	Gebursdatum	29.02.1930
`$age`	Alter	18

Geschlechtsabhängige Anrede

Variable	Bedeutung	Beispiel
`$pronoun`	Pronomen (er; sie; er/sie)	er/sie
`$my_child`	Bezeichnung des Kindes (mein Sohn; meine Tochter; mein Kind)	mein Kind
`$salutation`	Liebe Anrede (Lieber; Liebe; Liebe/r)	Liebe/r
`$salutation_formal`	Formelle Anrede (Sehr geehrter Herr; Sehr geehrte Frau; Sehr geehrte/r Herr/Frau)	Liebe/r

Kontaktdaten

Variable	Bedeutung	Beispiel
`$street`	Straße inkl. Hausnummer	Demostraße 123
`$adress_extra`	Adresszusatz	c/o Demobriefkasten
`$zip`	Postleitzahl	12345
`$local`	Ort	Musterstadt
`$country`	Land	Testland
`$adress`	Adresse mit Zeilenumbruch	Kim Mustermensch c/o Demobriefkasten Demostraße 123 12345 Musterstadt TESTLAND
`$tel`	Telefonnummer	+49 123 45 67 67
`$mobile`	Mobiltelefonnummer	+49 123 45 67 67
`$email`	E-Mail-Adresse	info@example.com

Der Adressblock muss mehrzeilig sein. Der Wert muss {$adress|noescape} sein.

Abgeschickt von…

Variable	Bedeutung	Beispiel
`$creator_first_name`	Vorname	Kira
`$creator_last_name`	Nachname	Demomensch
`$creator_role`	Rolle in der Organisation	Vorstand
`$creator_email`	E-Mail	info@example.com
`$creator_mobile`	Mobilnummer	+49 123 45 67 67
`$creator_initial`	Initialen	KD

Organisation

Variable	Bedeutung	Beispiel
`$org_name`	Organisationsname	Demoverein e.V.
`$org_shortname`	Organisationsname abgekürzt	DEMO
`$org_street`	Straße der Organisation	Demostraße 12a
`$org_co`	Adresszusatz der Organisation	c/o Demobriefkasten
`$org_zip`	Postleitzahl der Organisation	12345
`$org_local`	Ort der Organisation	Demostadt
`$org_adress`	Anschrift der Organisation	Demoverein e.V. c/o Demobriefkasten Demostraße 123 12345 Demostadt
`$org_adress`	IBAN der Organisation	DE19123412341234123412
`$org_bic`	BIC der Organisation	MARKDEFF
`$org_taxnr`	Steuenummer der Organisation	00 / 123 / 45679
`$org_ust`	USt-IdNr. der Organisation	DE999999999
`$org_statutes`	URL zur Satzung	https://example.com/documents/satzung.pdf
`$org_email`	E-Mail-Adresse der Organisation	info@example.com
`$org_website`	Webseite URL der Organisation	https://example.com
`$org_website`	Impressum-URL der Organisation	https://example.com/impressum
`$system_url`	URL des AHOI-Systems	https://ahoi.example.com/

Veranstaltung

Variable	Bedeutung	Beispiel
`$event_title`	Name der Veranstaltung	Demoevent
`$event_id`	ID der Veranstaltung	1
`$event_id`	ID der Veranstaltung	1
`$event_location`	Ort der Veranstaltung	Veranstaltungsort
`$event_start_date`	Startdatum der Veranstaltung	29.02.2000
`$event_start`	Startzeitpunkt der Veranstaltung	29.02.2000 22:00
`$event_end_date`	Enddatum der Veranstaltung	29.02.2000
`$event_end`	Endzeitpunkt der Veranstaltung	29.02.2000 22:00
`$event_cancel_url`	URL zu den Widderufsbedingungen der Veranstaltung	https://example.com/agb
`$event_data_url`	URL zu den Datenverwendungsrichtlinien der Veranstaltung	https://example.com/agb
`$event_agb_url`	URL zu den Teilnahmebedingungen der Veranstaltung	https://example.com/agb
`$booking_code`	Buchungscode des Teilnehmenden der Veranstaltung	0X0X0
`$nr`	Ticketfolgenummer des Teilnehmenden der Veranstaltung	1

Finanzen

Variable	Bedeutung	Beispiel
Forderung
`$ar_id`	Forderungsnummer	D22.0X0
`$invoice_payable_until`	Datum Zahlungsziel	00.00.2022
`$note`	öffentliche Notiz	Das ist meine Anmerkung.
Rechnungsdokument
`$invoice_rid`	Rechnungsnummer ohne AHOI-Infix	2022017
`$reference`	Rechnungsnummer mit AHOI-Infix	2022A017
`$invoice_transaction_code`	Transaktionscode für PayPal, GoCardless usw.	0X00X
`$invoice_date`	Rechnungsdatum	00.00.2022
`$tax_notice`	Steueranmerkungen	Für die Steuergruppe X gibt wurde nach § 12 (1) keine Steuer ausgewiesen.
Lastschriftverfahren
`$debit_link`	Mitgliedsindividuelle URL zur Einrichtung des Mandats bei GoCardless	http://ahoi.example.com/lastschrift/mitglied/d84a5152eb822201
`$payment_method`	Optionale Zahlungsmethode (paypal; debit)	debit
`$debit_charge_date`	Lastschriftdatum, wenn Zahlungsmethode Lastschrift	19.06.2022
`$debit_amount`	Lastschriftsumme, wenn Zahlungsmethode Lastschrift	15,00
`$debit_mandate_reference`	Lastschriftmandatsreferenz, wenn Zahlungsmethode Lastschrift	DEMOVEREIN-PHBMF
`$debit_reference`	Lastschriftzahlungsreferenz, wenn Zahlungsmethode Lastschrift, meist Forderungsnummer	D22.0X0
Mahnung
`$overdue_level`	Mahnstufe laut System (1/2/3)	1
`$overdue_fee`	Mahngebühr laut System	1,00
`$date_original`	Datum der ursprünglichen Forderung	12.12.2022

Mitgliedschaft

Variable	Bedeutung	Beispiel
`$type_name`	Bezeichnung der Mitgliedsart im Singular	Einzelmitglied
`$type_name_plural`	Bezeichnung der Mitgliedsart im Plural	Einzelmitglieder
`$type_price`	Mitgliedsbeitrag	10,00
`$type_payperiod`	Beitragsperiode	monthly
`$type_maxage`	Höchstalter der Mitgliedsart	27
`$custom_fee`	Mitgliedsindividueller Beitrag pro Beitragsperiode (nur ganzzahlig)	20
`$type_has_next`	Mitgliedsart nach erreichen des Höchstalters	1
`$type_next_name`	Bezeichnung der neuen Mitgliedsart (Singular)	Fördermitglied
`$type_next_name_plural`	Bezeichnung der neuen Mitgliedsart (Plural)	Fördermitglied
`$date_joined`	Datum des Vereinseintritts	12.12.2022
$date_resigned	Datum des Vereinsaustritts	12.12.2022

Kündigungsbestätigung

Variable	Bedeutung	Beispiel
`$date_cancel`	Datum der Kündigungsbestätigung, laut Eingabe	12.12.2022