NFeWizard

https://nfewizard-org.github.io/
Admin
NFeWizard is a Node.js library that simplifies interaction with SEFAZ web services, providing robust...
Tokens:36,139
Snippets:88
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### NFE_OperacaoNaoRealizada Response Example

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

This is an example of the response structure received after sending an NFE_OperacaoNaoRealizada event. It includes details about the lot, status, and event registration.

```json
[
  {
    "idLote": "1",
    "tpAmb": "2",
    "verAplic": "AN_1.8.4",
    "cOrgao": "91",
    "cStat": "128",
    "xMotivo": "Lote de evento processado",
    "retEvento": {
      "infEvento": {
        "tpAmb": "2",
        "verAplic": "AN_1.8.4",
        "cOrgao": "91",
        "cStat": "135",
        "xMotivo": "Evento registrado e vinculado a NF-e",
        "chNFe": "99999999999999999999999999999999999999999999",
        "tpEvento": "210240",
        "xEvento": "Operacao nao Realizada",
        "nSeqEvento": "1",
        "CNPJDest": "99999999999999",
        "dhRegEvento": "2024-07-17T17:35:55-03:00",
        "nProt": "999999999999999"
      }
    },
    "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"><soap:Body><nfeRecepcaoEventoNFResult xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeRecepcaoEvento4\"><retEnvEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><idLote>1</idLote><tpAmb>2</tpAmb><verAplic>AN_1.8.4</verAplic><cOrgao>91</cOrgao><cStat>128</cStat><xMotivo>Lote de evento processado</xMotivo><retEvento versao=\"1.00\"><infEvento Id=\"ID999999999999999\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><tpAmb>2</tpAmb><verAplic>AN_1.8.4</verAplic><cOrgao>91</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>99999999999999999999999999999999999999999999</chNFe><tpEvento>210240</tpEvento><xEvento>Operacao nao Realizada</xEvento><nSeqEvento>1</nSeqEvento><CNPJDest>99999999999999</CNPJDest><dhRegEvento>2024-07-17T17:35:55-03:00</dhRegEvento><nProt>999999999999999</nProt></infEvento></retEvento></retEnvEvento></nfeRecepcaoEventoNFResult></soap:Body></soap:Envelope>
```

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

### Initialize and Use NFeWizard-io

Source: https://nfewizard-org.github.io/

Example showing how to instantiate the library, load the environment configuration, and perform a DFe distribution query.

```javascript
import NFeWizard from 'nfewizard-io';

// Instanciar
const nfewizard = new NFeWizard();

// Inicializar
await nfeWizard.NFE_LoadEnvironment({
    config: {
        dfe: {
            baixarXMLDistribuicao: true,
            pathXMLDistribuicao: "tmp/DistribuicaoDFe",
            armazenarXMLAutorizacao: true,
            pathXMLAutorizacao: "tmp/Autorizacao",
            armazenarXMLRetorno: true,
            pathXMLRetorno: "tmp/RequestLogs",
            armazenarXMLConsulta: true,
            pathXMLConsulta: "tmp/RequestLogs",
            armazenarXMLConsultaComTagSoap: false,
            armazenarRetornoEmJSON: true,
            pathRetornoEmJSON: "tmp/DistribuicaoDFe",

            pathCertificado: "certificado.pfx",
            senhaCertificado: "123456",
            UF: "SP",
            CPFCNPJ: "99999999999999",
        },
        nfe: {
            ambiente: 2,
            versaoDF: "4.00",
            idCSC: 1,
            tokenCSC: '99999999-9999-9999-9999-999999999999'
        },
        email: {
            host: 'smtp.example.com',
            port: 587,
            secure: false,
            auth: {
                user: 'seu-email@example.com',
                pass: 'sua-senha'
            },
            emailParams: {
                from: '"Seu Nome" <seu-email@example.com>',
                to: 'destinatario@example.com',
            }
        },
        lib: {
            connection: {
                timeout: 30000,
            },
        }
    }
});

// Exemplo de Utilização
const chaveNFe: DFePorChaveNFe = {
    cUFAutor: 35,
    CNPJ: '99999999999999',
    consChNFe: {
        chNFe: '00000000000000000000000000000000000000000000'
    },
}

await nfeWizard.NFE_DistribuicaoDFePorChave(chaveNFe);
```

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

