Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,12 @@ Dual format via tsdown (Rolldown): ESM (`dist/index.js`) + CommonJS (`dist/index
- Run `npm run generate` after modifying any OpenAPI spec in `openapi/spec/`
- Typecheck and tests must pass before commits (`npm run typecheck && npm test -- --run`)
- The CHANGELOG is written in Portuguese
- `docs/` is mirrored to the public documentation portal
(<https://nfe.io/docs/desenvolvedores/bibliotecas/node/>; `README.md` becomes the index page;
`EXTENDING.md` and `EXTENSIBILITY_SUMMARY.md` stay here). Keep the machine frontmatter the portal
uses as search facets on every page:
- `tags` with `nodejs`, the page type, the fiscal document and the subject;
- `integration: [sdk]`;
- `status: deprecated` for pages out of circulation.

Sync with a three-way merge, never by copying over: the portal edits these pages too.
7 changes: 7 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
tags: [nodejs, referencia]
integration: [sdk]
status: deprecated
superseded_by: /docs/desenvolvedores/bibliotecas/node
---

# NFE.io SDK v3 - API Reference

> ⚠️ **Legacy reference (v3), not maintained.** This file was written for the 3.x SDK and is no
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ layout_type: IntegrationLayout
heroImage: /docs/img/bibliotecas/nodejs.svg
ctaLabel: GitHub NFE.io Node.js
ctaUrl: https://github.com/nfe/client-nodejs
tags: [nodejs, nfse, nfe, nfce, cte, how-to]
integration: [sdk]
---

# Biblioteca Node.js NFE.io
Expand Down
2 changes: 2 additions & 0 deletions docs/async-and-polling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Assíncrono e polling
sidebar_position: 3
slug: assincrono-e-polling
description: Retorno discriminado (202 vs 201), estados de FlowStatus, createAndWait/cancelAndWait e emissão webhook-driven.
tags: [nodejs, nfse, nfe, nfce, emissao, referencia]
integration: [sdk]
---

# Emissão assíncrona e polling
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Configuração
sidebar_position: 2
slug: configuracao
description: Chaves de API (apiKey e dataApiKey), ambiente, timeout, retry e reconfiguração em runtime do NfeClient.
tags: [nodejs, autenticacao, referencia]
integration: [sdk]
---

# Configuração
Expand Down
2 changes: 2 additions & 0 deletions docs/downloads.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Downloads (PDF/XML)
sidebar_position: 6
slug: downloads-pdf-xml
description: Baixe DANFE/PDF e XML de uma nota identificada, em bytes (Buffer) ou por link, conforme o recurso.
tags: [nodejs, nfse, nfe, nfce, cte, xml, referencia]
integration: [sdk]
---

# Downloads (PDF/XML)
Expand Down
2 changes: 2 additions & 0 deletions docs/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Erros
sidebar_position: 8
slug: erros
description: Hierarquia de erros (NfeError), type guards, mapeamento de status HTTP e política de retry.
tags: [nodejs, erro, referencia]
integration: [sdk]
---

# Erros
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Primeiros passos
sidebar_position: 1
slug: primeiros-passos
description: Instale o pacote nfe-io, crie um NfeClient, emita sua primeira NFS-e e acompanhe o processamento com createAndWait/polling.
tags: [nodejs, nfse, emissao, how-to]
integration: [sdk]
---

# Primeiros passos
Expand Down
2 changes: 2 additions & 0 deletions docs/multi-host-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Multi-host / multi-chave
sidebar_position: 4
slug: multi-host-e-multi-chave
description: A NFE.io é composta por várias APIs em hosts distintos e duas chaves (principal e de dados). Entenda qual recurso usa qual host e chave.
tags: [nodejs, autenticacao, referencia]
integration: [sdk]
---

# Roteamento multi-host / multi-chave
Expand Down
2 changes: 2 additions & 0 deletions docs/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Paginação
sidebar_position: 5
slug: paginacao
description: Listas page-style com filtros de data, envelopes de resposta por recurso e iteração automática de empresas.
tags: [nodejs, paginacao, referencia]
integration: [sdk]
---

# Paginação
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Endereços (CEP)
sidebar_position: 11
slug: consulta-cep
description: Consulte endereços por CEP com nfe.addresses (host address.api.nfe.io). Suporta apenas lookup por CEP; retorna um Address único.
tags: [nodejs, consulta, referencia]
integration: [sdk]
---

# Consulta de endereço (CEP)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Certificados
sidebar_position: 7
slug: certificados
description: Consulta e remoção de certificados digitais por thumbprint com nfe.certificates (host api.nfse.io), com variantes v1.
tags: [nodejs, certificado, referencia]
integration: [sdk]
---

# Certificados (por thumbprint)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/companies.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Empresas
sidebar_position: 4
slug: empresas
description: CRUD de empresas emitentes, iteração paginada, verificação de existência e gestão de certificados digitais com nfe.companies.
tags: [nodejs, empresa, referencia]
integration: [sdk]
---

# Empresas (emitentes)
Expand Down
3 changes: 3 additions & 0 deletions docs/recursos/consumer-invoice-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ sidebar_label: Consulta CFe-SAT
sidebar_position: 21
slug: consulta-cfe-sat
description: nfe.consumerInvoiceQuery consulta cupons CFe-SAT por chave de acesso — métodos descontinuados, porque a plataforma não serve as rotas.
tags: [nodejs, consulta, referencia]
integration: [sdk]
status: deprecated
---

# Consulta de cupom (CFe-SAT)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/consumer-invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: NFC-e (consumidor)
sidebar_position: 3
slug: nfc-e
description: Emita e gerencie NFC-e com nfe.consumerInvoices no host api.nfse.io — emissão webhook-driven e environment obrigatório na listagem/leituras.
tags: [nodejs, nfce, emissao, referencia]
integration: [sdk]
---

# NFC-e (notas de consumidor)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/inbound-product-invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: NF-e de entrada
sidebar_position: 19
slug: nfe-de-entrada
description: Captura automática de NF-e de entrada (distribuição DF-e) com nfe.inboundProductInvoices (host api.nfse.io).
tags: [nodejs, nfe, inbound, distribuicao, referencia]
integration: [sdk]
---

# NF-e de entrada (inbound)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/legal-entity-lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Consulta CNPJ
sidebar_position: 12
slug: consulta-cnpj
description: Consulte dados cadastrais e de inscrição estadual por CNPJ com nfe.legalEntityLookup (host legalentity.api.nfe.io).
tags: [nodejs, consulta, referencia]
integration: [sdk]
---

# Consulta de CNPJ
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/legal-people.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Pessoas jurídicas
sidebar_position: 14
slug: pessoas-juridicas
description: CRUD de pessoas jurídicas (tomadores) por empresa com nfe.legalPeople, incluindo criação em lote e busca por CNPJ.
tags: [nodejs, referencia]
integration: [sdk]
---

# Pessoas jurídicas (tomadores PJ)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/municipal-taxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Inscrições municipais
sidebar_position: 5
slug: inscricoes-municipais
description: CRUD de inscrições municipais (pré-requisito da NFS-e) com nfe.municipalTaxes, incluindo a semântica de substituição do update (PUT).
tags: [nodejs, nfse, inscricao-municipal, referencia]
integration: [sdk]
---

# Inscrições municipais
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/natural-people.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Pessoas físicas
sidebar_position: 15
slug: pessoas-fisicas
description: CRUD de pessoas físicas (tomadores) por empresa com nfe.naturalPeople, incluindo criação em lote e busca por CPF.
tags: [nodejs, referencia]
integration: [sdk]
---

# Pessoas físicas (tomadores PF)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/natural-person-lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Consulta CPF
sidebar_position: 13
slug: consulta-cpf
description: Consulte a situação cadastral de um CPF com nfe.naturalPersonLookup (host naturalperson.api.nfe.io). Requer data de nascimento.
tags: [nodejs, consulta, referencia]
integration: [sdk]
---

# Consulta de CPF
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Notificações
sidebar_position: 8
slug: notificacoes
description: Liste, consulte, remova e envie por e-mail as notificações da empresa com nfe.notifications (host api.nfe.io).
tags: [nodejs, notificacao, referencia]
integration: [sdk]
---

# Notificações
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/product-invoice-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Consulta NF-e
sidebar_position: 20
slug: consulta-nfe
description: Consulte NF-e por chave de acesso e baixe PDF/XML com nfe.productInvoiceQuery (host nfe.api.nfe.io).
tags: [nodejs, consulta, nfe, referencia]
integration: [sdk]
---

# Consulta de NF-e por chave (SEFAZ)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/product-invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Notas de produto
sidebar_position: 2
slug: notas-fiscais-de-produto
description: Emita e gerencie NF-e com nfe.productInvoices no host api.nfse.io — emissão webhook-driven, carta de correção, downloads e inutilização.
tags: [nodejs, nfe, emissao, referencia]
integration: [sdk]
---

# Notas fiscais de produto (NF-e)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/rtc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: RTC
sidebar_position: 10
slug: recursos-rtc
description: Recursos de emissão no leiaute RTC — serviceInvoicesRtc (NFS-e) e productInvoicesRtc (NF-e/NFC-e).
tags: [nodejs, nfse, nfe, nfce, rtc, reforma-tributaria, emissao, referencia]
integration: [sdk]
---

# RTC (recursos)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/service-invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Notas de serviço
sidebar_position: 1
slug: notas-fiscais-de-servico
description: Emita, liste, consulte, cancele e baixe NFS-e com nfe.serviceInvoices no host api.nfe.io /v1, tratando o retorno discriminado 202.
tags: [nodejs, nfse, emissao, referencia]
integration: [sdk]
---

# Notas fiscais de serviço (NFS-e)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/state-taxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Inscrições estaduais
sidebar_position: 6
slug: inscricoes-estaduais
description: CRUD de inscrições estaduais (pré-requisito da NF-e) com nfe.stateTaxes, incluindo troca de autorizador (switchAuthorizer).
tags: [nodejs, nfe, inscricao-estadual, referencia]
integration: [sdk]
---

# Inscrições estaduais
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/tax-calculation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Cálculo de impostos
sidebar_position: 17
slug: calculo-de-impostos
description: Calcule tributos (ICMS, PIS, COFINS, IPI, II) por item com nfe.taxCalculation (host api.nfse.io).
tags: [nodejs, impostos, referencia]
integration: [sdk]
---

# Cálculo de impostos
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/tax-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Códigos de tributos
sidebar_position: 16
slug: codigos-de-tributos
description: Liste códigos de operação, finalidade de aquisição e perfis fiscais com nfe.taxCodes (host api.nfse.io, chave principal).
tags: [nodejs, impostos, catalogo, referencia]
integration: [sdk]
---

# Códigos auxiliares (tax codes)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/transportation-invoices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: CT-e (transporte)
sidebar_position: 18
slug: cte-transporte
description: Habilite e consulte CT-e por chave de acesso com nfe.transportationInvoices (host api.nfse.io).
tags: [nodejs, cte, inbound, referencia]
integration: [sdk]
---

# CT-e (conhecimento de transporte)
Expand Down
2 changes: 2 additions & 0 deletions docs/recursos/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Webhooks
sidebar_position: 9
slug: recurso-webhooks
description: Métodos de webhooks por conta, verificação de assinatura e lista de eventos ao vivo com nfe.webhooks.
tags: [nodejs, webhook, referencia]
integration: [sdk]
---

# Webhooks (recurso)
Expand Down
2 changes: 2 additions & 0 deletions docs/rtc-emission.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Emissão RTC
sidebar_position: 9
slug: emissao-rtc
description: Emita NFS-e e NF-e/NFC-e no leiaute RTC (IBS/CBS/IS). O RTC é selecionado pelo payload, no mesmo endpoint da emissão atual.
tags: [nodejs, nfse, nfe, nfce, rtc, reforma-tributaria, emissao, referencia]
integration: [sdk]
---

# Emissão RTC (Reforma Tributária do Consumo)
Expand Down
2 changes: 2 additions & 0 deletions docs/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_label: Webhooks
sidebar_position: 7
slug: webhooks
description: Verificação de assinatura HMAC-SHA1 (x-hub-signature), webhooks por empresa e por conta, e lista de eventos ao vivo.
tags: [nodejs, webhook, referencia]
integration: [sdk]
---

# Webhooks
Expand Down
Loading