Metadata-Version: 2.1
Name: odoo-addon-account_financial_report_block_pdf
Version: 18.0.1.0.0
Requires-Python: >=3.10
Requires-Dist: odoo-addon-account_financial_report==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Block the generation of financial PDF reports
Home-page: https://github.com/sygel-technology/sy-account-financial-reporting
License: AGPL-3
Author: Sygel,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

===================================
Account Financial Reports Block PDF
===================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:242dd12a53539a8cec4ec373c14c65cb762d10e1f1d5bde4844c6c5019536419
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-sygel--technology%2Fsy--account--financial--reporting-lightgray.png?logo=github
    :target: https://github.com/sygel-technology/sy-account-financial-reporting/tree/18.0/account_financial_report_block_pdf
    :alt: sygel-technology/sy-account-financial-reporting

|badge1| |badge2| |badge3|

This module allows to block the generation of financial reports in PDF
format. It is possible to configure the list of financial reports that
have to be blocked.

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure the list of financial reports that cannot be printed in PDF
you need to:

- Go to Settings > Technical > System Parameters.

- Find or create a system parameter called
  "forbidden.pdf.financial.reports".

- Introduce the technical name of the wizard generator models that need
  to be blocked separated by commas. The link between the financial
  reports in the module account_financial_report and the technical name
  of their wizards is as follows:

  - General Ledger: general.ledger.report.wizard
  - Journal Ledger: journal.ledger.report.wizard
  - Trial Balance: trial.balance.report.wizard
  - Open Items: open.items.report.wizard
  - Aged Partner Balance: aged.partner.balance.report.wizard
  - VAT Report: vat.report.wizard

For instance, if the PDF generation of the General Ledger and Trial
Balance reports have to be blocked, the
"forbidden.pdf.financial.reports" system parameter should contain the
value "general.ledger.report.wizard,trial.balance.report.wizard" (with
no quotes).

Keep in mind that all the PDF reports are blocked by default when this
module is installed.

If a new report that inherits the abstract class
account_financial_report_abstract_wizard is developed, its PDF report
can also be blocked by adding the name of its own wizard in the
"forbidden.pdf.financial.reports" system parameter list.

Usage
=====

When a user tries to generate the PDF file of a financial report whose
PDF file have been blocked, an error message appears.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/sygel-technology/sy-account-financial-reporting/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/sygel-technology/sy-account-financial-reporting/issues/new?body=module:%20account_financial_report_block_pdf%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Sygel

Contributors
------------

- `Sygel <https://www.sygel.es>`__:

  - Manuel Regidor
  - Valentín Vinagre

Maintainers
-----------

This module is part of the `sygel-technology/sy-account-financial-reporting <https://github.com/sygel-technology/sy-account-financial-reporting/tree/18.0/account_financial_report_block_pdf>`_ project on GitHub.

You are welcome to contribute.
