Brazil Fiscal Report

https://engenere.github.io/BrazilFiscalReport/
Admin
Brazil Fiscal Report is a Python library for generating Brazilian auxiliary fiscal documents in PDF...
Tokens:10,730
Snippets:151
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Core Library

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Installs the core library with support for DANFE and DACCe. Use this for basic functionality.

```bash
pip install brazilfiscalreport
```

--------------------------------

### Set Up Virtual Environment and Install Dependencies

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Create a Python virtual environment, activate it, and install project dependencies including optional extras for dacte, damdfe, and cli, along with testing tools.

```bash
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
pip install -e '.[dacte,damdfe,cli]'
pip install pytest pytest-cov ruff
```

--------------------------------

### Install Pre-commit Hooks

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Install the pre-commit package to manage and install repository pre-commit hooks, which automate code checks before commits.

```bash
pip install pre-commit
pre-commit install
```

--------------------------------

### Clone Repository and Navigate

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Clone the project repository and navigate into the project directory to begin development setup.

```bash
git clone https://github.com/Engenere/BrazilFiscalReport.git
cd BrazilFiscalReport
```

--------------------------------

### Install Optional Dependencies

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Installs optional dependencies for specific document types. Choose the extras needed for your use case.

```bash
pip install 'brazilfiscalreport[dacte]'
```

```bash
pip install 'brazilfiscalreport[damdfe]'
```

```bash
pip install 'brazilfiscalreport[cli]'
```

```bash
pip install 'brazilfiscalreport[dacte,damdfe,cli]'
```

--------------------------------

### Install qpdf for PDF Tests

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Install the qpdf utility, which is required for PDF comparison tests. This command is for Ubuntu/Debian-based systems.

```bash
sudo apt-get install qpdf
```

--------------------------------

### Example Configuration File (config.yaml)

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

An example `config.yaml` file demonstrating how to configure issuer details, logo path, and margins for the CLI commands. The `ISSUER` section is specific to the `dacce` command, while `LOGO` and margins apply to `danfe`, `dacte`, and `damdfe`.

```yaml
ISSUER:
  nome: "EMPRESA LTDA"
  end: "AV. TEST, 100"
  bairro: "CENTRO"
  cep: "01010-000"
  cidade: "SÃO PAULO"
  uf: "SP"
  fone: "(11) 1234-5678"

LOGO: "/path/to/logo.jpg"
TOP_MARGIN: 5.0
RIGHT_MARGIN: 5.0
BOTTOM_MARGIN: 5.0
LEFT_MARGIN: 5.0

```

--------------------------------

### Full DACTE Customization Example

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Demonstrates creating a DacteConfig object with various customization options and using it to generate a DACTE PDF.

```python
from brazilfiscalreport.dacte import (
    Dacte,
    DacteConfig,
    DecimalConfig,
    FontType,
    Margins,
    ReceiptPosition,
)

# Path to the XML file
xml_file_path = 'cte.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Create a configuration instance
config = DacteConfig(
    logo='path/to/logo.png',
    margins=Margins(top=10, right=10, bottom=10, left=10),
    receipt_pos=ReceiptPosition.BOTTOM,
    decimal_config=DecimalConfig(price_precision=2, quantity_precision=2),
    font_type=FontType.TIMES,
)

# Use this config when creating a Dacte instance
dacte = Dacte(xml_content, config=config)
dacte.output('output_dacte.pdf')

```

--------------------------------

### Full DAMDFE Customization Example

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Generate a DAMDFE PDF with a comprehensive set of customizations including logo, margins, decimal precision, and font type. This example demonstrates how to instantiate and apply a `DamdfeConfig` object.

```python
from brazilfiscalreport.damdfe import (
    Damdfe,
    DamdfeConfig,
    DecimalConfig,
    FontType,
    Margins,
)

# Path to the XML file
xml_file_path = 'mdfe.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Create a configuration instance
config = DamdfeConfig(
    logo='path/to/logo.png',
    margins=Margins(top=10, right=10, bottom=10, left=10),
    decimal_config=DecimalConfig(price_precision=2, quantity_precision=2),
    font_type=FontType.TIMES,
)

# Use this config when creating a Damdfe instance
damdfe = Damdfe(xml_content, config=config)
damdfe.output('output_damdfe.pdf')

```

