[17.0][MIG] l10n_br_mis_report

l10n_br_mis_report/README.rst

@@ -0,0 +1,209 @@
+===========================================================
+Relatórios contábeis brasileiros: Balanço Patrimonial e DRE
+===========================================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:2084eb600d57917460125c75a02ade11230d4db04b3fc2cb35e616f2949cf06e
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-OCA%2Fl10n--brazil-lightgray.png?logo=github
+    :target: https://github.com/OCA/l10n-brazil/tree/16.0/l10n_br_mis_report
+    :alt: OCA/l10n-brazil
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/l10n-brazil-16-0/l10n-brazil-16-0-l10n_br_mis_report
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/l10n-brazil&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Este módulo implementa **Modelos de Relatórios Contábeis Brasileiros**,
+como o **Demonstrativo de Resultados do Exercício (DRE)** e o **Balanço
+Patrimonial (BP)**, baseados na norma **ITG 1000**. Ele permite que
+pequenas empresas e microentidades gerem relatórios contábeis de acordo
+com os padrões brasileiros, com a flexibilidade de personalizar os
+modelos conforme o plano de contas de cada empresa.
+
+**Nota:** Embora esses modelos sejam **inspirados no ITG 1000**, eles
+**não correspondem exatamente ao modelo proposto pela norma**. Além
+disso, pode haver **diferenças** em relação às versões mais recentes do
+ITG 1000.
+
+Para mais informações, consulte as `Normas Simplificadas para PMEs no
+site do
+CFC <https://cfc.org.br/tecnica/normas-brasileiras-de-contabilidade/normas-simplificadas-para-pmes/>`__.
+
+**Observação:** Esses modelos são um **ponto de partida** e precisam ser
+**ajustados** de acordo com o plano de contas da sua empresa. Por
+padrão, eles estão configurados com os prefixos das contas contábeis da
+**localização brasileira da OCA**. Para saber mais sobre como configurar
+corretamente esses modelos, consulte a **seção de configuração**.
+
+Balanço Patrimonial (BP)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Abaixo está um exemplo visual de um **Balanço Patrimonial** inspirado no
+ITG 1000:
+
+|Balanço Patrimonial|
+
+Demonstrativo de Resultados do Exercício (DRE)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Abaixo está um exemplo visual de um **DRE** (Demonstrativo de Resultados
+do Exercício) inspirado no ITG 1000:
+
+|DRE|
+
+.. |Balanço Patrimonial| image:: https://raw.githubusercontent.com/OCA/l10n-brazil/16.0/l10n_br_mis_report/static/description/bp.png
+.. |DRE| image:: https://raw.githubusercontent.com/OCA/l10n-brazil/16.0/l10n_br_mis_report/static/description/dre.png
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+Este módulo tem como dependência o módulo ``mis_builder``, que pode ser
+encontrado nos seguintes locais:
+
+-  `Odoo Community Association (OCA)
+   Shop <https://odoo-community.org/shop>`__
+-  `Repositório no GitHub <https://github.com/OCA/mis-builder>`__
+
+Configuration
+=============
+
+Esses relatórios são estruturados inicialmente com base no **prefixo das
+contas**. Se você estiver utilizando um plano de contas customizado, é
+importante revisar o campo **prefixo da conta** no cadastro do plano de
+contas para garantir que está alinhado com o que foi configurado no
+modelo de relatório.
+
+No entanto, essa configuração pode ser ajustada para utilizar **outros
+métodos de identificação** oferecidos pela ferramenta **SIG** (Sistema
+de Informação Gerencial), equivalente ao **MIS** (Management Information
+System) em inglês, implementada pelo módulo **mis_builder**.
+
+Para alterar um modelo, siga os passos abaixo:
+
+1. Acesse **Faturamento > Configuração > Relatórios SIG > Modelos do
+   Relatório SIG**.
+2. Selecione o modelo que deseja editar e ajuste os critérios de
+   identificação, incluindo o **prefixo das contas** ou outro método de
+   identificação disponível.
+3. Certifique-se de que os **prefixos configurados** no modelo do
+   relatório estejam **alinhados** com os prefixos do seu plano de
+   contas.
+
+Para mais detalhes sobre como configurar, consulte a documentação do
+**mis_builder**.
+
+Usage
+=====
+
+1. Acesse Faturamento > Relatórios > Relatórios SIG > Relatórios SIG
+
+2. Crie um **novo Relatório**.
+
+3. Selecione um dos **modelos de relatórios contabeis brasileiro**.
+
+4. Na aba **Layout**, você pode desativar a **expansão das contas** para
+   gerar um relatório mais resumido.
+
+5. Para selecionar os períodos, siga uma das opções abaixo:
+
+   -  Selecione diretamente o **intervalo de datas** ou o **nome do
+      período** desejado para obter o relatório referente a esse período
+      específico.
+   -  Ative o **Modo de Comparação** e, na guia **Colunas**, defina
+      quantas colunas deseja, com períodos diferentes. Esses períodos
+      podem ser configurados com **datas fixas** ou períodos relativos.
+      Por exemplo, defina "Tipo de período" como "Ano", com
+      "Deslocamento" = "0" e "Duração" = "1" para o ano corrente (N), e
+      "Deslocamento" = "-1" para o ano anterior (N-1). Lembre-se de
+      ajustar a **data base** do relatório para o ano a ser analisado.
+
+6. Clique em **Visualizar**, **Imprimir** ou **Exportar** para calcular
+   o relatório e executar a ação desejada.
+
+7. No modo de visualização, você pode clicar no **valor** das linhas
+   detalhadas para visualizar os **registros contábeis relacionados**.
+
+Known issues / Roadmap
+======================
+
+Fornecer modelos de **Balanço Patrimonial (BP)** e **Demonstrativo de
+Resultados do Exercício (DRE)** conforme a norma **ITG 1000**, com
+versões para:
+
+-  **Pequenas Empresas**
+-  **Microentidades**
+
+Changelog
+=========
+
+
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-brazil/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/OCA/l10n-brazil/issues/new?body=module:%20l10n_br_mis_report%0Aversion:%2016.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
+-------
+
+* KMEE
+
+Contributors
+------------
+
+-  Luis Felipe Mileo <[email protected]>
+-  Diego Paradeda <[email protected]>
+-  Antônio S. Pereira Neto <[email protected]>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-mileo| image:: https://github.com/mileo.png?size=40px
+    :target: https://github.com/mileo
+    :alt: mileo
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-mileo| 
+
+This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/16.0/l10n_br_mis_report>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

l10n_br_mis_report/__manifest__.py

@@ -0,0 +1,25 @@
+# Copyright 2019 KMEE
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Relatórios contábeis brasileiros: Balanço Patrimonial e DRE",
+    "summary": """
+        Templates de relatórios contábeis brasileiros: Balanço Patrimonial e DRE""",
+    "version": "17.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "KMEE,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/l10n-brazil",
+    "maintainers": ["mileo"],
+    "development_status": "Beta",
+    "depends": [
+        "mis_builder",
+        "l10n_br_coa",
+    ],
+    "data": [
+        "data/mis_report_styles.xml",
+        "data/mis_report_bp_generic.xml",
+        "data/mis_report_bp_simple.xml",
+        "data/mis_report_dre_generic.xml",
+        "data/mis_report_dre_simple.xml",
+    ],
+}