How is \Magento\Tax\Model\Config::applyTaxAfterDiscount() implemented and used?

dmitry_fedyuk · February 2, 2017, 5:56pm

Implementation

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Config.php#L180-L193


/**
 * Check what taxes should be applied after discount
 *
 * @param   null|string|bool|int|Store $store
 * @return  bool
 */
public function applyTaxAfterDiscount($store = null)
{
    return (bool)$this->_scopeConfig->getValue(
        self::CONFIG_XML_PATH_APPLY_AFTER_DISCOUNT,
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
        $store
    );
}

Details: How is the «Apply Customer Tax» («Before Discount» / «After Discount») option handled?

Usages

1. Magento\Tax\Helper\Data::applyTaxAfterDiscount()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Helper/Data.php#L171-L180


/**
 * Check what taxes should be applied after discount
 *
 * @param  null|int|string|Store $store
 * @return bool
 */
public function applyTaxAfterDiscount($store = null)
{
    return $this->_config->applyTaxAfterDiscount($store);
}

2. Magento\Tax\Model\Config::getCalculationSequence()

3. Magento\Tax\Model\Calculation\AbstractAggregateCalculator::calculateWithTaxInPrice()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Calculation/AbstractAggregateCalculator.php#L12-L86


/**
 * {@inheritdoc}
 */
protected function calculateWithTaxInPrice(QuoteDetailsItemInterface $item, $quantity, $round = true)
{
    $taxRateRequest = $this->getAddressRateRequest()->setProductClassId(
        $this->taxClassManagement->getTaxClassId($item->getTaxClassKey())
    );
    $rate = $this->calculationTool->getRate($taxRateRequest);
    $storeRate = $storeRate = $this->calculationTool->getStoreRate($taxRateRequest, $this->storeId);


    $discountTaxCompensationAmount = 0;
    $applyTaxAfterDiscount = $this->config->applyTaxAfterDiscount($this->storeId);
    $discountAmount = $item->getDiscountAmount();


    // Calculate $rowTotalInclTax
    $priceInclTax = $this->calculationTool->round($item->getUnitPrice());
    $rowTotalInclTax = $priceInclTax * $quantity;
    if (!$this->isSameRateAsStore($rate, $storeRate)) {
        $priceInclTax = $this->calculatePriceInclTax($priceInclTax, $storeRate, $rate, $round);
        $rowTotalInclTax = $priceInclTax * $quantity;
    }
    $rowTaxExact = $this->calculationTool->calcTaxAmount($rowTotalInclTax, $rate, true, false);
    $deltaRoundingType = self::KEY_REGULAR_DELTA_ROUNDING;
    if ($applyTaxAfterDiscount) {
        $deltaRoundingType = self::KEY_TAX_BEFORE_DISCOUNT_DELTA_ROUNDING;
    }
    $rowTax = $this->roundAmount($rowTaxExact, $rate, true, $deltaRoundingType, $round, $item);
    $rowTotal = $rowTotalInclTax - $rowTax;
    $price = $rowTotal / $quantity;
    if ($round) {
        $price = $this->calculationTool->round($price);
    }


    //Handle discount
    if ($applyTaxAfterDiscount) {
        //TODO: handle originalDiscountAmount
        $taxableAmount = max($rowTotalInclTax - $discountAmount, 0);
        $rowTaxAfterDiscount = $this->calculationTool->calcTaxAmount(
            $taxableAmount,
            $rate,
            true,
            false
        );
        $rowTaxAfterDiscount = $this->roundAmount(
            $rowTaxAfterDiscount,
            $rate,
            true,
            self::KEY_REGULAR_DELTA_ROUNDING,
            $round,
            $item
        );
        // Set discount tax compensation
        $discountTaxCompensationAmount = $rowTax - $rowTaxAfterDiscount;
        $rowTax = $rowTaxAfterDiscount;
    }


    // Calculate applied taxes
    /** @var  \Magento\Tax\Api\Data\AppliedTaxInterface[] $appliedTaxes */
    $appliedRates = $this->calculationTool->getAppliedRates($taxRateRequest);
    $appliedTaxes = $this->getAppliedTaxes($rowTax, $rate, $appliedRates);


    return $this->taxDetailsItemDataObjectFactory->create()
        ->setCode($item->getCode())
        ->setType($item->getType())
        ->setRowTax($rowTax)
        ->setPrice($price)
        ->setPriceInclTax($priceInclTax)
        ->setRowTotal($rowTotal)
        ->setRowTotalInclTax($rowTotalInclTax)
        ->setDiscountTaxCompensationAmount($discountTaxCompensationAmount)
        ->setAssociatedItemCode($item->getAssociatedItemCode())
        ->setTaxPercent($rate)
        ->setAppliedTaxes($appliedTaxes);
}