--------------------------------

### Install CLI Dependencies

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Install the necessary dependencies for the CLI tool using pip. This command ensures all required packages are available for the CLI functionality.

```bash
pip install 'brazilfiscalreport[cli]'
```

--------------------------------

### Check CLI Version

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Verify the installed version of the Brazil Fiscal Report CLI. Use either the long `--version` or short `-v` flag.

```bash
bfrep --version
```

--------------------------------

### Generate DAMDFE PDF from XML

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Load MDF-e XML content and generate a DAMDFE PDF. Ensure the XML file is correctly formatted.

```python
from brazilfiscalreport.damdfe import Damdfe

# Path to the XML file
xml_file_path = 'mdfe.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the DAMDFE object with the loaded XML content
damdfe = Damdfe(xml=xml_content)

# Save the generated PDF to a file
damdfe.output('damdfe.pdf')

```

--------------------------------

### Generate DAMDFE PDF using CLI

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Generate a DAMDFE PDF directly from the command line interface by providing the path to the MDF-e XML file.

```bash
bfrep damdfe /path/to/mdfe.xml

```

--------------------------------

### Basic Usage

Source: https://engenere.github.io/BrazilFiscalReport/dacce

This snippet shows the basic usage of the DaCCe class to load an XML file and generate a PDF.

```APIDOC
## Basic Usage

This section demonstrates the fundamental steps to generate a DACCe PDF using the `DaCCe` class.

### Python CLI Example

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the CC-e PDF object with the loaded XML content
cce = DaCCe(xml=xml_content)

# Save the generated PDF to a file
cce.output('cce.pdf')
```

### Command Line Usage

```bash
bfrep dacce /path/to/cce.xml
```

```

--------------------------------

### Configure Product Description Display

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Customize the information displayed in the product description column of the DANFE, including branch details, ANP, ANVISA, and additional information. Defaults are provided for each field.

```python
config.product_description_config = ProductDescriptionConfig(
    display_branch=True,
    branch_info_prefix="=>",
    display_additional_info=True,
    display_anp=True,
    display_anvisa=True,
)
```

--------------------------------

### Lint and Format Code with Ruff

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Manually check code for style issues and format the code using Ruff, the project's chosen linter and formatter.

```bash
ruff check .
ruff format .
```

--------------------------------

### Basic Usage

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

This snippet shows the basic usage of the DaCCe class to load CC-e XML content and generate a PDF.

```APIDOC
## Basic Usage

This example demonstrates how to use the `DaCCe` class to load CC-e XML content and generate a PDF.

### Python CLI Example

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the CC-e PDF object with the loaded XML content
cce = DaCCe(xml=xml_content)

# Save the generated PDF to a file
cce.output('cce.pdf')
```

### Command Line Example

```bash
bfrep dacce /path/to/cce.xml
```
```

--------------------------------

### Generate Customized DACCe PDF with Issuer and Logo

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

This Python snippet demonstrates how to instantiate the DaCCe class with both issuer details and a logo image for a customized DACCe PDF.

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Issuer information
emitente = {
    "nome": "EMPRESA LTDA",
    "end": "AV. TEST, 100",
    "bairro": "CENTRO",
    "cidade": "SÃO PAULO",
    "uf": "SP",
    "fone": "(11) 1234-5678",
}

# Instantiate with issuer and logo
cce = DaCCe(xml=xml_content, emitente=emitente, image="path/to/logo.png")

# Save the generated PDF to a file
cce.output('cce.pdf')

```

--------------------------------

### Generate DACTE PDF from XML

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Loads an XML file and generates a DACTE PDF. Ensure the XML file is correctly formatted.

```python
from brazilfiscalreport.dacte import Dacte

# Path to the XML file
xml_file_path = 'cte.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the DACTE object with the loaded XML content
dacte = Dacte(xml=xml_content)
dacte.output('output_dacte.pdf')

