br.com.brasilnfe/fiscal

REMOTE · API.BRASILNFE.COM.BR · SCANNED AUG 3

Brazilian fiscal MCP server - issue NF-e, NFC-e, NFS-e, CT-e, MDF-e and DC-e via SEFAZ.

Available components

+5 this week 66 66 Trust /100

Trust breakdown (6 categories)

How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. How we score →

Endpoint Security63

The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
Authorisation not fully verified: this server exposes a tool marked destructive (evento_cancelar) and its handshake is open, but we could not confirm whether a tool call is gated, so we do not assert it is callable unauthenticated. View diagnostics → Unverified
HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
The HSTS (Strict-Transport-Security) header is present. View diagnostics → Pass
DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail

Transport & Reachability100

Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass

Schema Quality & AI Usability66

100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Pass
AI-judged instruction clarity (good).Pass
Context-footprint check failed: tool/resource definitions use about 9571 tokens (~273/item across 35 items; 34 tools + 1 resources), over budget; trim descriptions and params. See how to fix → Fail
Usage-examples check failed: none of the tools include examples. See how to fix → Fail

Stability & Change Management27

Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial

Tool Coverage85

100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
47% of tool parameters carry a description.Partial
Structured output schemas are declared (85% of tools); any adoption earns full credit.Pass

Capabilities100

Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass

Install

Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.

remote · api.brasilnfe.com.br

Claude Codex opencode OpenClaw Hermes Other

# add to Claude Code

claude mcp add --transport http br-com-brasilnfe-fiscal https://api.brasilnfe.com.br/services/Mcp

# ~/.codex/config.toml

[mcp_servers.br-com-brasilnfe-fiscal]
url = "https://api.brasilnfe.com.br/services/Mcp"

// opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "br-com-brasilnfe-fiscal": {
      "type": "remote",
      "url": "https://api.brasilnfe.com.br/services/Mcp",
      "enabled": true
    }
  }
}

# add to OpenClaw

openclaw mcp add br-com-brasilnfe-fiscal --url https://api.brasilnfe.com.br/services/Mcp --transport streamable-http

# ~/.hermes/config.yaml

mcp_servers:
  br-com-brasilnfe-fiscal:
    url: "https://api.brasilnfe.com.br/services/Mcp"

// mcp.json

{
  "mcpServers": {
    "br-com-brasilnfe-fiscal": {
      "type": "http",
      "url": "https://api.brasilnfe.com.br/services/Mcp"
    }
  }
}

The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.

Changelog

Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.

3 Aug 26 +1

No change was recorded against any check on this day. Stability & Change Management went from 23 to 27. That category is still filling its 30-day observation window: 7 days of observed history at the previous scan, 8 at this one. The score rises as the window fills, whether or not the server changes.
1 Aug 26 +1

No change was recorded against any check on this day. Stability & Change Management went from 17 to 20. That category is still filling its 30-day observation window: 5 days of observed history at the previous scan, 6 at this one. The score rises as the window fills, whether or not the server changes.
31 Jul 26 +1
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
29 Jul 26 +1

No change was recorded against any check on this day. Stability & Change Management went from 7 to 10. That category is still filling its 30-day observation window: 2 days of observed history at the previous scan, 3 at this one. The score rises as the window fills, whether or not the server changes.
28 Jul 26 +1

No change was recorded against any check on this day. Stability & Change Management went from 3 to 7. That category is still filling its 30-day observation window: 1 days of observed history at the previous scan, 2 at this one. The score rises as the window fills, whether or not the server changes.
27 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
26 Jul 26 61

First indexed and scored.

Show 6 earlier entries Hide earlier entries

Diagnostics

Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.

Captured 3 Aug 2026 · Probed https://api.brasilnfe.com.br/services/Mcp

TLS valid

Negotiated TLS 1.2 with TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 .

Subject	Issuer	Valid from	Valid until	Key	Signature	Serial
CN=api.brasilnfe.com.br	CN=R13,O=Let's Encrypt,C=US	19 May 2026	17 Aug 2026	RSA 3072	SHA256-RSA	52ef002026ec8a44e6101c375e6637a630b
SANs: api.brasilnfe.com.br
CN=R13,O=Let's Encrypt,C=US (CA)	CN=ISRG Root X1,O=Internet Security Research Group,C=US	13 Mar 2024	12 Mar 2027	RSA 2048	SHA256-RSA	5a00f212d8d4b480f3924157ea298305

DNSSEC insecure

Validation of api.brasilnfe.com.br. — Not signed

Zone	DS	Keys	Algorithms	Outcome
.	trust_anchor	20326, 38696	8, 8	Verified
br.	present	38298	13	Verified
com.br.	present	18646	13	Verified
brasilnfe.com.br.	absent			Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation

Authentication No authorisation required

The endpoint answered without asking for a token. Anyone who knows the URL can reach it.

Result	No authorisation required
HTTP status	200

Header	Value
strict-transport-security	max-age=2592000

Transports 2 probes

Transport	URL	Outcome	Status	Location
streamable-http	https://api.brasilnfe.com.br/services/Mcp	Verified	200
http (plaintext)	http://api.brasilnfe.com.br/services/Mcp	HTTPS enforced	307	https://api.brasilnfe.com.br/services/Mcp

MCP tools — 34 exposed · ~9,363 tokens

The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.

Tool Tokens

arquivo_baixar Baixar XML ou PDF do documento ~141

Baixa o arquivo (XML ou PDF/DANFE) de uma NF-e/NFC-e/NFS-e por chave de acesso. Retorna conteúdo em base64.

Input Output Examples

Name	Type	Req	Description
Base64Logo	string\|null	—	—
ChaveNF	string\|null	—	—
Chaves	array\|null	—	—
FileType	integer	—	Tipo do documento fiscal (Padrão 1 - XML) Valores: 1 - XML; 2 - DANFE
TipoDocumentoFiscal	integer	—	Tipo do documento fiscal (Padrão 1 - Saída) Valores: 0 - Entrada; 1 - Saída

No output schema declared.

No examples provided.

arquivo_baixar_evento Baixar XML ou PDF de evento ~160

Baixa o arquivo de um evento (CC-e, cancelamento, manifestação, encerramento) por chave de acesso + número sequencial. Retorna conteúdo em base64.

