Artisan commands

quittio/laravel registers its commands in the console; quittio/managed adds the commands for stored invoices and extends quittio:install and quittio:render; quittio/country-de adds quittio:base-rate:update. The commands return exit code 0 on success and 1 on failure (the cases are listed per command), so CI jobs and the scheduler can react to them.

Command Package Purpose
quittio:install laravel Publish the configuration, optionally templates and fonts; --managed installs the Managed layer
quittio:preview laravel Render a sample invoice with the configured design
quittio:render laravel, managed Render an invoice from a JSON file, or render a stored invoice again
quittio:validate laravel Validate an XML or PDF e-invoice and print a report
quittio:read laravel Read an e-invoice and show its content
quittio:benchmark laravel Measure rendering performance
quittio:countries laravel Show the installed country packs
quittio:schemas:download laravel Download the KoSIT validator and the XRechnung configuration, compile the Peppol rules
quittio:codelists:update laravel Regenerate the code lists (development)
make:quittio-template laravel Create a template from the default template
quittio:sequence:show managed Show the number sequences
quittio:sequence:set managed Increase a number sequence
quittio:verify managed Check the hashes of the archived documents
quittio:retention:check managed List (and delete) invoices past their retention period
quittio:drafts:prune managed Delete left-behind cancellation and correction drafts
quittio:base-rate:update country-de Fetch the Basiszinssatz (§ 247 BGB) from the Deutsche Bundesbank

php artisan about shows a section “Quittio” with the active country packs and profiles.

Commands that ask for confirmation (quittio:sequence:set, quittio:retention:check --delete, quittio:drafts:prune) treat a run without interaction (--no-interaction, the scheduler, CI) as “no” and exit with 1; pass --force there.

quittio:install

php artisan quittio:install {--views} {--fonts} {--managed} {--force}
Option Effect
--views Also publish the Blade templates (quittio-views)
--fonts Also publish the fonts (quittio-fonts, to resources/fonts/quittio/inter); the renderer searches resources/fonts/quittio and its subdirectories automatically
--managed Also install the Managed layer (needs quittio/managed)
--force Overwrite existing files

Publishes config/quittio.php (quittio-config) and the selected tags, then prints the next steps (seller, country pack, preview). Exits with 1 when --managed is given without quittio/managed.

With --managed the Managed installer then:

  1. publishes config/quittio-managed.php (quittio-managed-config, overwritten with --force),
  2. publishes the migrations (quittio-managed-migrations) unless they were published before (detected by file name, because vendor:publish gives migrations new timestamps),
  3. asks “Run the migrations now?” (default yes) and runs migrate --force; when you decline, it prints the next steps and ends with exit code 0,
  4. if no issuer profile exists, asks for the first one: key (default), company name (required), street and number, postcode, city, country (DE), VAT identifier, tax number (only without VAT identifier), e-mail address for invoices (contact and electronic address), IBAN, BIC (only with IBAN) and time zone (default: app.timezone, or Europe/Berlin for Germany when that is UTC). The profile becomes the default issuer.

Without interaction (-n) it runs the migrations without asking and skips the issuer profile. The immutability triggers are not published; publish them separately (see Managed layer). Exits with 1 when the migrations or the database fail.

quittio:preview

php artisan quittio:preview {--scenario=simple} {--template=} {--format=pdf} {--locale=} {--output=}
Option Default Effect
--scenario simple Sample scenario (see Scenarios)
--template configured A view that rendering accepts: default, the configured pdf.template, a view under quittio::templates. or one of pdf.templates, e.g. invoices.acme.layout from make:quittio-template (no partials; the view must exist)
--format pdf pdf or html
--locale scenario locale (de) Locale of the labels
--output storage/app/quittio/preview/{scenario}.{format} Target file; missing directories are created

Renders the scenario with the configured design, validation mode warn and the watermark “PREVIEW” (“VORSCHAU” in German), like the preview route. Unknown scenarios, formats, templates or invalid locales exit with 1.

quittio:render

php artisan quittio:render {invoice?} {--json=} {--format=} {--profile=} {--output=}
Argument / option Effect
invoice Number, UUID or id of a stored invoice of the Managed layer (see below). Takes precedence over --json.
--json JSON file with invoice data in the format of InvoiceData::toJson() (see Getting started)
--format Output format; default: defaults.format, else the automatic choice
--profile Profile
--output Existing directory (the file gets filename()) or target file; default: the current directory

