ViewModelFactory

build()#

public function build(
    InvoiceData $invoice,
    ViewContext $context = new \Quittio\Core\View\ViewContext(),
): InvoiceViewModel

The view model of an invoice.

Returns

InvoiceViewModel

Throws

CalculationException – when the invoice is not calculated

buildDocument()#

public function buildDocument(
    DocumentData $document,
    ViewContext $context = new \Quittio\Core\View\ViewContext(),
): InvoiceViewModel

View model for quotes, delivery notes, reminders and other documents. Templates see the same structure as for invoices plus the "documentInfo" node.

Returns

InvoiceViewModel

Throws

CalculationException – when the document is not calculated

isSpecialSchemeLine()#

public static function isSpecialSchemeLine(InvoiceLine $line): bool

static

Whether a line is taxed under a margin scheme or the special scheme for travel agents (section 25, 25a UStG): category E with one of SPECIAL_SCHEME_CODES on the line.

Returns

bool

legalNoteTexts()#

public static function legalNoteTexts(InvoiceData $invoice): list<string>

static

The "legalNotes" of the view model: exemption reasons (BT-120) and regulatory, legal and tax notes (BT-22), in this order and without duplicates.

Returns

list<string>

mergePresentation()#

public static function mergePresentation(
    Presentation $own,
    Presentation $defaults,
): Presentation

static

$own over $defaults, property by property: values of $own that equal the defaults of an empty Presentation count as not set and keep the value of $defaults, unless $own names the property in $explicit (e.g. false, [] or "A4" over a configured value). Labels are merged key by key.

Returns

Presentation

mixedExemptGroup()#

public static function mixedExemptGroup(
    InvoiceData $invoice,
): array{special: ?BigDecimal, other: ?BigDecimal}|null

static

The exempt VAT group (category E) when it mixes lines of a special scheme with other exempt lines: EN 16931 allows only one E group (BR-E-01), whose code then conflicts. The PDF shows the two parts in rows of their own when the line net amounts add up to the taxable amount of the group and no document level allowance or charge is exempt: then ['special' => net amount, 'other' => net amount]; ['special' => null, 'other' => null] when they cannot be told apart; null when the group does not mix.

Returns

array{special: ?Brick\Math\BigDecimal, other: ?Brick\Math\BigDecimal}|null

otherNotes()#

public static function otherNotes(InvoiceData $invoice): list<Note>

static

The notes outside "legalNotes" in the order of the view model's "notes".

Returns

list<Note>

remittance()#

public static function remittance(InvoiceData $invoice): string

static

Remittance information (BT-83), otherwise the invoice number.

Returns

string

vatRowIndexes()#

public static function vatRowIndexes(InvoiceData $invoice): array<int, int>

static

The index of the row of the view model's "vatRows" that shows each VAT breakdown row (BG-23), by the index of the breakdown: a mixed exempt group (mixedExemptGroup()) takes two rows, its first one is given.

Returns

array<int, int>