Input Output Examples

Name	Type	Req	Description
ChaveNF	string\|null	—	Chave de acesso da Nota Fiscal (44 dígitos) à qual o evento está vinculado.
NuProtocolo	string\|null	—	Número do protocolo do evento (somente dígitos). Identifica o evento específico (ex.: Carta de Correção, Cancelamento) registrado para a nota fiscal.
TipoArquivo	integer	—	Tipo do arquivo do evento a ser retornado. Valores: 1 - XML do evento; 2 - PDF da Carta de Correção (CC-e)

No output schema declared.

No examples provided.

arquivo_baixar_periodo Exportar arquivos do período ~357

Exporta múltiplos arquivos (XML/PDF) de um período em um único ZIP base64. Útil para backup, contabilidade ou auditoria.

Input Output Examples

Name	Type	Req	Description
Chaves	array\|null	—	Chaves pagar pegar notas fiscal especificas
DtFim	string	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
DtInicio	string	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
JuntarArquivosPDF	boolean	—	Anexar todas as notas fiscais retornadas em um unico arquivo PDF
Situacoes	array\|null	—	Filtra por situação. Vazio = todas (comportamento padrão). Combinável.
TipoAmbiente	integer	—	Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação
TipoNota	integer	—	Tipo de ambiente (Padrão 1 - Saída) Valores: 1 - Saídas; 2 - Entradas; 3 - Saídas e Entradas
Type	integer	—	Tipo do documento fiscal (Padrão 1 - XML) Valores: 0 - PDF; 1 - XML; 2 - EXCEL
aplicarPlanoAjustes	boolean	—	Aplicar plano de ajustes de impostos
cpfCnpjs	array\|null	—	CPFs ou CNPJs dos clientes das notas
incluirCCe	boolean	—	Incluir carta de correção emitidas no periodo

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64FilesCompacted	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Quantidade	integer	—	—

No examples provided.

cadastro_consultar Consultar Inscrição Estadual (IE) na SEFAZ ~198

Consulta a Inscrição Estadual (IE) de um contribuinte na SEFAZ estadual (mundo NF-e/ICMS), por CNPJ/CPF/IE + UF. ATENÇÃO: muitas UFs NÃO oferecem este serviço (ex: RJ) e prestadores de serviço normalmente NÃO têm IE - nesses casos a IE não vem, e ISSO NÃO SIGNIFICA QUE O CNPJ ESTEJA INATIVO. Quando a SEFAZ não retorna e o documento é CNPJ, há fallback automático na Receita Federal (campo 'fonte'='receita') trazendo razão social, situação cadastral e endereço - sempre leia o campo 'mensagem'. Para apenas saber se um CNPJ está ativo ou pegar seus dados cadastrais (sem precisar da IE), prefira cliente_consultar.

Input Output Examples

Name	Type	Req	Description
cpfCnpjIe	string\|null	—	—
uf	string\|null	—	UF do CPF, CNPJ, IE

