DocumentAllowance
extends DocumentAllowanceCharge
in package
Read onlyYes
FinalYes
Document level allowance (BG-20). An allowance has exactly one VAT category and rate.
Table of Contents
Properties
- $amount : Money|null
- $baseAmount : Money|null
- $exemptionReason : string|null
- $exemptionReasonCode : VatExemptionReasonCode|RawCode|null
- $percent : BigDecimal|null
- $reason : string|null
- $reasonCode : BackedEnum|RawCode|null
- $vatCategory : VatCategory
- $vatRate : BigDecimal|null
Methods
- __construct() : mixed
- isCharge() : bool
- reasonCodeValue() : string|null
- with() : static
- Returns a copy with the given properties replaced.
Properties
$amount
public
Money|null
$amount
$baseAmount
public
Money|null
$baseAmount
= null
$exemptionReason
public
string|null
$exemptionReason
= null
$exemptionReasonCode
public
VatExemptionReasonCode|RawCode|null
$exemptionReasonCode
= null
$percent
public
BigDecimal|null
$percent
= null
$reason
public
string|null
$reason
= null
$reasonCode
public
BackedEnum|RawCode|null
$reasonCode
= null
$vatCategory
public
VatCategory
$vatCategory
$vatRate
public
BigDecimal|null
$vatRate
= null
Methods
__construct()
public
__construct(Money|null $amount, VatCategory $vatCategory[, BigDecimal|null $vatRate = null ][, Money|null $baseAmount = null ][, BigDecimal|null $percent = null ][, string|null $reason = null ][, AllowanceReasonCode|RawCode|null $reasonCode = null ][, string|null $exemptionReason = null ][, VatExemptionReasonCode|RawCode|null $exemptionReasonCode = null ]) : mixed
Parameters
- $amount : Money|null
- $vatCategory : VatCategory
- $vatRate : BigDecimal|null = null
- $baseAmount : Money|null = null
- $percent : BigDecimal|null = null
- $reason : string|null = null
- $reasonCode : AllowanceReasonCode|RawCode|null = null
- $exemptionReason : string|null = null
- $exemptionReasonCode : VatExemptionReasonCode|RawCode|null = null
isCharge()
public
isCharge() : bool
Return values
boolreasonCodeValue()
public
reasonCodeValue() : string|null
Return values
string|nullwith()
Returns a copy with the given properties replaced.
public
with(array<string, mixed> $changes) : static
Parameters
- $changes : array<string, mixed>