### Implement NFE_ConfirmacaoDaOperacao

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example of how to structure and call the NFE_ConfirmacaoDaOperacao method using the NFE Wizard library.

```typescript
import { ConfirmacaoDaOperacao } from '@Protocols';

const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
const confirmacaoDaOperacao: ConfirmacaoDaOperacao = {
    idLote: 1,
    evento: [
        {
            tpAmb: 2,
            cOrgao: 91,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '210200',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Confirmacao da Operacao',
            }
        }
    ]
}

await nfeWizard.NFE_ConfirmacaoDaOperacao(confirmacaoDaOperacao);
```

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

### Execute NFE_Cancelamento

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example of how to structure the Cancelamento object and invoke the NFE_Cancelamento method.

```typescript
import { Cancelamento } from '@Protocols';

const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
const cancelamento: Cancelamento = {
    idLote: 1,
    evento: [
        {
            tpAmb: 2,
            cOrgao: 35,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '110111',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Cancelamento',
                nProt: '999999999999999',
                xJust: 'Cancelamento homologacao',
            }
        }
    ]
}

await nfeWizard.NFE_Cancelamento(cancelamento);
```

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

### Configure NFe Event Batch

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example showing the structure of an event batch including various event types like Ciencia, Confirmacao, Carta de Correcao, and Cancelamento.

```typescript
import { EventoNFe } from '@Protocols';

const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
const evento: EventoNFe = {
    idLote: 1,
    evento: [
        // O método aceita até 20 eventos por lote
        {
            cOrgao: 91,
            tpAmb: 2,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '210210',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Ciencia da Operacao',
            }
        },
        {
            tpAmb: 2,
            cOrgao: 91,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '210200',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Confirmacao da Operacao',
            }
        },
        {
            cOrgao: 35,
            tpAmb: 2,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '110110',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Carta de Correção',
                xCorrecao: 'Teste de homologação',
                xCondUso: 'A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.',
            }
        },
        {
            tpAmb: 2,
            cOrgao: 35,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '110111',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Cancelamento',
                nProt: '999999999999999',
                xJust: 'Cancelamento homologacao',
            }
        },
        {
            cOrgao: 91,
            tpAmb: 2,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '210220',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Desconhecimento da Operacao',
            }
        },
        {
            cOrgao: 91,
            tpAmb: 2,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '210240',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Operacao nao Realizada',
                xJust: 'Teste Operacao nao Realizada em homologação'
            }
        },
        {
            tpAmb: 2,
            cOrgao: 91,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '110140',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'EPEC',
                cOrgaoAutor: 35,
                tpAutor: 1,
                verAplic: '1.00',
                dhEmi: '2024-07-10T09:38:55-03:00',
                tpNF: 1,
                IE: '999999999999',
                dest: {
                    UF: 'SP',
                    CNPJ: '99999999999999',
                    IE: '999999999999',
                    vNF: '999.99',
                    vICMS: '999.99',
                    vST: '999.99',

```

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

### Example Response Object

Source: https://nfewizard-org.github.io/nfeDistribuicaoDfe

The structure of the JSON response returned by the distribution service, including the original XML string.

