Shipping price showing different in printed pdf #38595

DhruvBasan · 2024-04-09T12:00:29Z

Description (*)

In Stores -> Configuration -> Sales -> Tax -> In the "Display Shipping Price" tab, we can specify whether to show shipping prices including or excluding tax. As seen in screenshot 1, I've set the "Display Shipping Price" option to "Including Tax." Consequently, in screenshot 2, the shipping price is displayed including tax on the sales-order_invoice-view page. However, when we print the order in PDF format from this page, the shipping price is shown as excluding tax, which is incorrect. It should be displayed as per tax configuration and similar to the sales-order_invoice-view page because we are printing the page. You can view the printed PDF in screenshot 3.

Screenshot-1:

Screenshot-2:

Screenshot-3:

Manual testing scenarios (*)

1: Navigate to Admin->Store->Sales->Tax and Select the option as shown in screenshot 4 &5
Screenshot-4:

Screenshot 5:

2: create a one tax rule you can see the screenshot 6 i have created one tax rule with 25% tax rate
Screenshot-6:

3:Now order one product from the frontend
4:Now navigate to admin side and create a invoice of that order
5:Now, navigate to Sales -> Invoice and view the invoice you created.
6:now print the order from invoice page as you can see the diffrence of the shipping price in the sales-order_invoice-view page and in the pdf as depricated in screenshot 2 & 3.

Expected result (*)

The shipping charges should be shown the same way they are displayed on the sales-order_invoice-view page since we are printing the page.

Actual result (*)

The shipping charges are displayed differently on the PDF compared to the sales order invoice view page

Aditional information

The file public_html/app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php is responsible for the content seen in the printed PDF. The logic for displaying shipping charges is found in lines 607 to 610 of this file. However, there is no logic implemented to show shipping charges according to the configuration settings. On the other hand, in public_html/app/code/Magento/Sales/view/adminhtml/templates/order/invoice/create/form.phtml, the logic is implemented to fetch the configuration and then display the shipping charges accordingly on the sales-order_invoice-view page. You can see the logic of form.phtml in Screenshot 7, where shipping charges are displayed according to the configuration. However, in AbstractPdf.php, there is no such logic implemented, and only the shipping price excluding tax is shown, as depicted in Screenshot 8.

Screenshot 7:

Screenshot-8:

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Shipping price showing diffrent in printed pdf #38608: Shipping price showing diffrent in printed pdf

m2-assistant · 2024-04-09T12:00:32Z

Hi @DhruvBasan. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

DhruvBasan · 2024-04-09T12:16:58Z

@magento run all tests

engcom-Hotel · 2024-04-10T13:53:56Z

@magento create issue

engcom-Hotel · 2024-05-30T05:40:07Z

@magento run all tests

engcom-Hotel

Hello @DhruvBasan,

Thanks for the contribution!

Please check the below review comments, for Backward compatibility, please mark the newly added parameters to null in constructor and use ObjectManager to initialize those.

Also please check the failed tests, it seems they are failing due to code changes.

Thanks

engcom-Hotel · 2024-05-30T12:00:49Z

app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php

+    /**
+     * @var Magento\Tax\Helper\Data
+     */
+    protected $taxHelper;


Make this variable as private

engcom-Hotel · 2024-05-30T12:01:56Z

app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php

        \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
        \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation,
        \Magento\Sales\Model\Order\Address\Renderer $addressRenderer,
+        TaxHelper $taxHelper,


Make this null by default to maintain backward compatibility.

engcom-Hotel · 2024-05-30T12:02:47Z

app/code/Magento/Sales/Model/Order/Pdf/AbstractPdf.php

        $this->_pdfTotalFactory = $pdfTotalFactory;
        $this->_pdfItemsFactory = $pdfItemsFactory;
        $this->inlineTranslation = $inlineTranslation;
+        $this->taxHelper = $taxHelper;


Use the ObjectManager to initialize this variable.

engcom-Hotel · 2024-05-30T12:04:15Z

app/code/Magento/Sales/Model/Order/Pdf/Creditmemo.php

        \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
        \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation,
        \Magento\Sales\Model\Order\Address\Renderer $addressRenderer,
+        \Magento\Tax\Helper\Data $taxHelper,


Make this null by default

engcom-Hotel · 2024-05-30T12:04:51Z

app/code/Magento/Sales/Model/Order/Pdf/Creditmemo.php

            $localeDate,
            $inlineTranslation,
            $addressRenderer,