Name	Type	Req	Description
Contato	object\|null	—	—
Endereco	object\|null	—	—
cnaePrincipal	string\|null	—	—
cpfCnpj	string\|null	—	—
dataInicioAtividade	string\|null	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
dataOcorrenciaBaixa	string\|null	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
dataUltimaAlteracaoCadastral	string\|null	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
fonte	string\|null	—	Fonte dos dados: "sefaz" (Inscrição Estadual da SEFAZ estadual), "receita" (fallback na Receita Federal quando a UF não oferece a consulta ou o contribuinte não tem IE - comum em prestadores de servi…
ie	string\|null	—	—
ieAtual	string\|null	—	—
ieUnica	string\|null	—	—
indicadorCredenciamentoCTe	integer	—	Indicador de contribuinte credenciado a emitir CT-e. Valores: 0 - Não credenciado para emissão da CT-e;; 1 - Credenciado;; 2 - Credenciado com obrigatoriedade para todas operações;; 3 - Credenciado c…
indicadorCredenciamentoNFe	integer	—	Indicador de contribuinte credenciado a emitir NF-e. Valores: 0 - Não credenciado para emissão da NF-e;; 1 - Credenciado;; 2 - Credenciado com obrigatoriedade para todas operações;; 3 - Credenciado c…
mensagem	string\|null	—	Mensagem explicativa do resultado: por que a IE não veio, qual fonte foi usada, e o aviso de que vazio NÃO significa CNPJ inativo. Fica vazio quando a SEFAZ retornou a Inscrição Estadual normalmente.
nomeFantasia	string\|null	—	—
razaoSocial	string\|null	—	—
regimeApuracao	string\|null	—	—
situacao	integer	—	Situação do contribuinte: 0 - não habilitado; 1 - habilitado.
status	integer	—	Status Consulta Valores: 0 - Não Encontrada;; 1 - Encontrada;
ufConsultada	string\|null	—	—

No examples provided.

cliente_consultar Consultar cliente/destinatario por CNPJ, CPF, IE ou nome ~286

Pesquisa unificada de cliente/fornecedor. Tenta primeiro o cadastro local da empresa logada e, se nao achar e o termo for um CNPJ valido, consulta a BrasilAPI (Receita Federal) - razao social, endereco, situacao cadastral. E a tool CORRETA pra saber se um CNPJ esta ativo e pegar seus dados (razao social, endereco) - nao confunda com cadastro_consultar, que so traz Inscricao Estadual (IE) da SEFAZ. Use ANTES de pedir CNPJ ao usuario; geralmente o usuario informa nome ou apelido (ex: 'TNT', 'Correios'). Obs: consulta na Receita so funciona por CNPJ - CPF nao tem base publica. Para obter a Inscricao Estadual (operacao com ICMS), use cadastro_consultar. PAGINACAO: Limite default 10 (max 50). Use Offset pra ir alem - o retorno traz TotalGeral. Se TotalGeral > matches retornados, peça mais paginas em vez de inventar/agrupar.

Input Output Examples

Name	Type	Req	Description
Fontes	array\|null	—	—
IncluirInativas	boolean	—	—
Limite	integer\|null	—	—
Offset	integer\|null	—	—
Termo	string\|null	—	—
TipoBusca	string\|null	—	—
Uf	string\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	—
ConsultouBrasilApi	boolean	—	—
Limite	integer	—	—
Matches	array\|null	—	—
Offset	integer	—	—
TermoNormalizado	string\|null	—	—
TipoDetectado	string\|null	—	—
TotalGeral	integer	—	—
TotalLocal	integer	—	—

No examples provided.

cliente_criar Cadastrar novo cliente (destinatario/fornecedor/transportadora) ~160

Cadastra um novo Cliente no sistema da empresa logada (CNPJ ou CPF, razao social, endereco, IE). Use depois de cliente_consultar quando o usuario confirmar que quer salvar o cadastro. Se ja existir cliente com mesmo CpfCnpj devolve erro com Id existente - use cliente_editar.

Input Output Examples

Name	Type	Req	Description
ConsumidorFinal	boolean\|null	—	—
CpfCnpj	string	yes	—
Email	string\|null	—	—
Endereco	object\|null	—	—
Id	integer\|null	—	—
Ie	string\|null	—	—
Im	string\|null	—	—
IndicadorIe	integer\|null	—	—
Nome	string	yes	—
Telefone	string\|null	—	—

Name	Type	Req	Description
Cliente	object\|null	—	—
Erro	string\|null	—	—
Id	integer\|null	—	—
Ok	boolean	—	—

No examples provided.

cliente_editar Editar cliente cadastrado ~200

Atualiza dados de um Cliente existente no cadastro. O campo Id e obrigatorio. ATENCAO: envie o payload COMPLETO - campos omitidos sao zerados, nao preservados. Para edicao parcial, faca cliente_consultar primeiro e mande os dados existentes mais o que muda. Valida ownership por UserCreate (cliente tem que pertencer ao usuario logado) e por empresa (IdEmpresa tem que ser a logada, 0 ou null - se for outra empresa sua, troque antes).

Input Output Examples

Name	Type	Req	Description
ConsumidorFinal	boolean\|null	—	—
CpfCnpj	string	yes	—
Email	string\|null	—	—
Endereco	object\|null	—	—
Id	integer\|null	—	—
Ie	string\|null	—	—
Im	string\|null	—	—
IndicadorIe	integer\|null	—	—
Nome	string	yes	—
Telefone	string\|null	—	—

Name	Type	Req	Description
Cliente	object\|null	—	—
Erro	string\|null	—	—
Id	integer\|null	—	—
Ok	boolean	—	—

No examples provided.

cte_desacordo Registrar desacordo de CT-e ~102

Registra desacordo do tomador com um CT-e recebido (evento tipo 4 do CT-e). Prazo: 45 dias da emissão.

Input Output Examples

Name	Type	Req	Description
Chave	string\|null	—	—
NumeroSequencial	integer\|null	—	Número sequencial do evento
Observacao	string\|null	—	—
TipoAmbiente	integer	—	Tipo do Documento Fiscal: Valores: 1 - Produção; 2 - Homologação

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

cte_emitir Emitir CT-e ~653

Emite CT-e (Conhecimento de Transporte Eletrônico). Requer serviço CT-e habilitado no cadastro da empresa e certificado digital A1 ou A3 configurado.

Input Output Examples

Name	Type	Req	Description
Carga	object	yes	Dados da carga transportada (produto predominante, lista de detalhes, documentos fiscais que acompanham). OBRIGATÓRIO. Para Tipo de serviço 0/1/2/6/7/8 também exige Carga.Documentos com ao menos 1 NF…
Cfop	integer	yes	CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída.
Codigo	integer\|null	—	—
Destinatario	object\|null	—	—
DtEmissao	string\|null	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
Expedidor	object\|null	—	—
IdentificadorInterno	string\|null	—	—
Imposto	object\|null	—	—
Lote	integer\|null	—	—
Modal	object	yes	Modal de transporte (rodoviário, aéreo, aquaviário, ferroviário, dutoviário, multimodal). OBRIGATÓRIO. Tipo: 1=Rodoviário, 2=Aéreo, 3=Aquaviário, 4=Ferroviário, 5=Dutoviário, 6=Multimodal.
ModeloDocumento	integer	yes	Modelo do Conhecimento de Transporte Eletrônico. Valores: 57 - CT-e (Conhecimento de Transporte Eletrônico); 67 - CT-e OS (Outros Serviços de transporte)
NaturezaOperacao	string	yes	Descrição da natureza da operação (ex: "Prestação de serviço de transporte").
Numero	integer\|null	—	—
Observacao	string\|null	—	—
Remetente	object\|null	—	—
Retira	boolean	—	—
Serie	integer\|null	—	—
Servico	object	yes	Dados do serviço prestado (Tipo, CodMunicipioInicio, CodMunicipioFim com 7 dígitos cada, MunicipioInicio/MunicipioFim, ValorPrestacao > 0, ValorReceber > 0). OBRIGATÓRIO. Tipo: 0=Normal, 1=Subcontrat…
TipoAmbiente	integer	yes	Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal)
TipoCte	integer	yes	Tipo do CT-e. Valores: 0 - CT-e Normal (caso mais comum); 1 - CT-e de Complemento de Valores; 2 - CT-e de Anulação; 3 - CT-e Substituto
Tomador	object\|null	—	—

Name	Type	Req	Description
avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.
base64DACTe	string\|null	—	—
base64Xml	string\|null	—	—
chave	string\|null	—	—
erros	array\|null	—	Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
numero	integer	—	—
serie	integer	—	—
status	integer	—	Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).
tipoAmbiente	string\|null	—	—

No examples provided.

dce_emitir Emitir DC-e ~695

Emite DC-e (Declaração de Conteúdo Eletrônica) para transporte de itens não-fiscais por pessoa física ou MEI. Requer serviço DC-e habilitado no cadastro.

Input Output Examples

