Package

Name	business-templates
Version	0.1.0
Entry point	templates/lib.typ
Compiler	Typst 0.15 or later
License	MIT

#import "@local/business-templates:0.1.0": invoice, concept

The package is installed locally, see Installation.

Accounting functions

invoice(data: none, company: none)
offer(data: none, company: none)
credit-note(data: none, company: none)
reminder(data: none, company: none)
delivery-note(data: none, company: none)
order-confirmation(data: none, company: none)
quotation-request(data: none, company: none)
time-sheet(data: none, company: none)
letter(data: none, company: none, [body])
credentials(data: none, company: (:), locale: none)

Parameter	Type	Content
data	dictionary	the document, usually json("…"); shape per schema
company	dictionary	company.json; company.logo may be replaced by image bytes
locale	dictionary	credentials only: labels, default templates/locale/<company.language>.json
body	content	letter only, optional: the letter text with headings, lists and tables, after data.content

company.language defaults to de. invoice, offer, credit-note and order-confirmation panic if the totals in data do not add up (details). All set the PDF title (document number) and author (company name); all except time-sheet set the PDF date to the document date.

Running-text functions

Used as a show rule (#show: concept.with(…)); the last positional parameter body is the rest of the document. Every function also takes:

Parameter	Default	Content
company	none	company.json
locale	none	labels; default from company.language
logo	none	logo as content; overrides company.logo (not on task-list)
show-title-page, show-footer	true	not on handout

Template-specific parameters, with defaults:

Function	Parameters
concept	title, document_number, client_name, project_name, version: "1.0", status: "Entwurf", tags: (), created_at, authors: (), show_toc: true
documentation	title, document_number, subject, client_name, project_name, doc_type: "Dokumentation", version: "1.0", status: "Entwurf", tags: (), authors: (), created_at, show_toc: true
contract	title, document_number, contract_type: "Dienstleistungsvertrag", parties: (), effective_date, termination_date, created_at, status, show_toc: true
protocol	title, document_number, meeting_date, meeting_time, location, participants: (), absent: (), moderator, note_taker, created_at, show_toc: false
specification	title, document_number, subject, client_name, project_name, version: "1.0", status: "Entwurf", tags: (), authors: (), created_at, last_updated, show_toc: true
proposal	title, document_number, client_name, project_name, budget, timeline, version: "1.0", status: "Angebot", tags: (), created_at, valid_until, authors: (), show_toc: true
sla	title, document_number, service_provider, customer, effective_date, termination_date, review_period, version: "1.0", status: "Aktiv", created_at, show_toc: true
task-list	title: "Aufgabenliste", subtitle, project, client, document-number, created (today), tasks: (), categories: (), notes
handout	title, handout-type: "Aufgabenblatt", category, subject, target-group: "Oberstufe", ai-context, competencies: (), duration, materials: (), version: "1.0"

Parameters without a default shown default to none. Dates are strings and printed as given.

task-list is usually called directly with an empty body (#task-list(…)[]). A task is a dictionary with title and optionally status (todo, in-progress, done, blocked), priority (high, medium, low), due, assignee, tags, description, depends-on, condition and subtasks; a category has name, optional description and tasks.

Handout helpers

aufgabe(nummer, punkte: none, cat-color: rgb("#3b6df2"), body)
hinweis(body)
wichtig(body)
antwortfeld(hoehe: 80pt, linien: false)
textblock(quelle: none, body)
kriterium(name, beschreibung, gewicht: none)

See Handout.

JSON schemas

JSON Schema draft 2020-12, in schema/ and published at https://casoon.github.io/typst-business-templates/schema/<name>.schema.json:

Schema	Describes
company	company.json
invoice	data of invoice (also read by typstgen for ZUGFeRD)
offer	data of offer
credit-note	data of credit-note
reminder	data of reminder
delivery-note	data of delivery-note
order-confirmation	data of order-confirmation
quotation-request	data of quotation-request
time-sheet	data of time-sheet
letter	data of letter
credentials	data of credentials
common	shared definitions: date, decimal, money, vat_rate, address, recipient, bank_account

Every field carries a description, including which fields the templates do not render and which only typstgen reads. A JSON file names its schema with "$schema" for editor support; the templates ignore that key.

typstgen.toml

The keys a project typically sets (full reference):

Key	Example	Purpose
template_paths	["."]	the project folder becomes the root for absolute paths such as /data/company.json
package_path	"../../packages"	folder containing local/business-templates/0.1.0, if the package is not in the Typst package directory
font_paths	["fonts"]	folders with the preset fonts

Paths are relative to the working directory, so run typstgen from the project folder.

Locales

templates/locale/ contains de, en, es, fr, it, nl and pt, all with the same keys. A custom locale: dictionary follows the same shape; missing keys fall back to built-in defaults.