4. Magento\Tax\Model\Calculation\AbstractAggregateCalculator::calculateWithTaxNotInPrice()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Calculation/AbstractAggregateCalculator.php#L88-L168


/**
 * {@inheritdoc}
 */
protected function calculateWithTaxNotInPrice(QuoteDetailsItemInterface $item, $quantity, $round = true)
{
    $taxRateRequest = $this->getAddressRateRequest()->setProductClassId(
        $this->taxClassManagement->getTaxClassId($item->getTaxClassKey())
    );
    $rate = $this->calculationTool->getRate($taxRateRequest);
    $appliedRates = $this->calculationTool->getAppliedRates($taxRateRequest);


    $applyTaxAfterDiscount = $this->config->applyTaxAfterDiscount($this->storeId);
    $discountAmount = $item->getDiscountAmount();
    $discountTaxCompensationAmount = 0;


    // Calculate $rowTotal
    $price = $this->calculationTool->round($item->getUnitPrice());
    $rowTotal = $price * $quantity;
    $rowTaxes = [];
    $rowTaxesBeforeDiscount = [];
    $appliedTaxes = [];
    //Apply each tax rate separately
    foreach ($appliedRates as $appliedRate) {
        $taxId = $appliedRate['id'];
        $taxRate = $appliedRate['percent'];
        $rowTaxPerRate = $this->calculationTool->calcTaxAmount($rowTotal, $taxRate, false, false);
        $deltaRoundingType = self::KEY_REGULAR_DELTA_ROUNDING;
        if ($applyTaxAfterDiscount) {
            $deltaRoundingType = self::KEY_TAX_BEFORE_DISCOUNT_DELTA_ROUNDING;
        }
        $rowTaxPerRate = $this->roundAmount($rowTaxPerRate, $taxId, false, $deltaRoundingType, $round, $item);
        $rowTaxAfterDiscount = $rowTaxPerRate;


        //Handle discount
        if ($applyTaxAfterDiscount) {
            //TODO: handle originalDiscountAmount
            $taxableAmount = max($rowTotal - $discountAmount, 0);
            $rowTaxAfterDiscount = $this->calculationTool->calcTaxAmount(
                $taxableAmount,
                $taxRate,
                false,
                false
            );
            $rowTaxAfterDiscount = $this->roundAmount(
                $rowTaxAfterDiscount,
                $taxId,
                false,
                self::KEY_REGULAR_DELTA_ROUNDING,
                $round,
                $item
            );
        }
        $appliedTaxes[$taxId] = $this->getAppliedTax(
            $rowTaxAfterDiscount,
            $appliedRate
        );


        $rowTaxes[] = $rowTaxAfterDiscount;
        $rowTaxesBeforeDiscount[] = $rowTaxPerRate;
    }
    $rowTax = array_sum($rowTaxes);
    $rowTaxBeforeDiscount = array_sum($rowTaxesBeforeDiscount);
    $rowTotalInclTax = $rowTotal + $rowTaxBeforeDiscount;
    $priceInclTax = $rowTotalInclTax / $quantity;
    if ($round) {
        $priceInclTax = $this->calculationTool->round($priceInclTax);
    }


    return $this->taxDetailsItemDataObjectFactory->create()
        ->setCode($item->getCode())
        ->setType($item->getType())
        ->setRowTax($rowTax)
        ->setPrice($price)
        ->setPriceInclTax($priceInclTax)
        ->setRowTotal($rowTotal)
        ->setRowTotalInclTax($rowTotalInclTax)
        ->setDiscountTaxCompensationAmount($discountTaxCompensationAmount)
        ->setAssociatedItemCode($item->getAssociatedItemCode())
        ->setTaxPercent($rate)
        ->setAppliedTaxes($appliedTaxes);
}

5. Magento\Tax\Model\Calculation\UnitBaseCalculator::calculateWithTaxInPrice()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Calculation/UnitBaseCalculator.php#L33-L104


/**
 * {@inheritdoc}
 */