```

--------------------------------

### Generate Fiscal Reports using Python

Source: https://engenere.github.io/BrazilFiscalReport/getting-started?q=

Generates various fiscal report PDFs from XML content. Each class corresponds to a specific document type.

```python
from brazilfiscalreport.danfe import Danfe

danfe = Danfe(xml=xml_content)
danfe.output("danfe.pdf")

```

```python
from brazilfiscalreport.dacce import DaCCe

dacce = DaCCe(xml=xml_content)
dacce.output("dacce.pdf")

```

```python
from brazilfiscalreport.dacte import Dacte

dacte = Dacte(xml=xml_content)
dacte.output("dacte.pdf")

```

```python
from brazilfiscalreport.damdfe import Damdfe

damdfe = Damdfe(xml=xml_content)
damdfe.output("damdfe.pdf")

```

--------------------------------

### Generate DANFSE PDF via CLI

Source: https://engenere.github.io/BrazilFiscalReport/danfse?q=

Generate a DANFSE PDF directly from the command line using the bfrep tool. Provide the path to the nfse.xml file.

```bash
bfrep danfse /path/to/nfse.xml

```

--------------------------------

### Generate Fiscal Reports using CLI

Source: https://engenere.github.io/BrazilFiscalReport/getting-started?q=

Generates fiscal reports from the terminal using the 'bfrep' command. Specify the document type and XML file path.

```bash
bfrep danfe /path/to/nfe.xml

```

```bash
bfrep dacce /path/to/cce.xml

```

```bash
bfrep dacte /path/to/cte.xml

```

```bash
bfrep damdfe /path/to/mdfe.xml

```

--------------------------------

### Generate DANFE PDF from XML using CLI

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Use the command-line interface to generate a PDF DANFE directly from an XML file path.

```bash
bfrep danfe /path/to/nfe.xml

```

--------------------------------

### Load XML and Generate DANFSE PDF

Source: https://engenere.github.io/BrazilFiscalReport/danfse?q=

Load XML content from a file and generate a DANFSE PDF. Ensure the XML file is correctly encoded.

```python
from brazilfiscalreport.danfse import Danfse

# Path to the XML file
xml_file_path = 'nfse.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the DANFSE object with the loaded XML content
danfse = Danfse(xml=xml_content)
danfse.output('output_danfse.pdf')

```

--------------------------------

### Generate DAMDFE Document

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Generate a DAMDFE (Documento Auxiliar do Manifesto Eletrônico de Documentos Fiscais) from an XML file using the `damdfe` command.

```bash
bfrep damdfe /path/to/mdfe.xml
```

--------------------------------

### Generate DACTE Document

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Generate a DACTE (Documento Auxiliar do Conhecimento de Transporte Eletrônico) from an XML file using the `dacte` command.

```bash
bfrep dacte /path/to/cte.xml
```

--------------------------------

### Generate DANFE PDF from XML using Python

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Load an XML file and generate a PDF DANFE. Ensure the XML file is correctly formatted.

```python
from brazilfiscalreport.danfe import Danfe

# Path to the XML file
xml_file_path = 'nfe.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the DANFE object with the loaded XML content
danfe = Danfe(xml=xml_content)
danfe.output('output_danfe.pdf')

```

--------------------------------

### Configure Danfe Margins

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Set the top, right, bottom, and left margins for the PDF document in millimeters. The default is 5mm for all sides.

```python
config.margins = Margins(top=5, right=5, bottom=5, left=5)
```

--------------------------------

### Run Project Tests with Pytest

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Execute all project tests using pytest. This command runs the test suite to ensure code integrity.

```bash
pytest
```

--------------------------------

### Generate DACTE PDF via CLI

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Command-line interface command to generate a DACTE PDF from an XML file. Provide the path to the XML file as an argument.

```bash
bfrep dacte /path/to/cte.xml

```

--------------------------------

### Generate DAMDFE PDF

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Generates a DAMDFE PDF from XML content. Use this for DAMDFE document creation.

```python
from brazilfiscalreport.damdfe import Damdfe