Name	Type	Req	Description
CnpjTransportadora	string\|null	—	CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora.
Codigo	integer\|null	—	—
DeclaracaoContribuinteICMS	string	yes	Texto da declaração de contribuinte ICMS (xObs1). OBRIGATÓRIO, até 2000 caracteres. Texto padrão sugerido: "Declaro, sob as penas da lei, que não sou contribuinte do ICMS."
DeclaracaoCrimeTributario	string	yes	Texto da declaração de crime tributário (xObs2). OBRIGATÓRIO, até 5000 caracteres. Texto padrão sugerido: "Declaro, sob as penas da lei, que o conteúdo desta declaração é verdadeiro e que não estou c…
Destinatario	object	yes	Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo.
IdentificadorInterno	string\|null	—	—
InformacoesAdicionaisFisco	string\|null	—	Informações adicionais de interesse do fisco (opcional, até 2000 caracteres).
InformacoesComplementares	string\|null	—	Informações complementares (opcional, até 5000 caracteres).
Itens	array	yes	Itens/produtos declarados no conteúdo (mínimo 1, máximo 999). Cada item exige Descricao (até 120 chars) e ValorTotal > 0. NCM opcional (2 ou 8 dígitos quando informado).
Lote	integer\|null	—	—
ModalidadeTransporte	integer	—	Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora
Numero	integer\|null	—	—
Remetente	object	yes	Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe).
Serie	integer\|null	—	—
SiteMarketplace	string\|null	—	URL do site do marketplace (obrigatório quando TipoEmitente=1)
TipoAmbiente	integer	yes	Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste)
TipoEmitente	integer	—	Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios)
UfFisco	string\|null	—	Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora.
ValorTotal	number\|null	—	Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0.
XOrgaoFisco	string\|null	—	Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0)

Name	Type	Req	Description
avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.
base64DACE	string\|null	—	—
base64Xml	string\|null	—	—
chave	string\|null	—	—
erros	array\|null	—	Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
numero	integer	—	—
protocolo	string\|null	—	—
serie	integer	—	—
status	integer	—	Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).
tipoAmbiente	string\|null	—	—

No examples provided.

evento_cancelar Cancelar documento fiscal ~608

Cancela um documento fiscal autorizado (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e). Informe a chave de 44 dígitos e a justificativa (mínimo 15 caracteres). Para NFS-e use TipoDocumento=1 e informe NumeroNFSe ao invés de chave. Prazo SEFAZ NF-e: 24h após autorização (algumas UFs mais).

Input Output Examples

Name	Type	Req	Description
ChaveNF	string	yes	Chave de acesso de 44 dígitos da NF-e/NFC-e/CT-e/MDF-e/DC-e a cancelar. Obrigatório quando TipoDocumento = 0 (documentos NFe-family). Para NFS-e (TipoDocumento = 1) use NumeroNFSe.
CodCancelamentoNFSe	integer	—	Código do motivo de cancelamento da NFS-e (Padrão 1) Valores: 1 - Erro na emissão; 2 - Serviço não prestado; 3 - Duplicidade da nota; 9 - Outros
CpfCnpjRemetenteDCe	string\|null	—	CPF ou CNPJ do Usuário Emitente (Remetente) da DC-e original. Obrigatório no cancelamento de DC-e quando a nota não está cadastrada no sistema (caso esteja, o valor é lido da própria NotaFiscal).
DataEvento	string\|null	—	Data do evento de cancelamento do documento (Caso não for enviado é considerada a data e hora atual)
Justificativa	string	yes	Motivo do cancelamento. MÍNIMO 15 caracteres, MÁXIMO 1000. NÃO use texto genérico como "cancelamento" ou "erro" - descreva o motivo real (ex: "Erro no valor unitário do produto X"). Obrigatório para…
NumeroNFSe	string\|null	—	Número da NFS-e a ser cancelada
NumeroProtocolo	string\|null	—	Número do protocolo de autorização original do documento (obrigatório quando a nota foi emitida por OUTRO sistema externo). Se o documento foi emitido pelo próprio BrasilNFe, o protocolo é localizado…
NumeroSequencial	integer\|null	—	Número sequencial do evento
TipoAmbiente	integer	yes	Ambiente do documento original (DEVE bater com o ambiente onde a nota foi emitida). IMPORTANTE: passe explicitamente. Se a nota foi emitida em homologação (testes), use 2. Valores: 1 - Produção; 2 -…
TipoDocumento	integer	yes	Tipo do documento fiscal a cancelar. Valores: 0 - NF-e, NFC-e, CT-e, MDF-e, DC-e (usa ChaveNF de 44 dígitos); 1 - NFS-e (usa NumeroNFSe + CodCancelamentoNFSe + TipoAmbiente)

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

evento_carta_correcao Enviar Carta de Correção (CC-e) ~340

Envia Carta de Correção (CC-e) para uma NF-e ou CT-e já autorizada (evento tipo 2). Não pode corrigir: valores, datas de emissão/saída, partes envolvidas (CNPJ/CPF), regimes tributários ou número/série do documento. Limite: 20 CC-e por NF-e.

Input Output Examples

Name	Type	Req	Description
ChaveNF	string	yes	Chave de acesso de 44 dígitos da NF-e ou CT-e a corrigir.
Correcao	string\|null	—	Texto da correção (mínimo 15, máximo 1000 caracteres). Obrigatório para NF-e (modelo 55). Não pode corrigir variáveis que afetam tributos (valores, quantidades, base de cálculo, alíquotas) nem dados…
Correcoes	array\|null	—	Lista de correções estruturadas (campo, grupo, valor). Usado SOMENTE para CT-e (modelo 57). Para NF-e/NFC-e use o campo Correcao acima.
NumeroSequencial	integer\|null	—	Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível.
TipoAmbiente	integer	yes	Ambiente do documento original (DEVE bater com o ambiente onde a nota foi emitida). IMPORTANTE: passe explicitamente. Se a nota foi emitida em homologação, use 2. Valores: 1 - Produção; 2 - Homologaç…

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

evento_inutilizar Inutilizar numeração ~276

Inutiliza uma faixa de numeração não utilizada na SEFAZ. Útil quando há quebra de sequência por erro de emissão. Não pode ser desfeito. Operação rara - confirme com o usuário antes.

Input Output Examples

