API reference / Quittio \ Core \ Data \ AllowanceCharge
DocumentAllowanceCharge
abstract readonly class in quittio/core
Quittio\Core\Data\AllowanceCharge\DocumentAllowanceCharge · Source
Common structure of document level allowances (BG-20) and charges (BG-21).
The exemption reason and code are package-internal inputs like on LineVat: EN 16931 carries them on the VAT breakdown (BT-120, BT-121). The calculator uses them when the VAT group of the entry has no invoice lines that provide a reason.
Properties#
| Property | Type | Description |
|---|---|---|
$amount readonly | ?Brick\Money\Money | |
$baseAmount readonly | ?Brick\Money\Money | |
$exemptionReason readonly | ?string | |
$exemptionReasonCode readonly | VatExemptionReasonCode|RawCode|null | |
$percent readonly | ?Brick\Math\BigDecimal | |
$reason readonly | ?string | |
$reasonCode readonly | BackedEnum|RawCode|null | |
$vatCategory readonly | VatCategory | |
$vatRate readonly | ?Brick\Math\BigDecimal |
Methods#
| Method | Description |
|---|---|
->__construct() | |
->isCharge() | |
->reasonCodeValue() | |
->with() | Returns a copy with the given properties replaced. |
__construct()#
public function __construct(
?Money $amount,
VatCategory $vatCategory,
?BigDecimal $vatRate = null,
?Money $baseAmount = null,
?BigDecimal $percent = null,
?string $reason = null,
BackedEnum|RawCode|null $reasonCode = null,
?string $exemptionReason = null,
VatExemptionReasonCode|RawCode|null $exemptionReasonCode = null,
)| Parameter | Type | Description |
|---|---|---|
$amount | ?Brick\Money\Money | |
$vatCategory | VatCategory | |
$vatRate | ?Brick\Math\BigDecimal = null | |
$baseAmount | ?Brick\Money\Money = null | |
$percent | ?Brick\Math\BigDecimal = null | |
$reason | ?string = null | |
$reasonCode | BackedEnum|RawCode|null = null | |
$exemptionReason | ?string = null | |
$exemptionReasonCode | VatExemptionReasonCode|RawCode|null = null |
isCharge()#
abstract public function isCharge(): bool- Returns
bool
reasonCodeValue()#
public function reasonCodeValue(): ?string- Returns
?string
with()#
public function with(array<string, mixed> $changes): staticReturns a copy with the given properties replaced.
| Parameter | Type | Description |
|---|---|---|
$changes | array<string, mixed> |
- Returns
static