```json
{
  "retDistDFeInt": {
    "tpAmb": "1",
    "verAplic": "1.7.1",
    "cStat": "138",
    "xMotivo": "Documento(s) localizado(s)",
    "dhResp": "2024-07-16T17:58:27-03:00",
    "ultNSU": "000000000006026",
    "maxNSU": "000000000006068",
    "loteDistDFeInt": {
      "docZip": [
        "H4sIAAAAAAAEAIWS3W...",
        "H4sIAAAAAAAEAIVSXW...",
        "H4sIAAAAAAAEAIWSbW...",
        "H4sIAAAAAAAEAIWSy2...",
        "H4sIAAAAAAAEAKVYaX..."
      ]
    }
  },
  "xml": "<?xml version= \"1.0\" encoding= \"utf-8\"?> <soap:Envelope xmlns:soap= \"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi= \"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd= \"http://www.w3.org/2001/XMLSchema\"> <soap:Body> <nfeDistDFeInteresseResponse xmlns= \"http://www.portalfiscal.inf.br/nfe/wsdl/NFeDistribuicaoDFe\"> <nfeDistDFeInteresseResult> <retDistDFeInt xmlns:xsd= \"http://www.w3.org/2001/XMLSchema\" xmlns:xsi= \"http://www.w3.org/2001/XMLSchema-instance\" versao= \"1.01\" xmlns= \"http://www.portalfiscal.inf.br/nfe\"> <tpAmb>1</tpAmb> <verAplic>1.7.1</verAplic> <cStat>138</cStat> <xMotivo>Documento(s) localizado(s)</xMotivo> <dhResp>2024-07-16T17:58:27-03:00</dhResp> <ultNSU>000000000006026</ultNSU> <maxNSU>000000000006068</maxNSU> <loteDistDFeInt> <docZip NSU= \"000000000005977\" schema= \"resNFe_v1.01.xsd\"> H4sIAAAAAAAEAIWS3W...</docZip> <docZip NSU= \"000000000005978\" schema= \"resNFe_v1.01.xsd\"> H4sIAAAAAAAEAIVSXW...</docZip> <docZip NSU= \"000000000005979\" schema= \"resNFe_v1.01.xsd\"> H4sIAAAAAAAEAIWSbW...</docZip> <docZip NSU= \"000000000005980\" schema= \"resNFe_v1.01.xsd\"> H4sIAAAAAAAEAIWSy2...</docZip> <docZip NSU= \"000000000005981\" schema= \"procEventoNFe_v1.00.xsd\"> H4sIAAAAAAAEAKVYaX...</docZip> </loteDistDFeInt> </retDistDFeInt> </nfeDistDFeInteresseResult> </nfeDistDFeInteresseResponse> </soap:Body> </soap:Envelope>"
}
```

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

### NFeConsultaProtocolo Service Response Example

Source: https://nfewizard-org.github.io/nfeConsultaProtocolo

This is a sample JSON response from the NFeConsultaProtocolo service, detailing the status of an NF-e, including environment, application version, status code, reason, and protocol information.

```json
{
  "tpAmb": "2",
  "verAplic": "SP_NFE_PL009_V4",
  "cStat": "100",
  "xMotivo": "Autorizado o uso da NF-e",
  "cUF": "35",
  "dhRecbto": "2024-07-16T17:21:44-03:00",
  "chNFe": "99999999999999999999999999999999999999999999",
  "protNFe": {
    "infProt": {
      "tpAmb": "2",
      "verAplic": "SP_NFE_PL009_V4",
      "chNFe": "99999999999999999999999999999999999999999999",
      "dhRecbto": "2024-07-14T09:57:08-03:00",
      "nProt": "999999999999999",
      "digVal": "",
      "cStat": "100",
      "xMotivo": "Autorizado o uso da NF-e"
    }
  },
  "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?> <soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"> <soap:Body> <nfeResultMsg xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeConsultaProtocolo4\"> <retConsSitNFe versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe"> <tpAmb>1</tpAmb> <verAplic>SP_NFE_PL009_V4</verAplic> <cStat>100</cStat> <xMotivo>Autorizado o uso da NF-e</xMotivo> <cUF>35</cUF> <dhRecbto>2024-07-11T21:51:46-03:00</dhRecbto> <chNFe>99999999999999999999999999999999999999999999</chNFe> <protNFe versao=\"4.00\"> <infProt> <tpAmb>1</tpAmb> <verAplic>SP_NFE_PL009_V4</verAplic> <chNFe>99999999999999999999999999999999999999999999</chNFe> <dhRecbto>2024-02-06T15:36:49-03:00</dhRecbto> <nProt></nProt> <digVal></digVal> <cStat>100</cStat> <xMotivo>Autorizado o uso da NF-e</xMotivo> </infProt> </protNFe> </retConsSitNFe> </nfeResultMsg> </soap:Body> </soap:Envelope>"
}
```

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

