\Einvoicing\AllowanceOrCharge¶

getReasonCode()¶

Get reason code

public getReasonCode(): string|null

Returns

• string|null — Reason code

setReasonCode()¶

Set reason code

public setReasonCode($reasonCode: string|null): \Einvoicing\AllowanceOrCharge

Parameters

• $reasonCode: string|null — Reason code

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getReason()¶

Get reason

public getReason(): string|null

Returns

• string|null — Reason expressed as text

setReason()¶

Set reason

public setReason($reason: string|null): \Einvoicing\AllowanceOrCharge

Parameters

• $reason: string|null — Reason expressed as text

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getAmount()¶

Get amount

public getAmount(): float

Returns

• float — Allowance/charge amount

setAmount()¶

Set amount

public setAmount($amount: float): \Einvoicing\AllowanceOrCharge

Parameters

• $amount: float — Allowance/charge amount

Returns

• \Einvoicing\AllowanceOrCharge — This instance

isPercentage()¶

Is percentage

public isPercentage(): bool

Returns

• bool — Whether amount is a percentage or not

markAsPercentage()¶

Mark as percentage

public markAsPercentage(): \Einvoicing\AllowanceOrCharge

Returns

• \Einvoicing\AllowanceOrCharge — This instance

markAsFixedAmount()¶

Mark as fixed amount (not a percentage)

public markAsFixedAmount(): \Einvoicing\AllowanceOrCharge

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getEffectiveAmount()¶

Get effective amount relative to base amount

public getEffectiveAmount($baseAmount: float): float

Parameters

• $baseAmount: float — Base amount

Returns

• float — Effective amount

getVatCategory()¶

Get VAT category code

public getVatCategory(): string

Returns

• string — VAT category code

setVatCategory()¶

Set VAT category code

public setVatCategory($categoryCode: string): \Einvoicing\AllowanceOrCharge

Parameters

• $categoryCode: string — VAT category code

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getVatRate()¶

Get VAT rate

public getVatRate(): float|null

Returns

• float|null — VAT rate as a percentage or NULL when not subject to VAT

setVatRate()¶

Set VAT rate

public setVatRate($rate: float|null): \Einvoicing\AllowanceOrCharge

Parameters

• $rate: float|null — VAT rate as a percentage or NULL when not subject to VAT

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getVatExemptionReasonCode()¶

Get VAT exemption reason code

public getVatExemptionReasonCode(): string|null

Returns

• string|null — VAT exemption reason code

setVatExemptionReasonCode()¶

Set VAT exemption reason code

public setVatExemptionReasonCode($reasonCode: string|null): \Einvoicing\AllowanceOrCharge

Parameters

• $reasonCode: string|null — VAT exemption reason code

Returns

• \Einvoicing\AllowanceOrCharge — This instance

getVatExemptionReason()¶

Get VAT exemption reason

public getVatExemptionReason(): string|null

Returns

• string|null — VAT exemption reason expressed as text

setVatExemptionReason()¶

Set VAT exemption reason

public setVatExemptionReason($reason: string|null): \Einvoicing\AllowanceOrCharge

Parameters

• $reason: string|null — VAT exemption reason expressed as text

Returns

• \Einvoicing\AllowanceOrCharge — This instance