+            $taxHelper,


initialize $taxHelper with ObjectManager

engcom-Charlie · 2024-06-03T06:17:53Z

Hi @DhruvBasan,

Thank you for your contribution!

Did you get time to work on the changes.

Thank you!

DhruvBasan · 2024-06-03T10:29:46Z

@engcom-Hotel @engcom-Charlie I have made the changes to the files as per your suggestions. Kindly review them.

engcom-Hotel · 2024-06-04T05:41:36Z

@magento run all tests

engcom-Hotel

Thanks @DhruvBasan, for quick workaround, but it seems the failed tests are due to code changes. I Request you to please fix them.

Thanks

engcom-Charlie · 2024-06-11T06:54:13Z

Hi @DhruvBasan,

Thank you for your contribution!

Did you get time to work on the build failures.

Thank you!

engcom-Bravo · 2024-06-18T08:35:35Z

Hello,

Internal team has started to work on it

Thanks.

engcom-Bravo · 2024-07-05T07:35:09Z

Hello,

As I can see this issue got fixed in the scope of the internal Jira ticket AC-11798 by the internal team
Related commits:https://github.com/search?q=repo%3Amagento%2Fmagento2+AC-11798&type=commits

Based on the Jira ticket, the target version is 2.4.8-beta1.

Thanks

Shipping price showing diffrent in printed pdf

f1835f0

m2-assistant bot mentioned this pull request Apr 10, 2024

[Issue] Shipping price showing diffrent in printed pdf #38608

Closed

5 tasks

m2-community-project bot added the Progress: pending review label Apr 10, 2024

engcom-Hotel added Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. and removed Progress: pending review labels Apr 10, 2024

m2-community-project bot added Progress: on hold Progress: pending review and removed Progress: on hold labels Apr 10, 2024

DhruvBasan changed the title ~~Shipping price showing diffrent in printed pdf~~ Shipping price showing different in printed pdf Apr 18, 2024

sinhaparul added the Project: Community Picked PRs upvoted by the community label May 21, 2024

engcom-Hotel self-requested a review May 30, 2024 05:39

m2-community-project bot added Progress: review and removed Progress: pending review labels May 30, 2024

Merge branch '2.4-develop' into pdf-shipping-price

99445f4

engcom-Hotel requested changes May 30, 2024

View reviewed changes

m2-community-project bot assigned engcom-Hotel May 30, 2024

m2-community-project bot added Progress: needs update and removed Progress: review labels May 30, 2024

engcom-Charlie assigned engcom-Charlie and unassigned engcom-Charlie May 31, 2024

optimize the code as per suggestion

641b391

DhruvBasan requested a review from engcom-Hotel June 3, 2024 10:29

m2-community-project bot added Progress: pending review and removed Progress: needs update labels Jun 4, 2024

Merge branch '2.4-develop' into pdf-shipping-price

c2750f5

m2-community-project bot added Progress: review and removed Progress: pending review labels Jun 4, 2024

engcom-Hotel requested changes Jun 4, 2024

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Jun 4, 2024

engcom-Bravo closed this Jul 5, 2024

m2-community-project bot removed the Progress: needs update label Jul 5, 2024

Shipping price showing different in printed pdf #38595

Shipping price showing different in printed pdf #38595

Uh oh!

Conversation

DhruvBasan commented Apr 9, 2024 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Manual testing scenarios (*)

Expected result (*)

Actual result (*)

Aditional information

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Apr 9, 2024

Uh oh!

DhruvBasan commented Apr 9, 2024

Uh oh!

engcom-Hotel commented Apr 10, 2024

Uh oh!

engcom-Hotel commented May 30, 2024

Uh oh!

engcom-Hotel left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel May 30, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel May 30, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel May 30, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel May 30, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel May 30, 2024

Choose a reason for hiding this comment

Uh oh!

engcom-Charlie commented Jun 3, 2024

Uh oh!

DhruvBasan commented Jun 3, 2024

Uh oh!

engcom-Hotel commented Jun 4, 2024

Uh oh!

engcom-Hotel left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Charlie commented Jun 11, 2024

Uh oh!

engcom-Bravo commented Jun 18, 2024

Uh oh!

engcom-Bravo commented Jul 5, 2024

Uh oh!

Uh oh!

DhruvBasan commented Apr 9, 2024 •

edited by m2-assistant bot

Loading