### NFE_Cancelamento Response Format

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example of the JSON response returned after a successful NFE_Cancelamento request.

```json
[
  {
    "idLote": "1",
    "tpAmb": "2",
    "verAplic": "SP_EVENTOS_PL_100",
    "cOrgao": "35",
    "cStat": "128",
    "xMotivo": "Lote de Evento Processado",
    "retEvento": {
      "infEvento": {
        "tpAmb": "2",
        "verAplic": "SP_EVENTOS_PL_100",
        "cOrgao": "35",
        "cStat": "135",
        "xMotivo": "Evento registrado e vinculado a NF-e",
        "chNFe": "99999999999999999999999999999999999999999999",
        "tpEvento": "110111",
        "xEvento": "Cancelamento registrado",
        "nSeqEvento": "1",
        "CNPJDest": "99999999999999",
        "dhRegEvento": "2024-07-17T17:37:52-03:00",
        "nProt": "999999999999999"
      }
    },
    "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"><soap:Body><nfeResultMsg xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeRecepcaoEvento4\"><retEnvEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><idLote>1</idLote><tpAmb>2</tpAmb><verAplic>SP_EVENTOS_PL_100</verAplic><cOrgao>35</cOrgao><cStat>128</cStat><xMotivo>Lote de Evento Processado</xMotivo><retEvento versao=\"1.00\"><infEvento><tpAmb>2</tpAmb><verAplic>SP_EVENTOS_PL_100</verAplic><cOrgao>35</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>99999999999999999999999999999999999999999999</chNFe><tpEvento>110111</tpEvento><xEvento>Cancelamento registrado</xEvento><nSeqEvento>1</nSeqEvento><CNPJDest>99999999999999</CNPJDest><dhRegEvento>2024-07-17T17:37:52-03:00</dhRegEvento><nProt>999999999999999</nProt></infEvento></retEvento></retEnvEvento></nfeResultMsg></soap:Body></soap:Envelope>"
  }
]
```

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

### NFE_DistribuicaoDFePorUltNSU

Source: https://nfewizard-org.github.io/nfeDistribuicaoDfe

Specific method to distribute fiscal documents starting from the last received NSU.

```APIDOC
## NFE_DistribuicaoDFePorUltNSU

### Description
Consults fiscal documents starting from the last received NSU.

### Parameters
#### Request Body
- **cUFAutor** (Number) - Required - Code of the UF of the author
- **CNPJ** (String) - Required - CNPJ of the interested party
- **distNSU** (Object) - Required - Contains ultNSU for distribution by last NSU
```

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

### NFeInutilizacao Request Example

Source: https://nfewizard-org.github.io/nfeInutilizacao

This snippet demonstrates how to construct and send an inutilization request using the NFeInutilizacao service. Ensure the InutilizacaoData object is correctly populated with all required fields before calling the service.

```typescript
import { InutilizacaoData } from '@Protocols';

const inutilizacao: InutilizacaoData = {
    cUF: 35,
    CNPJ: '99999999999999',
    ano: '24',
    mod: '55',
    serie: '1',
    nNFIni: '112',
    nNFFin: '112',
    xJust: 'Teste de homologação',
}

await nfeWizard.NFE_Inutilizacao(inutilizacao)
```

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

### NFE Authorization Data Structure

Source: https://nfewizard-org.github.io/nfeAutorizacao

Example of the JSON structure required for the NFE authorization payload.