protected function calculateWithTaxInPrice(QuoteDetailsItemInterface $item, $quantity, $round = true)
{
    $taxRateRequest = $this->getAddressRateRequest()->setProductClassId(
        $this->taxClassManagement->getTaxClassId($item->getTaxClassKey())
    );
    $rate = $this->calculationTool->getRate($taxRateRequest);
    $storeRate = $storeRate = $this->calculationTool->getStoreRate($taxRateRequest, $this->storeId);


    // Calculate $priceInclTax
    $applyTaxAfterDiscount = $this->config->applyTaxAfterDiscount($this->storeId);
    $priceInclTax = $this->calculationTool->round($item->getUnitPrice());
    if (!$this->isSameRateAsStore($rate, $storeRate)) {
        $priceInclTax = $this->calculatePriceInclTax($priceInclTax, $storeRate, $rate, $round);
    }
    $uniTax = $this->calculationTool->calcTaxAmount($priceInclTax, $rate, true, false);
    $deltaRoundingType = self::KEY_REGULAR_DELTA_ROUNDING;
    if ($applyTaxAfterDiscount) {
        $deltaRoundingType = self::KEY_TAX_BEFORE_DISCOUNT_DELTA_ROUNDING;
    }
    $uniTax = $this->roundAmount($uniTax, $rate, true, $deltaRoundingType, $round, $item);
    $price = $priceInclTax - $uniTax;


    //Handle discount
    $discountTaxCompensationAmount = 0;
    $discountAmount = $item->getDiscountAmount();
    if ($applyTaxAfterDiscount) {
        //TODO: handle originalDiscountAmount
        $unitDiscountAmount = $discountAmount / $quantity;
        $taxableAmount = max($priceInclTax - $unitDiscountAmount, 0);
        $unitTaxAfterDiscount = $this->calculationTool->calcTaxAmount(
            $taxableAmount,
            $rate,
            true,
            false
        );
        $unitTaxAfterDiscount = $this->roundAmount(
            $unitTaxAfterDiscount,
            $rate,
            true,
            self::KEY_REGULAR_DELTA_ROUNDING,
            $round,
            $item
        );


        // Set discount tax compensation
        $unitDiscountTaxCompensationAmount = $uniTax - $unitTaxAfterDiscount;
        $discountTaxCompensationAmount = $unitDiscountTaxCompensationAmount * $quantity;
        $uniTax = $unitTaxAfterDiscount;
    }
    $rowTax = $uniTax * $quantity;


    // Calculate applied taxes
    /** @var  \Magento\Tax\Api\Data\AppliedTaxInterface[] $appliedTaxes */
    $appliedRates = $this->calculationTool->getAppliedRates($taxRateRequest);
    $appliedTaxes = $this->getAppliedTaxes($rowTax, $rate, $appliedRates);


    return $this->taxDetailsItemDataObjectFactory->create()
        ->setCode($item->getCode())
        ->setType($item->getType())
        ->setRowTax($rowTax)
        ->setPrice($price)
        ->setPriceInclTax($priceInclTax)
        ->setRowTotal($price * $quantity)
        ->setRowTotalInclTax($priceInclTax * $quantity)
        ->setDiscountTaxCompensationAmount($discountTaxCompensationAmount)
        ->setAssociatedItemCode($item->getAssociatedItemCode())
        ->setTaxPercent($rate)
        ->setAppliedTaxes($appliedTaxes);
}

6. Magento\Tax\Model\Calculation\UnitBaseCalculator::calculateWithTaxNotInPrice()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/Calculation/UnitBaseCalculator.php#L106-L184


/**
 * {@inheritdoc}
 */
