API reference / Quittio \ Core \ Tax
StatesInvoiceNote
interface in quittio/core · extends TaxPreset
Quittio\Core\Tax\StatesInvoiceNote · Source
A preset that requires a note on the invoice, e.g. a statement the law prescribes for the special scheme of the preset. The builder adds the note once (BT-22, subject REG) when a line uses the preset, unless the invoice has a note with the same text already.
Methods#
| Method | Description |
|---|---|
->category() | VAT category (BT-151). |
->exemptionReason() | Exemption reason text (BT-120), shown in XML and PDF. |
->exemptionReasonCode() | VATEX code of the exemption reason (BT-121); null for taxed supplies. |
->invoiceNote() | The text of the note in the locale, or null for none. |
->key() | Stable key, prefixed with the country code, e.g. "de.standard". |
->rate() | VAT rate in percent (BT-152); null for categories without a rate (e.g. O). |
category()#
public function category(): VatCategoryVAT category (BT-151).
- Returns
VatCategory
exemptionReason()#
public function exemptionReason(?string $locale = null): ?stringExemption reason text (BT-120), shown in XML and PDF.
| Parameter | Type | Description |
|---|---|---|
$locale | ?string = null |
- Returns
?string
exemptionReasonCode()#
public function exemptionReasonCode(): VatExemptionReasonCode|RawCode|nullVATEX code of the exemption reason (BT-121); null for taxed supplies.
- Returns
VatExemptionReasonCode|RawCode|null
invoiceNote()#
public function invoiceNote(?string $locale = null): ?stringThe text of the note in the locale, or null for none.
| Parameter | Type | Description |
|---|---|---|
$locale | ?string = null |
- Returns
?string
key()#
public function key(): stringStable key, prefixed with the country code, e.g. "de.standard".
- Returns
string
rate()#
public function rate(): ?BigDecimalVAT rate in percent (BT-152); null for categories without a rate (e.g. O).
- Returns
?Brick\Math\BigDecimal