Shipping discount does not get included in a new invoice if earlier invoice with the discount is cancelled.

[higuhi]

Preconditions and environment

• Magento version: 2.4.5-p1 (Vanilla Magento 2 with Sample Data)
• PHP Version: 8.1.2
• Maria DB: 10.4
• Apache: 2.4.52
• Composer: 2.2.6
• ElasticSearch: 7.17.8

Steps to reproduce

In app/code/Magento/Sales/Model/Order/Invoice.php, three invoice states are defined.

    /**#@+
     * Invoice states
     */
    const STATE_OPEN = 1;

    const STATE_PAID = 2;

    const STATE_CANCELED = 3;

And, in app/code/Magento/Sales/Model/Order/Invoice/Total/Discount.php, the Discount::collect() function checks if the shipping discount has already been invoiced with the private function Discount::isShippingDiscount()

        /**
         * Checking if shipping discount was added in previous invoices.
         * So basically if we have invoice with positive discount and it
         * was not canceled we don't add shipping discount to this one.
         */
        if ($this->isShippingDiscount($invoice)) {
            $totalDiscountAmount = $totalDiscountAmount + $invoice->getOrder()->getShippingDiscountAmount();
            $baseTotalDiscountAmount = $baseTotalDiscountAmount +
                $invoice->getOrder()->getBaseShippingDiscountAmount();
        }

Then, the function loops the invoice collection if the shipping discount has been applied to earlier invoices.

    private function isShippingDiscount(Invoice $invoice): bool
    {
        $addShippingDiscount = true;
        foreach ($invoice->getOrder()->getInvoiceCollection() as $previousInvoice) {
            if ($previousInvoice->getDiscountAmount()) {
                $addShippingDiscount = false;
            }
        }
        return $addShippingDiscount;
    }

The condition to test the discount amount should also test if the invoice is not Canceled in case the invoice, for some reason, has been removed because the new invoice needs to add the shipping discount which has been canceled.

So, it should be...

    private function isShippingDiscount(Invoice $invoice): bool
    {
        $addShippingDiscount = true;
        foreach ($invoice->getOrder()->getInvoiceCollection() as $previousInvoice) {
            if ($previousInvoice->getState() != \Magento\Sales\Model\Order\Invoice::STATE_CANCELED && $previousInvoice->getDiscountAmount()) {
                $addShippingDiscount = false;
            }
        }
        return $addShippingDiscount;
    }

Steps to produce

1. Deploy the sample data
2. Navigate MARKETING > Cart Price Rules
3. Create a discount that applies to the shipping amount. For example, this is a discount on Shipping Fee when the order has more than 10 items:
   • Under Conditions: Total Items Quantity equals or greater than 10,
   • Under Actions:
     • Apply: Percent of product price discount
     • Discount Amount: 30
     • Apply to Shipping Amount: Yes <--- this is important
4. Create an order to get the shipping discount
5. Make a partial invoice (this will create an invoice with shipping & handling with the discount)
6. Somehow change the state of the invoice to "STATE_CANCEL" (the easier way is by directly changing the state from DB)

   UPDATE sales_invoice SET state = 3 WHERE entity_id = {entity id of the invoice};
   UPDATE sales_invoice_grid SET state = 3 WHERE entity_id = {entity id of the invoice};
   

7. Make the invoice for the remaining (this will create an invoice without the discount on the shipping & handling fee)

NOTE: the above steps use "partial invoice" only to make the reproduction of the issue easier. It is possible to reproduce with a standard full invoice but you must somehow cancel the invoice and also revert the invoiced quantity of each product line in the order so that the order can be invoiced again.

Expected result

The invoice should include the discount on shipping if the earlier invoices with the discount have been canceled.

Actual result

The shipping discount does not get included in the subsequent invoices if the earlier "Cancelled" invoice includes the shipping discount.

Additional information

Although it is not possible to have an invoice with the state, STATE_CANCELED, in the vanilla Magento setup, the state is defined in the code and some payment gateways make use of the state to indicate the issue in the payment capture.

In such cases, Magento Core should check for the state of the invoice and ignore those canceled invoices, so that the shipping discount is correctly included when the invoice for the order is re-issued. (The comment in the code says that "So basically if we have invoice with positive discount and it was not canceled we don't add shipping discount to this one." )

Release note

Additional validation of the invoice state so that a new invoice includes the shipping discount if the earlier invoices with the discount are canceled.

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @higuhi. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Bravo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Bravo]

Hi @higuhi,

Thank you for reporting and collaboration.
Verified the issue on Magento 2.4-develop instance.Kindly refer the screenshots.

Steps to produce

1.Deploy the sample data
2.Navigate MARKETING > Cart Price Rules
3.Create a discount that applies to the shipping amount. For example, this is a discount on Shipping Fee when the order has more than 10 items:
Under Conditions: Total Items Quantity equals or greater than 10,
Under Actions:
Apply: Percent of product price discount
Discount Amount: 30
Apply to Shipping Amount: Yes <--- this is important
4.Create an order to get the shipping discount
5.Make a partial invoice (this will create an invoice with shipping & handling with the discount)

6.Somehow change the state of the invoice to "STATE_CANCEL" (the easier way is by directly changing the state from DB)

UPDATE sales_invoice SET state = 3 WHERE entity_id = {entity id of the invoice};
UPDATE sales_invoice_grid SET state = 3 WHERE entity_id = {entity id of the invoice};

7.Make the invoice for the remaining (this will create an invoice without the discount on the shipping & handling fee)

Kindly elaborate expected and actual result.Where Shipping discount will get included in new invoice, and please let us know if we missed anything.

Thanks.

[engcom-Bravo]

Hi @higuhi,

We have noticed that this issue has not been updated for a period of 14 Days.
Hence we assume that this issue is fixed now, so we are closing it. Please raise a fresh ticket or reopen this ticket if you need more assistance on this.

Thanks.