Name	Type	Req	Description
Justificativa	string	yes	Justificativa da inutilização. Mínimo 15, máximo 255 caracteres. Descreva o motivo real (ex: "Erro de digitação - série pulada por engano no sistema interno").
ModeloDocumento	integer	yes	Código do modelo do Documento Fiscal a inutilizar. Valores: 55 - NF-e; 65 - NFC-e; 57 - CT-e
NumeracaoFinal	integer	yes	Final da faixa numérica a inutilizar. Deve ser >= NumeracaoInicial.
NumeracaoInicial	integer	yes	Início da faixa numérica a inutilizar. Deve ser > 0 e <= NumeracaoFinal.
Serie	integer	yes	Série referente ao modelo do documento. Deve ser > 0.
TipoAmbiente	integer	yes	Identificação do Ambiente. IMPORTANTE: passe explicitamente. Inutilização em produção é IRREVERSÍVEL. Valores: 1 - Produção (faixa fica DEFINITIVAMENTE inutilizada na SEFAZ); 2 - Homologação (teste)

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

evento_manifestar Manifestar destinatário ~276

Registra a manifestação do destinatário sobre uma NF-e. TipoEvento: 0=ciência da operação, 1=confirmação da operação, 2=desconhecimento, 3=operação não realizada.

Input Output Examples

Name	Type	Req	Description
Chave	string	yes	Chave de acesso de 44 dígitos da NF-e a manifestar.
Justificativa	string\|null	—	Justificativa. OBRIGATÓRIA quando TipoManifestacao = 4 (mínimo 15 caracteres). Para outros tipos pode omitir.
NumeroSequencial	integer\|null	—	Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível.
TipoAmbiente	integer	yes	Ambiente do documento original (DEVE bater com o ambiente onde a nota foi emitida). IMPORTANTE: passe explicitamente. Manifestação de NF de prod precisa ser ambiente 1. Valores: 1 - Produção; 2 - Hom…
TipoManifestacao	integer	yes	Tipo da manifestação do destinatário. Valores: 1 - Confirmação da Operação; 2 - Ciência da Operação; 3 - Desconhecimento da Operação; 4 - Operação não Realizada (exige Justificativa com 15+ caractere…

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

fci_gerar Gerar FCI ~114

Gera o arquivo FCI (Ficha de Conteúdo de Importação) requerido para produtos com conteúdo importado em operações interestaduais.

Input Output Examples

Name	Type	Req	Description
Produtos	array\|null	—	Produtos para gerar os registros do arquivo FCI
Transmitir	boolean	—	Quando verdadeiro, além de gerar o arquivo, assina e transmite a mídia via programa TED. Requer certificado e-CNPJ configurado na empresa.
ValidarCodigos	boolean	—	Quando verdadeiro retorna erro caso envie produtos com código repetido

No output schema declared.

No examples provided.

health Health-check ~27

Verifica a saúde da API BrasilNFe (status, timestamp, versão). Não recebe parâmetros.

Input Output Examples

Input schema present but exposes no named parameters.

No output schema declared.

No examples provided.

imposto_calcular Simular cálculo de impostos ~60

Simula o cálculo de impostos (ICMS, PIS, COFINS, IPI, ST) sobre uma lista de produtos sem emitir nota. Útil para precificação.

Input Output Examples

Name	Type	Req	Description
Capacity	integer	—	—
Count	integer	—	—

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Impostos	object\|null	—	—
Total	object\|null	—	—

No examples provided.

mdfe_emitir Emitir MDF-e ~552

Emite MDF-e (Manifesto Eletrônico de Documentos Fiscais), agrupando vários CT-e/NF-e em um único transporte. Obrigatório para transportadores com vários DFs no mesmo veículo.

Input Output Examples

Name	Type	Req	Description
Aereo	object\|null	—	—
Aquaviario	object\|null	—	—
DataEmissao	string\|null	—	Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)
Ferroviario	object\|null	—	—
Rodoviario	object\|null	—	Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1.
carregamentos	array\|null	—	—
codigo	integer\|null	—	—
descarregamentos	array\|null	—	—
identificadorInterno	string\|null	—	—
lote	integer\|null	—	—
modalidade	integer	yes	Modalidade de transporte. Valores: 1 - Rodoviário (exige objeto Rodoviario com placa, condutores e percurso); 2 - Aéreo (exige objeto Aereo); 3 - Aquaviário (exige objeto Aquaviario); 4 - Ferroviário…
numero	integer\|null	—	—
observacao	string\|null	—	—
observacaoFisco	string\|null	—	—
percursoUfs	array\|null	—	—
peso	number	yes	Peso bruto total das mercadorias em KG. DEVE ser > 0.
produtoPredominante	object\|null	—	Produto predominante transportado. Opcional.
seguros	array\|null	—	—
serie	integer\|null	—	—
tipoAmbiente	integer	yes	Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação
tipoEmitente	integer	yes	Tipo de emitente. Valores: 1 - Prestador de Serviço de Transporte (transportadora); 2 - Transportador de carga própria (mais comum - empresa transportando seus próprios produtos)
ufCarregamento	string	yes	UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...).
ufDescarregamento	string	yes	UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...).
valor	number	yes	Valor total das mercadorias transportadas. DEVE ser > 0.

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
base64DAMDFe	string\|null	—	—
base64Xml	string\|null	—	—
chave	string\|null	—	—
codRespostaSefaz	integer	—	—
numero	integer	—	—
status	integer	—	1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote
tipoAmbiente	string\|null	—	—

No examples provided.

mdfe_encerrar Encerrar MDF-e ~193

Encerra um MDF-e já autorizado (evento tipo 3). Obrigatório ao final de cada transporte. Sem encerramento, novos MDF-e podem ser bloqueados pela SEFAZ.

Input Output Examples

Name	Type	Req	Description
chave	string	yes	Chave de acesso de 44 dígitos do MDF-e a encerrar.
numeroSequencial	integer\|null	—	Número sequencial do evento. Se omitido, o sistema usa o próximo disponível.
protocolo	string\|null	—	Protocolo de autorização do MDF-e original. Opcional - se omitido, o sistema localiza pela chave.
tipoAmbiente	integer	yes	Ambiente do MDF-e original (DEVE bater com o ambiente onde o manifesto foi emitido). IMPORTANTE: passe explicitamente. ATENÇÃO: encerramento é DEFINITIVO - revise os dados antes. Valores: 1 - Produçã…

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
CodStatusRespostaSefaz	integer	—	—
DsAmbiente	string\|null	—	—
DsEvento	string\|null	—	—
DsMotivo	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
NuProtocolo	string\|null	—	—
NumeroSequencial	integer	—	—
Status	integer	—	1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento

No examples provided.

nfe_emitir Emitir NF-e ou NFC-e ~1,203

Emite uma NF-e (modelo 55) ou NFC-e (modelo 65) na SEFAZ. Use modeloDocumento=55 para NF-e (B2B com destinatário CPF/CNPJ) ou modeloDocumento=65 para NFC-e (consumidor final). Retorna chave de acesso (44 dígitos), número, protocolo, status e XML/DANFE em base64. Operação síncrona (pode levar 5-30s). Use tipoAmbiente=2 (homologação) para testes.

Input Output Examples

Name	Type	Req	Description
CalcularIBPT	boolean	—	Indica operação com Consumidor final (NFCe de ser 1 Validar!)
Cliente	object\|null	—	Destinatário da nota. OBRIGATÓRIO para NF-e (modelo 55). Para NFC-e (modelo 65) só é obrigatório quando IndicadorPresenca = 4 (entrega a domicílio). Quando informado para NF-e mod 55, exige: CpfCnpj,…
Cobranca	object\|null	—	—
Codigo	string\|null	—	B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.
ConsumidorFinal	boolean	—	Indica operação com Consumidor final (NFCe de ser 1 Validar!)
DataEmissao	string\|null	—	Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)
DataEntradaSaida	string\|null	—	Data e Hora da saída ou de entrada da produto/serviço
Entrega	object\|null	—	—
EnviarEmail	boolean	—	—
Exporta	object\|null	—	—
Finalidade	integer	yes	Finalidade da emissão da NF. Valores: 1 - Normal (caso mais comum); 2 - Complementar (referenciando NF anterior em NFReferencia); 3 - Ajuste; 4 - Devolução; 5 - Nota de crédito; 6 - Nota de débito
IdentificadorInterno	string\|null	—	—
IndicadorPresenca	integer	yes	Indicador de presença do comprador no estabelecimento comercial no momento da operação. Padrão sugerido para NF-e B2B = 9 (operação não presencial, outros). Para NFC-e varejo = 1 (presencial). Valore…
Intermediador	object\|null	—	Dados do intermediador/marketplace (site ou plataforma de terceiros).
Justificativa	string\|null	—	Utilizar quando o tipo de emissão for diferente normal
Lote	integer\|null	—	Lote da Nota Fiscal
ModeloDocumento	integer	yes	Código do modelo do Documento Fiscal. Valores: 55 - NF-e (B2B / com destinatário CPF/CNPJ identificado); 65 - NFC-e (consumidor final / varejo)
NFReferencia	array\|null	—	Notas fiscal de Referência
NaturezaOperacao	string	yes	Descrição da natureza da operação (máx 60 caracteres). Exemplos: "Venda de mercadoria", "Remessa para industrialização", "Devolução de venda".
Numero	integer\|null	—	Número da nota fiscal
Observacao	string\|null	—	—
ObservacaoFisco	string\|null	—	—
Pagamentos	array\|null	—	Formas de pagamento. OBRIGATÓRIO quando Finalidade = 1 (Normal). Para finalidades 2/3/4/5/6 pode ficar vazio. Para NFC-e (mod 65) deve haver pelo menos um pagamento com FormaPagamento diferente de "9…
Produtos	array	yes	Itens da nota fiscal. Mínimo 1 item.
Retencoes	object\|null	—	Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML.
Serie	integer\|null	—	Série da nota Fiscal
TipoAmbiente	integer	yes	Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão REAL, com valor fiscal, irreversível); 2 - Homologação (teste, sem valor fiscal - use durante desenvolvimento e testes)
TpNFCredito	integer\|null	—	Tipo de Nota de Crédito. Obrigatório quando Finalidade = 5. Código SEFAZ: Valores: 1 - Multa e juros; 2 - Apropriação de crédito presumido de IBS sobre saldo devedor na ZFM; 3 - Retorno
TpNFDebito	integer\|null	—	Tipo de Nota de Débito. Obrigatório quando Finalidade = 6. Código SEFAZ: Valores: 1 - Transferência de créditos para Cooperativas; 2 - Anulação de Crédito por Saídas Imunes/Isentas; 3 - Débitos de no…
Transporte	object\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64File	string\|null	—	—
Base64Xml	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
ReturnNF	object\|null	—	—

No examples provided.

nfe_emitir_complementar Emitir NF-e complementar ~290

Emite uma NF-e complementar referenciando uma NF-e já autorizada. Usado para complementar valores, impostos ou itens (finalidade=2). Informe a chave da nota original em NFReferencia.

Input Output Examples

Name	Type	Req	Description
CFOP	integer	—	CFOP
Cliente	object\|null	—	—
Cobranca	object\|null	—	—
Codigo	string\|null	—	Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.
ImpostoComplementar	object\|null	—	—
Lote	integer\|null	—	Lote da Nota Fiscal
NFReferencia	string\|null	—	Notas fiscal de Referência
NaturezaOperacao	string\|null	—	Descrição da Natureza da Operação
Numero	integer\|null	—	Número da nota fiscal
Observacao	string\|null	—	—
ObservacaoFisco	string\|null	—	—
Produtos	array\|null	—	—
Serie	integer\|null	—	Série da nota Fiscal
TipoAmbiente	integer	—	Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação
TipoComplemento	integer	—	Tipo de complemento Valores: 0 - Complementar quantidade ou valor; 1 - Complementar impostos
Transporte	object\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64File	string\|null	—	—
Base64Xml	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
ReturnNF	object\|null	—	—

No examples provided.

nfe_previsualizar Pré-visualizar DANFE ~202

Gera o DANFE em PDF como pré-visualização, sem enviar para a SEFAZ. Útil para conferência visual antes de emitir.

Input Output Examples