```json
{
  "NFe": {
    "infNFe": {
      "ide": {
        "cUF": "35",
        "cNF": "99999999",
        "natOp": "VENDA DE MERCADORIA",
        "mod": "55",
        "serie": "1",
        "nNF": "999999999",
        "dhEmi": "2024-07-08T00:00:00-03:00",
        "tpNF": "1",
        "idDest": "1",
        "cMunFG": "9999999",
        "tpImp": "1",
        "tpEmis": "1",
        "cDV": "9",
        "tpAmb": "2",
        "finNFe": "1",
        "indFinal": "1",
        "indPres": "9",
        "indIntermed": "0",
        "procEmi": "0",
        "verProc": "1.0.0.0"
      },
      "emit": {
        "CNPJ": "99999999999999",
        "xNome": "NOME DO EMITENTE",
        "xFant": "NOME FANTASIA DO EMITENTE",
        "enderEmit": {
          "xLgr": "DESCRIÇÃO LOGRADOURO EMITENTE",
          "nro": "9999",
          "xBairro": "BAIRRO EMITENTE",
          "cMun": "9999999",
          "xMun": "MUNICIPIO",
          "UF": "SP",
          "CEP": "99999999",
          "cPais": "1058",
          "xPais": "BRASIL",
          "fone": "99999999999"
        },
        "IE": "999999999999",
        "CRT": "3"
      },
      "dest": {
        "CNPJ": "99999999999999",
        "xNome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
        "enderDest": {
          "xLgr": "DESCRIÇÃO LOGRADOURO DESTINATÁRIO",
          "nro": "9999",
          "xBairro": "BAIRRO DESTINATÁRIO",
          "cMun": "9999999",
          "xMun": "MUNICIPIO",
          "UF": "SP",
          "CEP": "99999999",
          "cPais": "1058",
          "xPais": "BRASIL",
          "fone": "99999999999"
        },
        "indIEDest": "1",
        "IE": "999999999999"
      },
      "det": {
        "prod": {
          "cProd": "99999999",
          "cEAN": "9999999999999",
          "xProd": "QUEIJO MUSSARELA",
          "NCM": "04061010",
          "EXTIPI": "00",
          "CFOP": "5102",
          "uCom": "KG",
          "qCom": "24.93",
          "vUnCom": "33.9",
          "vProd": "845.13",
          "cEANTrib": "9999999999999",
          "uTrib": "KG",
          "qTrib": "24.93",
          "vUnTrib": "33.9",
          "indTot": "1"
        },
        "imposto": {
          "ICMS": {
            "ICMS00": {
              "orig": "0",
              "CST": "00",
              "modBC": "3",
              "vBC": "845.13",
              "pICMS": "12.00",
              "vICMS": "101.42"
            }
          },
          "PIS": {
            "PISNT": {
              "CST": "06"
            }
          },
          "COFINS": {
            "COFINSNT": {
              "CST": "06"
            }
          }
        }
      },
      "total": {
        "ICMSTot": {
          "vBC": "845.13",
          "vICMS": "101.42",
          "vICMSDeson": "0.00",
          "vFCP": "0.00",
          "vBCST": "0.00",
          "vST": "0.00",
          "vFCPST": "0.00",
          "vFCPSTRet": "0.00",
          "vProd": "845.13",
          "vFrete": "0.00",
          "vSeg": "0.00",
          "vDesc": "0.00",
          "vII": "0.00",
          "vIPI": "0.00",
          "vIPIDevol": "0.00",
          "vPIS": "0.00",
          "vCOFINS": "0.00",
          "vOutro": "0.00",
          "vNF": "845.13"
        }
      },
      "transp": {
        "modFrete": "0",
        "vol": {

```

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

### NFeInutilizacao Response Example

Source: https://nfewizard-org.github.io/nfeInutilizacao

This JSON object represents a typical successful response from the NFeInutilizacao service for an inutilization request in a homologation environment. It includes status codes, reasons, and details about the processed request.