With --json the command renders like Quittio::make($data)->format(…)->profile(…)->render() with the configured validation mode and writes the main output (contents(): the PDF of zugferd and pdf, the XML of the XML formats). It prints the number, format, profile and path, and the findings when there are warnings. Validation errors are printed as a table and exit with 1, as do a missing --json, an unreadable file and any other error.

Managed layer. With invoice (and quittio/managed installed) the command renders an issued invoice whose documents are missing or failed: a UUID is looked up first, then the number (a number used by several issuers must be given as UUID), then the numeric id. When the current document version is complete it reports it and exits with 0. Missing files are rendered as a new document version (existing files are never overwritten); the command lists the missing files and the new version. Damaged files (hash mismatch) dispatch ArchiveIntegrityViolation and exit with 1, as do drafts and unknown invoices. Without quittio/managed, invoice exits with 1. See Rendering and archive.

quittio:validate

php artisan quittio:validate {file} {--profile=} {--kosit} {--verapdf} {--json}
Argument / option Effect
file XML or PDF file
--profile Expected profile (aliases allowed); a different profile fails
--kosit Also run the KoSIT validator (L5) with all settings of quittio.validation.drivers.kosit (mode, url, jar, scenarios, repository, configurations, java, timeout, fail_on_unavailable)
--verapdf Also run veraPDF (L6) with all settings of quittio.validation.drivers.verapdf (mode, binary, image, docker, timeout, fail_on_unavailable)
--json Print the result as JSON instead of the report

Reads the file and validates it with the configured levels plus kosit and verapdf (Quittio::coreWithLevels()): the drivers are built exactly as in a render run, a level already in validation.levels is not added twice, and the cached core of the application is not changed. With fail_on_unavailable set to false, a validator that cannot be reached or started is reported as a warning (KOSIT-UNAVAILABLE, VERAPDF-UNAVAILABLE) and does not fail the command. The report shows invoice number, syntax, profile, the checked levels and a table of findings (severity, level, code, business term, message and hint). --json prints {"valid": …, "levels": […], "messages": [{severity, code, message, level, bt, path, hint, xpath}], "profile": …}.

Exit code 0 when the file has no errors and, with --profile, the expected profile; warnings do not fail. A missing or unreadable file, a file that cannot be read as e-invoice, errors and a profile mismatch exit with 1. See Validation.

quittio:read

php artisan quittio:read {file} {--json}
Argument / option Effect
file XML or PDF file
--json Print the invoice data as JSON (InvoiceData::toJson())

Shows number, issue date, type code, syntax and profile, seller and buyer (with country), the embedded file name of a PDF, a table of the lines (position, item, quantity and unit, net amount, VAT category and rate), net total, VAT and amount due (the totals declared in the file) and the findings of the reader. A missing or unreadable file exits with 1. See Reading incoming invoices.

quittio:benchmark

php artisan quittio:benchmark {--count=20} {--scenario=simple} {--format=*}
Option Default Effect
--count 20 Measured runs per format (at least 1)
--scenario simple Sample scenario
--format cii, zugferd Formats; repeat the option for several (--format=cii --format=zugferd)

Renders the scenario once per format to warm up fonts and caches, then --count times with validation mode warn, and prints average, minimum, 95th percentile and maximum in milliseconds plus the peak memory. An unknown scenario exits with 1.

quittio:countries

php artisan quittio:countries

Lists the active country packs: code, class, profiles, number of rules and format rules, and the defaults (currency, locale, profile). Without a country pack it warns that only EN 16931 rules are checked (exit code 0). See Country packs.

quittio:schemas:download

php artisan quittio:schemas:download {--path=} {--force} {--without-peppol} {--java=java}
Option Default Effect
--path storage/quittio/validators Target directory
--force – Download and compile again, also when the files exist
--without-peppol – Skip compiling the Peppol BIS Billing 3.0 rules
--java java Java binary for compiling the Peppol rules

Downloads into the target directory:

File Content
validator.jar KoSIT validator 1.6.3 (standalone)
xrechnung/ XRechnung validator configuration (release v2026-08-31, XRechnung 3.0.2), with scenarios.xml
peppol/PEPPOL-EN16931-UBL.xsl Peppol BIS Billing 3.0 Schematron (v3.0.20), compiled with SchXslt 1.10.1 and the Saxon of the validator JAR

Existing files are kept unless --force is given. It needs the zip extension, and Java 11 or newer for the Peppol rules and for running the validator. Afterwards it prints the configuration for validation.drivers.kosit in mode cli (jar, scenarios, repository and, with Peppol, configurations), reminds you to add kosit to validation.levels, and prints the command that starts the validator as a daemon for the default mode daemon, on the port of validation.drivers.kosit.url (default http://127.0.0.1:8081, so -P 8081; the validator’s own default port is 8080):

java -jar '…/validators/validator.jar' -s '…/validators/xrechnung/scenarios.xml' -r '…/validators/xrechnung' \
    -s '…/peppol-scenarios.xml' -r '…/validators' -D -P 8081

Download and compile errors exit with 1. See Validation and Official validators in CI.

quittio:codelists:update

php artisan quittio:codelists:update {xsl?} {--target=}
Argument / option Default Effect
xsl storage/quittio/validators/xrechnung/resources/cii/16b/xsl/EN16931-CII-validation.xsl EN 16931 CII Schematron XSL of the validator configuration
--target the code lists of quittio/core (resources/codelists) Output directory

For package development: regenerates the JSON code lists (units, currencies, countries, VAT categories, VATEX, EAS and ICD schemes, payment means, …) from the official rules and prints the number of codes per list. In an application, pass --target; the default writes into the installed package. A missing XSL exits with 1 (run quittio:schemas:download first).

make:quittio-template

php artisan make:quittio-template {name} {--force}
Argument / option Effect
name Template name: lower-case letters, digits, - and _, starting with a letter or digit
--force Overwrite an existing template

Copies the default template (layout.blade.php and partials/) to resources/views/invoices/{name} and points the layout to its own partials. Use it with ->template('invoices.{name}.layout') (allowed by the default pdf.templates) or for every invoice with pdf.template. An invalid name, or an existing template without --force, exits with 1. See Templates and design.

quittio:sequence:show

Managed layer.

php artisan quittio:sequence:show {--issuer=}
Option Effect
--issuer Only the sequences of this issuer key

Lists every number sequence (key {issuer}:{sequence}:{period}, e.g. default:invoice:2026) with its next value and pattern, ordered by key. Sequences are created when the first invoice of a period is issued. See Numbering.

quittio:sequence:set

Managed layer.

php artisan quittio:sequence:set {key} {value} {--force}
Argument / option Effect
key Sequence key {issuer}:{sequence}:{period}, e.g. default:invoice:2026
value New next value, a positive integer greater than the current one
--force Do not ask for confirmation

Raises the next value of a sequence, e.g. when migrating from another system; lowering it is refused. A sequence that does not exist yet is created ahead of time, but only when the numbering would use it: the issuer must exist, the sequence must be invoice or a kind with its own sequence for that issuer (cancellation, correction), and the period must match the reset mode (2026 yearly, 2026-10 monthly, all never). The pattern comes from the configuration. The change runs in a transaction with a row lock and is written to the audit log. Invalid values or keys, a lower value and a declined confirmation exit with 1. See Numbering.

quittio:verify

Managed layer.

php artisan quittio:verify {--from=} {--to=} {--issuer=}
Option Effect
--from Issue date from (Y-m-d, inclusive)
--to Issue date to (Y-m-d, inclusive)
--issuer Only invoices of this issuer key

Checks every issued invoice (of all issuers, the tenancy scope does not apply): the archived XML and PDF of the current document version must exist and match their SHA-256 hashes. Issued invoices whose documents were never archived (render status pending, rendering or failed) count as problems too. Every problem dispatches ArchiveIntegrityViolation (invoice, path, problem); the run writes the audit entry verified with the number of checked invoices and violations. Problems are printed as a table and exit with 1. See Rendering and archive.

quittio:retention:check

Managed layer.

php artisan quittio:retention:check {--delete} {--force}
Option Effect
--delete Delete the expired invoices and their archived documents (asks for confirmation)
--force Do not ask for confirmation

Lists the issued invoices past their retention period that are not on legal hold (an invoice counts as expired two days after retention_until) and dispatches RetentionExpired for each of them; it also reports archived files of deleted invoices that could not be deleted yet. Without --delete nothing changes.

With --delete it first retries the leftover files, then deletes by group: an invoice together with all invoices connected to it through cancellations, partial cancellations, corrections and replacements, and only when every member is expired and none is on legal hold; otherwise the command names the invoice that keeps the group. The rows of a group (relations, deliveries, referring drafts, invoices) go in one transaction with audit entries, then all archived files of all document versions; files that cannot be deleted are tried again by the next run. Failures of single groups are reported and the run continues (exit code 0); a declined confirmation exits with 1. See Rendering and archive.

quittio:drafts:prune

Managed layer.

php artisan quittio:drafts:prune {--older-than=60} {--force}
Option Default Effect
--older-than 60 Minimum age of cancellation drafts in minutes
--force – Do not ask for confirmation

Deletes drafts that can never be issued: cancellation drafts older than --older-than minutes (left behind, e.g. by a crash, while cancel() or cancelPartially() issued them) and correction drafts whose original is no longer in status issued or no longer exists. It lists them (draft, kind, original, created), asks, and deletes each through the model (audit entry deleted_draft); a draft issued meanwhile is not touched. A non-numeric --older-than or a declined confirmation exits with 1. See Cancellations and corrections.

quittio:base-rate:update

php artisan quittio:base-rate:update [--dry-run]

Fetches the base rate according to § 247 BGB from the statistics API of the Deutsche Bundesbank (series BBIN1.M.DE.BBK.BBKBAS2.EUR.ME) and stores the rates that the table shipped with Quittio does not contain in quittio-de.base_rate_file (default storage/app/quittio/base-rates.json). Default interest (DefaultInterest) then covers periods after the shipped table without a new release. Registered by the German country pack (GermanyServiceProvider).

Option Effect
--dry-run Show the rates, write nothing

It prints the latest rate and the new ones, warns when a value differs from the shipped table (the Bundesbank value is used) and writes the file only when something changed. Exit code 1 when the API cannot be reached or returns no rates, or when quittio-de.base_rate_file is empty. See Country packs: base rate table.

Scheduling

// routes/console.php
use Illuminate\Support\Facades\Schedule;

Schedule::command('quittio:verify')->weekly()->onOneServer();                  // exit code 1 on problems
Schedule::command('quittio:drafts:prune --force')->daily()->onOneServer();
Schedule::command('quittio:retention:check')->monthly()->onOneServer();        // report and RetentionExpired events
Schedule::command('quittio:base-rate:update')->weekly()->onOneServer();        // new Basiszinssatz on 1 January and 1 July
Command Recommendation
quittio:verify Daily or weekly; react to failures with ->onFailure(…) or ->emailOutputOnFailure(…) and listen for ArchiveIntegrityViolation. On large archives limit the range, e.g. ['--from' => now()->subDays(8)->toDateString()], and run a full check less often.
quittio:drafts:prune Daily with --force
quittio:retention:check Monthly without --delete for a report; add --delete --force only when expired invoices should be deleted without review
quittio:schemas:download Not scheduled: in deployment or CI, when you use the KoSIT validator
quittio:base-rate:update Weekly (or daily in January and July): the new rate is stored as soon as the Bundesbank has published it

Publish tags

php artisan vendor:publish --tag=quittio-config
Tag Package Publishes to
quittio-config laravel config/quittio.php
quittio-views laravel resources/views/vendor/quittio/templates (default template and partials; override the package views)
quittio-lang laravel lang/vendor/quittio (labels, rule messages, codes, terms)
quittio-fonts laravel resources/fonts/quittio/inter (Inter). resources/fonts/quittio and its subdirectories are added to the font directories automatically, so further font files placed there only need an entry in pdf.fonts
quittio-managed-config managed config/quittio-managed.php
quittio-managed-migrations managed database/migrations (tables of the Managed layer, with new timestamps)
quittio-managed-triggers managed database/migrations (immutability triggers, recommended for production)
quittio-managed-views managed resources/views/vendor/quittio-managed (mail view)
quittio-managed-lang managed lang/vendor/quittio-managed (mail and invoice texts)
quittio-de-config country-de config/quittio-de.php (base rates)

Publishing is only registered in the console.