2021-05-11-handling-tax-free-dependent-values.md

title	issue
Handling tax-free dependent values	NEXT-14599

Core

• Deprecated taxFree from Shopware/Core/System/Country/CountryEntity, use $customerTax->getEnabled() instead.
• Deprecated companyTaxFree from Shopware/Core/System/Country/CountryEntity, use $companyTax->getEnabled() instead.
• Added two new properties customerTax, companyTax to Shopware/Core/System/Country/CountryEntity.
• Added two new fields customerTax, companyTax to Shopware/Core/System/Country/CountryDefinition.
• Added two new columns customer_tax and company_tax to country table.
• Added TaxFreeConfigField to Shopware/Core/Framework/DataAbstractionLayer/Field which stores customer_tax and company_tax in country.
• Added TaxFreeConfig to Shopware/Core/Framework/DataAbstractionLayer which will be decoded by the corresponding TaxFreeConfigField.
• Added TaxFreeConfigFieldSerializer to Shopware/Core/Framework/DataAbstractionLayer/FieldSerializer.

---

Upgrade Information

Change tax-free get and set in CountryEntity

Deprecated taxFree and companyTaxFree in Shopware/Core/System/Country/CountryEntity, use customerTax and companyTax instead.

If you are writing the fields directly, the tax-free of the country will be used:

Before

$countryRepository->create([
        [
            'id' => Uuid::randomHex(),
            'taxFree' => true,
            'companyTaxFree' => true,
            ...
        ]
    ],
    $context
);

After

$countryRepository->create([
        [
            'id' => Uuid::randomHex(),
            'customerTax' => [
                'enabled' => true, // enabled is taxFree value in old version
                'currencyId' => $currencyId,
                'amount' => 0,
            ],
            'companyTax' => [
                'enabled' => true, // enabled is companyTaxFree value in old version
                'currencyId' => $currencyId,
                'amount' => 0,
            ],
            ...
        ]
    ],
    $context
);

How to use the new getter and setter of tax-free in country:

Before

• To get tax-free

$country->getTaxFree();
$country->getCompanyTaxFree();

• To set tax-free

$country->setTaxFree($isTaxFree);
$country->setCompanyTaxFree($isTaxFree);

After

• To get tax-free

$country->getCustomerTax()->getEnabled(); // enabled is taxFree value in old version
$country->getCompanyTax()->getEnabled(); // enabled is companyTaxFree value in old version

• To set tax-free

// TaxFreeConfig::__construct(bool $enabled, string $currencyId, float $amount);
$country->setCusotmerTax(new TaxFreeConfig($isTaxFree, $currencyId, $amount));
$country->setCompanyTax(new TaxFreeConfig($isTaxFree, $currencyId, $amount));