damdfe = Damdfe(xml=xml_content)
damdfe.output("damdfe.pdf")

```

--------------------------------

### Generate DANFE PDF (Simplified)

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

A simplified pattern for generating a DANFE PDF when XML content is already available.

```python
from brazilfiscalreport.danfe import Danfe

danfe = Danfe(xml=xml_content)
danfe.output("danfe.pdf")

```

--------------------------------

### Run Tests with Coverage

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Run tests using pytest and generate a code coverage report for the specified project directory.

```bash
pytest --cov=./brazilfiscalreport --cov-branch
```

--------------------------------

### Generate DACCe Document

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Generate a DACCe (Documento Auxiliar de Comunicação de Complemento Eletrônico) from an XML file using the `dacce` command. This command utilizes the `ISSUER` details from the `config.yaml` file.

```bash
bfrep dacce /path/to/cce.xml
```

--------------------------------

### Generate Fiscal Reports via CLI

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Quickly generates fiscal reports from the terminal using the bfrep command-line tool. Specify the document type and the path to the XML file.

```bash
bfrep danfe /path/to/nfe.xml
bfrep dacce /path/to/cce.xml
bfrep dacte /path/to/cte.xml
bfrep damdfe /path/to/mdfe.xml

```

--------------------------------

### Generate DANFE with Custom Configuration

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Use this snippet to create a Danfe object with a comprehensive set of customizations. Ensure the XML file and logo paths are correct. This configuration allows for fine-grained control over the DANFE's appearance and content.

```python
from brazilfiscalreport.danfe import (
    Danfe,
    DanfeConfig,
    DecimalConfig,
    FontType,
    FooterStamp,
    InvoiceDisplay,
    Margins,
    ProductDescriptionConfig,
    ReceiptPosition,
    TaxConfiguration,
)

# Path to the XML file
xml_file_path = 'nfe.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Create a configuration instance
config = DanfeConfig(
    logo='path/to/logo.png',
    margins=Margins(top=10, right=10, bottom=10, left=10),
    receipt_pos=ReceiptPosition.BOTTOM,
    decimal_config=DecimalConfig(price_precision=2, quantity_precision=2),
    tax_configuration=TaxConfiguration.ICMS_ST,
    invoice_display=InvoiceDisplay.FULL_DETAILS,
    font_type=FontType.TIMES,
    display_pis_cofins=True,
    product_description_config=ProductDescriptionConfig(
        display_branch=True,
        display_additional_info=True,
    ),
    footer_stamp=FooterStamp(
        logo='path/to/footer_logo.png',
        text='Powered by',
    ),
)

# Use this config when creating a Danfe instance
danfe = Danfe(xml_content, config=config)
danfe.output('output_danfe.pdf')

```

--------------------------------

### Customizing DACCe

Source: https://engenere.github.io/BrazilFiscalReport/dacce

Explore how to customize the DACCe generation by providing issuer information and a logo image.

```APIDOC
## Customizing DACCe 🎨

The `DaCCe` class accepts several parameters to customize the generated DACCe document.

### Parameters

*   **xml** (`str`): The XML content of the CC-e event. This is a required parameter.
*   **emitente** (`dict` or `None`): A dictionary containing the issuer (emitente) information. If provided, these details will be displayed in the header of the DACCe. The dictionary should include the following keys: `nome`, `end`, `bairro`, `cidade`, `uf`, `fone`.
    *   **Example**: 
        ```python
        emitente = {
            "nome": "EMPRESA LTDA",
            "end": "AV. TEST, 100",
            "bairro": "CENTRO",
            "cidade": "SÃO PAULO",
            "uf": "SP",
            "fone": "(11) 1234-5678",
        }
        ```
    *   **Default**: `None` (no issuer info displayed).
*   **image** (`str`, `BytesIO`, `bytes`, or `None`): Path to a logo image file or binary image data to be displayed in the header alongside the issuer information.
    *   **Example**: 
        ```python
        image = "path/to/logo.jpg"
        ```
    *   **Default**: `None` (no logo).