```json
{
  "tpAmb": "2",
  "verAplic": "SP_NFE_PL009_V4",
  "cStat": "102",
  "xMotivo": "Inutilização de número homologado",
  "cUF": "35",
  "ano": "24",
  "CNPJ": "99999999999999",
  "mod": "55",
  "serie": "1",
  "nNFIni": "999",
  "nNFFin": "999",
  "dhRecbto": "2024-07-16T18:14:13-03:00",
  "nProt": "999999999999999",
  "xml": "<?xml version= \"1.0\" encoding= \"utf-8\"?> <soap:Envelope xmlns:soap= \"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi= \"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd= \"http://www.w3.org/2001/XMLSchema\"> <soap:Body> <nfeResultMsg xmlns= \"http://www.portalfiscal.inf.br/nfe/wsdl/NFeInutilizacao4\"> <retInutNFe versao= \"4.00\" xmlns= \"http://www.portalfiscal.inf.br/nfe\"> <infInut> <tpAmb>2</tpAmb> <verAplic>SP_NFE_PL009_V4</verAplic> <cStat>102</cStat> <xMotivo>Inutilização de número homologado</xMotivo> <cUF>35</cUF> <ano>24</ano> <CNPJ>99999999999999</CNPJ> <mod>55</mod> <serie>1</serie> <nNFIni>999</nNFIni> <nNFFin>999</nNFFin> <dhRecbto>2024-07-16T18:14:13-03:00</dhRecbto> <nProt>999999999999999</nProt> </infInut> </retInutNFe> </nfeResultMsg> </soap:Body> </soap:Envelope>"
}
```

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

### NFE Distribution Response Example

Source: https://nfewizard-org.github.io/nfeDistribuicaoDfe

This JSON structure represents the typical response from the NFE distribution service, including status information and compressed document data.

```json
{
  "retDistDFeInt": {
    "tpAmb": "1",
    "verAplic": "1.7.1",
    "cStat": "138",
    "xMotivo": "Documento localizado",
    "dhResp": "2024-07-16T17:43:35-03:00",
    "loteDistDFeInt": {
      "docZip": "H4sIAAAAAAAEANU6a5..."
    }
  },
  "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?> <soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"> <soap:Body> <nfeDistDFeInteresseResponse xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeDistribuicaoDFe\"> <nfeDistDFeInteresseResult> <retDistDFeInt xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" versao=\"1.01\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"> <tpAmb>2</tpAmb> <verAplic>1.7.1</verAplic> <cStat>138</cStat> <xMotivo>Documento localizado</xMotivo> <dhResp>2024-07-11T21:57:05-03:00</dhResp> <loteDistDFeInt> <docZip NSU=\"000000000000040\" schema=\"procNFe_v4.00.xsd\"> </docZip> </loteDistDFeInt> </retDistDFeInt> </nfeDistDFeInteresseResult> </nfeDistDFeInteresseResponse> </soap:Body> </soap:Envelope>"
}
```

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

### Instalar a biblioteca NFeWizard

Source: https://nfewizard-org.github.io/nfeInicializarAmbiente

Comandos para adicionar a dependência do projeto utilizando npm ou yarn.

```bash
npm install nfewizard-io
```

```bash
yarn add nfewizard-io
```

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

### Configurar o ambiente NFeWizard

Source: https://nfewizard-org.github.io/nfeInicializarAmbiente

Exemplo de inicialização do ambiente com configurações de DFe, NFe, e-mail e logs. Certifique-se de que os dados fornecidos estejam na ordem correta para a geração e validação dos XMLs.

