SALI Technical Changes

Author: samueljlieber

content/applications/finance/fiscal_localizations/brazil.rst

@@ -67,6 +67,9 @@ localization:
    * - :guilabel:`Brazilian Accounting EDI` & :guilabel:`Brazilian Accounting EDI for services`
      - `l10n_br_edi` & `l10n_br_edi_services`
      - Provides electronic invoicing for goods and services for Brazil through AvaTax.
+   * - :guilabel:`Brazilian Accounting EDI for POS`
+     - `l10n_br_edi_pos`
+     - Provides electronic invoicing for Brazil through Avatax in the POS.
    * - :guilabel:`Brazil Pix QR codes`
      - `l10n_br_pix`
      - Implements Pix QR codes for Brazil.
@@ -509,7 +512,6 @@ accurately provided in the original invoice, a debit note can be issued.
 .. seealso::
    :ref:`Issue a debit note <accounting/credit_notes/issue-debit-note>`
 
-
 Invoice cancellation
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -519,6 +521,8 @@ It is possible to cancel an electronic invoice that was validated by the governm
    Check whether the electronic invoice is still within the cancellation deadline, which may vary
    according to the legislation of each state.
 
+.. _brazil/e-invoice-nf-e:
+
 E-invoices for goods (NF-e)
 ***************************
 