### Usage Example with Customization

This example demonstrates how to instantiate `DaCCe` with custom issuer details and a logo image.

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Issuer information
emitente = {
    "nome": "EMPRESA LTDA",
    "end": "AV. TEST, 100",
    "bairro": "CENTRO",
    "cidade": "SÃO PAULO",
    "uf": "SP",
    "fone": "(11) 1234-5678",
}

# Instantiate with issuer and logo
cce = DaCCe(xml=xml_content, emitente=emitente, image="path/to/logo.png")

# Save the generated PDF to a file
cce.output('cce.pdf')
```

```

--------------------------------

### Generate DACCe PDF from XML using CLI

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

This command-line interface command generates a DACCe PDF from a specified CC-e XML file.

```bash
bfrep dacce /path/to/cce.xml

```

--------------------------------

### Generate DACCe PDF from XML using Python

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

Use this snippet to load CC-e XML content and generate a DACCe PDF. Ensure the XML file is correctly formatted.

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Instantiate the CC-e PDF object with the loaded XML content
cce = DaCCe(xml=xml_content)

# Save the generated PDF to a file
cce.output('cce.pdf')

```

--------------------------------

### Generate DANFE Document

Source: https://engenere.github.io/BrazilFiscalReport/cli?q=

Generate a DANFE (Documento Auxiliar da Nota Fiscal Eletrônica) from an XML file using the `danfe` command.

```bash
bfrep danfe /path/to/nfe.xml
```

--------------------------------

### Generate DACCe PDF

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Generates a DACCe PDF from XML content. Use this for generating DACCe documents.

```python
from brazilfiscalreport.dacce import DaCCe

dacce = DaCCe(xml=xml_content)
dacce.output("dacce.pdf")

```

--------------------------------

### Regenerate Reference PDFs for Tests

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Regenerate the reference PDF files used in tests by running pytest with the BFR_GENERATE_EXPECTED environment variable set to 1. Use with caution and review changes.

```bash
BFR_GENERATE_EXPECTED=1 pytest tests/test_danfe.py
```

--------------------------------

### Set Danfe Font Size

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Select the font size for the PDF document. Available options are BIG and SMALL. Defaults to SMALL.

```python
config.font_size = FontSize.BIG
```

--------------------------------

### Run Tests for Specific Document Type

Source: https://engenere.github.io/BrazilFiscalReport/contributing

Execute tests specifically for the DANFE document type by targeting the relevant test file.

```bash
pytest tests/test_danfe.py
```

--------------------------------

### Set Logo for DAMDFE PDF

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Configure the DAMDFE generator to include a custom logo in the PDF. The logo can be provided as a file path or binary data.

```python
config.logo = "path/to/logo.jpg"  # Using a file path

```

--------------------------------

### Set Danfe Logo Path

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Specify the file path to a logo image to be included in the PDF. Alternatively, binary image data can be provided.

```python
config.logo = "path/to/logo.jpg"  # Using a file path
```

--------------------------------

### Enable PIS COFINS Display in Danfe

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Set to True to display PIS and COFINS taxes in the DANFE totals. Defaults to False.

```python
config.display_pis_cofins = True
```

--------------------------------

### Enable Line Break for Supplementary Info

Source: https://engenere.github.io/BrazilFiscalReport/danfe

When True, uses a semicolon to create a newline in the supplementary information (infCpl) of the DANFE. Defaults to False.

```python
config.infcpl_semicolon_newline= True
```

--------------------------------

### Customizing DACCe

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

This section details the parameters available for customizing the DACCe generation, including issuer information and a logo.

```APIDOC
## Customizing DACCe 🎨

The `DaCCe` class accepts the following parameters to customize the generated DACCe.

### Parameters

* **xml**
  * **Type**: `str`
  * **Description**: The XML content of the CC-e event.
  * **Required**: Yes.

* **emitente**
  * **Type**: `dict` or `None`
  * **Description**: A dictionary containing the issuer (emitente) information. When provided, the issuer details are displayed in the header of the DACCe.
  * **Keys**: `nome`, `end`, `bairro`, `cidade`, `uf`, `fone`
  * **Example**: 
```python
emitente = {
    "nome": "EMPRESA LTDA",
    "end": "AV. TEST, 100",
    "bairro": "CENTRO",
    "cidade": "SÃO PAULO",
    "uf": "SP",
    "fone": "(11) 1234-5678",
}
```
  * **Default**: `None` (no issuer info displayed).

* **image**
  * **Type**: `str`, `BytesIO`, `bytes`, or `None`
  * **Description**: Path to a logo image file or binary image data to be displayed in the header alongside the issuer information.
  * **Example**: 
```python
image = "path/to/logo.jpg"
```
  * **Default**: `None` (no logo).

### Usage Example with Customization

```python
from brazilfiscalreport.dacce import DaCCe

# Path to the XML file
xml_file_path = 'cce.xml'

# Load XML Content
with open(xml_file_path, "r", encoding="utf8") as file:
    xml_content = file.read()

# Issuer information
emitente = {
    "nome": "EMPRESA LTDA",
    "end": "AV. TEST, 100",
    "bairro": "CENTRO",
    "cidade": "SÃO PAULO",
    "uf": "SP",
    "fone": "(11) 1234-5678",
}

# Instantiate with issuer and logo
cce = DaCCe(xml=xml_content, emitente=emitente, image="path/to/logo.png")

# Save the generated PDF to a file
cce.output('cce.pdf')
```
```

--------------------------------

### Specify Logo Image for DACCe Header

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

Provide the file path to a logo image to be displayed in the DACCe header. The image can be a file path, bytes, or a BytesIO object.

```python
image = "path/to/logo.jpg"

```

--------------------------------

### Generate DACTE PDF

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Generates a DACTE PDF from XML content. This is used for DACTE document generation.

```python
from brazilfiscalreport.dacte import Dacte

dacte = Dacte(xml=xml_content)
dacte.output("dacte.pdf")

```

--------------------------------

### Configure Receipt Position in Danfe

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Determine the position of the receipt section within the DANFE. Options are TOP, BOTTOM, or LEFT. Note that in landscape orientation, the receipt is fixed to the far left and cannot be customized.

```python
config.receipt_pos = ReceiptPosition.BOTTOM
```

--------------------------------

### Set Margins for DAMDFE PDF

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Customize the page margins (top, right, bottom, left) for the generated DAMDFE PDF. Default margins are 5mm.

```python
config.margins = Margins(top=10, right=10, bottom=10, left=10)

```

--------------------------------

### Generate DANFE PDF from XML

Source: https://engenere.github.io/BrazilFiscalReport/getting-started

Generates a DANFE PDF from an NF-e XML file. Ensure the XML content is loaded correctly.

```python
from brazilfiscalreport.danfe import Danfe

# Load the XML content
with open("nfe.xml", "r", encoding="utf8") as file:
    xml_content = file.read()

# Generate the PDF
danfe = Danfe(xml=xml_content)
danfe.output("danfe.pdf")

```

--------------------------------

### Configure Custom Footer Stamp

Source: https://engenere.github.io/BrazilFiscalReport/danfe?q=

Use this to render a custom stamp with a logo and text on every page of the invoice. The stamp is right-aligned and automatically reserved within the bottom margin.

```python
config.footer_stamp = FooterStamp(
    logo="path/to/logo.png",
    text="Powered by",
)
```

--------------------------------

### Enable DACTE Cancelled Watermark

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Enables a "CANCELADA" watermark on the DACTE PDF for cancelled documents.

```python
config.watermark_cancelled = True

```

--------------------------------

### Define Issuer Information for DACCe

Source: https://engenere.github.io/BrazilFiscalReport/dacce?q=

This dictionary structure defines the required keys for issuer information when customizing the DACCe header. Ensure all keys are present for proper display.

```python
emitente = {
    "nome": "EMPRESA LTDA",
    "end": "AV. TEST, 100",
    "bairro": "CENTRO",
    "cidade": "SÃO PAULO",
    "uf": "SP",
    "fone": "(11) 1234-5678",
}