```javascript
import NFeWizard from 'nfewizard-io';

const nfewizard = new NFeWizard();

await nfeWizard.NFE_LoadEnvironment({
        config: {
            dfe: {
                baixarXMLDistribuicao: true,
                pathXMLDistribuicao: "tmp/DistribuicaoDFe",
                armazenarXMLAutorizacao: true,
                pathXMLAutorizacao: "tmp/Autorizacao",
                armazenarXMLRetorno: true,
                pathXMLRetorno: "tmp/RequestLogs",
                armazenarXMLConsulta: true,
                pathXMLConsulta: "tmp/RequestLogs",
                armazenarXMLConsultaComTagSoap: false,
                armazenarRetornoEmJSON: false,
                pathRetornoEmJSON: "tmp/DistribuicaoDFe",

                pathCertificado: "certificado.pfx",
                senhaCertificado: "1234",
                UF: "SP",
                CPFCNPJ: "99999999999999",
            },
            nfe: {
                ambiente: 2,
                versaoDF: "4.00",
                idCSC: 1,
                tokenCSC: '99999999-9999-9999-9999-999999999999'
            },
            email: {
                host: 'mail.provider.com.br',
                port: 465,
                secure: true, 
                auth: {
                    user: 'nfe.example@email.com.br',
                    pass: '123456' 
                },
                emailParams: {
                    from: 'Company <noreply.company@email.com>',
                    to: 'customer.name@email.com.br',
                }
            },
            lib: {
                connection: {
                    timeout: 30000,
                },
                log: {
                    exibirLogNoConsole: true,
                    armazenarLogs: true,
                    pathLogs: 'tmp/Logs'
                },
                useOpenSSL: false,
                useForSchemaValidation: 'validateSchemaJsBased',
            }
        }
    });
```

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

### Send NFE Correction Letter

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example of how to structure the CartaDeCorrecao object and invoke the NFE_CartaDeCorrecao method.

```typescript
import { CartaDeCorrecao } from '@Protocols';

const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
const cartaDeCorrecao: CartaDeCorrecao = {
    idLote: 1,
    evento: [
        {
            cOrgao: 35,
            tpAmb: 2,
            CNPJ: '99999999999999',
            chNFe: '99999999999999999999999999999999999999999999',
            dhEvento: format(new Date(), "yyyy-MM-dd'T'HH:mm:ssXXX", { timeZone }),
            tpEvento: '110110',
            nSeqEvento: 1,
            verEvento: '1.00',
            detEvento: {
                descEvento: 'Carta de Correção',
                xCorrecao: 'Teste de homologação',
                xCondUso: 'A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.',
            }
        }
    ]
}

await nfeWizard.NFE_CartaDeCorrecao(cartaDeCorrecao);
```

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

### NFE Correction Letter Response

Source: https://nfewizard-org.github.io/nfeRecepcaoEvento

Example of the JSON response returned after processing a correction letter request.

```json
[
  {
    "idLote": "1",
    "tpAmb": "2",
    "verAplic": "SP_EVENTOS_PL_100",
    "cOrgao": "35",
    "cStat": "128",
    "xMotivo": "Lote de Evento Processado",
    "retEvento": {
      "infEvento": {
        "tpAmb": "2",
        "verAplic": "SP_EVENTOS_PL_100",
        "cOrgao": "35",
        "cStat": "135",
        "xMotivo": "Evento registrado e vinculado a NF-e",
        "chNFe": "99999999999999999999999999999999999999999999",
        "tpEvento": "110110",
        "xEvento": "Carta de Correção registrada",
        "nSeqEvento": "1",
        "CNPJDest": "99999999999999",
        "dhRegEvento": "2024-07-17T15:58:10-03:00",
        "nProt": "999999999999999"
      }
    },
    "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"><soap:Body><nfeResultMsg xmlns=\"http://www.portalfiscal.inf.br/nfe/wsdl/NFeRecepcaoEvento4\"><retEnvEvento versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nfe\"><idLote>1</idLote><tpAmb>2</tpAmb><verAplic>SP_EVENTOS_PL_100</verAplic><cOrgao>35</cOrgao><cStat>128</cStat><xMotivo>Lote de Evento Processado</xMotivo><retEvento versao=\"1.00\"><infEvento><tpAmb>2</tpAmb><verAplic>SP_EVENTOS_PL_100</verAplic><cOrgao>35</cOrgao><cStat>135</cStat><xMotivo>Evento registrado e vinculado a NF-e</xMotivo><chNFe>99999999999999999999999999999999999999999999</chNFe><tpEvento>110110</tpEvento><xEvento>Carta de Correção registrada</xEvento><nSeqEvento>1</nSeqEvento><CNPJDest>99999999999999</CNPJDest><dhRegEvento>2024-07-17T15:58:10-03:00</dhRegEvento><nProt>999999999999999</nProt></infEvento></retEvento></retEnvEvento></nfeResultMsg></soap:Body></soap:Envelope>"
  }
]
```

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

