### Example NF-e XML Schema Structure

This snippet demonstrates the basic structure of an NF-e XML Schema, including namespaces, imports of other schemas (like XMLDSig and basic types), and element definitions with annotations.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.portalfiscal.inf.br/nfe"
targetNamespace="http://www.portalfiscal.inf.br/nfe"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="xmldsig-core-schema_v1.01.xsd"/>
<xs:include schemaLocation="tiposBasico_v1.00.xsd"/>
<xs:element name="NFe">
<xs:annotation>
<xs:documentation>Nota Fiscal Eletrônica</xs:documentation>
</xs:annotation>
```

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

### SOAP Header Example (Deprecated in NF-e v4.0)

This snippet illustrates the structure of a SOAP Header that was previously used for message control in NF-e Web Services. It contained 'versaoDados' and 'cUF' to manage message versions and origin SEFAZ. This method has been removed starting from NF-e version 4.0.

```xml
<soap12:Header>
<nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/nfeAutorizacao">
<versaoDados>string</versaoDados>
<cUF>string</cUF>
</nfeCabecMsg>
</soap12:Header>
```

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

### Web Service - NFeConsultaCadastro

Used to query the cadastro (registration) of a CNPJ/CPF to get information about a company.

```APIDOC
## POST /NFeConsultaCadastro

### Description
This service is used to query the cadastro (registration) of a CNPJ/CPF.

### Method
POST

### Endpoint
/NFeConsultaCadastro

### Parameters
#### Request Body
- **Cadastro XML** (XML) - Required - The XML containing the CNPJ/CPF to be consulted.

### Request Example
```xml
<consCad xmlns="http://www.portalfiscal.inf.br/nfe">
  <!-- ... Consulta Cadastro data ... -->
</consCad>
```

### Response
#### Success Response (200)
- **Response XML** (XML) - Contains the cadastro information.

#### Response Example
```xml
<retConsCad xmlns="http://www.portalfiscal.inf.br/nfe">
  <!-- ... Cadastro details ... -->
</retConsCad>
```
```

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

### Web Services Overview

Complete list of available NF-e Web Services for electronic invoice management, including authorization, consultation, distribution, and event registration endpoints.

```APIDOC
## NF-e Web Services Available

### Web Service List

#### Core Services
- **NFeAutorizacao** - NF-e Authorization
- **NFeRetAutorizacao** - Authorization Return Consultation
- **NFeInutilização** - NF-e Sequence Number Inutilization
- **NFeConsultaProtocolo** - Protocol Consultation
- **NFeStatusServico** - Service Status
- **NFeConsultaCadastro** - Taxpayer Database Consultation
- **NFeDistribuicaoDFe** - Distribution of Documents
- **NFeRecepcaoEvento** - Event Registration

#### Event Types (NFeRecepcaoEvento)
- **Cancelamento** - NF-e/NFC-e Cancellation
- **Cancelamento por substituição** - Substitution Cancellation (NFC-e)
- **Carta de Correção** - Correction Letter
- **Manifestação do Destinatário** - Recipient Manifestation
- **EPEC** - Contingency Electronic Invoice
- **Pedido de Prorrogação** - Extension Request
- **Transportador** - Carrier Information
- **Comprovante de Entrega da NF-e** - Delivery Certificate
- **Cancelamento Comprovante de Entrega** - Delivery Certificate Cancellation
- **Eventos apuração do IBS e da CBS** - IBS and CBS Calculation Events
- **Consulta GTIN** - GTIN Consultation

### Documentation Structure

#### For Each Web Service
1. **Leiaute** - XML message structure and schema
2. **Regras de Validação** - Validation rules and business logic
3. **DANFE** - Document generation (Código de Barras and QR-code)
4. **Contingência** - Contingency procedures

### Document Types
- **NF-e** - Electronic Invoice (normal mode)
- **NFC-e** - Contingency Electronic Invoice

### Supported Features
- Digital signature with X.509 certificates
- Batch processing
- Synchronous and asynchronous operations
- Event-based communication
- Protocol-based return tracking
- Service status verification
- Contingency mode operations