```

--------------------------------

### Configure Custom Footer Stamp

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Use `FooterStamp` to add a custom logo and text to the footer of each invoice page. The stamp is right-aligned and automatically reserves space in the bottom margin.

```python
config.footer_stamp = FooterStamp(
    logo="path/to/logo.png",
    text="Powered by",
)

```

--------------------------------

### Configure Decimal Precision for DAMDFE PDF

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Adjust the decimal precision for prices and quantities in the DAMDFE PDF. Default precision is 4.

```python
config.decimal_config = DecimalConfig(price_precision=2, quantity_precision=2)

```

--------------------------------

### Set DACTE Margins

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Sets the page margins for the DACTE PDF. Values are in millimeters.

```python
config.margins = Margins(top=5, right=5, bottom=5, left=5)

```

--------------------------------

### Set DACTE Receipt Position

Source: https://engenere.github.io/BrazilFiscalReport/dacte

Configures the position of the receipt section in the DACTE PDF. Options are TOP, BOTTOM, or LEFT.

```python
config.receipt_pos = ReceiptPosition.BOTTOM

```

--------------------------------

### Set Font Type for DAMDFE PDF

Source: https://engenere.github.io/BrazilFiscalReport/damdfe

Choose the font style for the DAMDFE PDF. Available options are COURIER and TIMES. Default is TIMES.

```python
config.font_type = FontType.COURIER

```

--------------------------------

### Set Danfe Decimal Precision

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Configure the number of decimal places for prices and quantities. Specify precision for both price_precision and quantity_precision. Defaults to 4.

```python
config.decimal_config = DecimalConfig(price_precision=2, quantity_precision=2)
```

--------------------------------

### Customize DANFSE PDF Margins

Source: https://engenere.github.io/BrazilFiscalReport/danfse?q=

Customize the PDF output margins by providing a Margins object to DanfseConfig. This allows for fine-tuning the layout.

```python
from brazilfiscalreport.danfse import Danfse, DanfseConfig, Margins

config = DanfseConfig(
    margins=Margins(top=5, right=5, bottom=5, left=5)
)

danfse = Danfse(xml=xml_content, config=config)
danfse.output('output_danfse.pdf')

```

--------------------------------

### Set Danfe Font Type

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Choose the font style for the entire PDF document. Options include COURIER and TIMES. Defaults to TIMES.

```python
config.font_type = FontType.COURIER
```

--------------------------------

### Enable Cancelled Invoice Watermark

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Set to True to display a 'CANCELADA' watermark on DANFE for cancelled invoices. For XMLs without protNFe, 'SEM VALOR FISCAL' is shown regardless of this setting. Defaults to False.

```python
config.watermark_cancelled = True
```

--------------------------------

### Display Cancelled Watermark on DANFSE

Source: https://engenere.github.io/BrazilFiscalReport/danfse?q=

Enable a 'CANCELADA' watermark on the DANFSE PDF for cancelled documents by setting watermark_cancelled to True in DanfseConfig.

```python
from brazilfiscalreport.danfse import Danfse, DanfseConfig

config = DanfseConfig(watermark_cancelled=True)

danfse = Danfse(xml=xml_content, config=config)
danfse.output('output_danfse.pdf')

```

--------------------------------

### Configure Danfe Tax Display

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Specify which tax fields should be displayed in the DANFE. Available options are STANDARD_ICMS_IPI, ICMS_ST, and WITHOUT_IPI. This feature is currently not implemented.

```python
config.tax_configuration = TaxConfiguration.WITHOUT_IPI
```

--------------------------------

### Set Danfe Invoice Detail Level

Source: https://engenere.github.io/BrazilFiscalReport/danfe

Control the level of detail shown in the invoice section of the DANFE. Choose between DUPLICATES_ONLY or FULL_DETAILS. Defaults to FULL_DETAILS.

```python
config.invoice_display = InvoiceDisplay.FULL_DETAILS
```
Tokens:
Raw