Skip to content

Conversation

@antoine162
Copy link
Contributor

@antoine162 antoine162 commented Nov 3, 2021

New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.

@robodoo
Copy link
Collaborator

robodoo commented Nov 3, 2021

@antoine162 antoine162 force-pushed the 13.0-taxcloud-explain-how-to-automatically-set-tax-account branch 2 times, most recently from f29a14c to 5b8aa5c Compare November 3, 2021 14:32
@antoine162
Copy link
Contributor Author

@Feyensv @AntoineVDV
Bonjour Victor, bonjour Antoine, je ne sais pas si l'un d'entre vous pourrait reviewer ce petit ajout à la documentation TaxCloud? Cela explique comment configurer un compte par défaut pour les nouvelles taxes (ce qui est utile pour les taxes créées automatiquement par l'intégration Taxcloud). Merci d'avance!

@AntoineVDV
Copy link
Collaborator

@Feyensv @AntoineVDV Bonjour Victor, bonjour Antoine, je ne sais pas si l'un d'entre vous pourrait reviewer ce petit ajout à la documentation TaxCloud? Cela explique comment configurer un compte par défaut pour les nouvelles taxes (ce qui est utile pour les taxes créées automatiquement par l'intégration Taxcloud). Merci d'avance!

Hello! Les PRs qui touchent à la doc des apps doivent d'abord passer par l'équipe content. On s'occupera de check le côté technique ensuite ;)
cc @jcs-odoo

@antoine162
Copy link
Contributor Author

Ahhh génial merci!

Copy link
Contributor

@Lau-Odoo Lau-Odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @antoine162, here is a first review of your documentation.
Please, check this ;)

to open and edit your Company record.

Automatically post taxes to the correct Tax Payable account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding our RST guidelines, you shouldn't use this formatting for H4.
Please, find the RST guidelines here: https://www.odoo.com/documentation/14.0/contributing/documentation/rst_cheat_sheet.html

Also, add a space between the title and the paragraph.

Comment on lines 52 to 53
.. image:: media/taxcloud_user_defined_default_01.png
:align: center
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add an alt text to your image + align your .. image with :align:
For more info, please check our guidelines: https://www.odoo.com/documentation/14.0/contributing/documentation/rst_cheat_sheet.html

Comment on lines 55 to 70
* With Debug Mode activated, go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and click *Create*
* Click on *Field*, then, in the drop-down menu, on *Search More*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* With Debug Mode activated, go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and click *Create*
* Click on *Field*, then, in the drop-down menu, on *Search More*.
* With Debug Mode activated, go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and
click *Create*.
* Click on *Field*, then, in the drop-down menu, on *Search More*.

https://www.odoo.com/documentation/14.0/contributing/documentation/rst_guidelines.html#start-a-new-line-before-the-100th-character

Comment on lines 61 to 62
* In the pop-up's search box, filter on 'Model: tax.repartition.line' and 'Field: account'.
Select the 'account' field of the 'tax.repartition.line' model.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* In the pop-up's search box, filter on 'Model: tax.repartition.line' and 'Field: account'.
Select the 'account' field of the 'tax.repartition.line' model.
* In the pop-up's search box, filter on the model ``tax.repartition.line`` and the field ``account``.
Select the ``account`` field of the ``tax.repartition.line`` model.

so that the new taxes generated by the TaxCloud integration are created with the correct Tax Payable account:
* In your company's Chart of Accounts, take note of the ID of the Tax Payable account you want to use.

.. image:: media/taxcloud_user_defined_default_01.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this image necessary?
If so, please check our guidelines: https://www.odoo.com/documentation/14.0/contributing/documentation/content_guidelines.html#images
Imo, you could remove this image and replace it with some text.

Also, your images should be in another file as mentioned in our guidelines: https://www.odoo.com/documentation/14.0/contributing/documentation/content_guidelines.html#media-files

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tried to clarify this in the text as you suggested, but even then I doubt it would be clear enough for the reader if they are not used to finding the ID of a record through the URL string. To be safe, I think it's worth keeping the image (though I have resized it so as to focus on the URL bar).

.. image:: media/taxcloud_user_defined_default_01.png
:align: center

* With Debug Mode activated, go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and click *Create*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* With Debug Mode activated, go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and click *Create*
* Activate the :ref:`developer mode <developer-mode>`, then go to :menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and click on *Create*.

.. image:: media/taxcloud_user_defined_default_03.png
:align: center

* In the *Default Value* field, enter the ID of your company's Tax Payable account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* In the *Default Value* field, enter the ID of your company's Tax Payable account.
* In the **Default Value** field, enter the ID of your company's Tax Payable account.

Comment on lines 48 to 50
* For each of your companies which uses TaxCloud, you need to create a User-Defined Default
so that the new taxes generated by the TaxCloud integration are created with the correct Tax Payable account:
* In your company's Chart of Accounts, take note of the ID of the Tax Payable account you want to use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* For each of your companies which uses TaxCloud, you need to create a User-Defined Default
so that the new taxes generated by the TaxCloud integration are created with the correct Tax Payable account:
* In your company's Chart of Accounts, take note of the ID of the Tax Payable account you want to use.
* For each of your companies that uses TaxCloud, you need to create a **User-Defined Default**
so that the new taxes generated by the TaxCloud integration are created with the correct Tax Payable account:
* In your company's Chart of Accounts, take note of the ID of the Tax Payable account you want to use.

@antoine162 antoine162 force-pushed the 13.0-taxcloud-explain-how-to-automatically-set-tax-account branch from 5b8aa5c to 5166379 Compare November 8, 2021 13:40
@antoine162
Copy link
Contributor Author

Thank you so much @Lau-Odoo for looking at this and for being patient with me! I have read the documentation guidelines and have made some edits in accordance with your suggestions. The only suggestion I did not fully follow was the one about removing the first image, because I don't know whether the readers are familiar with finding the ID of a record in the URL string. Instead of removing the image, I have edited it to focus on the URL bar. Do let me know what you think is best.

@Lau-Odoo
Copy link
Contributor

Lau-Odoo commented Nov 9, 2021

Thank you so much @Lau-Odoo for looking at this and for being patient with me! I have read the documentation guidelines and have made some edits in accordance with your suggestions. The only suggestion I did not fully follow was the one about removing the first image, because I don't know whether the readers are familiar with finding the ID of a record in the URL string. Instead of removing the image, I have edited it to focus on the URL bar. Do let me know what you think is best.

Thanks for having reworked your PR. After a second review, everything looks good to me.

@Feyensv Feyensv changed the title [IMP] TaxCloud Integration: explain how to automatically set Tax Payable account on newly-generated taxes [IMP] accounting/taxcloud: specify default account for new taxes Nov 9, 2021
Comment on lines 49 to 51
* For each one of your companies that uses TaxCloud, it is necessary to create a
**User-Defined Default** so that the new taxes generated by the TaxCloud integration are created
with the correct Tax Payable account:
Copy link
Collaborator

@Feyensv Feyensv Nov 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* For each one of your companies that uses TaxCloud, it is necessary to create a
**User-Defined Default** so that the new taxes generated by the TaxCloud integration are created
with the correct Tax Payable account:
* For each one of your companies that uses TaxCloud, it might be necessary to create a
**User-Defined Default** so that the new taxes generated by the TaxCloud integration are created
with the correct Tax Payable account:
.. warning::
User defined defaults impacts all records at creation. It means that **All* new taxes will target the specified Tax
Payable account, unless the default value is modified manually (or another default takes precedence over the one
you defined).

Necessary might be too strict IMHO, I suppose some database still work fine without it :D.

Also, please add a clear explanation on "User defined defaults" to make sure the user knows this change impacts not only the taxcloud taxes (feel free to rephrase my sentence, but I believe the information should be provided).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Feyensv I agree and thanks for your edits! I've slightly rephrased them while keeping your meaning, do feel free to let me know if there's anything you'd like me to change!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only remaining step is to update your commit message to have a clear title & message according to our guidelines .
We do not strictly respect all points, but the commits should still follow the global logic:

  • title:
    • prefix: [ADD] if new page and content, [IMP] if improvement of existing content, [REM] in case of content removal
    • targeted scope: the scope/files modified by the commit (keep it simple, but we need to know what's targeted at first glance)
    • short explanation of the change or content improvement
  • Detailed explanation in commit message, if useful. Sometimes the commit title is enough to understand the commit content.

Something like:

[IMP] accounting/taxcloud: how to specify default account for new taxes

Detailed explanation

You can reuse the explanation you specified in the PR description as commit message ;).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much Victor for explaining this to me! I have changed the commit message to conform to the guidelines. :)

@antoine162 antoine162 force-pushed the 13.0-taxcloud-explain-how-to-automatically-set-tax-account branch from 5166379 to 1d5a343 Compare November 15, 2021 17:51
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.
@antoine162 antoine162 force-pushed the 13.0-taxcloud-explain-how-to-automatically-set-tax-account branch from 1d5a343 to b77ea69 Compare November 17, 2021 09:28
Copy link
Collaborator

@Feyensv Feyensv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

robodoo pushed a commit that referenced this pull request Nov 17, 2021
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.

closes #1271

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
@robodoo robodoo closed this Nov 17, 2021
@robodoo robodoo temporarily deployed to merge November 17, 2021 09:42 Inactive
@fw-bot fw-bot deleted the 13.0-taxcloud-explain-how-to-automatically-set-tax-account branch December 1, 2021 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants