Metadata-Version: 2.1
Name: odoo14-addon-l10n_br_sped_base
Version: 14.0.1.0.1
Summary: Framework abstrato pro SPED
Home-page: https://github.com/OCA/l10n-brazil
Author: Akretion, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 14.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Requires-Dist: odoo14-addon-l10n-br-fiscal
Requires-Dist: odoo<14.1dev,>=14.0a

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=========
SPED Base
=========

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

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/license-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/14.0/l10n_br_sped_base
    :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-14-0/l10n-brazil-14-0-l10n_br_sped_base
    :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=14.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Este módulo contém algumas abstrações utilizadas pelos módulos de SPED

Ele não faz nada sozinho, mas serve dentro dos 4 módulos:

  * l10n_br_sped_ecd
  * l10n_br_sped_efd_icms_ipi
  * l10n_br_sped_efd_pis_cofins
  * l10n_br_sped_ecf

Em especial, cada registro dos módulos de SPED herda do objeto abstrato
`l10n_br_sped.mixin` que conta com visões automáticas e metodos para importar ou escrever
registros dos SPED de forma recursiva.

Para cada tipo de arquivo SPED, o registro de abertura `0000` herda também do objeto
abstrato `l10n_br_sped.declaration` que conta com métodos para popular os registros
do SPED a partir das transações do Odoo e gerir arquivo do SPED.

Para gerir o SPED, basta criar uma declaração do SPED no menu apropriado.
Depois clicar em `Puxar os Dados do Odoo`. Isso vai percorer a arvore dos registros
do SPED e para cada registro vai usar `_odoo_domain` ou `_odoo_query` para ver
se tem records Odoo para mapear. Caso tiver vai chamar o metodo `_map_from_odoo` do registro.
Depois vai repetir a operação com os registros filhos.

Em cada módulo de SPED, existe 2 arquivos principais:

  * um arquivo com o número do leiaute que contém **os modelos abstratos de todos
    os registros do SPED com todos os campos**. Este arquivo é gerido pela ferramenta
    `spedextractor` a partir dos pdf de especificações e **não deve ser editado manualmente**.
  * um segundo arquivo que contém a **lista de todos registros concretos** que herdam desses
    primeiros modelos abstratos e contém assim todos os campos. Como o mixin de cada
    registro contém a versão do leiaute dentro do nome dele, temos uma forma de suportar
    várias versões dos leiautes. Esse arquivo dos registros concretos deve sim ser editado
    manualmente para completar os mappings. Para mapear um registro, deve se implementar
    o override desses 3 métodos:

    * `def _odoo_domain(self, parent_record, declaration)`: deve retornar um domain
      que permite a seleção dos records Odoo a serem mapeados de acordo com o record parente
      e os dados da declaração (onde tem as datas e a empresa por exemplo).
      Para usar esse metodo _odoo_domain, deve se definir também o atributo `_odoo_model`
    * `def _odoo_query(self, parent_record, declaration)`: caso a seleção dos records
      a serem mapeados não pode ser obtida por um domain, pode ser implementado esse
      override para retornar a query SQL para selecionar um result set a mapear.
      Neste caso, o record do método `_map_from_odoo` é um result set do query Postgres.
      Se você não implementar nem `_odoo_domain` nem `_odoo_query` e implementar o
      método `_map_from_odoo`, o registro vai ter uma instância gerida para cada declaração.
      É o caso por exemplo do registro I010 da ECD.
    * `def _map_from_odoo(self, record, parent_record, declaration)`: para facilitar,
      os overrides dos metodos `_map_from_odoo` de todos os registros já vem geridos
      de forma comentada com todos os campos do registro. Assim basta descomentar or método
      e implementar como é mapeado cada campo a partir do record, parent_record e dos
      dados da declaração.

.. IMPORTANT::
   This is an alpha version, the data model and design can change at any time without warning.
   Only for development or testing purpose, do not use in production.
   `More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
   :local:

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_sped_base%0Aversion:%2014.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
~~~~~~~

* Akretion

Contributors
~~~~~~~~~~~~

* `AKRETION <https://akretion.com/pt-BR/>`_:

  * Raphaël Valyi <raphael.valyi@akretion.com.br>

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-rvalyi| image:: https://github.com/rvalyi.png?size=40px
    :target: https://github.com/rvalyi
    :alt: rvalyi

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-rvalyi| 

This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/14.0/l10n_br_sped_base>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
