Autenticação
Chave de Dados vs Chave de Consulta, headers HTTP, variáveis de ambiente, precedência e empresa padrão no servidor MCP da NFE.io.
Chave de Dados vs Chave de Consulta, headers HTTP, variáveis de ambiente, precedência e empresa padrão no servidor MCP da NFE.io.
Calcule tributos (ICMS, PIS, COFINS, IPI, II) por item com nfe.taxCalculation (host api.nfse.io).
Execução do motor de regras tributárias por tenant, com retorno do detalhamento de impostos por item, no SDK Ruby da NFE.io.
Calcule os impostos de uma operação com o motor tributário da NFE.io via $nfe->taxCalculation->calculate, com escopo de tenant e payload em array.
Como a plataforma trata acentos, emoji, aspas curvas, travessões e caracteres invisíveis nos campos de texto da NFS-e, o que cada provedor municipal aceita e como corrigir uma rejeição.
As 21 ferramentas do servidor MCP da NFE.io — 13 gratuitas (sem chave) e 8 com chave.
Cenários em que a API de empresas retorna HTTP 400 ao criar/atualizar empresa, inscrição municipal/estadual e certificado — com o corpo real e a correção.
Catálogo dos cenários em que a API de NFS-e retorna HTTP 400 (BadRequest) na emissão e nas operações da nota, com a regra violada e como corrigir.
Consulta e remoção de certificados digitais por thumbprint com nfe.certificates (host api.nfse.io), com variantes v1.
Como definir códigos de serviço municipais personalizados por produto no WHMCS, com NBS, Indicador da Operação e Classificação Tributária por serviço.
Liste códigos de operação, finalidade de aquisição e perfis fiscais com nfe.taxCodes (host api.nfse.io, chave principal).
Distinção entre os dois contextos de eventCode no NFS-e Inbound: XSD tpEvento (webhook) vs EventCode do CSV de bulk export analítico.
Liste os dados de referência do motor tributário — códigos de operação, finalidades de aquisição e perfis fiscais — com $nfe->taxCodes, paginação 1-based com máximo de 50 por página.
Referência dos códigos HTTP retornados pela API, formato de erro, headers de rate limit e estratégia de retry com backoff exponencial.
Como avaliar se sua NF-e foi emitida, a partir do campo status e do histórico de eventos (lastEvents) devolvidos pela API.
Como avaliar se sua NFC-e foi emitida, a partir do campo status e do histórico de eventos (lastEvents) devolvidos pela API.
Todas as opções do Nfe\Client e do Nfe\Config — chaves de API, modelo de duas chaves, timeout, retry, logger PSR-3, transporte PSR-18 e overrides por requisição.
Todas as opções do Nfe::Client e do Nfe::Configuration — chaves de API, timeouts, retries, modelo de duas chaves, sandbox vs. produção, TLS e proxy.
Chaves de API (apiKey e dataApiKey), ambiente, timeout, retry e reconfiguração em runtime do NfeClient.
Com a conexão ativa, defina como as notas serão emitidas. A maior parte dos dados vem automaticamente da fatura do Stripe; aqui você configura o que o Stripe não conhece - principalmente o código de serviço municipal.
Blocos de configuração copy-paste para Claude Desktop, Claude Code, Cursor, Windsurf e VS Code no endpoint hosted da NFE.io.
O que a NFE.io já suporta, por Nota Técnica, na Reforma Tributária e no padrão nacional de NFS-e.
Habilite o recebimento de CT-e de entrada e consulte documentos e eventos por chave de acesso com $nfe->transportationInvoices no host api.nfse.io /v2.
Habilite a busca automática de CT-e (Distribuição DFe) e leia documentos e eventos recebidos por chave de acesso com client.transportation_invoices no host api.nfse.io /v2.
Consulta cadastral de pessoa jurídica por CNPJ — dados básicos e inscrição estadual (inclusive para emissão) no SDK Ruby da NFE.io.
Consulte dados cadastrais de pessoa jurídica por CNPJ e a inscrição estadual por UF com $nfe->legalEntityLookup no host legalentity.api.nfe.io.
Consulte dados cadastrais e de inscrição estadual por CNPJ com nfe.legalEntityLookup (host legalentity.api.nfe.io).
Consulta da situação cadastral de uma pessoa física (CPF + data de nascimento) na Receita Federal pelo SDK Ruby da NFE.io.
Consulte a situação cadastral de um CPF na Receita Federal com $nfe->naturalPersonLookup->getStatus, informando CPF e data de nascimento.
Consulte a situação cadastral de um CPF com nfe.naturalPersonLookup (host naturalperson.api.nfe.io). Requer data de nascimento.
Consulte cupons CFe-SAT por chave de acesso e baixe o XML com nfe.consumerInvoiceQuery (host nfe.api.nfe.io).
Consulte cupons fiscais CFe-SAT e NFC-e pela chave de acesso de 44 dígitos e baixe o XML com $nfe->consumerInvoiceQuery no host nfe.api.nfe.io.
Consulte endereços por CEP com nfe.addresses (host address.api.nfe.io). Suporta apenas lookup por CEP; retorna um Address único.
Consulta de endereços por CEP com $nfe->addresses->lookupByPostalCode no host address.api.nfe.io/v2 — família de dados, usa a dataApiKey.
Consulta de endereços por CEP, por termo livre e por filtro OData no recurso addresses do SDK Ruby da NFE.io.
Consulta de NF-e por chave de acesso — detalhes, download de PDF (DANFE) e XML, e listagem de eventos — no SDK Ruby da NFE.io.
Consulte NF-e por chave de acesso e baixe PDF/XML com nfe.productInvoiceQuery (host nfe.api.nfe.io).
Consulte qualquer NF-e pela chave de acesso de 44 dígitos, liste eventos e baixe DANFE/XML com $nfe->productInvoiceQuery no host nfe.api.nfe.io.
Consulta de cupom fiscal NFC-e (CFe-SAT) por chave de acesso — recuperação e download de XML — no SDK Ruby da NFE.io.
Esquema completo, coluna a coluna, do CSV analítico de NFS-e recebidas (resource company-nfse-inbound-analytical-csv).
Habilite e consulte CT-e por chave de acesso com nfe.transportationInvoices (host api.nfse.io).
Baixe DANFE/PDF e XML como Buffer, individualmente ou em ZIP por empresa, com o Accept correto.
Baixe PDF/XML das notas. Todos os métodos de download do SDK PHP devolvem os bytes crus como string — salve com file_put_contents, sem contratos especiais por recurso.
Baixe PDF/XML das notas. A maioria dos recursos devolve bytes binários (ASCII-8BIT) para salvar com File.binwrite; product_invoices devolve um Nfe::NfeFileResource com a URI do arquivo.
Retorno discriminado (202 vs 201), estados de FlowStatus, createAndWait/cancelAndWait e emissão webhook-driven.
Entenda o contrato HTTP 202, os resultados Pending e Issued discriminados por union types nativos com instanceof, e como montar um loop de polling com FlowStatus::isTerminal().
Entenda o contrato HTTP 202, os resultados Pending e Issued, o pattern matching com pending?/issued? e como montar um loop de polling com FlowStatus.terminal?.
Como usar externalId (idempotência) e RPS na emissão de NFS-e.
Cenários do grupo IBS/CBS da Reforma Tributária na emissão de NFS-e.
Cenários de retenção na emissão de NFS-e: IRRF, ISS retido, PIS/COFINS/CSLL, INSS e retenção plena.
Cenários de emissão de NFS-e em São Paulo com IBS/CBS após os manuais 3.3.7 a 3.3.9: total com documentos de reembolso, paidAmount, multa e juros, Valor Inicial Cobrado e recusas E1003/E1004.
Cenários de emissão de NFS-e por regime tributário do prestador (MEI, Simples, Lucro Presumido, Lucro Real) e por tipo de tomador.
Cenários por tipo de atividade na emissão de NFS-e: evento, construção, locação, comércio exterior, substituição, intermediário.
Cenários de tributação do ISS (cálculo manual, isento, imune, suspenso) e local de prestação na emissão de NFS-e.
Recursos de emissão no leiaute RTC — serviceInvoicesRtc (NFS-e) e productInvoicesRtc (NF-e/NFC-e).
Emita NFS-e e NF-e/NFC-e no layout da Reforma Tributária do Consumo com client.service_invoices_rtc (api.nfe.io /v1) e client.product_invoices_rtc (api.nfse.io /v2), selecionando o layout pela presença dos grupos IBS/CBS no payload.
Emita NFS-e e NF-e/NFC-e sob o layout da Reforma Tributária do Consumo com service_invoices_rtc e product_invoices_rtc — o layout é selecionado pela forma do payload (ibsCbs / items[].tax.IBSCBS), sem header discriminador.
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.
CRUD de empresas emissoras e leitura do status do certificado digital no recurso companies do SDK PHP da NFE.io — escopo de conta, remove() e listAll().
CRUD de empresas e ciclo de vida do certificado digital (upload, validação e status) no recurso companies do SDK Ruby da NFE.io.
CRUD de empresas emitentes, iteração paginada, verificação de existência e gestão de certificados digitais com nfe.companies.
Referência curada dos endpoints REST da recepção de NFS-e: empresas, documentos, downloads, manifestação e manutenção.
Referência dos endpoints da API para CT-e: metadados, XML, reprocessamento de webhooks e consolidação de batch.
Referência dos endpoints da API para NF-e: buscar metadados, baixar XML/PDF, eventos, manifestação e reprocessamento de webhook.
Códigos de status HTTP retornados pela API de recepção de NFS-e, formato do corpo de erro e como reagir a cada um.
Perguntas frequentes sobre o NFe/CTe Inbound — técnico (API, NSU, rate limit) e funcional (cobertura, fraude, sincronia, NFC-e).
Perguntas frequentes sobre a recepção automática de NFS-e: certificado, webhook, manifestação e exportação.
Referência completa do campo purposeType: os 6 valores possíveis de finalidade de emissão da NF-e, o código finNFe correspondente e as exigências de cada um.
Como cada fato posterior à emissão afeta o cálculo de débito e crédito de IBS/CBS feito pelo fisco, e como a NFE.io transmite cada documento e evento até a SEFAZ.
Definições dos termos técnicos e fiscais usados no NFe/CTe Inbound (NSU, DANFE, AN, IBS, CBS, EFD, manifestação, etc.).
CRUD de inscrições estaduais (pré-requisito da NF-e) com nfe.stateTaxes, incluindo troca de autorizador (switchAuthorizer).
CRUD das inscrições estaduais (Inscrição Estadual) de uma empresa, com paginação cursor-style, no SDK Ruby da NFE.io.
Gerencie as inscrições estaduais (IE) da empresa emissora com $nfe->stateTaxes — pré-requisito para emitir NF-e/NFC-e, com paginação por cursor e envelope stateTax.
CRUD de inscrições municipais (pré-requisito da NFS-e) com nfe.municipalTaxes, incluindo updatePrefecture (PATCH) e getSeries.
Prompts prontos por tarefa para usar o MCP da NFE.io no dia a dia - validar cadastros, decodificar chave de NFe, CNAE, correção pela Selic/IPCA, PTAX e mais.
Onde vivem as peças transversais do NFS-e Inbound: HMAC, polling ADN, signed URLs, auth, rate limiting. Referência rápida para consultar contrato técnico e abrir ticket no time certo.
Índice dos 32 cenários de emissão de NFS-e, com o payload base e o guia de cada eixo.
Captura automática de NF-e de entrada (distribuição DF-e) com nfe.inboundProductInvoices (host api.nfse.io).
Habilite a busca automática de NF-e de fornecedores (Distribuição DFe), leia documentos e eventos por chave de acesso e envie a manifestação do destinatário com client.inbound_product_invoices no host api.nfse.io /v2.
Emita e gerencie NFC-e com nfe.consumerInvoices no host api.nfse.io — emissão webhook-driven e environment obrigatório na listagem/leituras.
Complete API reference for the NFE.io Node.js SDK v3.
Referência de campos, subtipos e disponibilidade da Nota de Crédito e da Nota de Débito de NF-e, introduzidas pela Reforma Tributária.
Ative a busca automática de NF-e emitidas contra o seu CNPJ (distribuição DF-e), consulte documentos e eventos, baixe XML/PDF e manifeste-se com $nfe->inboundProductInvoices.
Gestão das NFS-e emitidas pelo módulo NFE.io no WHMCS — listagem, status, ações de reemissão, cancelamento, envio por e-mail e emissão manual a partir da fatura.
Emita NFC-e modelo 65 com $nfe->consumerInvoices no host api.nfse.io /v2 — retorno discriminado 202, listagem paginada, cancelamento e inutilização de faixa.
Emita NFC-e (modelo 65) com client.consumer_invoices no host api.nfse.io /v2 — emissão discriminada, listagem por cursor, downloads em bytes e inutilização coletiva.
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.
Emita NF-e modelo 55 com $nfe->productInvoices no host api.nfse.io /v2 — listagem por cursor com environment obrigatório, carta de correção, inutilização e downloads em bytes.
Emita NF-e modelo 55 com client.product_invoices no host api.nfse.io /v2 — listagem por cursor com environment obrigatório, carta de correção, inutilização e downloads por URI.
Emita, liste, consulte, cancele e baixe NFS-e com nfe.serviceInvoices no host api.nfe.io /v1, tratando o retorno discriminado 202.
Emita, liste, consulte, cancele e baixe NFS-e com $nfe->serviceInvoices no host api.nfe.io /v1, tratando o retorno discriminado 202 com instanceof.
Emita, liste, consulte, cancele e baixe NFS-e com client.service_invoices no host api.nfe.io /v1, tratando o retorno discriminado 202.
Liste, consulte, remova e envie por e-mail as notificações da empresa com nfe.notifications (host api.nfe.io).
Itere listas com Nfe\Util\ListResponse e leia os metadados de página em Nfe\Util\ListPage — paginação por página (pageIndex 1-based) ou por cursor, conforme o recurso.
Itere listas com Nfe::ListResponse (que inclui Enumerable) e leia os metadados de página em Nfe::ListPage — paginação por página ou por cursor, conforme o recurso.
Listas page-style com filtros de data, envelopes de resposta por recurso e iteração automática de empresas.
CRUD de pessoas físicas (tomadores PF) escopadas por empresa, com create_batch e find_by_tax_number, no SDK Ruby da NFE.io.
CRUD de pessoas físicas (tomadores PF) vinculadas a uma empresa com $nfe->naturalPeople — federalTaxNumber como string, createBatch sequencial e findByTaxNumber.
CRUD de pessoas físicas (tomadores) por empresa com nfe.naturalPeople, incluindo criação em lote e busca por CPF.
CRUD de pessoas jurídicas (tomadores PJ) escopadas por empresa, com create_batch e find_by_tax_number, no SDK Ruby da NFE.io.
CRUD de pessoas jurídicas (tomadores PJ) vinculadas a uma empresa com $nfe->legalPeople — create, createBatch sequencial, findByTaxNumber e delete.
CRUD de pessoas jurídicas (tomadores) por empresa com nfe.legalPeople, incluindo criação em lote e busca por CNPJ.
Referência dos campos de tributos federais na API de NFS-e da NFE.io: o que cada campo significa, formato de alíquota e valor, CST do PIS/COFINS e exemplos de requisição.
Documentação de referência do NFe/CTe Inbound: endpoints NF-e e CT-e, webhook events com HMAC, tipos e enums, códigos HTTP, FAQ e glossário.
Catálogos canônicos do NFS-e Inbound: eventos do webhook, códigos de evento (XSD vs CSV) e tabela de troubleshooting com HTTP codes, cStat SEFIN e deactivationReason.
Todos os campos do corpo (POST) de emissão de NFS-e, com tipo, obrigatoriedade e descrição.
Esta página lista os eventos fiscais que a NFE.io processa hoje, organizados pelo modelo de eventos do documento fiscal. Para cada evento: o código, quem o registra, como registrá-lo ou consultá-lo, e qual webhook notifica sobre ele.
Campos da Reforma Tributária (NBS, Classificação Tributária IBS/CBS, Indicador da Operação, PIS/COFINS e taxationType) no módulo NFE.io para WHMCS e a ordem de precedência aplicada na emissão.
Alíquotas de retenção de ISS, PIS, COFINS e tipo de tributação do ISSQN por código de serviço no módulo NFE.io para WHMCS.
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.
Entenda como o SDK roteia cada recurso para o host correto (api.nfe.io, api.nfse.io e os hosts de dados), o modelo de duas chaves e o override por requisição com RequestOptions.
Entenda como o SDK roteia cada recurso para o host correto (api.nfe.io, api.nfse.io e os hosts de dados), o modelo de duas chaves e o escape hatch base_url_overrides.
How the platform handles accents, emoji, curly quotes, dashes and invisible characters in NFS-e text fields, what each municipal provider accepts, and how to fix a rejection.
Listas de referência do CT-e — códigos de operação, finalidades de aquisição e perfis tributários — com paginação page-style no SDK Ruby da NFE.io.
Durante o seu processo de emissão de NFC-e via API, é possível que você se depare com uma série de status de retorno HTTP. Veja o que cada um significa.
Durante o seu processo de emissão de NF-e via API, é possível que você se depare com uma série de status de retorno HTTP. Veja o que cada um significa.
Referência dos enums usados na API NFe/CTe Inbound: EnvironmentSEFAZ, OperationType, MetadataResourceType, EntityStatus, CTeInterestedPartyRole e códigos de evento de manifestação.
Enumerações do domínio de recepção de NFS-e: tipo de documento, status, status de webhook, manifestação e notificações.
Hierarquia de erros (NfeError), type guards, mapeamento de status HTTP e política de retry.
A hierarquia Nfe\Exception, a tabela de códigos HTTP por classe, padrões idiomáticos de catch com instanceof, validação client-side fail-fast e erros de rede.
A hierarquia Nfe::Error, a tabela de códigos HTTP por classe, padrões idiomáticos de rescue, validação client-side fail-fast, RateLimitError#retry_after e erros de rede.
Como a NFE.io trata PIS, COFINS, CSLL, IR e INSS na emissão de NFS-e: tributo próprio × retido, cálculo automático e as mudanças da NT 007.
Como a NFE.io traduz PIS, COFINS, CSLL, IR e INSS para o XML do Ambiente Nacional e da Prefeitura de São Paulo: tpRetPisCofins, vRetCSLL, ValorCSLL e CST, conforme a NT 007.
Sinais de problema na recepção de NF-e/CT-e e como diagnosticar: NSU travado, empresa desativada, webhooks não chegando, rate limit.
Verifique a assinatura HMAC-SHA1 das entregas de webhook da NFE.io com Nfe::Webhook, leia o corpo cru antes de parsear o JSON e torne seus handlers idempotentes.
Verifique a assinatura HMAC-SHA1 das entregas de webhook da NFE.io com a classe estática Nfe\Webhook, leia o corpo cru antes de parsear o JSON e torne seus handlers idempotentes.
Diferença entre as versões v1 e v2 do payload de webhook de NFS-e e como cada empresa é versionada.
Catálogo dos eventos do webhook NFe/CTe Inbound (product_invoice_inbound, transportation_invoice_inbound), payload e contrato de validação HMAC-SHA1 (x-hub-signature).
Crie, liste, atualize, teste e exclua alvos de entrega de webhook por empresa com $nfe->webhooks — a verificação de assinatura fica na classe estática Nfe\Webhook.
Métodos de webhooks por empresa e por conta, verificação de assinatura e lista de eventos ao vivo com nfe.webhooks.
Verificação de assinatura HMAC-SHA1 (x-hub-signature), webhooks por empresa e por conta, e lista de eventos ao vivo.
CRUD de assinaturas de webhook por empresa, disparo de teste, lista de eventos disponíveis e verificação de assinatura no SDK Ruby da NFE.io.