===========================
Brazilian Localization Base
===========================

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

.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png
    :target: https://odoo-community.org/page/development-status
    :alt: Mature
.. |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_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-16-0/l10n-brazil-16-0-l10n_br_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=16.0
    :alt: Try me on Runboat

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

Este é o módulo 'raiz' da localização brasileira. Ele traz adaptações
nos modelos do módulo ``base`` do Odoo como Parceiros, Empresas e
Endereços:

- Campo CNPJ e CPF com formatação e validação destes campos;
- Campo de Inscrição Estadual com validação;
- Formatação dos campos de endereço;
- Código do Banco Central e Siscomex para países;
- Código do IBGE para estados e municípios;
- Lista dos Bancos brasileiros;
- Contas bancarias e chaves PIX dos parceiros;
- Lista dos municípios brasileiros.

Se trata de um módulo muito simples e maduro. Existem alguns outros
módulos simples que dependem apenas desse módulo ou quase como
``l10n_br_crm`` ou ``l10n_br_portal``.

Mas se você quiser emitir ou apenas gerenciar algum tipo de documento
fiscal como NF-e ou NFS-e, o próximo módulo que você deve olhar é o
``l10n_br_fiscal`` que é porém um módulo muito mais complexo.

**Table of contents**

.. contents::
   :local:

Installation
============

Este módulo depende dos pacotes Python:

- `erpbrasil.base <https://github.com/erpbrasil/erpbrasil.base>`__
- num2words
- phonenumbers
- email_validator

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

Após a instalação do módulo deve ser preenchido o endereço da empresa
para que a formação e validações necessárias para o Brasil funcione os
objetos parceiros e nos endereços.

Usage
=====

Após ter o endereço da empresa configurado, no cadastro do parceiro você
encotrar os campos CNPJ, CPF, IE, RG e os campos de endereço formatado
para o Brasil. Caso você tenha apenas o módulo base instalado, você pode
instalar o módulo Contact para acessar o cadastro de parceiros.

Known issues / Roadmap
======================

- Formatação da Inscrição Estadual de acordo com cada UF.

Changelog
=========

12.0.1.0.0 (2019)
-----------------

A partir da versão 12.0 foi extraído o pacote de validações cadastrais
``erpbrasil.base`` no intuito de minimizar o código que depende de uma
versão especifica do Odoo e para desenvolver sinergias com outras
comunidades de código aberto.

11.0 (unreleased)
-----------------

Devido ao atraso com a versão 11.0 foi decido de pular a versão 11.0 e
trabalhar direitamente para a versão 12.0.

10.0.1.0.0 (2017)
-----------------

Devido ao trabalho enorme com a reescritura do módulo de contabilidade
na versão 9 e a problemas pessoas de um dos autores, essa versão atrasou
um pouco para sair.

9.0.1.0.0 (2015)
----------------

8.0.1.0.0 (2014)
----------------

7.0.1.0.0 (2013)
----------------

Mudança do Launchpad para Github. Mudança importante com a unificação
das tabelas de parceiros e endereços.

6.1.1.0.0 (2012)
----------------

6.0.1.0.0 (2011)
----------------

5.0.1.0.0 (2009)
----------------

Este módulo foi criado na versão 5.0 do Odoo então chamado OpenERP. Era
inicialmente hospedado na plataforma Launchpad.

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_base%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
-------

* Akretion

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

- `Akretion <https://www.akretion.com/pt-BR>`__:

  - Renato Lima <renato.lima@akretion.com.br>
  - Raphaël Valyi <raphael.valyi@akretion.com.br>

- `KMEE <https://www.kmee.com.br>`__:

  - Luis Felipe Mileo <mileo@kmee.com.br>
  - Michell Stuttgart <michell.stuttgart@kmee.com.br>

- `Engenere <https://engenere.one>`__:

  - Antônio S. Pereira Neto <neto@engenere.one>

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

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

|maintainer-renatonlima| |maintainer-rvalyi| 

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

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