NFE.io
33 min
objetivo integração com o conjunto de apis da nfe io, provedora brasileira de dados cadastrais e documentos fiscais eletrônicos o conector reúne 8 módulos, cobrindo desde consultas simples (situação cadastral de cpf, dados de cnpj/inscrição estadual, endereço por cep, consulta de nf e/nfc e por chave de acesso) até a emissão e gestão completa de documentos fiscais (nf e, nfc e, ct e recebidos de terceiros, nfs e), cálculo de impostos e configuração de webhooks para acompanhar eventos fiscais criando um fluxo acesse fluxos na plataforma fluid clique em "criar fluxo" selecione o conector nfe io nomeie o fluxo e clique em "avançar" criando conexão para autenticar com a nfe io, é necessária uma api key gerada no painel da própria nfe io campos obrigatórios api key chave de api criada em https //api nfe io/v1/ como obter credenciais acesse o painel da sua conta na nfe io gere (ou copie) a api key da conta cole o valor no campo "api key" ao criar a conexão do conector nfe io no fluid a mesma api key vale para todos os módulos do conector — não é necessário criar uma conexão separada para cada um configurando fluxo ao configurar o passo, escolha primeiro o módulo (a funcionalidade da nfe io que deseja utilizar — ex consulta de cpf, nota fiscal, cálculo de impostos etc ), em seguida o recurso dentro desse módulo e, por fim, a operação desejada cada operação pode pedir informações adicionais para ser executada, como identificadores (ex id da empresa, chave de acesso) ou dados para montar o conteúdo que será enviado em operações de criação ou atualização, você escolhe como preencher esses dados por template (texto livre) ou por campos dinâmicos (um formulário guiado, com um campo para cada informação necessária) módulo > recursos > operações módulo consulta de cpf (v1) recurso naturalperson operação consulta de situação cadastral do cpf consulta a situação cadastral de uma pessoa física na receita federal parâmetros cpf (obrigatório) número do cpf a consultar data de nascimento (obrigatório) formato aaaa mm dd (ano mês dia) módulo consulta de nota fiscal (v2) recurso productinvoicesv2 operação consulta de nota fiscal eletrônica na sefaz por chave de acesso consulta os dados de uma nf e diretamente na sefaz parâmetros chave de acesso (obrigatório) chave de acesso da nf e operação consulta pdf de nota fiscal eletrônica na sefaz por chave de acesso retorna o danfe em pdf da nota parâmetros chave de acesso (obrigatório) operação consulta xml de nota fiscal eletrônica na sefaz por chave de acesso retorna o xml da nota parâmetros chave de acesso (obrigatório) operação consulta de eventos da nota fiscal eletrônica na sefaz por chave de acesso retorna os eventos associados à nota (cancelamento, carta de correção etc ) parâmetros chave de acesso (obrigatório) módulo consulta de nota fiscal de consumidor (v1) recurso consulta de nota fiscal de consumidor operação consulta de cupom fiscal eletrônico por chave de acesso consulta os dados de uma nfc e (cupom fiscal) por chave de acesso parâmetros chave de acesso (obrigatório) operação consulta xml de cupom fiscal eletrônico por chave de acesso retorna o xml do cupom parâmetros chave de acesso (obrigatório) módulo consulta de cnpj (v2) recurso legalentities operação consulta de dados do cnpj retorna dados cadastrais básicos de uma empresa parâmetros cnpj (obrigatório) operação consulta de inscrição estadual por cnpj retorna a inscrição estadual de uma empresa em um estado específico parâmetros cnpj (obrigatório) estado (obrigatório) sigla de uf — ac, al, am, ap, ba, ce, df, es, go, ma, mg, ms, mt, pa, pb, pe, pi, pr, rj, rn, ro, rr, rs, sc, se, sp, to, ex, na operação consulta de inscrição estadual por cnpj para avaliação de emissão de nota fiscal de produto mesma consulta acima, mas com validação voltada à emissão de nf e (indica se a ie está apta a emitir) parâmetros cnpj (obrigatório) estado (obrigatório) mesmas siglas de uf operação consulta de ie por cnpj caso existir mais de uma habilitada sugere a inscrição estadual mais adequada quando a empresa possui mais de uma ie habilitada no estado parâmetros cnpj (obrigatório) estado (obrigatório) mesmas siglas de uf módulo consulta de endereço recurso addresses operação consulta de nota fiscal eletrônica na sefaz por chave de acesso (nome exibido para esta operação — na prática, ela consulta um endereço pelo cep informado) retorna os dados de um endereço a partir do cep parâmetros código do cep (obrigatório) operação pesquisa de endereço por campos pesquisa endereços a partir de um termo de busca parâmetros pesquisa (obrigatório) termo genérico de pesquisa operação pesquisa de endereço por termo genérico pesquisa endereços a partir de um termo livre parâmetros termo genérico de pesquisa (obrigatório) módulo nota fiscal (v2) módulo principal do conector, com emissão e gestão completa de documentos fiscais recurso companies operação consultar todas as empresas da conta lista as empresas cadastradas na conta parâmetros id de início do contador (não obrigatório) padrão vazio id final do contador (não obrigatório) padrão vazio limite de resultados na página (não obrigatório) padrão 10 operação criar empresa cadastra uma nova empresa emissora parâmetros — preencha por template ou campos dinâmicos dados da empresa (obrigatório) razão social (obrigatório) id da conta (não obrigatório) nome fantasia (obrigatório) cnpj (obrigatório) regime tributário (não obrigatório) isento, microempreendedorindividual, simplesnacional, lucropresumido, lucroreal ou none endereço (obrigatório) logradouro, número (use "s/n" quando não houver número), bairro, complemento (opcional), cidade (código do município e nome), estado (sigla), cep, país — todos obrigatórios, exceto complemento operação consultar uma empresa pelo id parâmetros id da empresa (obrigatório) operação alterar uma empresa pelo id parâmetros id da empresa (obrigatório) demais campos mesma estrutura da operação "criar empresa" operação excluir uma empresa por id parâmetros id da empresa (obrigatório) recurso companies certificates operação consultar um certificado por seu status parâmetros id da empresa (obrigatório) status do certificado (não obrigatório) inactive, overdue, pending, active ou none operação upload de um certificado envia o certificado digital a1 da empresa parâmetros id da empresa (obrigatório) dados do certificado (obrigatório) senha (obrigatório) e arquivo do certificado em base64 (obrigatório) operação consultar um certificado por sua impressão digital parâmetros id da empresa (obrigatório) impressão digital do certificado informe para identificar o certificado desejado operação excluir um certificado por sua impressão digital parâmetros id da empresa (obrigatório) impressão digital do certificado informe para identificar o certificado a ser excluído recurso companies state taxes operação listar as inscrições estaduais parâmetros id da empresa (obrigatório) id de início do contador (não obrigatório) id final do contador (não obrigatório) limite de resultados na página (não obrigatório) padrão 10 operação criar uma inscrição estadual parâmetros id da empresa (obrigatório) dados do imposto estadual (obrigatório) estado (obrigatório, sigla da uf), ambiente (obrigatório none, production ou test), inscrição estadual (obrigatório), tipo de emissão (não obrigatório default, nfe ou nfce) operação consultar uma inscrição estadual pelo id parâmetros id da empresa (obrigatório) id da inscrição estadual (obrigatório) operação alterar uma inscrição estadual pelo id parâmetros id da empresa (obrigatório) id da inscrição estadual (obrigatório) operação excluir uma inscrição estadual pelo id parâmetros id da empresa (obrigatório) id da inscrição estadual (obrigatório) recurso consumer invoices (nfc e) operação listar as notas fiscais eletrônicas (nfce) parâmetros id da empresa (obrigatório) ambiente das notas (não obrigatório) production, test ou none id de início do contador (não obrigatório) id final do contador (não obrigatório) buscar por parâmetros (não obrigatório) pesquisa livre, ex buyer name 'empresa ltda' limite de resultados na página (não obrigatório) padrão 10 operação emitir uma nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) operação emitir uma nota fiscal de consumidor eletrônica (nfce) de forma síncrona parâmetros id da empresa (obrigatório) operação consultar por id uma nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) operação cancelar uma nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) operação consultar os produtos por id uma nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) id de início do contador (não obrigatório) padrão 0 limite de resultados na página (não obrigatório) padrão 10 operação consultar pdf do documento auxiliar da nota fiscal de consumidor eletrônica (danfe nfc e) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) operação consultar xml da nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) operação consultar xml de rejeição da nota fiscal de consumidor eletrônica (nfce) parâmetros id da empresa (obrigatório) id da nfc e (obrigatório) operação inutilizar números de nota fiscal parâmetros id da empresa (obrigatório) recurso product invoices (nf e) operação listar as notas fiscais eletrônicas (nfe) parâmetros id da empresa (obrigatório) ambiente das notas (obrigatório) production, test ou none id de início do contador (não obrigatório) id final do contador (não obrigatório) buscar por parâmetros (não obrigatório) pesquisa livre limite de resultados na página (não obrigatório) padrão 10 operação emitir uma nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) dados da nota fiscal (obrigatório) número (obrigatório), série (obrigatório), inscrição estadual (obrigatório), cliente (obrigatório nome, cpf/cnpj, endereço completo), itens (obrigatório — para cada item descrição, quantidade, valor unitário e ncm, todos obrigatórios), pagamentos (obrigatório — para cada pagamento tipo — dinheiro, cartão de crédito, cartão de débito, boleto, pix, transferência ou outros — e valor, ambos obrigatórios) operação consultar por id uma nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação cancelar uma nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação consultar os produtos por id uma nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) id de início do contador (não obrigatório) padrão 0 limite de resultados na página (não obrigatório) padrão 10 operação consultar eventos por id uma nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) id de início do contador (não obrigatório) padrão 0 limite de resultados na página (não obrigatório) padrão 10 operação consultar pdf do documento auxiliar da nota fiscal eletrônica (danfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação consultar xml da nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação consultar xml de rejeição da nota fiscal eletrônica (nfe) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação consultar xml da autorização em contingência (epec) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação enviar uma carta de correção para nota fiscal eletrônica (cc e) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) dados da carta de correção (obrigatório) motivo (obrigatório) operação consultar pdf do documento auxiliar da nota fiscal eletrônica (danfe) de carta de correção (cc e) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação consultar xml da carta de correção eletrônica (cc e) parâmetros id da empresa (obrigatório) id da nf e (obrigatório) operação inutilizar números de nota fiscal parâmetros id da empresa (obrigatório) id da nf e (obrigatório) dados da inutilização (obrigatório) motivo (obrigatório) operação inutilizar uma nota fiscal eletrônica (nfe) inutiliza uma faixa de numeração de notas parâmetros id da empresa (obrigatório) dados da inutilização (obrigatório) série (obrigatório), número inicial (obrigatório), número final (obrigatório), motivo (obrigatório) operação emitir uma nota fiscal eletrônica (nfe) informando um statetaxid parâmetros id da empresa (obrigatório) inscrição estadual (obrigatório) dados da nota fiscal (obrigatório) número, série, cliente (nome, cpf/cnpj, endereço), itens (descrição, quantidade, valor unitário, ncm), pagamentos (tipo, valor) — mesma estrutura da emissão padrão, mas sem repetir a inscrição estadual (já informada acima) recurso inbound operação obter os detalhes de um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) operação obter o xml de um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) operação obter o pdf de um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) operação obter os detalhes de um evento referente a um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) id do evento (obrigatório) operação obter o xml de um evento referente a um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) id do evento (obrigatório) operação enviar o evento de ciência da operação pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) tipo do evento (não obrigatório) valor padrão 210210 ("ciência da operação") recurso transportation invoices (ct e) operação ativar busca automática de documentos e eventos relacionados a conhecimento de transporte eletrônico (ct e) parâmetros id da empresa (obrigatório) operação inativar busca automática de documentos e eventos relacionados a conhecimento de transporte eletrônico (ct e) parâmetros id da empresa (obrigatório) operação reprocessar uma lista de nsu parâmetros id da empresa (obrigatório) operação reprocessar o lote pelo nsu parâmetros id da empresa (obrigatório) recurso inbound product invoices (nf e) operação ativar busca automática de documentos e eventos relacionados a nota fiscal eletrônica (nf e) parâmetros id da empresa (obrigatório) operação desativar busca automática de documentos e eventos relacionados a nota fiscal eletrônica (nf e) parâmetros id da empresa (obrigatório) operação obter detalhes da parametrização do serviço de distribuição (nf e) parâmetros id da empresa (obrigatório) operação obter os detalhes de uma nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) operação obter o json de uma nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) operação obter os detalhes de um evento referente a um ct e ou nf e pela chave de acesso de 44 dígitos parâmetros id da empresa (obrigatório) chave de acesso (obrigatório) id do evento (obrigatório) operação reprocessar o webhook pela chave de acesso de 44 dígitos ou pelo nsu parâmetros id da empresa (obrigatório) chave de acesso ou nsu (obrigatório) recurso webhooks operação listar os tipos de eventos gerados pela plataforma sem parâmetros operação listar os webhooks sem parâmetros operação criar um webhook parâmetros dados do webhook (obrigatório) url que receberá as notificações (obrigatório), eventos a notificar (obrigatório — escolha entre nota criada, nota atualizada, nota cancelada, erro na nota) operação excluir todos os webhooks existentes sem parâmetros operação consultar um webhook existente parâmetros id do webhook (obrigatório) operação alterar um webhook existente parâmetros id do webhook (obrigatório) demais campos mesma estrutura da operação "criar um webhook" operação excluir um webhook existente parâmetros id do webhook (obrigatório) operação criar notificação para testar um webhook parâmetros id do webhook (obrigatório) dados do teste (obrigatório) mensagem (obrigatório) módulo cálculo de impostos (v1) recurso códigos auxiliares operação listar códigos de operação parâmetros índice da página (não obrigatório) padrão 1 número de itens (não obrigatório) padrão 50 operação listar finalidades de aquisição parâmetros índice da página (não obrigatório) padrão 1 número de itens (não obrigatório) padrão 50 operação listar perfis fiscais do emissor parâmetros índice da página (não obrigatório) padrão 1 número de itens (não obrigatório) padrão 50 operação listar perfis fiscais do destinatário parâmetros índice da página (não obrigatório) padrão 1 número de itens (não obrigatório) padrão 50 recurso motor de cálculo operação calcula os impostos de uma operação parâmetros identificador da conta (obrigatório) módulo nota fiscal (v1) módulo de nota fiscal de serviço (nfs e), mantido em paralelo ao módulo "nota fiscal (v2)" recurso companies operação consultar todas as empresas da conta parâmetros itens por página (não obrigatório) número da página (não obrigatório) operação criar uma empresa sem parâmetros adicionais além dos dados da empresa operação obter os detalhes de uma empresa parâmetros id da empresa ou cnpj (obrigatório) operação alterar uma empresa pelo id parâmetros id da empresa (obrigatório) operação excluir uma empresa por id parâmetros id da empresa (obrigatório) recurso service invoices (nfs e) operação listar as notas fiscais de serviço (nfse) parâmetros id da empresa (obrigatório) operação emitir nota fiscal parâmetros id da empresa (obrigatório) operação obter os detalhes de uma nota fiscal de serviço (nfse) parâmetros id da empresa (obrigatório) id da nota fiscal (obrigatório) operação cancelar nota fiscal parâmetros id da empresa (obrigatório) id da nota fiscal de serviço (nfse) (obrigatório) operação enviar email para o tomador com a nota fiscal de serviço (nfse) parâmetros id da empresa (obrigatório) id da nota fiscal de serviço (nfse) (obrigatório) operação download do pdf da nota fiscal de serviço (nfse) parâmetros id da empresa (obrigatório) id da nota fiscal de serviço (nfse) (obrigatório) operação download do xml da nota fiscal de serviço (nfse) parâmetros id da empresa (obrigatório) id da nota fiscal de serviço (nfse) (obrigatório) recurso companies notifications operação listar as notificações de uma empresa parâmetros id da empresa (obrigatório) operação consultar uma notificação existente parâmetros id da empresa (obrigatório) id da notificação (obrigatório) operação excluir uma notificação parâmetros id da empresa (obrigatório) id da notificação (obrigatório) operação criar notificação via email da nota fiscal de serviço (nfse) parâmetros id da empresa (obrigatório) recurso eventtypes operação listar os tipos de eventos gerados pela plataforma sem parâmetros recurso legal people operação listar as pessoas jurídicas ativas parâmetros id da empresa (obrigatório) operação obter os detalhes de uma pessoa jurídica parâmetros id da empresa (obrigatório) id da pessoa jurídica (obrigatório) recurso natural people operação listar as pessoas físicas ativas parâmetros id da empresa (obrigatório) operação obter os detalhes de uma pessoa física parâmetros id da empresa (obrigatório) id da pessoa física (obrigatório) recurso webhooks mesma cobertura funcional do recurso webhooks do módulo "nota fiscal (v2)" — listar tipos de evento, listar/criar/consultar/alterar/excluir webhooks e testar via ping os webhooks configurados aqui são os mesmos exibidos no módulo "nota fiscal (v2)" — não é necessário configurar webhooks separados por módulo conclusão o conector nfe io na plataforma fluid permite consultar dados cadastrais (cpf, cnpj, inscrição estadual, endereço), consultar notas fiscais e cupons fiscais publicamente por chave de acesso, e — através do módulo "nota fiscal (v2)" — emitir e gerenciar o ciclo completo de nf e, nfc e, ct e recebidos de terceiros e nfs e, além de configurar webhooks para acompanhar eventos fiscais em tempo real por reunir várias funcionalidades da nfe io sob um único conector, escolha o módulo correto antes de configurar o recurso e a operação — a mesma conexão (api key) serve para todos eles última atualização 20 de agosto de 2026