protected function calculateWithTaxNotInPrice(QuoteDetailsItemInterface $item, $quantity, $round = true)
{
    $taxRateRequest = $this->getAddressRateRequest()->setProductClassId(
        $this->taxClassManagement->getTaxClassId($item->getTaxClassKey())
    );
    $rate = $this->calculationTool->getRate($taxRateRequest);
    $appliedRates = $this->calculationTool->getAppliedRates($taxRateRequest);


    $applyTaxAfterDiscount = $this->config->applyTaxAfterDiscount($this->storeId);
    $discountAmount = $item->getDiscountAmount();
    $discountTaxCompensationAmount = 0;


    // Calculate $price
    $price = $this->calculationTool->round($item->getUnitPrice());
    $unitTaxes = [];
    $unitTaxesBeforeDiscount = [];
    $appliedTaxes = [];
    //Apply each tax rate separately
    foreach ($appliedRates as $appliedRate) {
        $taxId = $appliedRate['id'];
        $taxRate = $appliedRate['percent'];
        $unitTaxPerRate = $this->calculationTool->calcTaxAmount($price, $taxRate, false, false);
        $deltaRoundingType = self::KEY_REGULAR_DELTA_ROUNDING;
        if ($applyTaxAfterDiscount) {
            $deltaRoundingType = self::KEY_TAX_BEFORE_DISCOUNT_DELTA_ROUNDING;
        }
        $unitTaxPerRate = $this->roundAmount($unitTaxPerRate, $taxId, false, $deltaRoundingType, $round, $item);
        $unitTaxAfterDiscount = $unitTaxPerRate;


        //Handle discount
        if ($applyTaxAfterDiscount) {
            //TODO: handle originalDiscountAmount
            $unitDiscountAmount = $discountAmount / $quantity;
            $taxableAmount = max($price - $unitDiscountAmount, 0);
            $unitTaxAfterDiscount = $this->calculationTool->calcTaxAmount(
                $taxableAmount,
                $taxRate,
                false,
                false
            );
            $unitTaxAfterDiscount = $this->roundAmount(
                $unitTaxAfterDiscount,
                $taxId,
                false,
                self::KEY_REGULAR_DELTA_ROUNDING,
                $round,
                $item
            );
        }
        $appliedTaxes[$taxId] = $this->getAppliedTax(
            $unitTaxAfterDiscount * $quantity,
            $appliedRate
        );


        $unitTaxes[] = $unitTaxAfterDiscount;
        $unitTaxesBeforeDiscount[] = $unitTaxPerRate;
    }
    $unitTax = array_sum($unitTaxes);
    $unitTaxBeforeDiscount = array_sum($unitTaxesBeforeDiscount);


    $rowTax = $unitTax * $quantity;
    $priceInclTax = $price + $unitTaxBeforeDiscount;


    return $this->taxDetailsItemDataObjectFactory->create()
        ->setCode($item->getCode())
        ->setType($item->getType())
        ->setRowTax($rowTax)
        ->setPrice($price)
        ->setPriceInclTax($priceInclTax)
        ->setRowTotal($price * $quantity)
        ->setRowTotalInclTax($priceInclTax * $quantity)
        ->setDiscountTaxCompensationAmount($discountTaxCompensationAmount)
        ->setAssociatedItemCode($item->getAssociatedItemCode())
        ->setTaxPercent($rate)
        ->setAppliedTaxes($appliedTaxes);
}

7. Magento\Tax\Model\System\Message\Notifications::checkDiscountSettings()

github.com

magento/magento2/blob/2.1.3/app/code/Magento/Tax/Model/System/Message/Notifications.php#L96-L109


/**
 * Check if tax discount settings are compatible
 *
 * Matrix for invalid discount settings is as follows:
 *      Before Discount / Excluding Tax
 *      Before Discount / Including Tax
 *
 * @param null|int|bool|string|\Magento\Store\Model\Store $store $store
 * @return bool
 */
public function checkDiscountSettings($store = null)
{
    return $this->taxConfig->applyTaxAfterDiscount($store);
}

8. Magento\Tax\Model\System\Message\Notification\ApplyDiscountOnPrices::checkSettings()

github.com

magento/magento2/blob/a2cf9b8/app/code/Magento/Tax/Model/System/Message/Notification/ApplyDiscountOnPrices.php#L130-L141


/**
 * Check if settings are valid.
 *
 * @param null|int|bool|string|\Magento\Store\Model\Store $store $store
 * @return bool false if settings are incorrect
 */
private function checkSettings($store = null)
{
    return $this->taxConfig->priceIncludesTax($store)
        || !$this->taxConfig->applyTaxAfterDiscount($store)
        || !$this->taxConfig->discountTax($store);
}

9. Magento\Tax\Model\System\Message\Notification\DiscountErrors::checkSettings()

github.com

magento/magento2/blob/a2cf9b8/app/code/Magento/Tax/Model/System/Message/Notification/DiscountErrors.php#L107-L120


/**
 * Check if tax discount settings are compatible
 *
 * Matrix for invalid discount settings is as follows:
 *      Before Discount / Excluding Tax
 *      Before Discount / Including Tax
 *
 * @param null|int|bool|string|\Magento\Store\Model\Store $store $store
 * @return bool
 */
private function checkSettings($store = null)
{
    return $this->taxConfig->applyTaxAfterDiscount($store);
}

dmitry_fedyuk · February 2, 2017, 6:09pm