CoolCMS API

TaxContext
in package

Read onlyYes
FinalYes

Input of {@see \App\UI\Api\System\Models\Managers\TaxManager::resolve()}.

Only facts about the transaction; everything about the seller (status on the date, country, VAT id) the manager loads itself from $sellerId.

Table of Contents

Properties

$customerCountryCode  : string|null
ISO2 of the customer's seat/residence; null falls back to the payment region, then to the seller country.
$customerDlvCountryCode  : string|null
Delivery country of goods; null = the customer country. Used only for nature `goods`.
$customerIsBusiness  : bool
$customerRegNo  : string|null
Company registration number of the customer. Only used to look up the business evidence of a non-EU customer without a VAT id; never changes the tax class.
$customerVatId  : string|null
Raw VAT id as typed by the customer (prefix optional).
$paymentRegionId  : int|null
$sellerId  : int
$supplyPlaceCountryCode  : string|null
Only `immovable_service`: where the property is; null = the customer country.
$taxDate  : DateTimeImmutable
Day the obligation to account for VAT arises: determines the rate, seller status and EU membership.
$vatIdCheckLimit  : VatIdCheckLimit|null
Safety cap of the automatic online checks (`RefreshStale`); null = unlimited (admin, CLI).
$vatIdPolicy  : VatIdPolicy

Methods

__construct()  : mixed

Properties

$customerCountryCode

ISO2 of the customer's seat/residence; null falls back to the payment region, then to the seller country.

public string|null $customerCountryCode = null

$customerDlvCountryCode

Delivery country of goods; null = the customer country. Used only for nature `goods`.

public string|null $customerDlvCountryCode = null

$customerIsBusiness

public bool $customerIsBusiness = false

$customerRegNo

Company registration number of the customer. Only used to look up the business evidence of a non-EU customer without a VAT id; never changes the tax class.

public string|null $customerRegNo = null

$customerVatId

Raw VAT id as typed by the customer (prefix optional).

public string|null $customerVatId = null

$paymentRegionId

public int|null $paymentRegionId = null

$supplyPlaceCountryCode

Only `immovable_service`: where the property is; null = the customer country.

public string|null $supplyPlaceCountryCode = null

$taxDate

Day the obligation to account for VAT arises: determines the rate, seller status and EU membership.

public DateTimeImmutable $taxDate

$vatIdCheckLimit

Safety cap of the automatic online checks (`RefreshStale`); null = unlimited (admin, CLI).

public VatIdCheckLimit|null $vatIdCheckLimit = null

Methods

__construct()

public __construct(int $sellerId, DateTimeImmutable $taxDate[, string|null $customerCountryCode = null ][, string|null $customerDlvCountryCode = null ][, bool $customerIsBusiness = false ][, string|null $customerVatId = null ][, int|null $paymentRegionId = null ][, string|null $supplyPlaceCountryCode = null ][, VatIdPolicy $vatIdPolicy = VatIdPolicy::CacheOnly ][, VatIdCheckLimit|null $vatIdCheckLimit = null ][, string|null $customerRegNo = null ]) : mixed
Parameters
$sellerId : int
$taxDate : DateTimeImmutable
$customerCountryCode : string|null = null
$customerDlvCountryCode : string|null = null
$customerIsBusiness : bool = false
$customerVatId : string|null = null
$paymentRegionId : int|null = null
$supplyPlaceCountryCode : string|null = null
$vatIdPolicy : VatIdPolicy = VatIdPolicy::CacheOnly
$vatIdCheckLimit : VatIdCheckLimit|null = null
$customerRegNo : string|null = null
On this page

Search results