### LIB Configuration

Source: https://nfewizard-org.github.io/configuracaoDeAmbiente

General library configuration options, including connection timeouts and logging.

```APIDOC
## LIB Configuration

### Description
General configuration options for the NFeWizard-io library.

### Parameters
#### Request Body
- **connection** (object) - Optional - Defines HTTP request configurations.
  - **connection.timeout** (integer) - Optional - Defines the timeout in milliseconds for HTTP requests made by the library. Default: 60000.
- **log** (object) - Optional - Defines log configurations.
  - **log.exibirLogNoConsole** (boolean) - Optional - Defines if logs should be displayed in the console. Default: false.
  - **log.armazenarLogs** (boolean) - Optional - Defines if logs should be stored in a file. Default: false.
  - **log.pathLogs** (string) - Optional - Defines the directory where logs will be saved.
- **useOpenSSL** (boolean) - Optional - Defines whether to use OpenSSL for cryptographic operations. Default: false.
- **useForSchemaValidation** (string) - Optional - Defines the schema validation method:
  `validateSchemaJsBased` = JavaScript-based validation
  `validateSchemaXmlLintBased` = xmllint-based validation. Default: validateSchemaJsBased.
```

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

### NFeAutorizacao - nfeAutorizacaoLote Method

Source: https://nfewizard-org.github.io/nfeAutorizacao

The nfeAutorizacaoLote method is designed to receive batches of NF-e (Nota Fiscal Eletrônica). It supports both asynchronous and synchronous processing and can handle up to 50 NF-e documents per batch, adhering to the NF-e layout specifications.

```APIDOC
## POST /nfeAutorizacaoLote

### Description
Receives a batch of NF-e documents for authorization. Supports asynchronous and synchronous processing. A single batch can contain up to 50 NF-e documents.

### Method
POST

### Endpoint
/nfeAutorizacaoLote

### Parameters
#### Request Body
- **nfes** (array[object]) - Required - An array of NF-e objects, with a maximum of 50 items. The structure of each NF-e object is defined in the 'Leiaute da NF-e' documentation.

### Request Example
```json
{
  "nfes": [
    {
      "ide": { ... },
      "emit": { ... },
      "dest": { ... },
      "det": [ { ... } ],
      "total": { ... },
      "infAdic": { ... }
    }
    // ... up to 49 more NF-e objects
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the processing status (e.g., 'processed', 'pending').
- **protocol** (string) - The unique protocol number for the batch.
- **errors** (array[object]) - A list of errors encountered during processing, if any.
  - **code** (string) - Error code.
  - **message** (string) - Error description.

#### Response Example
```json
{
  "status": "processed",
  "protocol": "123456789012345",
  "errors": []
}
```
```

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

### Execute NFE_DistribuicaoDFePorUltNSU

Source: https://nfewizard-org.github.io/nfeDistribuicaoDfe

Performs a distribution query specifically using the last NSU.

```typescript
import { DFePorUltimoNSU } from '@Protocols';

const ultimoNSU: DFePorUltimoNSU = {
    cUFAutor: 35,
    CNPJ: '99999999999999',
    distNSU: {
        ultNSU: '000000000000001'
    },
}

await nfeWizard.NFE_DistribuicaoDFePorUltNSU(ultimoNSU);
```
Tokens:
Raw