@@ -584,169 +588,169 @@ journal, and click the :menuselection:`⚙️ (gear) icon --> Invalidate Number
 PoS NFC-e
 ---------
 
-The NFC-e in Brazil is a legal document that supports the selling of goods or merchandise for Final Consumer.
-Just like the NF-e, the Electronic Consumer Invoice is also issued in XML file format and has an auxiliary document (DANFC-e) also known as the “NFC-e Summary”.
-This electronic document can be issued through Odoo POS app.
-Its legal validity is guaranteed by the digital signature and by SEFAZ (Secretaria da Fazenda) of each brazilian state.
+The NFC-e in Brazil is a legal document that supports the selling of goods or merchandise for final
+consumer. Just like the :ref:`NF-e <brazil/e-invoice-nf-e>`, the electronic consumer invoice is also
+issued in XML file format and has an auxiliary document (DANFC-e) also known as the *NFC-e Summary*.
+This electronic document can be issued through **Odoo Point of Sale app**.
+
+Its legal validity is guaranteed by the digital signature and by SEFAZ (Secretaria da Fazenda) of
+each Brazilian state.
+
+.. seealso::
+   :doc:`../../sales/point_of_sale`
 
 Configuration
 ~~~~~~~~~~~~~
 
-Install the new module: **l10nbr_edi_pos**.
-
-.. image:: brazil/l10n-br-new-module.png
-   :alt: NFC-e Module
+:ref:`Install <general/install>` the :guilabel:`Brazilian Accounting EDI for POS` (`l10nbr_edi_pos`)
+module.
 
-CSC Details
+CSC details
 ~~~~~~~~~~~
 
-Navigate to **Accounting** ‣ **Configuration** ‣ **Settings** ‣ **Avatax Brazil** section.
-.. image:: brazil/l10n-br-csc-fields.png
-   :alt: CSC Fields
-
-Ensure to enter the **CSC (Taxpayer Security Code)** information:
-**- CSC ID**
-**- CSC Number**
+Go to :menuselection:`Accounting --> Configuration --> Settings`, scroll to the :guilabel:`Taxes`
+section and find the :guilabel:`Avatax Brazil` section. Complete the following CSC (Taxpayer
+Security Code) fields:
 
-These information can be generated through **SEFAZ Website** of each brazilian state by the company’s accountant.
+- :guilabel:`CSC ID`: The *CSC ID* or *CSC Token* is an identification of the taxpayer security
+  code, which can have 1 to 6 digits and is available on the website of the State Department of
+  Finance (SEFAZ) of your state.
+- :guilabel:`CSC Number`: The *CSC Number* is a code of up to 36 characters that only you and the
+  Department of Finance know. It is used to generate the QR Code of the NFC-e and ensure the
+  authenticity of the DANFE.
 
+.. note::
+   The information required for these fields can be generated through the SEFAZ website of each
+   Brazilian state by the company's accountant.
 
-Product Configuration
+Product configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
-Navigate to **Products** ‣ **Products** ‣ **New**
-
-Activate the **“Point of Sale”** checkbox on the product form:
-.. image:: brazil/l10n-br-new-product.png
-   :alt: Activate point of sale on product
-
-Now, Navigate to **Sales tab** ‣ **Brazil accounting**
-.. image:: brazil/l10n-br-brazil-accounting-product.png
-   :alt: Product Brazil Accounting Fields
-
-Enter the information on the following fields:
-**CEST Code**
-**Mercosul NCM Code**
-**Source of Origin**
-**SPED Fiscal Product Type**
-**Purpose of Use**
+First :doc:`create a new product in POS <../../sales/point_of_sale/configuration>`, then in the
+:guilabel:`Sales` tab, configure the following :guilabel:`Brazil Accounting` fields:
 
-Click on Save.
+- :guilabel:`CEST Code`: A tax classification code used to identify goods and products subject to
+  tax substitution under ICMS regulations. It helps determine the applicable tax treatment and
+  procedures for specific items. Check if your product is subject or not to this in
+  https://www.codigocest.com.br/.
+- :guilabel:`Mercosul NCM Code`: NCM (Nomenclatura Comun do Mercosul) code from the Mercosur list.
+- :guilabel:`Source of Origin`: Indicates if the product has a foreign or national origin with
+  different variations and characteristics depending on the product use case.
+- :guilabel:`SPED Fiscal Product Type`: Fiscal product type according to SPED list table.
+- :guilabel:`Purpose of Use`: Indicates what this product is used for.
 
-Shop Configuration
+Shop configuration
 ~~~~~~~~~~~~~~~~~~
 
-Navigate to **Point of Sale** ‣ **Configuration** ‣ **Point of sales** ‣ **Create a new Point of Sale**
-.. image:: brazil/l10n-br-new-shop.png
-   :alt: Create a point of sale
+Go to :menuselection:`Point of Sale --> Configuration --> Point of Sales` and create a
+:guilabel:`New` shop. Choose an internal name for the new POS and save.
 
-Choose a name for the new Point of Sale and save.
-.. image:: brazil/l10n-br-create-new-shop.png
-   :alt: Point of sale form
+Then, go to :menuselection:`Point of Sale --> Configuration --> Settings` and scroll to the
+:guilabel:`Accounting` section, configure the :guilabel:`Brazilian EDI` fields. Make sure that the
+correct Point of Sale is :doc:`selected at the top of the screen
+<../../sales/point_of_sale/configuration>`.
 
-Now, Navigate to **Point of Sale** ‣ **Configuration** ‣ **Setting** ‣ **Brazilian EDI** section.
-Make sure that the correct Point of Sale is selected on the top of the screen
-.. image:: brazil/l10n-br-select-right-shop.png
-   :alt: Point of sale configuration settings
-
-Enter the following NFC-e informations:
-**- Series**
-**- Next number**
+- :guilabel:`Series`
+- :guilabel:`Next number`: the next NFC-e number in the sequence to be issued, for instance, if the
+  last number issued in SEFAZ is `100`, the *Next number* will be `101`.
 
 .. note::
-This is the next NFC-e number in the sequence to be issued, for instance, if the last number issued in SEFAZ is 100, the next number will be 101.
-
-.. image:: brazil/l10n-br-brazilian-edi.png
-   :alt: Brazilian EDI Fields
+   For the production environment, make sure that this information is updated.
 
-.. note::
-For the production environment, make sure that this information is updated.
+.. _brazil/generate-nfc-e:
 
 Generating an NFC-e
 ~~~~~~~~~~~~~~~~~~~
 
-Open the Shop and make a sale.
+First, :ref:`open the Shop and make a sale <pos/session-start>`.
 
-After validating the payment, Odoo will calculate taxes and issue an NFC-e. The valid NFC-e will appear on the right side of the screen.
+After validating the payment, Odoo calculates taxes and issues an NFC-e. The valid NFC-e appears on
+the right side of the screen.
 
 .. image:: brazil/l10n-br-nfce-succesfully-issued.png
-   :alt: NFC-e Success
+   :alt: NFC-e Success in a POS session.
 
 .. note::
-It’s also possible to issue NFC-e identifying the customer by their CPF/CNPJ, just click on guilabel:`Customer` button, then search for the customer if it’s already registered or click on guilabel:`Create` option.
+   It is also possible to issue an NFC-e that identifies the customer by their CPF/CNPJ. To do so,
+   click on the :icon:`fa-user` :guilabel:`Customer` button, then search for the customer if they
+   are already registered or click on :guilabel:`Create`.
 
-.. image:: brazil/l10n-br-customer-button.png
-   :alt: Point of Sale Creating New Customer
+   The following are mandatory fields to issue an CPF/CNPJ identified NFC-e:
 
-**The mandatory fields to issue CPF/CNPJ Identified NFC-e are:**
-**- Name**
-**- City** (where it’s being issued the invoice)
-**- State** (where it’s being issued the invoice)
-**- CPF/CNPJ**
-.. image:: brazil/l10n-br-create-new-customer.png
-   :alt: Final Consumer Form
+   - :guilabel:`Name`
+   - :guilabel:`City` and :guilabel:`State` of where the invoice is being issued
+   - :guilabel:`CPF/CNPJ`
+
+After saving the register, click on :guilabel:`Validate`, and the NFC-e appears highlighting the
+customer's CPF on the print.
 
-After saving the register, just click on validate, then the NFC-e will appear highlighting the Customer’s CPF on the print.
+Finally, there are two options to deliver the invoice to the customer:
 
-At this point, there’s two options to deliver the invoice to the customer:
-**- Print**
-**- Send via e-mail**
+- :guilabel:`Print`
+- :guilabel:`Send via e-mail`
 
-NFC-e Ticket Print
+NFC-e ticket print
 ~~~~~~~~~~~~~~~~~~
 
-This is the DANFC-e, the print of NFC-e when it is successfully issued and showing all the important information that is legally required.
+After :ref:`generating and validating the NFC-e <brazil/generate-nfc-e>`, deliver the invoice by
+clicking :guilabel:`Print`.
 
-.. image:: brazil/l10n-br-nfc-e-print.png
-   :alt: NFC-e Print
+.. example::
+   .. figure:: brazil/l10n-br-nfc-e-print.png
+      :alt: Printed NFC-e ticket example.
 
-.. note::
-**Tips**
-1- There’s no need to use Odoo IotBox to integrate the print NFC-e through the Point of Sale app.
-2- Odoo NFC-e Feature works with any thermal printer.
+      This is the DANFC-e, the print of NFC-e when it is successfully issued and showing all the
+      important information that is legally required.
+
+.. tip::
+   #. There's no need to use an :doc:`Odoo IoT Box <../../general/iot>` to integrate the print NFC-e
+      through the **Point of Sale** app.
+   #. The Odoo NFC-e feature works with any thermal printer.
 
 Re-issue PoS Order with NFC-e error
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If the NFC-e return an error, you can see the error message and after the error get fixed, it can be issued again:
-Inside the Shop Screen, navigate to **Options** ‣ **Orders**.
-
-.. image:: brazil/l10n-br-shop-selecting-orders.png
-   :alt: Access Orders on Shop
+If the NFC-e return an error, first correct the error, then issue the NFC-e again by going to
+:icon:`fa-bars` :menuselection:`(menu) --> Orders`.
 
-Filter for **Paid Orders** ‣  Click on the **Details** Button. Now you can see the Error and the button to “Send NFC-e”.
-.. image:: brazil/l10n-br-order-error-screen.png
-   :alt: Point of sale order view form
+Filter for :guilabel:`Paid` orders and click on the :guilabel:`Details` button. From here, the error
+is presented and the :guilabel:`Send NFC-e` button can be clicked.
 
 .. note::
-If the error fix is already done and the PoS Session is closed, it shows the Journal Entry of that order indicating that the taxes weren’t calculated correctly and after reprocessing the NFC-e, Odoo indicates the tax adjustment on that Journal Entry in the chatter.
+   If the error was fixed and the PoS Session was closed, Odoo indicates the tax adjustment on that
+   journal entry in the chatter. The journal entry of the order indicates that the taxes were not
+   calculated correctly and after reprocessing the NFC-e is necessary.
 
-NFC-e Refunds & Cancellations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The current scope of Odoo allows you to create refunds from Odoo, but cancellations need to be done on the government portal.
+.. image:: brazil/l10n-br-order-error-screen.png
+   :alt: Point of sale order view form.
 
-.. note::
-SEFAZ only allows users to cancel an NFC-e within 30 minutes after it has been issued directly on the SEFAZ Website. After this time, you need to make a Refund and issue a Return of Goods NF-e.
+NFC-e refunds & cancellations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Navigate to **Orders** ‣ **Paid Orders** ‣ **Open the order** ‣ Click **Refund** button
+Odoo allow *refunds* to be created from Odoo, but *cancellations* must be done from the government
+portal.
 
-Choose the payment method, amount, then click **“Payment”**
+.. important::
+   SEFAZ only allows users to cancel an NFC-e **within 30 minutes** after it has been issued
+   directly on the SEFAZ website. After this time, a manual refund would need to be made along with
+   issuing a *Return of Goods NF-e*.
 
-.. image:: brazil/l10n-br-reimbursement.png
-   :alt: Reimbursement button
+To issue a refund, go to :icon:`fa-bars` :menuselection:`(menu) --> Orders`, filter for
+:guilabel:`Paid` orders, open the order and click the :guilabel:`Refund` button.
 
-.. image:: brazil/l10n-br-make-payment-refund.png
-   :alt: Make Payment Refund
+Choose the :guilabel:`Payment method` and :guilabel:`Amount`, then click :guilabel:`Refund payment`.
 
 .. note::
-**Alternative Flow**
-- You can also reimburse and cancel the NFC-e through back-end navigating to **Orders** ‣ **Orders** ‣ **Open the Order** ‣ **Select a customer** ‣ Click the button **Payment** to reimburse ‣ Then click the button **Invoice** at the top of the screen to create the invoice and issue the Return of Goods NF-e.
+   Alternatively, reimburse and cancel the NFC-e through the backend by going to
+   :menuselection:`Point of Sale --> Orders --> Orders`. Open the order and select the customer,
+   then click the :guilabel:`Payment` button to reimburse. Then click the :guilabel:`Invoice` button
+   at the top of the screen to create the invoice and issue the *Return of Goods NF-e*.
 
-When the process is finalized, the approved return NF-e will be created, meaning the **previous NFC-e is canceled**.
+When the process is finalized, the approved return NF-e is created, meaning the
+**previous NFC-e is canceled**.
 
 .. image:: brazil/l10n-br-return-succeed.png
-   :alt: Return of Goods NF-e Approved
+   :alt: Return of Goods NF-e Approved.
 
 Vendor bills
 ------------