### Update Information
- Manual version: Updated to NT 2024.003 v.1.08
- Publication date: 24/10/2025
- Project: Nota Fiscal Eletrônica (Electronic Invoice)
- Regulatory body: SEFAZ (State Tax Administration)
```

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

### Exemplo de URL QR Code com CDATA

Demonstra o formato de preenchimento da URL do QR Code para a NFC-e, utilizando a seção CDATA para lidar com caracteres reservados do XML como o '&'. Inclui o protocolo, endereço do site da UF e parâmetros concatenados.

```xml
<![CDATA[https://www.sefaz.rs.gov.br/NFCE/NFCECOM.aspx?chNFe=43150108287693000157651010000000971000001251&nVersao=100&tpAmb=2&cDest=99999999000191&dhEmi=323031352d30312d32305431373a30303a34392d30323a3030&vNF=1.00&vICMS=0.00&digVal=2f4a703477714e6d6e4e646d31776b64743936655a486b65354f513d&cIdToken=000001&cHashQRCode=ecc4f0e7e612456f2e3521768bd572b6f0eae240]]>
```

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

### GET /event/cancel

This endpoint allows the cancellation of a previously registered event. The request includes the necessary information to identify and cancel the specified event.

```APIDOC
## GET /event/cancel

### Description
Cancels a previously registered event.

### Method
GET

### Endpoint
/event/cancel

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The ID of the event to cancel.

### Request Example
```json
{
  "eventId": "event_id"
}
```

### Response
#### Success Response (200)
- **response** (XML) - XML structure with the cancellation result.

#### Response Example
```json
{
  "response": "<retEventoCancelamento>...</retEventoCancelamento>"
}
```
```

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

### Exemplo de Requisição SOAP para NF-e

Estrutura de mensagem SOAP 1.2 para requisição ao Web Service de recepção da NF-e. Inclui o cabeçalho com a versão dos dados e UF, e o corpo com os dados da mensagem XML.

```xml
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/sce/wsdl/NfeRecepcao2">
<versaoDados>string</versaoDados>
<cUF>string</cUF>
</nfeCabecMsg>
</soap12:Header>
<soap12:Body>
<nfeDadosMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NfeRecepcao2"> xml</nfeDadosMsg>
</soap12:Body>
</soap12:Envelope>
```

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

### GET /api/epec/validate/cancellation-database

Accesses the cancellation/inutilization database to verify if the EPEC numbering is marked as inutilized in the SEFAZ database. Returns rejection code 662 if the numbering has been inutilized.

```APIDOC
## GET /api/epec/validate/cancellation-database

### Description
Accesses the inutilization database to check if the EPEC numbering is marked as inutilized in the SEFAZ database. This prevents reuse of cancelled or inutilized fiscal document numbers.

### Method
GET

### Endpoint
/api/epec/validate/cancellation-database

### Parameters
#### Query Parameters
- **uf** (string) - Required - State code (UF) of the emitter
- **cnpj_cpf** (string) - Required - CNPJ or CPF of the emitter
- **serie** (string) - Required - Series number
- **numero** (string) - Required - Number of the fiscal document
- **modelo** (integer) - Optional - Model number (default: 55)

### Request Example
GET /api/epec/validate/cancellation-database?uf=PR&cnpj_cpf=12345678901234&serie=1&numero=123&modelo=55

### Response
#### Success Response (200)
- **inutilized** (boolean) - Indicates if numbering is inutilized
- **error_code** (integer) - Error code if inutilized (662)
- **message** (string) - Descriptive message

#### Response Example
{
  "inutilized": false,
  "error_code": null,
  "message": "Numbering is available for use"
}

#### Error Response (200)
{
  "inutilized": true,
  "error_code": 662,
  "message": "Rejeição: Numeração do EPEC está inutilizada na Base de Dados da SEFAZ"
}

```

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

### GET /nfce/qrcode (Offline)

This endpoint describes the URL structure for generating the QR Code in the offline (contingency) scenario. It outlines the parameters required to construct the URL for accessing NFC-e data.

```APIDOC
## GET /nfce/qrcode/?p=<chave_acesso>|<versao_qrcode>|<tipo_ambiente>|<dia_data_emissao>|<valor_total_nfce>|<digVal>|<identificador_csc>|<codigo_hash>

### Description
Generates a QR code URL for NFC-e in the offline contingency scenario.

### Method
GET

### Endpoint
/nfce/qrcode/

### Parameters
#### Query Parameters
- **p** (string) - Required - Contains the parameters separated by '|'. See parameter details below.

#### Parameters within the 'p' query parameter (Offline):
- **chave_acesso** (string) - Required - 44 bytes - NFC-e access key.
- **versao_qrcode** (string) - Required - 1 byte - QR Code version (e.g., "2").
- **tipo_ambiente** (string) - Required - 1 byte - Environment identifier (1 –Production, 2 –Homologation).
- **dia_data_emissao** (string) - Required - 2 bytes - Day of the emission date.
- **valor_total_nfce** (string) - Required - 15 bytes - Total value of the NFC-e.
- **digVal** (string) - Required - 56 bytes - DigestValue of the NFC-e (SHA1).
- **identificador_csc** (string) - Required - 1-6 bytes - CSC identifier.
- **codigo_hash** (string) - Required - 40 bytes - Hash code of parameters (see section 3.3.2).

### Request Example
```
http://<dominio>/nfce/qrcode/?p=<chave_acesso>|<versao_qrcode>|<tipo_ambiente>|<dia_data_emissao>|<valor_total_nfce>|<digVal>|<identificador_csc>|<codigo_hash>
```

### Response
#### Success Response (200)
- Returns a QR code image to be rendered.

#### Response Example
```
QR Code Image
```
```

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

### XML Signature Example for NF-e

This XML snippet provides a sample structure for signing the NF-e document. It shows the placement of the signature, signed info, and key information, including the certificate. The signature process involves canonicalization, signature method, reference, transforms, digest method, and digest value.

```XML
<NFe xmlns="http://www.portalfiscal.inf.br/nfe" >
  <infNFe Id="NFe31060243816719000108550000000010001234567897" versao="1.01">
    ...
  </infNFe>
  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
      <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" />
      <Reference URI="#NFe31060243816719000108550000000010001234567897">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
          <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
        <DigestValue>vFL68WETQ+mvj1aJAMDx+oVi928=</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>IhXNhbdL1F9UGb2ydVc5v/gTB/y6r0KIFaf5evUi1i ...</SignatureValue>
    <KeyInfo>
      <X509Data>
        <X509Certificate>MIIFazCCBFOgAwIBAgIQaHEfNaxSeOEvZGlVDANB ... </X509Certificate>
      </X509Data>
    </KeyInfo>
  </Signature>
</NFe>
```

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

### GET /nfce/qrcode (Online)

This endpoint describes the URL structure for generating the QR Code in the online (non-contingency) scenario. It outlines the parameters required to construct the URL for accessing NFC-e data.

```APIDOC
## GET /nfce/qrcode?p=<chave_acesso>|<versao_qrcode>|<tipo_ambiente>|<identificador_csc>|<codigo_hash>

### Description
Generates a QR code URL for NFC-e in the online scenario.

### Method
GET

### Endpoint
/nfce/qrcode

### Parameters
#### Query Parameters
- **p** (string) - Required - Contains the parameters separated by '|'.  See parameter details below.

#### Parameters within the 'p' query parameter (Online):
- **chave_acesso** (string) - Required - 44 bytes - NFC-e access key.
- **versao_qrcode** (string) - Required - 1 byte - QR Code version (e.g., "2").
- **tipo_ambiente** (string) - Required - 1 byte - Environment identifier (1 - Production, 2 - Homologation).
- **identificador_csc** (string) - Required - 1-6 bytes - CSC identifier.
- **codigo_hash** (string) - Required - 40 bytes - Hash code of parameters (see section 3.3.1).

### Request Example
```
http://<dominio>/nfce/qrcode?p=<chave_acesso>|<versao_qrcode>|<tipo_ambiente>|<identificador_csc>|<codigo_hash>
```

### Response
#### Success Response (200)
- Returns a QR code image to be rendered.

#### Response Example
```
QR Code Image
```
```

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

### Web Service - NFeDistribuicaoDFe

Allows the distribution of DFe (Documentos Fiscais Eletrônicos) to interested parties.

```APIDOC
## POST /NFeDistribuicaoDFe

### Description
This service handles the distribution of DFe (Documentos Fiscais Eletrônicos).

### Method
POST

### Endpoint
/NFeDistribuicaoDFe

### Parameters
#### Request Body
- **Distribuicao XML** (XML) - Required - The XML containing the distribution request parameters.

### Request Example
```xml
<distDFeInt xmlns="http://www.portalfiscal.inf.br/nfe">
  <!-- ... Distribution request data ... -->
</distDFeInt>
```

### Response
#### Success Response (200)
- **Response XML** (XML) - Contains the distribution results.

#### Response Example
```xml
<retDistDFeInt xmlns="http://www.portalfiscal.inf.br/nfe">
  <!-- ... Distribution results ... -->
</retDistDFeInt>
```
```

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

### Exemplo de Retorno SOAP da NF-e

Estrutura de mensagem SOAP 1.2 para o retorno do Web Service de recepção da NF-e. Contém o cabeçalho com informações de versão e UF, e o corpo com o resultado da operação.

```xml
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NfeRecepcao2">
<versaoDados>string</versaoDados>
<cUF>string</cUF>
</nfeCabecMsg>
</soap12:Header>
<soap12:Body>
<nfeRecepcaoLote2Result xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NfeRecepcao2">
xml
</nfeRecepcaoResult>
</soap12:Body>
</soap12:Envelope>
```