Discount coupon value

[pilou2]

On ZC v2.0.0-rc2, discount coupons are displayed /calculated wrong values in checkout pages.
There is a unique tax class with rate of 10%.
There are two items in cart, one at $48.34 and the other at $35.00 gross price.
Flat rate shipping ($5) is used as shipping method and is set to same tax class as items (10%).
'ot_coupon' settings are default.

Coupon value is wrong when displaying prices with tax (orange color), which makes although tax and total wrong. But tax and total calculations appear to be good.
In table below, 'ZC' column is what is displayed in ZC v2.0.0-rc2, 'Good' column is what I think it should be and just for information and to identify lost penny, I included a 'no rounding' column. There is actually a penny loss in tax calculation when displaying prices with tax.

My understanding of discount coupons is that the discount should be applied to final total ($97.17 including tax) to get the new total and that tax should be re-calculate to fit this new total.

[pilou2]

I forgot to write it, but discount coupon is fixed at $8.
Then, if you look at total when displaying with no tax ($89.17) for what is considered good, it should be $89.18 so that numbers in the column above add correctly. In Excel sheet calculation for coupon value and tax are done without rounding which gives a total of $89.174 rounded at the end to $89.17.
Which result should be displayed in ZC, I am not sure. I would probably go for the mathematically more precise one of $89.17. It then equals the total when displaying tax.
To come back to coupons calculation, I will try to locate code that gives this weird 8.73 number in ot_coupon.php file.

[pilou2]

I got it fixed.
There were 3 problems:
1- Getting rid of all zen_round function calls fixed or at list minimized penny loss problem
2- Code to display coupon value was adding the tax difference when displaying prices with tax and doing nothing when displaying prices without tax. It should be the opposite, just display coupon value when prices with tax are displayed and remove tax difference when prices without tax are displayed.
Lines 597 and 598:

                        if (DISPLAY_PRICE_WITH_TAX == 'true' && $coupon_details['coupon_type'] == 'F') {
                            $od_amount['total'] += $od_amount['tax']; 

are replaced with this:

                        if (DISPLAY_PRICE_WITH_TAX == 'false' && $coupon_details['coupon_type'] == 'F') {
                            $od_amount['total'] -= $od_amount['tax']; 

3- Tax calculation after discount uses a ratio between discount and total of taxable products. It worked ok when displaying prices with tax, but when displaying prices without tax, it was using total without tax, which is wrong. It should always be total including taxes.
To fix this, line 50:

        $orderAmountTotal = (string)$orderTotalDetails['orderTotal'];  // coupon is applied against value of only qualifying/restricted products in cart 

was replaced by this:

        $orderAmountTotal = (DISPLAY_PRICE_WITH_TAX == 'true') ? (string)$orderTotalDetails['orderTotal'] : (string)($orderTotalDetails['orderTotal'] + $orderTotalDetails['orderTax']);  // coupon is applied against value of only qualifying/restricted products in cart 

Now everything looks good, but some testing is still needed with other settings.

[pilou2]

Here are the results:

[pilou2]

For Discount coupon by percentage, a modification was necessary too.
Line 545 was changed from:

$od_amount['total'] = zen_round($orderAmountTotal * ($coupon_details['coupon_amount'] / 100), $currencyDecimalPlaces); 

To this:

$od_amount['total'] = (DISPLAY_PRICE_WITH_TAX == 'true') ? $orderAmountTotal * ($coupon_details['coupon_amount'] / 100) : ($orderTotalDetails['orderTotal'] + $orderTotalDetails['orderTax'] - $orderTotalDetails['shippingTax']) * ($coupon_details['coupon_amount'] / 100); 

And lines 597-598 from:

                        if (DISPLAY_PRICE_WITH_TAX == 'true' && $coupon_details['coupon_type'] == 'F') {
                            $od_amount['total'] += $od_amount['tax']; 

To this:

                        if (DISPLAY_PRICE_WITH_TAX == 'false' && ($coupon_details['coupon_type'] == 'F' || $coupon_details['coupon_type'] == 'P')) {
                            $od_amount['total'] -= $od_amount['tax']; 

[lat9]

Thanks for this, @pilou2! In going through the other rounding errors, I had a feeling that these calculation issues would arise in ot_coupon as well.

Since that's going to be a fairly major change to that module, I'm suggesting that we defer these corrections to Zen Cart 2.0.1 so that we can get some testing time in on that and all the other rounding-related changes.

[DrByte]

Here are the results:

I acknowledge that you've made many updates to proposed coding changes since posting these screenshots, so I'm posting to ask whether the latest code still works as shown in these images?
... because in the US (tax-included-pricing is 'false'), if a person redeems a coupon worth $8.00, they'll want to see that coupon being worth $8.00 not $7.28 in the subtotals.

[pilou2]

I acknowledge that you've made many updates to proposed coding changes since posting these screenshots, so I'm posting to ask whether the latest code still works as shown in these images?
... because in the US (tax-included-pricing is 'false'), if a person redeems a coupon worth $8.00, they'll want to see that coupon being worth $8.00 not $7.28 in the subtotals.

Well, yes and no... In countries I know, there is always a sale tax to apply and when a shop gives you a discount it is always on final prices (tax included). It seems that in US, even at consumer level, tax excluded is the base. In ZC the option to recalculate tax allows both, hopefully. Problem is that in original code 'Credit Note' option was used for tax included discount (I think it was depending on the module), but credit note are in fact an accounting tool (negative invoice) used between company that trade tax excluded and do their adjustments (discounts) tax excluded too.
Because of this and my own experience of discounts, I interpreted the 'Credit Note' option as tax excluded discount and 'Standard' option as tax included.
Actual code follows this interpretation which might be opposite of original code.
Shop owners have to be careful how they set these options or it might end up like you said with an invoice different that what was said.
If you display prices without tax, then discount re-calculate tax should be set to 'Credit Note' with new code. If prices are displayed tax included, 'standard' option would be the best choice. Although in some case, like trade between professionals, you can have a mix of these.