Name	Type	Req	Description
Base64Xml	string\|null	—	—
TipoArquivo	integer	—	Tipo do arquivo que deseja pré-visualizar (Padrão - 0) Valores: 0 - XML; 1 - PDF
TipoEnvio	integer	—	Tipo do envio no qual será convertido para o tipo do arquivo informado (Padrão - 0) Valores: 0 - Base64 contendo as informações do XML; 1 - Objeto contendo as informações das notas fiscais
mostrarTarjaPreVisualizacao	boolean	—	Mostrar tarja "SEM VALOR FISCAL - PRÉ-VISUALIZAÇÃO" (Padrão - Verdadeiro) Somente para o tipo de arquivo 1 - PDF
notaFiscal	object\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64File	string\|null	—	—
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Status	boolean	—	—

No examples provided.

nfenercom_emitir Emitir NF-EnerCom ~364

Envia a NF-EnerCom (Nota Fiscal de Energia Comercializada) para autorização na SEFAZ.

Input Output Examples

Name	Type	Req	Description
comunicao	object\|null	—	Informações referente a nota de comunicação e Telecomunicação
dataEmissao	string	yes	Data de emissão do documento. Obrigatória.
destinatario	object	yes	Informações do destinatário (cliente). OBRIGATÓRIO.
energia	object\|null	—	Informações referente a nota de Energia
identificadorInterno	string\|null	—	Código de controle interno unico da venda. Evita duplicidades, caso configurado.
modeloDocumento	integer	yes	Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação
numero	integer\|null	—	Número da nota fiscal. Quando não informado é controlado pelo Painel
produtos	array	yes	Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP.
serie	string\|null	—	Série da nota fiscal. Quando não informado é controlado pelo Painel
situacao	integer	—	Situação do documento (Padrão 4) Valores: 1 - documento fiscal cancelado dentro do mesmo período de apuração;; 2 - documento fiscal emitido em substituição a um documento fiscal cancelado dentro do m…
tipoAmbiente	integer	yes	Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação
valorTotalFatura	number	yes	Valor total da fatura comercial. Deve ser > 0.

Name	Type	Req	Description
avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.
erros	array\|null	—	Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
status	integer	—	Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).

No examples provided.

nfenercom_gerar_arquivo Gerar arquivo NF-EnerCom ~219

Gera o arquivo da Nota Fiscal de Energia (NF-EnerCom). Pré-requisito para nfenercom_emitir.

Input Output Examples

Name	Type	Req	Description
ano	integer\|null	—	Ano de emissão das notas (4 dígitos). Obrigatório quando tipoGeracao = 1.
mes	integer\|null	—	Mês de emissão das notas (1-12). Obrigatório quando tipoGeracao = 1.
notas	array\|null	—	Notas Fiscais de Energia/Comunicação/Telecomunicação a incluir no arquivo. Obrigatório quando tipoGeracao = 2.
tipoAmbiente	integer	yes	Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação
tipoGeracao	integer	yes	Tipo de geração do arquivo. Valores: 1 - Gera o arquivo a partir das notas já emitidas no período (mes + ano informados); 2 - Gera o arquivo a partir da lista de notas informada em "notas"

No output schema declared.

No examples provided.

nfse_consultar Consultar NFS-e ~60

Consulta status e dados de uma NFS-e já enviada por número, série e ambiente.

Input Output Examples

Name	Type	Req	Description
Rps	array\|null	—	Rps para retornar (Se não enviar retorna todos)
codLote	string\|null	—	Código do lote

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64XmlLote	string\|null	—	Dados xml do lote, bytes em base64
CodLote	string\|null	—	Código atrelado ao lote; - Usado para busca de lotes
CodTipoAmbiente	integer	—	Código do ambiente de envio
DataRecebimento	string\|null	—	Data de recebimento do lote;
DsTipoAmbiente	string\|null	—	Descrição do ambiente de envio
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Lote	integer	—	Número do lote enviado;
MunicipioEnvio	string\|null	—	Municipio onde foi enviado
Notas	array\|null	—	—
Protocolo	string\|null	—	Número de protocolo do lote
StatusLote	integer	—	1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote; 4 - Ocorreu um erro ao analisar as informações do lote
TempoRequisicaoPrefeitura	integer	—	Tempo total da transmissão para prefeitura em milisegundos

No examples provided.

nfse_emitir Emitir NFS-e (serviços) ~133

Emite NFS-e (Nota Fiscal de Serviços Eletrônica). Cada município brasileiro tem regras e webservices próprios - confira o município emissor antes. Pode usar Portal Nacional NFS-e ou prefeitura específica conforme cadastro da empresa.

Input Output Examples

Name	Type	Req	Description
Lote	integer\|null	—	—
TipoAmbiente	integer	yes	Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste)
nFSInfo	array	yes	Lista de NFS-e a emitir no lote. Mínimo 1 item.

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Base64XmlLote	string\|null	—	Dados xml do lote, bytes em base64
CodLote	string\|null	—	Código atrelado ao lote; - Usado para busca de lotes
CodTipoAmbiente	integer	—	Código do ambiente de envio
DataRecebimento	string\|null	—	Data de recebimento do lote;
DsTipoAmbiente	string\|null	—	Descrição do ambiente de envio
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Lote	integer	—	Número do lote enviado;
MunicipioEnvio	string\|null	—	Municipio onde foi enviado
Notas	array\|null	—	—
Protocolo	string\|null	—	Número de protocolo do lote
StatusLote	integer	—	1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote; 4 - Ocorreu um erro ao analisar as informações do lote
TempoRequisicaoPrefeitura	integer	—	Tempo total da transmissão para prefeitura em milisegundos

No examples provided.

nota_listar Listar notas fiscais ~127

Lista NF-e/NFC-e/NFS-e emitidas ou recebidas pela empresa em um intervalo de datas. Suporta filtros por chave, número, status e tipo.

Input Output Examples

Name	Type	Req	Description
DtFim	string	—	Data final da busca
DtInicio	string	—	Data inicial da busca
IndentificadorInterno	string\|null	—	Busca notas que possui o código interno informado (somente saídas)
TipoDocumentoFiscal	integer	—	Tipo do documento fiscal (Padrão 0 - Entrada) Valores: 0 - Entradas; 1 - Saídas

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
Notas	array\|null	—	—

No examples provided.

produto_consultar Consultar produto por codigo, NCM, GTIN ou descricao ~145

