fiscal
Server Details
Brazilian fiscal MCP server - issue NF-e, NFC-e, NFS-e, CT-e, MDF-e and DC-e via SEFAZ.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
Glama MCP Gateway
Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.
Full call logging
Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.
Tool access control
Enable or disable individual tools per connector, so you decide what your agents can and cannot do.
Managed credentials
Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.
Usage analytics
See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.
Tool Definition Quality
Score is being calculated. Check back soon.
Available Tools
34 toolsarquivo_baixarBaixar XML ou PDF do documentoRead-onlyIdempotentInspect
Baixa o arquivo (XML ou PDF/DANFE) de uma NF-e/NFC-e/NFS-e por chave de acesso. Retorna conteúdo em base64.
| Name | Required | Description | Default |
|---|---|---|---|
| Chaves | No | ||
| ChaveNF | No | ||
| FileType | No | Tipo do documento fiscal (Padrão 1 - XML) Valores: 1 - XML; 2 - DANFE | |
| Base64Logo | No | ||
| TipoDocumentoFiscal | No | Tipo do documento fiscal (Padrão 1 - Saída) Valores: 0 - Entrada; 1 - Saída |
arquivo_baixar_eventoBaixar XML ou PDF de eventoRead-onlyIdempotentInspect
Baixa o arquivo de um evento (CC-e, cancelamento, manifestação, encerramento) por chave de acesso + número sequencial. Retorna conteúdo em base64.
| Name | Required | Description | Default |
|---|---|---|---|
| ChaveNF | No | Chave de acesso da Nota Fiscal (44 dígitos) à qual o evento está vinculado. | |
| NuProtocolo | No | 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 | No | Tipo do arquivo do evento a ser retornado. Valores: 1 - XML do evento; 2 - PDF da Carta de Correção (CC-e) |
arquivo_baixar_periodoExportar arquivos do períodoRead-onlyInspect
Exporta múltiplos arquivos (XML/PDF) de um período em um único ZIP base64. Útil para backup, contabilidade ou auditoria.
| Name | Required | Description | Default |
|---|---|---|---|
| Type | No | Tipo do documento fiscal (Padrão 1 - XML) Valores: 0 - PDF; 1 - XML; 2 - EXCEL | |
| DtFim | No | ||
| Chaves | No | Chaves pagar pegar notas fiscal especificas | |
| DtInicio | No | ||
| TipoNota | No | Tipo de ambiente (Padrão 1 - Saída) Valores: 1 - Saídas; 2 - Entradas; 3 - Saídas e Entradas | |
| cpfCnpjs | No | CPFs ou CNPJs dos clientes das notas | |
| incluirCCe | No | Incluir carta de correção emitidas no periodo | |
| TipoAmbiente | No | Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação | |
| JuntarArquivosPDF | No | Anexar todas as notas fiscais retornadas em um unico arquivo PDF | |
| aplicarPlanoAjustes | No | Aplicar plano de ajustes de impostos |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Quantidade | No | |
| Base64FilesCompacted | No |
cadastro_consultarConsultar Inscrição Estadual (IE) na SEFAZRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| uf | No | UF do CPF, CNPJ, IE | |
| cpfCnpjIe | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| ie | No | |
| fonte | No | 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ço) ou "indisponivel". |
| status | No | Status Consulta Valores: 0 - Não Encontrada;; 1 - Encontrada; |
| Contato | No | |
| cpfCnpj | No | |
| ieAtual | No | |
| ieUnica | No | |
| Endereco | No | |
| mensagem | No | 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. |
| situacao | No | Situação do contribuinte: 0 - não habilitado; 1 - habilitado. |
| razaoSocial | No | |
| nomeFantasia | No | |
| ufConsultada | No | |
| cnaePrincipal | No | |
| regimeApuracao | No | |
| dataInicioAtividade | No | |
| dataOcorrenciaBaixa | No | |
| indicadorCredenciamentoCTe | No | 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 com obrigatoriedade parcial;; 4 - a SEFAZ não fornece a informação. Este indicador significa apenas que o contribuinte é credenciado para emitir CT-e na SEFAZ consultada. |
| indicadorCredenciamentoNFe | No | 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 com obrigatoriedade parcial;; 4 - a SEFAZ não fornece a informação. Este indicador significa apenas que o contribuinte é credenciado para emitir NF-e na SEFAZ consultada. |
| dataUltimaAlteracaoCadastral | No |
cliente_consultarConsultar cliente/destinatario por CNPJ, CPF, IE ou nomeRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Uf | No | ||
| Termo | No | ||
| Fontes | No | ||
| Limite | No | ||
| Offset | No | ||
| TipoBusca | No | ||
| IncluirInativas | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Avisos | No | |
| Limite | No | |
| Offset | No | |
| Matches | No | |
| TotalGeral | No | |
| TotalLocal | No | |
| TipoDetectado | No | |
| TermoNormalizado | No | |
| ConsultouBrasilApi | No |
cliente_criarCadastrar novo cliente (destinatario/fornecedor/transportadora)Inspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Ie | No | ||
| Im | No | ||
| Nome | Yes | ||
| No | |||
| CpfCnpj | Yes | ||
| Endereco | No | ||
| Telefone | No | ||
| IndicadorIe | No | ||
| ConsumidorFinal | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Cliente | No |
cliente_editarEditar cliente cadastradoIdempotentInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Ie | No | ||
| Im | No | ||
| Nome | Yes | ||
| No | |||
| CpfCnpj | Yes | ||
| Endereco | No | ||
| Telefone | No | ||
| IndicadorIe | No | ||
| ConsumidorFinal | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Cliente | No |
cte_desacordoRegistrar desacordo de CT-eInspect
Registra desacordo do tomador com um CT-e recebido (evento tipo 4 do CT-e). Prazo: 45 dias da emissão.
| Name | Required | Description | Default |
|---|---|---|---|
| Chave | No | ||
| Observacao | No | ||
| TipoAmbiente | No | Tipo do Documento Fiscal: Valores: 1 - Produção; 2 - Homologação | |
| NumeroSequencial | No | Número sequencial do evento |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
cte_emitirEmitir CT-eInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Cfop | Yes | CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída. | |
| Lote | No | ||
| Carga | 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-e referenciada. | |
| Modal | 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. | |
| Serie | No | ||
| Codigo | No | ||
| Numero | No | ||
| Retira | No | ||
| Imposto | No | ||
| Servico | 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=Subcontratação, 2=Redespacho, 3=RedespachoIntermediario, 4=ServicoVinculadoMultimodal. | |
| TipoCte | 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 | No | ||
| DtEmissao | No | ||
| Expedidor | No | ||
| Remetente | No | ||
| Observacao | No | ||
| Destinatario | No | ||
| TipoAmbiente | Yes | Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal) | |
| ModeloDocumento | 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 | Yes | Descrição da natureza da operação (ex: "Prestação de serviço de transporte"). | |
| IdentificadorInterno | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| chave | No | |
| erros | No | Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao. |
| serie | No | |
| avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso. |
| numero | No | |
| status | No | Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida). |
| base64Xml | No | |
| base64DACTe | No | |
| tipoAmbiente | No |
dce_emitirEmitir DC-eInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Lote | No | ||
| Itens | 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). | |
| Serie | No | ||
| Codigo | No | ||
| Numero | No | ||
| UfFisco | No | Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora. | |
| Remetente | Yes | Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe). | |
| ValorTotal | No | Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0. | |
| XOrgaoFisco | No | Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0) | |
| Destinatario | Yes | Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo. | |
| TipoAmbiente | Yes | Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste) | |
| TipoEmitente | No | Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios) | |
| SiteMarketplace | No | URL do site do marketplace (obrigatório quando TipoEmitente=1) | |
| CnpjTransportadora | No | CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora. | |
| IdentificadorInterno | No | ||
| ModalidadeTransporte | No | Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora | |
| DeclaracaoCrimeTributario | 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 cometendo crime contra a ordem tributária." | |
| InformacoesComplementares | No | Informações complementares (opcional, até 5000 caracteres). | |
| DeclaracaoContribuinteICMS | 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." | |
| InformacoesAdicionaisFisco | No | Informações adicionais de interesse do fisco (opcional, até 2000 caracteres). |
Output Schema
| Name | Required | Description |
|---|---|---|
| chave | No | |
| erros | No | Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao. |
| serie | No | |
| avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso. |
| numero | No | |
| status | No | Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida). |
| base64Xml | No | |
| protocolo | No | |
| base64DACE | No | |
| tipoAmbiente | No |
evento_cancelarCancelar documento fiscalDestructiveInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| ChaveNF | 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. | |
| DataEvento | No | Data do evento de cancelamento do documento (Caso não for enviado é considerada a data e hora atual) | |
| NumeroNFSe | No | Número da NFS-e a ser cancelada | |
| TipoAmbiente | 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 - Homologação | |
| Justificativa | 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 TipoDocumento = 0 (NFe-family). | |
| TipoDocumento | 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) | |
| NumeroProtocolo | No | 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 automaticamente. | |
| NumeroSequencial | No | Número sequencial do evento | |
| CodCancelamentoNFSe | No | 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 | No | 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). |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
evento_carta_correcaoEnviar Carta de Correção (CC-e)Inspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| ChaveNF | Yes | Chave de acesso de 44 dígitos da NF-e ou CT-e a corrigir. | |
| Correcao | No | 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 de remetente/destinatário, nem data de emissão. Para CT-e use a lista Correcoes em vez deste campo. | |
| Correcoes | No | 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. | |
| TipoAmbiente | 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ção | |
| NumeroSequencial | No | Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível. |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
evento_inutilizarInutilizar numeraçãoDestructiveInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Serie | Yes | Série referente ao modelo do documento. Deve ser > 0. | |
| TipoAmbiente | 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) | |
| Justificativa | 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"). | |
| NumeracaoFinal | Yes | Final da faixa numérica a inutilizar. Deve ser >= NumeracaoInicial. | |
| ModeloDocumento | Yes | Código do modelo do Documento Fiscal a inutilizar. Valores: 55 - NF-e; 65 - NFC-e; 57 - CT-e | |
| NumeracaoInicial | Yes | Início da faixa numérica a inutilizar. Deve ser > 0 e <= NumeracaoFinal. |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
evento_manifestarManifestar destinatárioInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Chave | Yes | Chave de acesso de 44 dígitos da NF-e a manifestar. | |
| TipoAmbiente | 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 - Homologação | |
| Justificativa | No | Justificativa. OBRIGATÓRIA quando TipoManifestacao = 4 (mínimo 15 caracteres). Para outros tipos pode omitir. | |
| NumeroSequencial | No | Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível. | |
| TipoManifestacao | 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+ caracteres) |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
fci_gerarGerar FCIInspect
Gera o arquivo FCI (Ficha de Conteúdo de Importação) requerido para produtos com conteúdo importado em operações interestaduais.
| Name | Required | Description | Default |
|---|---|---|---|
| Produtos | No | Produtos para gerar os registros do arquivo FCI | |
| Transmitir | No | Quando verdadeiro, além de gerar o arquivo, assina e transmite a mídia via programa TED. Requer o TED instalado no servidor e certificado e-CNPJ configurado na empresa. | |
| ValidarCodigos | No | Quando verdadeiro retorna erro caso envie produtos com código repetido |
healthHealth-checkRead-onlyIdempotentInspect
Verifica a saúde da API BrasilNFe (status, timestamp, versão). Não recebe parâmetros.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
imposto_calcularSimular cálculo de impostosRead-onlyIdempotentInspect
Simula o cálculo de impostos (ICMS, PIS, COFINS, IPI, ST) sobre uma lista de produtos sem emitir nota. Útil para precificação.
| Name | Required | Description | Default |
|---|---|---|---|
| Count | No | ||
| Capacity | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Total | No | |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Impostos | No |
mdfe_emitirEmitir MDF-eInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| lote | No | ||
| peso | Yes | Peso bruto total das mercadorias em KG. DEVE ser > 0. | |
| Aereo | No | ||
| serie | No | ||
| valor | Yes | Valor total das mercadorias transportadas. DEVE ser > 0. | |
| codigo | No | ||
| numero | No | ||
| seguros | No | ||
| Aquaviario | No | ||
| Rodoviario | No | Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1. | |
| modalidade | 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 (exige objeto Ferroviario) | |
| observacao | No | ||
| DataEmissao | No | ||
| Ferroviario | No | ||
| percursoUfs | No | ||
| tipoAmbiente | Yes | Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação | |
| tipoEmitente | 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) | |
| carregamentos | No | ||
| ufCarregamento | Yes | UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...). | |
| observacaoFisco | No | ||
| descarregamentos | No | ||
| ufDescarregamento | Yes | UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...). | |
| produtoPredominante | No | Produto predominante transportado. Opcional. | |
| identificadorInterno | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| chave | No | |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| numero | No | |
| status | No | 1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote |
| base64Xml | No | |
| base64DAMDFe | No | |
| tipoAmbiente | No | |
| codRespostaSefaz | No |
mdfe_encerrarEncerrar MDF-eInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| chave | Yes | Chave de acesso de 44 dígitos do MDF-e a encerrar. | |
| protocolo | No | Protocolo de autorização do MDF-e original. Opcional - se omitido, o sistema localiza pela chave. | |
| tipoAmbiente | 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ção; 2 - Homologação | |
| numeroSequencial | No | Número sequencial do evento. Se omitido, o sistema usa o próximo disponível. |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | 1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento |
| DsEvento | No | |
| DsMotivo | No | |
| DsAmbiente | No | |
| NuProtocolo | No | |
| NumeroSequencial | No | |
| CodStatusRespostaSefaz | No |
nfe_emitirEmitir NF-e ou NFC-eInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Lote | No | Lote da Nota Fiscal | |
| Serie | No | Série da nota Fiscal | |
| Codigo | No | B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e. | |
| Numero | No | Número da nota fiscal | |
| Cliente | No | 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, NmCliente, IndicadorIe (1/2/9), Endereco com Logradouro e UF (e CEP/Município/Bairro quando não exportação). | |
| Entrega | No | ||
| Exporta | No | ||
| Cobranca | No | ||
| Produtos | Yes | Itens da nota fiscal. Mínimo 1 item. | |
| Retencoes | No | Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML. | |
| Finalidade | 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 | |
| Observacao | No | ||
| Pagamentos | No | Formas de pagamento. OBRIGATÓRIO quando Finalidade = 1 (Normal). Para finalidades 2/3/4 pode ficar vazio. Para NFC-e (mod 65) deve haver pelo menos um pagamento com FormaPagamento diferente de "90" (sem pagamento). | |
| Transporte | No | ||
| DataEmissao | No | Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada) | |
| EnviarEmail | No | ||
| CalcularIBPT | No | Indica operação com Consumidor final (NFCe de ser 1 Validar!) | |
| NFReferencia | No | Notas fiscal de Referência | |
| TipoAmbiente | 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) | |
| Justificativa | No | Utilizar quando o tipo de emissão for diferente normal | |
| ConsumidorFinal | No | Indica operação com Consumidor final (NFCe de ser 1 Validar!) | |
| ModeloDocumento | 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) | |
| ObservacaoFisco | No | ||
| DataEntradaSaida | No | Data e Hora da saída ou de entrada da produto/serviço | |
| NaturezaOperacao | Yes | Descrição da natureza da operação (máx 60 caracteres). Exemplos: "Venda de mercadoria", "Remessa para industrialização", "Devolução de venda". | |
| IndicadorPresenca | 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). Valores: 0 - Não se aplica; 1 - Operação presencial;; 2 - Operação não presencial, pela Internet;; 3 - Operação não presencial, Teleatendimento;; 4 - NFC-e em operação com entrega a domicílio;; 5 - Presencial fora do estabelecimento;; 9 - Operação não presencial, outros. | |
| IdentificadorInterno | No | ||
| IndicadorIntermediador | No | Indicador de intermediador/marketplace |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| ReturnNF | No | |
| Base64Xml | No | |
| Base64File | No |
nfe_emitir_complementarEmitir NF-e complementarInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| CFOP | No | CFOP | |
| Lote | No | Lote da Nota Fiscal | |
| Serie | No | Série da nota Fiscal | |
| Codigo | No | Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e. | |
| Numero | No | Número da nota fiscal | |
| Cliente | No | ||
| Cobranca | No | ||
| Produtos | No | ||
| Observacao | No | ||
| Transporte | No | ||
| NFReferencia | No | Notas fiscal de Referência | |
| TipoAmbiente | No | Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação | |
| ObservacaoFisco | No | ||
| TipoComplemento | No | Tipo de complemento Valores: 0 - Complementar quantidade ou valor; 1 - Complementar impostos | |
| NaturezaOperacao | No | Descrição da Natureza da Operação | |
| ImpostoComplementar | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| ReturnNF | No | |
| Base64Xml | No | |
| Base64File | No |
nfenercom_emitirEmitir NF-EnerComInspect
Envia a NF-EnerCom (Nota Fiscal de Energia Comercializada) para autorização na SEFAZ.
| Name | Required | Description | Default |
|---|---|---|---|
| serie | No | Série da nota fiscal. Quando não informado é controlado pelo Painel | |
| numero | No | Número da nota fiscal. Quando não informado é controlado pelo Painel | |
| energia | No | Informações referente a nota de Energia | |
| produtos | Yes | Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP. | |
| situacao | No | 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 mesmo período de apuração; 3 - documento fiscal complementar; 4 - demais casos | |
| comunicao | No | Informações referente a nota de comunicação e Telecomunicação | |
| dataEmissao | Yes | Data de emissão do documento. Obrigatória. | |
| destinatario | Yes | Informações do destinatário (cliente). OBRIGATÓRIO. | |
| tipoAmbiente | Yes | Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação | |
| modeloDocumento | Yes | Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação | |
| valorTotalFatura | Yes | Valor total da fatura comercial. Deve ser > 0. | |
| identificadorInterno | No | Código de controle interno unico da venda. Evita duplicidades, caso configurado. |
Output Schema
| Name | Required | Description |
|---|---|---|
| erros | No | Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao. |
| avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso. |
| status | No | Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida). |
nfenercom_gerar_arquivoGerar arquivo NF-EnerComInspect
Gera o arquivo da Nota Fiscal de Energia (NF-EnerCom). Pré-requisito para nfenercom_emitir.
| Name | Required | Description | Default |
|---|---|---|---|
| ano | No | Ano de emissão das notas (4 dígitos). Obrigatório quando tipoGeracao = 1. | |
| mes | No | Mês de emissão das notas (1-12). Obrigatório quando tipoGeracao = 1. | |
| notas | No | Notas Fiscais de Energia/Comunicação/Telecomunicação a incluir no arquivo. Obrigatório quando tipoGeracao = 2. | |
| tipoGeracao | 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" | |
| tipoAmbiente | Yes | Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação |
nfe_previsualizarPré-visualizar DANFERead-onlyIdempotentInspect
Gera o DANFE em PDF como pré-visualização, sem enviar para a SEFAZ. Útil para conferência visual antes de emitir.
| Name | Required | Description | Default |
|---|---|---|---|
| Base64Xml | No | ||
| TipoEnvio | No | 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 | |
| notaFiscal | No | ||
| TipoArquivo | No | Tipo do arquivo que deseja pré-visualizar (Padrão - 0) Valores: 0 - XML; 1 - PDF | |
| mostrarTarjaPreVisualizacao | No | Mostrar tarja "SEM VALOR FISCAL - PRÉ-VISUALIZAÇÃO" (Padrão - Verdadeiro) Somente para o tipo de arquivo 1 - PDF |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| Status | No | |
| Base64File | No |
nfse_consultarConsultar NFS-eRead-onlyIdempotentInspect
Consulta status e dados de uma NFS-e já enviada por número, série e ambiente.
| Name | Required | Description | Default |
|---|---|---|---|
| Rps | No | Rps para retornar (Se não enviar retorna todos) | |
| codLote | No | Código do lote |
Output Schema
| Name | Required | Description |
|---|---|---|
| Lote | No | Número do lote enviado; |
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Notas | No | |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| CodLote | No | Código atrelado ao lote; - Usado para busca de lotes |
| Protocolo | No | Número de protocolo do lote |
| StatusLote | No | 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 |
| Base64XmlLote | No | Dados xml do lote, bytes em base64 |
| DsTipoAmbiente | No | Descrição do ambiente de envio |
| MunicipioEnvio | No | Municipio onde foi enviado |
| CodTipoAmbiente | No | Código do ambiente de envio |
| DataRecebimento | No | Data de recebimento do lote; |
| TempoRequisicaoPrefeitura | No | Tempo total da transmissão para prefeitura em milisegundos |
nfse_emitirEmitir NFS-e (serviços)Inspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Lote | No | ||
| nFSInfo | Yes | Lista de NFS-e a emitir no lote. Mínimo 1 item. | |
| TipoAmbiente | Yes | Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste) |
Output Schema
| Name | Required | Description |
|---|---|---|
| Lote | No | Número do lote enviado; |
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Notas | No | |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| CodLote | No | Código atrelado ao lote; - Usado para busca de lotes |
| Protocolo | No | Número de protocolo do lote |
| StatusLote | No | 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 |
| Base64XmlLote | No | Dados xml do lote, bytes em base64 |
| DsTipoAmbiente | No | Descrição do ambiente de envio |
| MunicipioEnvio | No | Municipio onde foi enviado |
| CodTipoAmbiente | No | Código do ambiente de envio |
| DataRecebimento | No | Data de recebimento do lote; |
| TempoRequisicaoPrefeitura | No | Tempo total da transmissão para prefeitura em milisegundos |
nota_listarListar notas fiscaisRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| DtFim | No | Data final da busca | |
| DtInicio | No | Data inicial da busca | |
| TipoDocumentoFiscal | No | Tipo do documento fiscal (Padrão 0 - Entrada) Valores: 0 - Entradas; 1 - Saídas | |
| IndentificadorInterno | No | Busca notas que possui o código interno informado (somente saídas) |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Notas | No | |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
produto_consultarConsultar produto por codigo, NCM, GTIN ou descricaoRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Termo | No | ||
| Limite | No | ||
| Offset | No | ||
| TipoBusca | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Avisos | No | |
| Limite | No | |
| Offset | No | |
| Matches | No | |
| TotalGeral | No | |
| TotalLocal | No | |
| TipoDetectado | No | |
| TermoNormalizado | No |
produto_criarCadastrar novo produtoInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Ean | No | ||
| Ncm | No | ||
| Cest | No | ||
| Codigo | Yes | ||
| Descricao | Yes | ||
| FatorConversao | No | ||
| QuantidadeEstoque | No | ||
| ValorUnitarioVenda | Yes | ||
| UnidadeMedidaVendaSigla | Yes | ||
| UnidadeMedidaCompraSigla | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Produto | No |
produto_editarEditar produto cadastradoIdempotentInspect
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).
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Ean | No | ||
| Ncm | No | ||
| Cest | No | ||
| Codigo | Yes | ||
| Descricao | Yes | ||
| FatorConversao | No | ||
| QuantidadeEstoque | No | ||
| ValorUnitarioVenda | Yes | ||
| UnidadeMedidaVendaSigla | Yes | ||
| UnidadeMedidaCompraSigla | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Produto | No |
sefaz_statusStatus do serviço SEFAZRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| TipoAmbiente | No | ||
| ModeloDocumento | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Error | No | Mensagem de erro da operação. Vazia ("") quando foi bem-sucedida. |
| Avisos | No | Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida. |
| StatusSefaz | No |
tributacao_consultarConsultar regras de tributacaoRead-onlyIdempotentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| Cfop | No | ||
| Tipo | No | ||
| Termo | No | ||
| Limite | No | ||
| Offset | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Total | No | |
| Avisos | No | |
| Limite | No | |
| Offset | No | |
| Matches | No | |
| TotalGeral | No |
tributacao_criarCadastrar nova regra de tributacaoInspect
Cadastra uma nova regra de tributacao (CFOP + CSTs + aliquotas). Tipo 1=NFe, 2=NFCe, 3=Energia/Comunicacao. CstIbsCbs e obrigatorio (Reforma Tributaria).
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Cfop | Yes | ||
| Tipo | No | ||
| CstIpi | No | ||
| CstPis | No | ||
| AliqCbs | No | ||
| AliqIpi | No | ||
| AliqPis | No | ||
| ApiCode | No | ||
| CstIcms | No | ||
| AliqIcms | No | ||
| AutoAliq | No | ||
| AliqIbsUf | No | ||
| CstCofins | No | ||
| CstIbsCbs | No | ||
| Descricao | Yes | ||
| AliqCofins | No | ||
| AliqIbsMun | No | ||
| Observacao | No | ||
| AliqReducao | No | ||
| AliqDiferimento | No | ||
| EnquadramentoIpi | No | ||
| CodBeneficioFiscal | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Tributacao | No |
tributacao_editarEditar regra de tributacaoIdempotentInspect
Atualiza uma regra de tributacao existente. Id obrigatorio. ATENCAO: envie o payload COMPLETO - campos omitidos sao zerados. Faca tributacao_consultar antes pra ter os dados atuais, depois envie tudo + o que muda. Valida ownership por IdEmpresa.
| Name | Required | Description | Default |
|---|---|---|---|
| Id | No | ||
| Cfop | Yes | ||
| Tipo | No | ||
| CstIpi | No | ||
| CstPis | No | ||
| AliqCbs | No | ||
| AliqIpi | No | ||
| AliqPis | No | ||
| ApiCode | No | ||
| CstIcms | No | ||
| AliqIcms | No | ||
| AutoAliq | No | ||
| AliqIbsUf | No | ||
| CstCofins | No | ||
| CstIbsCbs | No | ||
| Descricao | Yes | ||
| AliqCofins | No | ||
| AliqIbsMun | No | ||
| Observacao | No | ||
| AliqReducao | No | ||
| AliqDiferimento | No | ||
| EnquadramentoIpi | No | ||
| CodBeneficioFiscal | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| Id | No | |
| Ok | No | |
| Erro | No | |
| Tributacao | No |
Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [{ "email": "your-email@example.com" }]
}The email address must match the email associated with your Glama account. Once published, Glama will automatically detect and verify the file within a few minutes.
Control your server's listing on Glama, including description and metadata
Access analytics and receive server usage reports
Get monitoring and health status updates for your server
Feature your server to boost visibility and reach more users
For users:
Full audit trail – every tool call is logged with inputs and outputs for compliance and debugging
Granular tool control – enable or disable individual tools per connector to limit what your AI agents can do
Centralized credential management – store and rotate API keys and OAuth tokens in one place
Change alerts – get notified when a connector changes its schema, adds or removes tools, or updates tool definitions, so nothing breaks silently
For server owners:
Proven adoption – public usage metrics on your listing show real-world traction and build trust with prospective users
Tool-level analytics – see which tools are being used most, helping you prioritize development and documentation
Direct user feedback – users can report issues and suggest improvements through the listing, giving you a channel you would not have otherwise
The connector status is unhealthy when Glama is unable to successfully connect to the server. This can happen for several reasons:
The server is experiencing an outage
The URL of the server is wrong
Credentials required to access the server are missing or invalid
If you are the owner of this MCP connector and would like to make modifications to the listing, including providing test credentials for accessing the server, please contact support@glama.ai.
Discussions
No comments yet. Be the first to start the discussion!