Pesquisa produto no cadastro da empresa logada. Aceita codigo interno, NCM (8 digitos), GTIN/EAN (8/12/13/14 digitos) ou descricao parcial. Use ANTES de criar produtos novos para evitar duplicatas. PAGINACAO: Limite default 20 (max 50). Use Offset pra ir alem - o retorno traz TotalGeral. Se TotalGeral > matches retornados, peça mais paginas em vez de inventar/agrupar.

Input Output Examples

Name	Type	Req	Description
Limite	integer\|null	—	—
Offset	integer\|null	—	—
Termo	string\|null	—	—
TipoBusca	string\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	—
Limite	integer	—	—
Matches	array\|null	—	—
Offset	integer	—	—
TermoNormalizado	string\|null	—	—
TipoDetectado	string\|null	—	—
TotalGeral	integer	—	—
TotalLocal	integer	—	—

No examples provided.

produto_criar Cadastrar novo produto ~166

Cadastra um novo Produto na empresa logada. Validacao de duplicata por Codigo. NCM aceito com 7 ou 8 digitos (zero-pad automatico). EAN/GTIN validado por digito verificador.

Input Output Examples

Name	Type	Req	Description
Cest	string\|null	—	—
Codigo	string	yes	—
Descricao	string	yes	—
Ean	string\|null	—	—
FatorConversao	number\|null	—	—
Id	integer\|null	—	—
Ncm	string\|null	—	—
QuantidadeEstoque	number\|null	—	—
UnidadeMedidaCompraSigla	string\|null	—	—
UnidadeMedidaVendaSigla	string	yes	—
ValorUnitarioVenda	number	yes	—

Name	Type	Req	Description
Erro	string\|null	—	—
Id	integer\|null	—	—
Ok	boolean	—	—
Produto	object\|null	—	—

No examples provided.

produto_editar Editar produto cadastrado ~207

Atualiza um Produto existente. Id obrigatorio. ATENCAO: envie o payload COMPLETO - campos omitidos sao zerados. Faca produto_consultar antes pra ter os dados atuais, depois envie tudo + o que muda. Valida ownership por UserCreate (produto tem que pertencer ao usuario logado) e por empresa (IdEmpresa tem que ser a logada ou 0 - se for outra empresa sua, troque antes).

Input Output Examples

Name	Type	Req	Description
Cest	string\|null	—	—
Codigo	string	yes	—
Descricao	string	yes	—
Ean	string\|null	—	—
FatorConversao	number\|null	—	—
Id	integer\|null	—	—
Ncm	string\|null	—	—
QuantidadeEstoque	number\|null	—	—
UnidadeMedidaCompraSigla	string\|null	—	—
UnidadeMedidaVendaSigla	string	yes	—
ValorUnitarioVenda	number	yes	—

Name	Type	Req	Description
Erro	string\|null	—	—
Id	integer\|null	—	—
Ok	boolean	—	—
Produto	object\|null	—	—

No examples provided.

sefaz_status Status do serviço SEFAZ ~58

Consulta o status do serviço de autorização da SEFAZ para uma UF e ambiente. Use antes de uma emissão em lote ou quando suspeitar de instabilidade.

Input Output Examples

Name	Type	Req	Description
ModeloDocumento	integer	—	—
TipoAmbiente	integer	—	—

Name	Type	Req	Description
Avisos	array\|null	—	Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.
Error	string\|null	—	Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida.
StatusSefaz	object\|null	—	—

No examples provided.

tributacao_consultar Consultar regras de tributacao ~182

Lista regras de tributacao da empresa (CFOP, CST, aliquotas ICMS/PIS/COFINS/IPI/IBS/CBS). Filtra por Tipo (1=NFe, 2=NFCe, 3=Energia/Comunicacao), CFOP especifico ou termo na descricao. Use antes de criar nota fiscal pra LLM saber quais tributos aplicar. PAGINACAO: Limite default 20 (max 50). Use Offset pra ir alem - o retorno traz TotalGeral. Se TotalGeral > matches retornados, peça mais paginas em vez de inventar/agrupar.

Input Output Examples

Name	Type	Req	Description
Cfop	integer\|null	—	—
Limite	integer\|null	—	—
Offset	integer\|null	—	—
Termo	string\|null	—	—
Tipo	integer\|null	—	—

Name	Type	Req	Description
Avisos	array\|null	—	—
Limite	integer	—	—
Matches	array\|null	—	—
Offset	integer	—	—
Total	integer	—	—
TotalGeral	integer	—	—

No examples provided.

tributacao_criar Cadastrar nova regra de tributacao ~303

Cadastra uma nova regra de tributacao (CFOP + CSTs + aliquotas). Tipo 1=NFe, 2=NFCe, 3=Energia/Comunicacao. CstIbsCbs e obrigatorio (Reforma Tributaria).

Input Output Examples

Name	Type	Req	Description
AliqCbs	number\|null	—	—
AliqCofins	number	—	—
AliqDiferimento	number\|null	—	—
AliqIbsMun	number\|null	—	—
AliqIbsUf	number\|null	—	—
AliqIcms	number	—	—
AliqIpi	number\|null	—	—
AliqPis	number	—	—
AliqReducao	number\|null	—	—
ApiCode	string\|null	—	—
AutoAliq	boolean	—	—
Cfop	integer	yes	—
CodBeneficioFiscal	string\|null	—	—
CstCofins	string\|null	—	—
CstIbsCbs	string\|null	—	—
CstIcms	string\|null	—	—
CstIpi	string\|null	—	—
CstPis	string\|null	—	—
Descricao	string	yes	—
EnquadramentoIpi	string\|null	—	—
Id	integer\|null	—	—
Observacao	string\|null	—	—
Tipo	integer	—	—

Name	Type	Req	Description
Erro	string\|null	—	—
Id	integer\|null	—	—
Ok	boolean	—	—
Tributacao	object\|null	—	—

No examples provided.

On this page

Handy links

Scoring key

80+ high trust
60–79 medium
below 60 low

How we score

Score history · last 30 days

26 Jul 3 Aug

Day	Score
26 Jul	61
27 Jul	61
28 Jul	62
29 Jul	63
30 Jul	63
31 Jul	64
1 Aug	65
2 Aug	65
3 Aug	66