{"name":"br.com.brasilnfe/fiscal","slug":"brasilnfe-fiscal","title":null,"description":"Brazilian fiscal MCP server - issue NF-e, NFC-e, NFS-e, CT-e, MDF-e and DC-e via SEFAZ.","url":"https://mcp.market/server/brasilnfe-fiscal","rating":null,"grade":"B","score":81,"certified":false,"status":"active","category":"other","tags":[],"presence":{"score":14,"stars":0,"forks":0,"downloads_week":null,"last_push_at":"2026-06-12T19:57:34.000Z","license":"NOASSERTION"},"uptime":{"percent":100,"checks":28,"ok":28,"last_checked_at":"2026-11-04T03:10:43.602Z","last_ok_at":"2026-11-04T03:10:43.602Z","latency_ms":488},"claimed":false,"transport":"remote","callable_via_gateway":true,"default_price_micros":0,"repository":"https://github.com/BrasilNFe/brasilnfe-mcp","website":"https://www.brasilnfe.com.br/mcp","version":"1.0.0","remotes":[{"type":"streamable-http","url":"https://api.brasilnfe.com.br/services/Mcp","headers":[{"description":"Bearer TOKEN da empresa. Obtenha no painel em https://api.brasilnfe.com.br","name":"Authorization"}]}],"packages":[],"tools":[{"name":"arquivo_baixar","description":"Baixa o arquivo (XML ou PDF/DANFE) de uma NF-e/NFC-e/NFS-e por chave de acesso. Retorna conteúdo em base64.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Chaves":{"type":["array","null"],"items":{"type":"string"}},"ChaveNF":{"type":["string","null"]},"FileType":{"type":"integer","enum":[1,2],"description":"Tipo do documento fiscal (Padrão 1 - XML) Valores: 1 - XML; 2 - DANFE","default":1},"TipoDocumentoFiscal":{"type":"integer","enum":[0,1],"description":"Tipo do documento fiscal (Padrão 1 - Saída) Valores: 0 - Entrada; 1 - Saída","default":1},"Base64Logo":{"type":["string","null"]}},"additionalProperties":false}},{"name":"arquivo_baixar_evento","description":"Baixa o arquivo de um evento (CC-e, cancelamento, manifestação, encerramento) por chave de acesso + número sequencial. Retorna conteúdo em base64.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"ChaveNF":{"type":["string","null"],"description":"Chave de acesso da Nota Fiscal (44 dígitos) à qual o evento está vinculado."},"NuProtocolo":{"type":["string","null"],"description":"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":{"type":"integer","enum":[1,2],"description":"Tipo do arquivo do evento a ser retornado. Valores: 1 - XML do evento; 2 - PDF da Carta de Correção (CC-e)"}},"additionalProperties":false}},{"name":"arquivo_baixar_periodo","description":"Exporta múltiplos arquivos (XML/PDF) de um período em um único ZIP base64. Útil para backup, contabilidade ou auditoria.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"DtInicio":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"DtFim":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Type":{"type":"integer","enum":[0,1,2],"description":"Tipo do documento fiscal (Padrão 1 - XML) Valores: 0 - PDF; 1 - XML; 2 - EXCEL","default":1},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação","default":1},"TipoNota":{"type":"integer","enum":[1,2,3],"description":"Tipo de ambiente (Padrão 1 - Saída) Valores: 1 - Saídas; 2 - Entradas; 3 - Saídas e Entradas","default":1},"Chaves":{"type":["array","null"],"items":{"type":"string"},"description":"Chaves pagar pegar notas fiscal especificas"},"cpfCnpjs":{"type":["array","null"],"items":{"type":"string"},"description":"CPFs ou CNPJs dos clientes das notas"},"JuntarArquivosPDF":{"type":"boolean","description":"Anexar todas as notas fiscais retornadas em um unico arquivo PDF"},"incluirCCe":{"type":"boolean","description":"Incluir carta de correção emitidas no periodo"},"aplicarPlanoAjustes":{"type":"boolean","description":"Aplicar plano de ajustes de impostos","default":true},"Situacoes":{"type":["array","null"],"items":{"type":"integer"},"description":"Filtra por situação. Vazio = todas (comportamento padrão). Combinável."}},"additionalProperties":false}},{"name":"cadastro_consultar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"cpfCnpjIe":{"type":["string","null"]},"uf":{"type":["string","null"],"description":"UF do CPF, CNPJ, IE"}},"additionalProperties":false}},{"name":"cliente_consultar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Termo":{"type":["string","null"]},"Uf":{"type":["string","null"]},"TipoBusca":{"type":["string","null"]},"IncluirInativas":{"type":"boolean"},"Fontes":{"type":["array","null"],"items":{"type":"string"}},"Limite":{"type":["integer","null"]},"Offset":{"type":["integer","null"]}},"additionalProperties":false}},{"name":"cliente_criar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"CpfCnpj":{"type":"string"},"Nome":{"type":"string"},"IndicadorIe":{"type":["integer","null"]},"Ie":{"type":["string","null"]},"Im":{"type":["string","null"]},"ConsumidorFinal":{"type":["boolean","null"]},"Endereco":{"type":["object","null"],"properties":{"Logradouro":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"CodMunicipio":{"type":["integer","null"]},"Uf":{"type":["string","null"]},"Cep":{"type":["string","null"]},"Pais":{"type":["string","null"]},"CodPais":{"type":["integer","null"]}},"additionalProperties":false},"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]}},"required":["CpfCnpj","Nome"],"additionalProperties":false}},{"name":"cliente_editar","description":"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).","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"CpfCnpj":{"type":"string"},"Nome":{"type":"string"},"IndicadorIe":{"type":["integer","null"]},"Ie":{"type":["string","null"]},"Im":{"type":["string","null"]},"ConsumidorFinal":{"type":["boolean","null"]},"Endereco":{"type":["object","null"],"properties":{"Logradouro":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"CodMunicipio":{"type":["integer","null"]},"Uf":{"type":["string","null"]},"Cep":{"type":["string","null"]},"Pais":{"type":["string","null"]},"CodPais":{"type":["integer","null"]}},"additionalProperties":false},"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]}},"required":["CpfCnpj","Nome"],"additionalProperties":false}},{"name":"cte_desacordo","description":"Registra desacordo do tomador com um CT-e recebido (evento tipo 4 do CT-e). Prazo: 45 dias da emissão.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo do Documento Fiscal: Valores: 1 - Produção; 2 - Homologação"},"Chave":{"type":["string","null"]},"Observacao":{"type":["string","null"]},"NumeroSequencial":{"type":["integer","null"],"description":"Número sequencial do evento"}},"additionalProperties":false}},{"name":"cte_emitir","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Codigo":{"type":["integer","null"]},"Lote":{"type":["integer","null"]},"Serie":{"type":["integer","null"]},"Numero":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"ModeloDocumento":{"type":"integer","enum":[57,67],"description":"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)","default":57},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal)"},"TipoCte":{"type":"integer","enum":[0,1,2,3],"description":"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"},"Retira":{"type":"boolean"},"DtEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Cfop":{"type":"integer","description":"CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída."},"NaturezaOperacao":{"type":"string","description":"Descrição da natureza da operação (ex: \"Prestação de serviço de transporte\")."},"Observacao":{"type":["string","null"]},"Modal":{"type":"object","properties":{"Tipo":{"type":"integer","enum":[1,2,3,4,5,6],"description":"Modal do CT-e: Valores: 1 - Rodoviário; 2 - Aéreo; 3 - Aquaviário; 4 - Ferroviário; 5 - Dutoviário; 6 - Multimodal","default":1},"Rodoviario":{"type":["object","null"],"properties":{"OCCs":{"type":["array","null"],"items":{"type":"object","properties":{"Serie":{"type":["string","null"]},"Numero":{"type":"integer"},"DtEmissaoColeta":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Emissor":{"type":["object","null"],"properties":{"Cnpj":{"type":["string","null"],"description":"CNPJ do emissor da OCC"},"Ie":{"type":["string","null"],"description":"Inscrição estadual do emissor"},"CodigoInternoOCC":{"type":["string","null"],"description":"Código interno da OCC na empresa emissora"},"Uf":{"type":["string","null"],"description":"Estado do emissor da OCC"},"Telefone":{"type":["string","null"],"description":"Telefone do emissor da OCC"}},"additionalProperties":false}},"additionalProperties":false},"description":"Lista de coletas realizadas para compor o frete."}},"additionalProperties":false}},"additionalProperties":false,"description":"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."},"Carga":{"type":"object","properties":{"ValorTotal":{"type":"number","description":"Valor total da carga. (vCarga)"},"ProdutoPredominante":{"type":["string","null"],"description":"Nome do Produto Predominante. (proPred)"},"Detalhes":{"type":["array","null"],"items":{"type":"object","properties":{"CodUnidadeMedida":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Código da Unidade de Medida (cUnid) Valores: 0 - Metro Cúbico (M3); 1 - Quilograma (KG); 2 - Tonelada (TON); 3 - Unidade (UNIDADE); 4 - Litros (LITROS); 5 - MMBTU (MMBTU)"},"Quantidade":{"type":"number","description":"Quantidade da Carga (qCarga). Ex: 10000"},"TipoMedida":{"type":["string","null"],"description":"Tipo de Medida. (tpMed). Ex: \"quilos gramas\""}},"additionalProperties":false},"description":"Detalhes das quantidades da carga. (infQ)"},"Documentos":{"type":["array","null"],"items":{"type":"object","properties":{"Chave":{"type":["string","null"]},"PIN":{"type":["string","null"]}},"additionalProperties":false},"description":"Documentos fiscais que acompanham a carga. (infNFe)"},"OutrosDocumentos":{"type":["array","null"],"items":{"type":"object","properties":{"TipoDocumento":{"type":"integer","enum":[0,10,59,65,99],"description":"Tipo do documento originário. (tpDoc) Valores: 0 - Declaração; 10 - Dutoviário; 59 - CF-e SAT; 65 - NFC-e; 99 - Outros (exige Descricao)"},"Descricao":{"type":["string","null"],"description":"Descrição do documento. Obrigatória quando TipoDocumento = 99. (descOutros)"},"Numero":{"type":["string","null"],"description":"Número do documento. (nDoc)"},"DtEmissao":{"type":["string","null"],"description":"Data de emissão do documento. (dEmi)"},"Valor":{"type":["number","null"],"description":"Valor do documento fiscal. (vDocFisc)"},"DtPrevisao":{"type":["string","null"],"description":"Data prevista de entrega. (dPrev)"}},"additionalProperties":false,"description":"Outros documentos que acompanham a carga, quando não há NF/NF-e (ex.: mudança, C2C). Mapeia para infDoc/infOutros do CT-e."},"description":"Outros documentos que acompanham a carga quando não há NF-e (ex.: declaração de mudança, C2C). (infOutros)"}},"additionalProperties":false,"description":"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."},"Imposto":{"type":["object","null"],"properties":{"ICMS":{"type":["object","null"],"properties":{"CST":{"type":["string","null"],"description":"Código de Situação Tributária (CST) do ICMS. (Ex: 00, 20, 40, 41, 51, 60, 90, etc.) Para empresas do Simples Nacional, é usando o 90 automáticamente."},"BaseCalculo":{"type":"number","description":"Base de Cálculo do ICMS. (vBC)"},"Aliquota":{"type":"number","description":"Alíquota do ICMS (em percentual). (pICMS)"},"Valor":{"type":"number","description":"Valor do ICMS. (vICMS)"},"PercentualReducaoBaseCalculo":{"type":["number","null"],"description":"Percentual de Redução da Base de Cálculo. (pRedBC) Usado nos CSTs 20 e 90."},"AliquotaOutraUF":{"type":["number","null"],"description":"Alíquota do ICMS devido a Outra UF. (pICMSOutraUF) Usado no CST OutraUF."},"ValorICMSOutraUF":{"type":["number","null"],"description":"Valor do ICMS devido a Outra UF. (vICMSOutraUF) Usado no CST OutraUF."}},"additionalProperties":false,"description":"Informações do ICMS"},"ValorTotalTributos":{"type":["number","null"],"description":"Valor total dos tributos federais e estaduais, aproximado conforme Lei 12.741/12."},"InformacoesAdicionaisFisco":{"type":["string","null"],"description":"Informações Adicionais de Interesse do Fisco."},"Difal":{"type":["object","null"],"properties":{"BaseCalculoUfDestino":{"type":"number","description":"Base de Cálculo do ICMS na UF de Destino. (vBCUFFim)"},"PercentualFCPUfDestino":{"type":"number","description":"Percentual do Fundo de Combate à Pobreza (FCP) na UF de destino. (pFCPUFFim)"},"AliquotaICMSUfDestino":{"type":"number","description":"Alíquota interna da UF de destino para o ICMS. (pICMSUFFim)"},"AliquotaInterestadual":{"type":"number","description":"Alíquota interestadual das UF envolvidas. (pICMSInter)"},"PercentualPartilhaICMS":{"type":"number","description":"Percentual de Partilha do ICMS (Ex: 80, 20, 0, etc.). (pICMSInterPart)"},"ValorFCPUfDestino":{"type":"number","description":"Valor do Fundo de Combate à Pobreza (FCP) na UF de destino. (vFCPUFFim)"},"ValorICMSUfDestino":{"type":"number","description":"Valor total do ICMS devido à UF de destino (já com o FCP). (vICMSUFFim)"},"ValorICMSUfInicio":{"type":"number","description":"Valor do ICMS devido à UF de origem (Início). (vICMSUFIni)"}},"additionalProperties":false,"description":"Informações sobre o ICMS Partilha (DIFAL/ICMS UF Fim)."},"TributosFederal":{"type":["object","null"],"properties":{"ValorPis":{"type":["number","null"],"description":"Valor do PIS retido. (vPIS)"},"ValorCofins":{"type":["number","null"],"description":"Valor do COFINS retido. (vCOFINS)"},"ValorIr":{"type":["number","null"],"description":"Valor do Imposto de Renda retido. (vIR)"},"ValorInss":{"type":["number","null"],"description":"Valor do INSS retido. (vINSS)"},"ValorCsll":{"type":["number","null"],"description":"Valor da CSLL retida. (vCSLL)"}},"additionalProperties":false,"description":"Lista de PIS e COFINS (Tributos Federais)."},"IBSCBS":{"type":["object","null"],"properties":{"CodClassificacaoTributaria":{"type":["string","null"],"description":"Código de Classificação Tributária do IBS/CBS (cClassTrib). O CST é derivado dos 3 primeiros dígitos. Quando vazio, assume \"000001\"."},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo do IBS/CBS (vBC). Quando null, usa o valor total da prestação."},"AliquotaIBSUF":{"type":["number","null"],"description":"Alíquota do IBS de competência das UF (pIBSUF)."},"AliquotaIBSMun":{"type":["number","null"],"description":"Alíquota do IBS de competência do Município (pIBSMun)."},"AliquotaCBS":{"type":["number","null"],"description":"Alíquota da CBS (pCBS)."},"PercentualReducaoIBS":{"type":["number","null"],"description":"Percentual de redução da alíquota do IBS (pRedAliq de gRed), usado nos CST 011/200/515. Quando null, não aplica redução."},"PercentualReducaoCBS":{"type":["number","null"],"description":"Percentual de redução da alíquota da CBS (pRedAliq de gRed). Pode divergir de PercentualReducaoIBS."},"PercentualDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (pDif de gDif), usado nos CST 510/515."}},"additionalProperties":false,"description":"Informações do IBS/CBS (Reforma Tributária - NT 2025.001). Quando preenchido, gera o grupo imp/IBSCBS no XML do CT-e."}},"additionalProperties":false},"Servico":{"type":"object","properties":{"Tipo":{"type":"integer","enum":[0,1,2,3,4,6,7,8],"description":"Tipo do Serviço: Valores: 0 - Normal; 1 - Subcontratação; 2 - Redespacho; 3 - Redespacho Intermediário; 4 - Serviço Vinculado ao Multimodal; 6 - Transporte de Pessoas; 7 - Transporte de Valores; 8 - Excesso de Bagagem"},"CodMunicipioInicio":{"type":"integer","description":"Código IBGE do município do início do transporte"},"MunicipioInicio":{"type":["string","null"],"description":"Nome do município do início do transporte"},"CodMunicipioFim":{"type":"integer","description":"Código IBGE do município do destino o transporte"},"MunicipioFim":{"type":["string","null"],"description":"Nome do município do destino do transporte"},"ValorPrestacao":{"type":"number","description":"O valor total cobrado pela prestação do serviço de transporte."},"ValorReceber":{"type":"number","description":"O valor líquido a receber pelo transportador."},"Componentes":{"type":["array","null"],"items":{"type":"object","properties":{"Nome":{"type":["string","null"]},"Valor":{"type":"number"}},"additionalProperties":false},"description":"Lista de componentes que detalham como o valor total do frete foi formado."}},"additionalProperties":false,"description":"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."},"Tomador":{"type":["object","null"],"properties":{"IndicadorIe":{"type":"integer","enum":[1,2,9],"description":"Indicador de IE: Valores: 1 - Contribuinte do ICMS; 2 - Contribuinte isento de inscrição; 9 - Não contribuinte"},"TipoTomador":{"type":"integer","enum":[0,1,2,3,4],"description":"Tipo do participante do CT-e: Valores: 0 - Remetente; 1 - Expedidor; 2 - Recebedor; 3 - Destinatário; 4 - Outros (Informar dados Tomador)"},"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Destinatario":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Remetente":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Expedidor":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false}},"required":["ModeloDocumento","TipoAmbiente","TipoCte","Cfop","NaturezaOperacao","Modal","Carga","Servico"],"additionalProperties":false}},{"name":"dce_emitir","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Codigo":{"type":["integer","null"]},"Lote":{"type":["integer","null"]},"Serie":{"type":["integer","null"]},"Numero":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste)"},"TipoEmitente":{"type":"integer","enum":[0,1,2,3,4],"description":"Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios)","default":3},"XOrgaoFisco":{"type":["string","null"],"description":"Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0)"},"UfFisco":{"type":["string","null"],"description":"Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora."},"ModalidadeTransporte":{"type":"integer","enum":[0,1,2],"description":"Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora","default":2},"CnpjTransportadora":{"type":["string","null"],"description":"CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora."},"SiteMarketplace":{"type":["string","null"],"description":"URL do site do marketplace (obrigatório quando TipoEmitente=1)"},"Remetente":{"type":"object","properties":{"CpfCnpj":{"type":["string","null"],"description":"CPF ou CNPJ"},"Nome":{"type":["string","null"],"description":"Nome ou Razão Social"},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe)."},"Destinatario":{"type":"object","properties":{"CpfCnpj":{"type":["string","null"],"description":"CPF ou CNPJ"},"Nome":{"type":["string","null"],"description":"Nome ou Razão Social"},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo."},"Itens":{"type":"array","items":{"type":"object","properties":{"Descricao":{"type":"string","description":"Descrição do produto/conteúdo (1-120 caracteres). Obrigatória."},"NCM":{"type":["string","null"],"description":"Código NCM. Quando informado deve ter 2 ou 8 dígitos. Opcional na DC-e."},"Quantidade":{"type":["number","null"],"description":"Quantidade do item."},"ValorUnitario":{"type":["number","null"],"description":"Valor unitário do item."},"ValorTotal":{"type":"number","description":"Valor total do item. Deve ser > 0."},"InformacoesAdicionais":{"type":["string","null"],"description":"Informações adicionais do produto (opcional, até 500 caracteres)"}},"additionalProperties":false,"required":["Descricao","ValorTotal"]},"description":"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)."},"ValorTotal":{"type":["number","null"],"description":"Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0."},"InformacoesComplementares":{"type":["string","null"],"description":"Informações complementares (opcional, até 5000 caracteres)."},"InformacoesAdicionaisFisco":{"type":["string","null"],"description":"Informações adicionais de interesse do fisco (opcional, até 2000 caracteres)."},"DeclaracaoContribuinteICMS":{"type":"string","description":"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":{"type":"string","description":"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.\""}},"required":["TipoAmbiente","Remetente","Destinatario","Itens","DeclaracaoContribuinteICMS","DeclaracaoCrimeTributario"],"additionalProperties":false}},{"name":"evento_cancelar","description":"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).","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"ChaveNF":{"type":"string","description":"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."},"NumeroProtocolo":{"type":["string","null"],"description":"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."},"Justificativa":{"type":"string","description":"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)."},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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","default":1},"DataEvento":{"type":["string","null"],"description":"Data do evento de cancelamento do documento (Caso não for enviado é considerada a data e hora atual)"},"NumeroNFSe":{"type":["string","null"],"description":"Número da NFS-e a ser cancelada"},"CodCancelamentoNFSe":{"type":"integer","enum":[1,2,3,9],"description":"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","default":1},"TipoDocumento":{"type":"integer","enum":[0,1],"description":"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)"},"NumeroSequencial":{"type":["integer","null"],"description":"Número sequencial do evento"},"CpfCnpjRemetenteDCe":{"type":["string","null"],"description":"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)."}},"required":["ChaveNF","Justificativa","TipoAmbiente","TipoDocumento"],"additionalProperties":false}},{"name":"evento_carta_correcao","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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","default":1},"ChaveNF":{"type":"string","description":"Chave de acesso de 44 dígitos da NF-e ou CT-e a corrigir."},"Correcao":{"type":["string","null"],"description":"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."},"NumeroSequencial":{"type":["integer","null"],"description":"Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível."},"Correcoes":{"type":["array","null"],"items":{"type":"object","properties":{"Campo":{"type":["string","null"]},"Grupo":{"type":["string","null"]},"Valor":{"type":["string","null"]}},"additionalProperties":false},"description":"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."}},"required":["TipoAmbiente","ChaveNF"],"additionalProperties":false}},{"name":"evento_inutilizar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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)"},"ModeloDocumento":{"type":"integer","enum":[55,65,57],"description":"Código do modelo do Documento Fiscal a inutilizar. Valores: 55 - NF-e; 65 - NFC-e; 57 - CT-e"},"Serie":{"type":"integer","description":"Série referente ao modelo do documento. Deve ser > 0."},"Justificativa":{"type":"string","description":"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\")."},"NumeracaoInicial":{"type":"integer","description":"Início da faixa numérica a inutilizar. Deve ser > 0 e <= NumeracaoFinal."},"NumeracaoFinal":{"type":"integer","description":"Final da faixa numérica a inutilizar. Deve ser >= NumeracaoInicial."}},"required":["TipoAmbiente","ModeloDocumento","Serie","Justificativa","NumeracaoInicial","NumeracaoFinal"],"additionalProperties":false}},{"name":"evento_manifestar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Chave":{"type":"string","description":"Chave de acesso de 44 dígitos da NF-e a manifestar."},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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","default":1},"TipoManifestacao":{"type":"integer","enum":[1,2,3,4],"description":"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)"},"Justificativa":{"type":["string","null"],"description":"Justificativa. OBRIGATÓRIA quando TipoManifestacao = 4 (mínimo 15 caracteres). Para outros tipos pode omitir."},"NumeroSequencial":{"type":["integer","null"],"description":"Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível."}},"required":["Chave","TipoAmbiente","TipoManifestacao"],"additionalProperties":false}},{"name":"fci_gerar","description":"Gera o arquivo FCI (Ficha de Conteúdo de Importação) requerido para produtos com conteúdo importado em operações interestaduais.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Produtos":{"type":["array","null"],"items":{"type":"object","properties":{"Codigo":{"type":["string","null"],"description":"Código interno que identifica a mercadoria no estabelecimento"},"Descricao":{"type":["string","null"],"description":"Descrição da Mercadoria"},"Ncm":{"type":["string","null"],"description":"Código baseado na tabela da Nomenclatura Comum do MERCOSUL"},"Gtin":{"type":["string","null"],"description":"Código Global Trade Item Number, se houver"},"UnidadeMedida":{"type":["string","null"],"description":"Unidade a que se refere o valor de saída da mercadoria"},"ValorSaida":{"type":"number","description":"Valor de saída (comercialização) da mercadoria"},"ValorImportado":{"type":["number","null"],"description":"Valor da parcela importada do exterior (Obrigatório caso não for informado o Percentual Importado)"},"PercentualImportado":{"type":["number","null"],"description":"Percentual do conteúdo de importação informado pelo contribuinte (Obrigatório caso não for informado o Valor Importado)"}},"additionalProperties":false},"description":"Produtos para gerar os registros do arquivo FCI"},"ValidarCodigos":{"type":"boolean","description":"Quando verdadeiro retorna erro caso envie produtos com código repetido","default":true},"Transmitir":{"type":"boolean","description":"Quando verdadeiro, além de gerar o arquivo, assina e transmite a mídia via programa TED. Requer certificado e-CNPJ configurado na empresa."}},"additionalProperties":false}},{"name":"health","description":"Verifica a saúde da API BrasilNFe (status, timestamp, versão). Não recebe parâmetros.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{},"additionalProperties":false}},{"name":"imposto_calcular","description":"Simula o cálculo de impostos (ICMS, PIS, COFINS, IPI, ST) sobre uma lista de produtos sem emitir nota. Útil para precificação.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Capacity":{"type":"integer"},"Count":{"type":"integer"}},"additionalProperties":false}},{"name":"mdfe_emitir","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação","default":1},"identificadorInterno":{"type":["string","null"]},"codigo":{"type":["integer","null"]},"lote":{"type":["integer","null"]},"numero":{"type":["integer","null"]},"serie":{"type":["integer","null"]},"tipoEmitente":{"type":"integer","enum":[1,2],"description":"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)","default":2},"DataEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"ufCarregamento":{"type":"string","description":"UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...)."},"ufDescarregamento":{"type":"string","description":"UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...)."},"observacao":{"type":["string","null"]},"observacaoFisco":{"type":["string","null"]},"modalidade":{"type":"integer","enum":[1,2,3,4],"description":"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)","default":1},"valor":{"type":"number","description":"Valor total das mercadorias transportadas. DEVE ser > 0."},"peso":{"type":"number","description":"Peso bruto total das mercadorias em KG. DEVE ser > 0."},"Rodoviario":{"type":["object","null"],"properties":{"tipoRodado":{"type":"integer","enum":[1,2,3,4,5,6],"description":"Tipo de Rodado (Padrão 1) Valores: 1 - Truck; 2 - Toco; 3 - Cavalo Mecânico; 4 - VAN; 5 - Utilitário; 6 - Outros"},"tipoCarroceria":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Tipo de Carroceria (Padrão 1) Valores: 0 - Não aplicavel; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider"},"placa":{"type":["string","null"]},"renavam":{"type":["string","null"]},"uf":{"type":["string","null"]},"tara":{"type":"integer","description":"Tara em KG"},"capKG":{"type":["integer","null"],"description":"Capacidade em KG do veículo de tração. Opcional."},"capM3":{"type":["integer","null"],"description":"Capacidade em M3 do veículo de tração. Opcional."},"CIOT":{"type":["object","null"],"properties":{"codigo":{"type":["string","null"]},"cnpj":{"type":["string","null"]}},"additionalProperties":false},"condutores":{"type":["array","null"],"items":{"type":"object","properties":{"nome":{"type":["string","null"]},"cpf":{"type":["string","null"]}},"additionalProperties":false}},"reboques":{"type":["array","null"],"items":{"type":"object","properties":{"placa":{"type":["string","null"],"description":"Placa do reboque (sem máscara)."},"renavam":{"type":["string","null"]},"uf":{"type":["string","null"],"description":"UF de licenciamento do reboque (sigla de 2 letras)."},"tara":{"type":["integer","null"],"description":"Tara em KG"},"capKG":{"type":["integer","null"]},"capM3":{"type":["integer","null"]},"tipoCarroceria":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Tipo de Carroceria Valores: 0 - Não aplicável; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider"}},"additionalProperties":false},"description":"Lista de veículos de reboque acoplados à tração. Opcional - se nulo/vazio,"},"contratantes":{"type":["array","null"],"items":{"type":"object","properties":{"cpfCnpj":{"type":["string","null"],"description":"CPF, CNPJ ou identificador estrangeiro do contratante do transporte."},"nome":{"type":["string","null"],"description":"Razão social ou nome do contratante."},"nroContrato":{"type":["string","null"],"description":"Número do contrato do transportador com o contratante, para prestações continuadas."},"vContratoGlobal":{"type":["number","null"],"description":"Valor global do contrato. Usar somente no pagamento a prazo."}},"additionalProperties":false},"description":"Contratantes do serviço de transporte (grupo infANTT/infContratante)."},"valePedagio":{"type":["object","null"],"properties":{"dispositivos":{"type":["array","null"],"items":{"type":"object","properties":{"cnpjFornecedor":{"type":["string","null"],"description":"CNPJ da empresa fornecedora do vale-pedágio."},"cpfCnpjPagador":{"type":["string","null"],"description":"CPF ou CNPJ do responsável pelo pagamento. Informar quando não for o emitente do MDF-e."},"numeroComprovante":{"type":["string","null"],"description":"Número do comprovante de compra."},"valor":{"type":"number","description":"Valor do vale-pedágio."},"tipo":{"type":["string","null"],"description":"Tipo do vale-pedágio: 01 - TAG, 02 - Cupom, 03 - Cartão."}},"additionalProperties":false},"description":"Dispositivos do vale-pedágio."},"categoriaCombinacaoVeicular":{"type":["string","null"],"description":"Categoria de combinação veicular (02 a 14, conforme número de eixos)."}},"additionalProperties":false,"description":"Vale-pedágio (grupo infANTT/valePed)."},"pagamentos":{"type":["array","null"],"items":{"type":"object","properties":{"cpfCnpjResponsavel":{"type":["string","null"],"description":"CPF, CNPJ ou identificador estrangeiro do responsável pelo pagamento do frete."},"nomeResponsavel":{"type":["string","null"],"description":"Razão social ou nome do responsável pelo pagamento."},"componentes":{"type":["array","null"],"items":{"type":"object","properties":{"tipo":{"type":["string","null"],"description":"Tipo do componente: 01 - Vale-Pedágio; 02 - Impostos, taxas e contribuições; 03 - Despesas; 99 - Outros."},"valor":{"type":"number","description":"Valor do componente."},"descricao":{"type":["string","null"],"description":"Descrição do componente (usar quando tipo = 99)."}},"additionalProperties":false},"description":"Componentes do pagamento do frete."},"valorContrato":{"type":"number","description":"Valor total do contrato."},"altoDesempenho":{"type":"boolean","description":"Operação de transporte de alto desempenho (frota dedicada/fidelizada)."},"indicadorPagamento":{"type":"integer","description":"Forma de pagamento: 0 - à vista; 1 - a prazo."},"valorAdiantamento":{"type":["number","null"],"description":"Valor do adiantamento (usar apenas em pagamento a prazo)."},"anteciparAdiantamento":{"type":"boolean","description":"Concordância em antecipar o adiantamento."},"parcelas":{"type":["array","null"],"items":{"type":"object","properties":{"numero":{"type":"integer","description":"Número da parcela."},"vencimento":{"type":["string","null"],"description":"Data de vencimento da parcela."},"valor":{"type":["number","null"],"description":"Valor da parcela."}},"additionalProperties":false},"description":"Parcelas do pagamento (informar somente se a prazo)."},"tipoAntecipacao":{"type":["integer","null"],"description":"Permissão de antecipação das parcelas: 0 - não permite; 1 - permite; 2 - permite mediante confirmação."},"infoBancaria":{"type":["object","null"],"properties":{"codBanco":{"type":["string","null"],"description":"Número do banco. Informar junto com a agência (ou use cnpjInstituicaoPagamento, ou pix)."},"codAgencia":{"type":["string","null"],"description":"Número da agência bancária."},"cnpjInstituicaoPagamento":{"type":["string","null"],"description":"CNPJ da instituição de pagamento eletrônico do frete (alternativa ao banco/agência)."},"pix":{"type":["string","null"],"description":"Chave PIX para recebimento do frete (alternativa ao banco/agência)."}},"additionalProperties":false,"description":"Informações bancárias para recebimento do frete."}},"additionalProperties":false},"description":"Informações de pagamento do frete (grupo infANTT/infPag)."}},"additionalProperties":false,"description":"Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1."},"Aereo":{"type":["object","null"],"properties":{"nacionalidade":{"type":["string","null"]},"matricula":{"type":["string","null"]},"numeroVoo":{"type":["string","null"]},"aerodromoEmbarque":{"type":["string","null"]},"aerodromoDestino":{"type":["string","null"]},"dataVoo":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"}},"additionalProperties":false},"Aquaviario":{"type":["object","null"],"properties":{"cnpjAgencia":{"type":["string","null"]},"tipoEmbarcacao":{"type":"integer"},"codEmbarcacao":{"type":["string","null"]},"nomeEmbarcacao":{"type":["string","null"]},"numeroViagem":{"type":["string","null"]},"codPortoEmbarque":{"type":["string","null"]},"codPortoDestino":{"type":["string","null"]}},"additionalProperties":false},"Ferroviario":{"type":["object","null"],"properties":{"prefixo":{"type":["string","null"]},"DataLiberacao":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"origem":{"type":["string","null"]},"destino":{"type":["string","null"]},"quantidadeVagoes":{"type":"integer"},"Vagoes":{"type":["array","null"],"items":{"type":"object","properties":{"serie":{"type":"integer"},"numero":{"type":"integer"},"sequencia":{"type":["integer","null"]},"toneladaUtil":{"type":"number"},"pesoBc":{"type":"number","description":"Peso Base de Cálculo de Frete em Toneladas"},"pesoReal":{"type":"number","description":"Peso Real em Toneladas"}},"additionalProperties":false}}},"additionalProperties":false},"seguros":{"type":["array","null"],"items":{"type":"object","properties":{"indicadorResponsavel":{"type":"integer","enum":[1,2],"description":"Identificação do Ambiente (Padrão 1) Valores: 1 - Emitente do MDF-e; 2 - Responsável pela contratação","default":1},"cpfCnpjResponsavel":{"type":["string","null"],"description":"CPF ou CNPJ do responsável pela contratação do seguro. Informar somente quando indicadorResponsavel = 2 (responsável pela contratação); se for o próprio emitente do MDF-e, o CNPJ da empresa é utilizado automaticamente."},"cnpjSegurador":{"type":["string","null"],"description":"CNPJ da seguradora (somente dígitos)."},"nomeSegurador":{"type":["string","null"],"description":"Razão social / nome da seguradora."},"numeroApolice":{"type":["string","null"],"description":"Número da apólice de seguro. Obrigatório para modal rodoviário no MDF-e versão 3.00."},"numerosAverbacao":{"type":["array","null"],"items":{"type":"string"},"description":"Lista de números de averbação do seguro (0..N). Opcional."}},"additionalProperties":false}},"carregamentos":{"type":["array","null"],"items":{"type":"object","properties":{"codMunicipio":{"type":"integer"},"municipio":{"type":["string","null"]}},"additionalProperties":false}},"descarregamentos":{"type":["array","null"],"items":{"type":"object","properties":{"codMunicipio":{"type":"integer"},"municipio":{"type":["string","null"]},"chaveDfe":{"type":["string","null"]},"transportePerigosos":{"type":["array","null"],"items":{"type":"object","properties":{"codigoONU":{"type":["string","null"]},"quantidade":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false}},"percursoUfs":{"type":["array","null"],"items":{"type":"string"}},"produtoPredominante":{"type":["object","null"],"properties":{"tpCarga":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11],"description":"Tipo de Carga (Resolução ANTT 5.849/2019). Valor de 1 a 11. Valores: 1 - Granel sólido; 2 - Granel líquido; 3 - Frigorificada; 4 - Conteinerizada; 5 - Carga Geral; 6 - Neogranel; 7 - Perigosa (granel sólido); 8 - Perigosa (granel líquido); 9 - Perigosa (carga frigorificada); 10 - Perigosa (conteinerizada); 11 - Perigosa (carga geral)"},"descricao":{"type":["string","null"],"description":"Descrição do produto predominante (1 a 120 caracteres)."},"cEan":{"type":["string","null"],"description":"GTIN/EAN do produto. Opcional. Use \"SEM GTIN\" se não houver."},"ncm":{"type":["string","null"],"description":"Código NCM do produto. Opcional. Aceita 2 ou 8 dígitos."},"infLotacao":{"type":["object","null"],"properties":{"localCarrega":{"type":["object","null"],"properties":{"cep":{"type":["string","null"],"description":"CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados."},"latitude":{"type":["string","null"],"description":"Latitude. Informe junto com longitude quando não houver CEP."},"longitude":{"type":["string","null"],"description":"Longitude. Informe junto com latitude quando não houver CEP."}},"additionalProperties":false,"description":"Local de carregamento da lotação. Informe CEP OU (latitude + longitude)."},"localDescarrega":{"type":["object","null"],"properties":{"cep":{"type":["string","null"],"description":"CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados."},"latitude":{"type":["string","null"],"description":"Latitude. Informe junto com longitude quando não houver CEP."},"longitude":{"type":["string","null"],"description":"Longitude. Informe junto com latitude quando não houver CEP."}},"additionalProperties":false,"description":"Local de descarregamento da lotação. Informe CEP OU (latitude + longitude)."}},"additionalProperties":false,"description":"Informações de carga lotação. Opcional - só preencha quando o MDF-e for de carga lotação."}},"additionalProperties":false,"description":"Produto predominante transportado. Opcional."}},"required":["tipoAmbiente","tipoEmitente","ufCarregamento","ufDescarregamento","modalidade","valor","peso"],"additionalProperties":false}},{"name":"mdfe_encerrar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"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","default":1},"chave":{"type":"string","description":"Chave de acesso de 44 dígitos do MDF-e a encerrar."},"protocolo":{"type":["string","null"],"description":"Protocolo de autorização do MDF-e original. Opcional - se omitido, o sistema localiza pela chave."},"numeroSequencial":{"type":["integer","null"],"description":"Número sequencial do evento. Se omitido, o sistema usa o próximo disponível."}},"required":["tipoAmbiente","chave"],"additionalProperties":false}},{"name":"nfe_emitir","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Serie":{"type":["integer","null"],"description":"Série da nota Fiscal"},"Numero":{"type":["integer","null"],"description":"Número da nota fiscal"},"Lote":{"type":["integer","null"],"description":"Lote da Nota Fiscal"},"DataEntradaSaida":{"type":["string","null"],"description":"Data e Hora da saída ou de entrada da produto/serviço"},"DataEmissao":{"type":["string","null"],"description":"Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)"},"Codigo":{"type":["string","null"],"description":"B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e."},"Justificativa":{"type":["string","null"],"description":"Utilizar quando o tipo de emissão for diferente normal"},"NFReferencia":{"type":["array","null"],"items":{"type":"string"},"description":"Notas fiscal de Referência"},"NFPagamentoAntecipado":{"type":["array","null"],"items":{"type":"string"},"description":"Grupo de notas de antecipação de pagamento (gPagAntecipado - Reforma Tributária)."},"IndicadorPresenca":{"type":"integer","enum":[0,1,2,3,4,5,9],"description":"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.","default":9},"Intermediador":{"type":["object","null"],"properties":{"Cnpj":{"type":"string","description":"CNPJ do intermediador da transação (marketplace/plataforma de terceiros). Obrigatório."},"IdCadIntTran":{"type":"string","description":"Identificação do vendedor no site do intermediador (usuário/login cadastrado). Obrigatório."}},"additionalProperties":false,"required":["Cnpj","IdCadIntTran"],"description":"Dados do intermediador/marketplace (site ou plataforma de terceiros)."},"ConsumidorFinal":{"type":"boolean","description":"Indica operação com Consumidor final (NFCe de ser 1 Validar!)"},"CalcularIBPT":{"type":"boolean","description":"Indica operação com Consumidor final (NFCe de ser 1 Validar!)","default":true},"NaturezaOperacao":{"type":"string","description":"Descrição da natureza da operação (máx 60 caracteres). Exemplos: \"Venda de mercadoria\", \"Remessa para industrialização\", \"Devolução de venda\"."},"ModeloDocumento":{"type":"integer","enum":[55,65],"description":"Código do modelo do Documento Fiscal. Valores: 55 - NF-e (B2B / com destinatário CPF/CNPJ identificado); 65 - NFC-e (consumidor final / varejo)","default":55},"Finalidade":{"type":"integer","enum":[1,2,3,4,5,6],"description":"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","default":1},"TipoDanfe":{"type":["integer","null"],"enum":[0,1,2,3,4,5,6,null],"description":"Formato de impressão do DANFE (tag tpImp da NF-e). Não informado = padrão atual (1-Retrato para NF-e, 4 para NFC-e). Valores: 0 - Sem geração de DANFE; 1 - DANFE normal, Retrato (padrão NF-e); 2 - DANFE normal, Paisagem; 3 - DANFE Simplificado; 4 - DANFE NFC-e (padrão NFC-e; somente modelo 65); 5 - DANFE NFC-e em mensagem eletrônica (somente modelo 65); 6 - DANFE Simplificado Tipo 2 (NT 2026.002/2026.003, Ajuste SINIEF 13/26; somente modelo 55) - NF-e de varejo em operação típica de NFC-e, impressa em bobina com QR Code. Exige operação interna (CFOP 5xxx), consumidor final, finalidade 1-Normal, saída, sem notas referenciadas e IndicadorPresenca 1, 4 ou 5."},"TpNFDebito":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,null],"description":"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 notas fiscais não processadas na apuração; 4 - Multa e juros; 5 - Transferência de crédito de sucessão; 6 - Pagamento antecipado; 7 - Perda em estoque"},"TpNFCredito":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"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 por recusa total na entrega ou por não localização do destinatário; 4 - Redução de valores; 5 - Transferência de crédito na sucessão; 6 - Retorno por recusa parcial na entrega"},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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)","default":2},"Observacao":{"type":["string","null"]},"ObservacaoFisco":{"type":["string","null"]},"IdentificadorInterno":{"type":["string","null"]},"EnviarEmail":{"type":"boolean"},"Cliente":{"type":["object","null"],"properties":{"CpfCnpj":{"type":"string","description":"CPF (11 dígitos) ou CNPJ (14 dígitos) do destinatário. Aceita com ou sem máscara - o sistema normaliza. Obrigatório para NF-e (modelo 55). Em operações de exportação (CFOP iniciado em 3/7) pode ter de 5 a 20 caracteres."},"NmCliente":{"type":"string","description":"Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55)."},"IndicadorIe":{"type":"integer","enum":[1,2,9],"description":"Indicador de Inscrição Estadual. Para NFC-e (modelo 65) DEVE ser 9. Para NF-e (modelo 55) aceita 1, 2 ou 9. Valores: 1 - Contribuinte ICMS (informar a IE do destinatário); 2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS; 9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS","default":9},"Ie":{"type":["string","null"]},"IsUf":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"required":["CpfCnpj","NmCliente"],"description":"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)."},"Produtos":{"type":"array","items":{"type":"object","properties":{"NmProduto":{"type":"string","description":"Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\"."},"CodProdutoServico":{"type":"string","description":"Código/SKU INTERNO do produto no cadastro da empresa (1-60 caracteres alfanuméricos). NÃO usar NCM, CFOP, EAN, GTIN nem códigos da Receita aqui - cada um tem campo próprio (NCM, CFOP, EAN). Exemplos válidos: \"PROD-001\", \"DETIPE500\", \"SKU12345\". Se a empresa não usa SKU interno, repita o EAN ou use \"1\"."},"EAN":{"type":["string","null"],"description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras (8, 12, 13 ou 14 dígitos). Quando o produto não tem GTIN cadastrado, informe a string \"SEM GTIN\" (literal). Não usar como código interno."},"NCM":{"type":"string","description":"Código NCM com exatamente 8 dígitos (Nomenclatura Comum do Mercosul). Identifica a classificação fiscal do produto na Receita. NÃO é o código interno - código interno vai em CodProdutoServico. Para serviços ou itens sem produto físico (transferência de crédito, etc.), use \"00000000\"."},"CEST":{"type":["string","null"],"description":"Código CEST (7 dígitos). Obrigatório quando o CST/CSOSN do ICMS indicar substituição tributária (rejeição 806 da SEFAZ). Consulte a tabela CEST oficial pelo NCM do produto."},"Quantidade":{"type":"number","description":"Quantidade comercial do produto. Aceita de 0 a 4 casas decimais e até 11 inteiros. Deve ser maior que zero (exceto para finalidade 2 - Complementar e 3 - Ajuste)."},"QuantidadeTributavel":{"type":["number","null"],"description":"Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros."},"UnidadeComercial":{"type":"string","description":"Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\"."},"UnidadeComercialTributavel":{"type":["string","null"],"description":"Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial."},"ValorDesconto":{"type":"number","description":"Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal)."},"ValorUnitario":{"type":"number","description":"Valor unitário do produto (>= 0). Aceita até 10 casas decimais."},"ValorUnitarioTributavel":{"type":["number","null"],"description":"Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario."},"ValorTotal":{"type":"number","description":"Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0."},"ValorSeguro":{"type":["number","null"],"description":"Valor Seguro"},"ValorFrete":{"type":["number","null"],"description":"Valor Frete"},"ValorOutrasDespesas":{"type":["number","null"],"description":"Valor Outras Despesas"},"CFOP":{"type":"integer","description":"Código Fiscal de Operações e Prestações (CFOP). Exatamente 4 dígitos. Primeiro dígito indica a natureza: 1/2/3 = entrada (interna/interestadual/exterior), 5/6/7 = saída (interna/interestadual/exterior). Para NFC-e (modelo 65) só são aceitos: 5101, 5102, 5103, 5104, 5115, 5405, 5656, 5667, 5933 (rejeição 725)."},"NItemPed":{"type":["integer","null"],"description":"Número do item do Pedido de Compra"},"xPed":{"type":["string","null"],"description":"Número do Pedido de Compra"},"ChaveAcessoReferenciada":{"type":["string","null"],"description":"Chave de acesso (44 dígitos) da NF-e ORIGINAL que este item está devolvendo. Usado apenas em NF-e de devolução (Finalidade = 4, Reforma Tributária / NT 2025.002). Quando preenchida, o item é referenciado pelo grupo DFeReferenciado (por item) em vez do NFReferencia (nível nota) - os dois não podem coexistir."},"NItemReferenciado":{"type":["integer","null"],"description":"Número do item (nItem) na NF-e ORIGINAL a que este item de devolução corresponde. É o número do item na nota de venda original, NÃO o número do item nesta devolução. Opcional; acompanha ChaveAcessoReferenciada."},"nFCI":{"type":["string","null"],"description":"Número de controle da FCI - Ficha de Conteúdo de Importação"},"cBenef":{"type":["string","null"],"description":"Código de Beneficio Fiscal na UF"},"InformacaoAdicional":{"type":["string","null"],"description":"Informaçoes adicional"},"OrigemProduto":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8],"description":"Origem do produto (Tabela A da NF-e). Padrão para a maioria dos casos = 0 (nacional). Valores: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; 1 - Estrangeira - Importação direta, exceto a indicada no código 6; 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7; 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%; 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes; 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural; 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural; 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%","default":0},"CodTributacao":{"type":["string","null"],"description":"Código do grupo tributário pré-cadastrado no Painel. Quando informado, o sistema aplica automaticamente CFOP, CST, ICMS, IPI, PIS e COFINS do grupo, dispensando o preenchimento do bloco Imposto e do CFOP do item."},"Imposto":{"type":"object","properties":{"IBSCBS":{"type":["object","null"],"properties":{"CodClassificacaoTributaria":{"type":["string","null"],"description":"Código de Classificação Tributária (Padrão 000001)"},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo"},"AliquotaIBSUF":{"type":["number","null"],"description":"Alíquota do IBS de competência das UF"},"AliquotaIBSMun":{"type":["number","null"],"description":"Alíquota do IBS de competência do Município"},"AliquotaCBS":{"type":["number","null"],"description":"Alíquota da CBS"},"PercentualReducaoIBS":{"type":["number","null"],"description":"Percentual de redução da alíquota do IBS (pRedAliq de gIBSUF/gIBSMun), usado no grupo gRed dos CST 011/200/515. Fixo por cClassTrib na tabela oficial (ex.: 100 para 200003 alimentação/Anexo I, 60 para educação/saúde). Quando null, é preenchido automaticamente pela tabela oficial (TabelaReducaoIbsCbs)."},"PercentualReducaoCBS":{"type":["number","null"],"description":"Percentual de redução da alíquota da CBS (pRedAliq de gCBS). Pode divergir de PercentualReducaoIBS (ex.: 200025 = IBS 60 / CBS 100). Quando null, é preenchido automaticamente pela tabela oficial."},"PercentualDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (pDif do grupo gDif), usado nos CST 510/515. Informado pelo contribuinte - NÃO é fixo por cClassTrib. O valor diferido (vDif) é deduzido do IBS/CBS devido."}},"additionalProperties":false},"ICMS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"Código da Situação Tributária (CST) do ICMS, OU Código de Situação da Operação no Simples Nacional (CSOSN). Para empresas no Simples Nacional (CRT 1) ou MEI (CRT 4) use CSOSN: \"101\",\"102\",\"103\",\"201\",\"202\",\"203\",\"300\",\"400\",\"500\",\"900\". Para empresas em Regime Normal (CRT 3) use CST do ICMS: \"00\",\"10\",\"20\",\"30\",\"40\",\"41\",\"50\",\"51\",\"60\",\"70\",\"90\"."},"AliquotaICMS":{"type":["number","null"],"description":"Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201"},"AliquotaICMSST":{"type":["number","null"],"description":"Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201"},"AliquotaMVA":{"type":["number","null"],"description":"Alíquota - Obrigatório para situação tributária nº 201, 202 e 203"},"AliquotaCredito":{"type":["number","null"],"description":"Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201"},"RedICMS":{"type":["number","null"],"description":"Redução ICMS"},"RedICMSST":{"type":["number","null"],"description":"Redução ICMS ST"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"},"ValorIcms":{"type":["number","null"],"description":"Valor do Icms (Calculado Automaticamente quando não informado)"},"motivoDesoneracaoIcms":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,8,9,10,11,16,null],"description":"1 - Táxi;; 2 - Deficiente Físico;; 3 - Produtor Agropecuário;; 4 - Frotista / Locadora;; 5 - Diplomático / Consular;; 6 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 - CONTRAN e suas alterações);; 7 - SUFRAMA; 8 - Venda a Orgãos Publicos; 9 - Outros. (v2.0); 10 - Deficiente Condutor (Convênio ICMS 38/12). (v3.1); 11 - Deficiente não Condutor (Convênio ICMS 38/12). (v3.1); 16 - Olimpíadas Rio 2016"},"valorDesoneracaoIcms":{"type":["number","null"]},"aliquotaDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (Utilizado somente no CST 51)"},"modalidadeBcIcms":{"type":"integer","enum":[0,1,2,3],"description":"0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação"},"STRetido":{"type":["object","null"],"properties":{"BaseCalculo":{"type":["number","null"],"description":"vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior."},"AliquotaConsumidorFinal":{"type":["number","null"],"description":"pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP)."},"ValorICMSSubstituto":{"type":["number","null"],"description":"vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior."},"ValorICMSST":{"type":["number","null"],"description":"vICMSSTRet - Valor do ICMS-ST retido na operação anterior. Opcional: quando não informado, é calculado por (BaseCalculo x AliquotaConsumidorFinal / 100 - ValorICMSSubstituto). Informe o valor fiel da nota de entrada quando ele divergir da fórmula padrão."},"BaseCalculoFCP":{"type":["number","null"],"description":"vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior."},"AliquotaFCP":{"type":["number","null"],"description":"pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100."},"PercentualReducaoBaseEfetiva":{"type":["number","null"],"description":"pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final)."},"BaseCalculoEfetiva":{"type":["number","null"],"description":"vBCEfet - Base de cálculo efetiva (consumidor final). Opcional: quando não informada, é calculada por (ValorTotal + frete + seguro + outras despesas - desconto) x (1 - PercentualReducaoBaseEfetiva/100). Informe o valor fiel quando a composição da base divergir."},"AliquotaEfetiva":{"type":["number","null"],"description":"pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100."}},"additionalProperties":false,"description":"Grupo de ICMS-ST retido em operação anterior. Preencher SOMENTE em CST 60 ou CSOSN 500 (revenda de mercadoria cujo ICMS-ST já foi retido por substituição tributária). Quando informado, prevalece sobre a estimativa automática derivada da configuração de ST do produto."},"AliquotaAdRemRetido":{"type":["number","null"],"description":"adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente)."},"QuantidadeMonoRetido":{"type":["number","null"],"description":"qBCMonoRet - Quantidade tributada retida anteriormente (em unidade de medida da legislação). Opcional no CST 61. Quando não informada, assume a quantidade comercial do item."},"ValorIcmsMonoRetido":{"type":["number","null"],"description":"vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido."}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"IPI":{"type":["object","null"],"properties":{"CodEnquadramento":{"type":"string","description":"Código de Enquadramento Legal do IPI - EXATAMENTE 3 dígitos (com zeros à esquerda se necessário). Para a maioria dos casos não imunes/suspensos use \"999\" (tributação normal sem enquadramento especial). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"CodSituacaoTributaria":{"type":"string","description":"CST do IPI. Valores: \"00\",\"49\",\"50\",\"99\" (saída tributada/não tributada/isenta/outras saídas) ou \"01\",\"02\",\"03\",\"04\",\"05\",\"51\",\"52\",\"53\",\"54\",\"55\" (entradas - usar conforme o caso). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"Aliquota":{"type":"number","description":"Aliquota do IPI"},"ValorIpiDevolvido":{"type":"number","description":"Valor do IPI devolvido"},"PercentualMercadoriaDevolvida":{"type":"number","description":"Percentual da mercadoria devolvida"}},"additionalProperties":false,"required":["CodEnquadramento","CodSituacaoTributaria"]},"PIS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do PIS (Tabela II - Situação Tributária do PIS). Valores válidos: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\" (entradas) e \"49\",\"50\",\"51\",\"52\",\"53\",\"54\",\"55\",\"56\",\"60\",\"61\",\"62\",\"63\",\"64\",\"65\",\"66\",\"67\",\"70\",\"71\",\"72\",\"73\",\"74\",\"75\",\"98\",\"99\" (saídas/outras). O CST precisa ser compatível com o tipo de NF (entrada quando CFOP começa com 1/2/3, saída quando começa com 5/6/7)."},"Aliquota":{"type":"number","description":"Aliquota do PIS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"COFINS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do COFINS (mesma tabela do PIS - Tabela II). Geralmente é o MESMO valor usado no PIS. O CST precisa ser compatível com o tipo de NF (entrada/saída) conforme o CFOP do item."},"Aliquota":{"type":"number","description":"Aliquota do COFINS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"Importacao":{"type":["object","null"],"properties":{"BaseCalculo":{"type":"number"},"DespesasAduaneiras":{"type":"number"},"Valor":{"type":"number"},"ValorIOF":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false,"description":"Tributação do item (ICMS / IPI / PIS / COFINS / IBSCBS / Importação). OBRIGATÓRIO a menos que CodTributacao esteja preenchido - nesse caso pode omitir este bloco. Para NF-e (modelo 55): ICMS + IPI + PIS + COFINS são todos obrigatórios e validados em conjunto. Para NFC-e (modelo 65): ICMS + PIS + COFINS obrigatórios; IPI dispensado."},"Combustivel":{"type":["object","null"],"properties":{"CodProdutoANP":{"type":["string","null"]},"DescricaoProdutoANP":{"type":["string","null"]},"UFConsumo":{"type":["string","null"]}},"additionalProperties":false},"DeclaracaoImportacao":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"],"description":"Número do Documento de Importação (DI, DSI, DIRE, ...)"},"DataRegistro":{"type":"string","description":"Data de Registro do documento de importação"},"LocalDesenbaraco":{"type":["string","null"],"description":"Local de Desembaraço Aduaneiro"},"UfDesenbaraco":{"type":["string","null"],"description":"Sigla da UF onde ocorreu o Desembaraço Aduaneiro"},"DataDesenbaraco":{"type":"string","description":"Data do Desembaraço Aduaneiro"},"TipoViaTransporte":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12],"description":"Via de transporte internacional informada na Declaração de Importação (DI) Valores: 1 - Marítima; 2 - Fluvial; 3 - Lacustre; 4 - Aérea; 5 - Postal; 6 - Ferroviária; 7 - Rodoviária; 8 - Conduto / Rede Transmissão; 9 - Meios Próprios; 10 - Entrada / Saída ficta; 11 - Courier; 12 - Handcarry"},"ValorAFRMM":{"type":["number","null"],"description":"Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante"},"TipoIntermedio":{"type":"integer","enum":[1,2,3],"description":"Forma de importação quanto a intermediação Valores: 1 - Importação por conta própria; 2 - Importação por conta e ordem; 3 - Importação por encomenda"},"Cnpj":{"type":["string","null"],"description":"CNPJ do adquirente ou do encomendante"},"Uf":{"type":["string","null"],"description":"Sigla da UF do adquirente ou do encomendante"},"CodExportador":{"type":["string","null"],"description":"Código do Exportador"},"CodFabricante":{"type":["string","null"],"description":"Código do Fabricante Extrangeiro"}},"additionalProperties":false},"Rastros":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroLote":{"type":["string","null"],"description":"Número do lote do produto (1-20 caracteres)"},"QuantidadeLote":{"type":"number","description":"Quantidade de produto no lote"},"DataFabricacao":{"type":"string","description":"Data de fabricação/produção"},"DataValidade":{"type":"string","description":"Data de validade"},"CodigoAgregacao":{"type":["string","null"],"description":"Código de agregação (opcional)"}},"additionalProperties":false},"description":"Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas."},"Agropecuaria":{"type":["object","null"],"properties":{"Defensivos":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroReceituario":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres)."},"CpfResponsavelTecnico":{"type":"string","description":"CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável."}},"additionalProperties":false,"required":["NumeroReceituario","CpfResponsavelTecnico"]},"description":"Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico."},"GuiaTransito":{"type":["object","null"],"properties":{"TipoGuia":{"type":"integer","enum":[1,2,3,4,5,6,7],"description":"Tipo da guia de trânsito. Valores: 1 - GTA (Guia de Trânsito Animal); 2 - TTA (Termo de Trânsito Animal); 3 - DTA (Documento de Transferência Animal); 4 - ATV (Autorização de Trânsito Vegetal); 5 - PTV (Permissão de Trânsito Vegetal); 6 - GTV (Guia de Trânsito Vegetal); 7 - Guia Florestal (DOF, SisFlora-PA/MT, SIAM-MG)"},"UfGuia":{"type":"string","description":"Sigla da UF emissora da guia (2 caracteres)."},"SerieGuia":{"type":["string","null"],"description":"Série da guia (1-9 dígitos). Opcional."},"NumeroGuia":{"type":"string","description":"Número da guia (1-9 dígitos)."}},"additionalProperties":false,"required":["TipoGuia","UfGuia","NumeroGuia"],"description":"Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal."}},"additionalProperties":false,"description":"Informações de produtos agropecuários e florestais (NT 2024.003 - Grupo ZF). Obrigatório a partir de 01/03/2026 quando o NCM cair em: 01XXXXXX / 0301XXXX (animais vivos - GuiaTransito), 06-12XXXX (vegetais primários - GuiaTransito, UFs ainda inativas), 3808.52 a 3808.99 (defensivos - Defensivos). Já obrigatório em BA, GO, MA, MT para NCM 0102XXXX (bovinos) desde 01/10/2025."}},"additionalProperties":false,"required":["NmProduto","CodProdutoServico","NCM","Quantidade","UnidadeComercial","ValorUnitario","ValorTotal","CFOP","OrigemProduto","Imposto"]},"description":"Itens da nota fiscal. Mínimo 1 item."},"Pagamentos":{"type":["array","null"],"items":{"type":"object","properties":{"IndicadorPagamento":{"type":"integer","description":"0 - A vista, 1 - Prazo"},"Desconto":{"type":"number"},"Descricao":{"type":["string","null"]},"FormaPagamento":{"type":["string","null"],"enum":["01","02","03","04","05","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","90","91","99",null],"description":"01 - Dinheiro; 02 - Cheque; 03 - Cartão de Crédito; 04 - Cartão de Débito; 05 - Cartão da Loja (Private Label), Crediário Digital, Outros Crediários; 10 - Vale Alimentação; 11 - Vale Refeição; 12 - Vale Presente; 13 - Vale Combustível; 14 - Duplicata Mercantil; 15 - Boleto Bancário; 16 - Depósito Bancário; 17 - Pagamento Instantâneo (PIX) - Dinâmico; 18 - Transferência Bancária, Carteira Digital; 19 - Programa de fidelidade, cashback, crédito virtual; 20 - Pagamento Instantâneo (PIX) - Estático; 21 - Crédito em Loja; 22 - Pagamento Eletrônico não Informado - falha de hardware; 23 - Pagamento Instantâneo (PIX) - Automático; 24 - TEF Book Transfer; 90 - Sem pagamento; 91 - Pagamento Posterior; 99 - Outros"},"VlPago":{"type":"number"},"VlTroco":{"type":"number"},"DataPagamento":{"type":["string","null"],"description":"Data do pagamento (dPag - NT 2023.004). Opcional."},"CNPJPagamento":{"type":["string","null"],"description":"CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (CNPJPag - NT 2023.004). Informar junto com UFPagamento (os dois ou nenhum). Opcional."},"UFPagamento":{"type":["string","null"],"description":"UF do estabelecimento onde o pagamento foi processado (UFPag - NT 2023.004). Opcional."},"TipoIntegracao":{"type":"boolean","description":"Pagamento integrado com automação?"},"CNPJCredenciadora":{"type":["string","null"]},"BandeiraOperadora":{"type":["string","null"],"enum":["01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","99",null],"description":"01 - Visa; 02 - Mastercard; 03 - American Express; 04 - Sorocred; 05 - Diners Club; 06 - Elo; 07 - Hipercard; 08 - Aura; 09 - Cabal; 10 - Alelo; 11 - Banes Card; 12 - CalCard; 13 - Credz; 14 - Discover; 15 - GoodCard; 16 - GreenCard; 17 - Hiper; 18 - JcB; 19 - Mais; 20 - MaxVan; 21 - Policard; 22 - RedeCompras; 23 - Sodexo; 24 - ValeCard; 25 - Verocheque; 26 - VR; 27 - Ticket; 99 - Outros"},"NumeroAutorizacao":{"type":["string","null"],"description":"Número de autorização da operação (cAut). Para PIX, informar o EndToEndId (e2eid) da transação."},"CNPJRecebedor":{"type":["string","null"],"description":"CNPJ do beneficiário do pagamento (CNPJReceb - NT 2023.004). Opcional."},"IdTerminalPagamento":{"type":["string","null"],"description":"Identificador do terminal de pagamento (idTermPag - NT 2023.004). Opcional, 1-40 caracteres."}},"additionalProperties":false},"description":"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 \"90\" (sem pagamento)."},"Cobranca":{"type":["object","null"],"properties":{"Fatura":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"]},"Valor":{"type":"number"},"Desconto":{"type":"number"},"ValorLiquido":{"type":"number"}},"additionalProperties":false},"Parcelas":{"type":["array","null"],"items":{"type":"object","properties":{"Vencimento":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Valor":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false},"Transporte":{"type":["object","null"],"properties":{"ModalidadeFrete":{"type":"integer","enum":[0,1,2,3,4,9],"description":"0 - Contratação do Frete por conta do Remetente (CIF); 1 - Contratação do Frete por conta do Destinatário (FOB); 2 - Contratação do Frete por conta de Terceiros; 3 - Transporte Próprio por conta do Remetente; 4 - Transporte Próprio por conta do Destinatário; 9 - Sem Ocorrência de Transporte"},"NmTransportador":{"type":["string","null"]},"CNPJ":{"type":["string","null"]},"NmMunicipio":{"type":["string","null"]},"DsEndereco":{"type":["string","null"]},"IE":{"type":["string","null"]},"UF":{"type":["string","null"]},"Vagao":{"type":["string","null"]},"Balsa":{"type":["string","null"]},"Veiculo":{"type":["object","null"],"properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false},"Reboque":{"type":["array","null"],"items":{"type":"object","properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false}},"Volumes":{"type":["array","null"],"items":{"type":"object","properties":{"Numero":{"type":["string","null"]},"QuantidadeVolume":{"type":"integer"},"Especie":{"type":["string","null"]},"Marca":{"type":["string","null"]},"PesoBruto":{"type":"number"},"PesoLiquido":{"type":"number"},"Lacres":{"type":["array","null"],"items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false},"Exporta":{"type":["object","null"],"properties":{"LocalDespacho":{"type":["string","null"],"description":"Descrição do local de despacho"},"UFSaidaPais":{"type":["string","null"],"description":"Sigla da UF de Embarque ou de transposição de fronteira"},"LocalEmbarqueTransp":{"type":["string","null"],"description":"Descrição do Local de Embarque ou de transposição de fronteira"}},"additionalProperties":false},"Entrega":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Retencoes":{"type":["object","null"],"properties":{"BaseCalculoIRRF":{"type":["number","null"],"description":"Base de cálculo do IRRF"},"ValorIRRF":{"type":["number","null"],"description":"Valor retido do IRRF"},"ValorRetidoPIS":{"type":["number","null"],"description":"Valor retido de PIS"},"ValorRetidoCOFINS":{"type":["number","null"],"description":"Valor retido de COFINS"},"ValorRetidoCSLL":{"type":["number","null"],"description":"Valor retido de CSLL"},"BaseCalculoRetencaoPrevidencia":{"type":["number","null"],"description":"Base de cálculo da retenção da Previdência Social"},"ValorRetencaoPrevidencia":{"type":["number","null"],"description":"Valor da retenção da Previdência Social"}},"additionalProperties":false,"description":"Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML."},"ValorFrete":{"type":["number","null"],"description":"Valor total do frete da nota. Quando informado, é distribuído proporcionalmente entre os itens (proporção pelo ValorTotal de cada item), SUBSTITUINDO o ValorFrete informado em cada produto. Não informado (nulo) = o frete de cada item é usado como enviado."},"ValorTotal":{"type":["number","null"],"description":"Valor total esperado da nota (vNF), usado apenas para validação. Quando informado e diferente do valor total calculado (produtos - descontos + frete + seguro + outras despesas + impostos que compõem o total), a emissão é bloqueada e o erro detalha o cálculo. Não informado (nulo) = sem validação."}},"required":["IndicadorPresenca","NaturezaOperacao","ModeloDocumento","Finalidade","TipoAmbiente","Produtos"],"additionalProperties":false}},{"name":"nfe_emitir_complementar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoComplemento":{"type":"integer","enum":[0,1],"description":"Tipo de complemento Valores: 0 - Complementar quantidade ou valor; 1 - Complementar impostos","default":1},"CFOP":{"type":"integer","description":"CFOP"},"Serie":{"type":["integer","null"],"description":"Série da nota Fiscal"},"Numero":{"type":["integer","null"],"description":"Número da nota fiscal"},"Lote":{"type":["integer","null"],"description":"Lote da Nota Fiscal"},"Codigo":{"type":["string","null"],"description":"Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e."},"NFReferencia":{"type":["string","null"],"description":"Notas fiscal de Referência"},"NaturezaOperacao":{"type":["string","null"],"description":"Descrição da Natureza da Operação"},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação"},"ObservacaoFisco":{"type":["string","null"]},"Observacao":{"type":["string","null"]},"Cliente":{"type":["object","null"],"properties":{"CpfCnpj":{"type":"string","description":"CPF (11 dígitos) ou CNPJ (14 dígitos) do destinatário. Aceita com ou sem máscara - o sistema normaliza. Obrigatório para NF-e (modelo 55). Em operações de exportação (CFOP iniciado em 3/7) pode ter de 5 a 20 caracteres."},"NmCliente":{"type":"string","description":"Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55)."},"IndicadorIe":{"type":"integer","enum":[1,2,9],"description":"Indicador de Inscrição Estadual. Para NFC-e (modelo 65) DEVE ser 9. Para NF-e (modelo 55) aceita 1, 2 ou 9. Valores: 1 - Contribuinte ICMS (informar a IE do destinatário); 2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS; 9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS","default":9},"Ie":{"type":["string","null"]},"IsUf":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"required":["CpfCnpj","NmCliente"]},"Transporte":{"type":["object","null"],"properties":{"ModalidadeFrete":{"type":"integer","enum":[0,1,2,3,4,9],"description":"0 - Contratação do Frete por conta do Remetente (CIF); 1 - Contratação do Frete por conta do Destinatário (FOB); 2 - Contratação do Frete por conta de Terceiros; 3 - Transporte Próprio por conta do Remetente; 4 - Transporte Próprio por conta do Destinatário; 9 - Sem Ocorrência de Transporte"},"NmTransportador":{"type":["string","null"]},"CNPJ":{"type":["string","null"]},"NmMunicipio":{"type":["string","null"]},"DsEndereco":{"type":["string","null"]},"IE":{"type":["string","null"]},"UF":{"type":["string","null"]},"Vagao":{"type":["string","null"]},"Balsa":{"type":["string","null"]},"Veiculo":{"type":["object","null"],"properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false},"Reboque":{"type":["array","null"],"items":{"type":"object","properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false}},"Volumes":{"type":["array","null"],"items":{"type":"object","properties":{"Numero":{"type":["string","null"]},"QuantidadeVolume":{"type":"integer"},"Especie":{"type":["string","null"]},"Marca":{"type":["string","null"]},"PesoBruto":{"type":"number"},"PesoLiquido":{"type":"number"},"Lacres":{"type":["array","null"],"items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false},"Cobranca":{"type":["object","null"],"properties":{"Fatura":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"]},"Valor":{"type":"number"},"Desconto":{"type":"number"},"ValorLiquido":{"type":"number"}},"additionalProperties":false},"Parcelas":{"type":["array","null"],"items":{"type":"object","properties":{"Vencimento":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Valor":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false},"ImpostoComplementar":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":["string","null"],"description":"Código da Situação Tributária (CST)"},"AliquotaICMS":{"type":"number","description":"Alíquota ICMS"},"AliquotaICMSST":{"type":"number","description":"Alíquota ICMSST"},"BaseCalculoICMS":{"type":"number","description":"Base de cálculo do ICMS complementar"},"ValorICMS":{"type":"number","description":"Valor do complemento do ICMS"},"BaseCalculoICMSST":{"type":"number","description":"Base de cálculo do ICMSST complementar"},"ValorICMSST":{"type":"number","description":"Valor do complemento do ICMSST"},"BaseCalculoIPI":{"type":"number","description":"Base de cálculo do IPI"},"ValorIPI":{"type":"number","description":"Valor do complemento do IPI"}},"additionalProperties":false},"Produtos":{"type":["array","null"],"items":{"type":"object","properties":{"NmProduto":{"type":"string","description":"Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\"."},"CodProdutoServico":{"type":"string","description":"Código/SKU INTERNO do produto no cadastro da empresa (1-60 caracteres alfanuméricos). NÃO usar NCM, CFOP, EAN, GTIN nem códigos da Receita aqui - cada um tem campo próprio (NCM, CFOP, EAN). Exemplos válidos: \"PROD-001\", \"DETIPE500\", \"SKU12345\". Se a empresa não usa SKU interno, repita o EAN ou use \"1\"."},"EAN":{"type":["string","null"],"description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras (8, 12, 13 ou 14 dígitos). Quando o produto não tem GTIN cadastrado, informe a string \"SEM GTIN\" (literal). Não usar como código interno."},"NCM":{"type":"string","description":"Código NCM com exatamente 8 dígitos (Nomenclatura Comum do Mercosul). Identifica a classificação fiscal do produto na Receita. NÃO é o código interno - código interno vai em CodProdutoServico. Para serviços ou itens sem produto físico (transferência de crédito, etc.), use \"00000000\"."},"CEST":{"type":["string","null"],"description":"Código CEST (7 dígitos). Obrigatório quando o CST/CSOSN do ICMS indicar substituição tributária (rejeição 806 da SEFAZ). Consulte a tabela CEST oficial pelo NCM do produto."},"Quantidade":{"type":"number","description":"Quantidade comercial do produto. Aceita de 0 a 4 casas decimais e até 11 inteiros. Deve ser maior que zero (exceto para finalidade 2 - Complementar e 3 - Ajuste)."},"QuantidadeTributavel":{"type":["number","null"],"description":"Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros."},"UnidadeComercial":{"type":"string","description":"Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\"."},"UnidadeComercialTributavel":{"type":["string","null"],"description":"Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial."},"ValorDesconto":{"type":"number","description":"Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal)."},"ValorUnitario":{"type":"number","description":"Valor unitário do produto (>= 0). Aceita até 10 casas decimais."},"ValorUnitarioTributavel":{"type":["number","null"],"description":"Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario."},"ValorTotal":{"type":"number","description":"Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0."},"ValorSeguro":{"type":["number","null"],"description":"Valor Seguro"},"ValorFrete":{"type":["number","null"],"description":"Valor Frete"},"ValorOutrasDespesas":{"type":["number","null"],"description":"Valor Outras Despesas"},"CFOP":{"type":"integer","description":"Código Fiscal de Operações e Prestações (CFOP). Exatamente 4 dígitos. Primeiro dígito indica a natureza: 1/2/3 = entrada (interna/interestadual/exterior), 5/6/7 = saída (interna/interestadual/exterior). Para NFC-e (modelo 65) só são aceitos: 5101, 5102, 5103, 5104, 5115, 5405, 5656, 5667, 5933 (rejeição 725)."},"NItemPed":{"type":["integer","null"],"description":"Número do item do Pedido de Compra"},"xPed":{"type":["string","null"],"description":"Número do Pedido de Compra"},"ChaveAcessoReferenciada":{"type":["string","null"],"description":"Chave de acesso (44 dígitos) da NF-e ORIGINAL que este item está devolvendo. Usado apenas em NF-e de devolução (Finalidade = 4, Reforma Tributária / NT 2025.002). Quando preenchida, o item é referenciado pelo grupo DFeReferenciado (por item) em vez do NFReferencia (nível nota) - os dois não podem coexistir."},"NItemReferenciado":{"type":["integer","null"],"description":"Número do item (nItem) na NF-e ORIGINAL a que este item de devolução corresponde. É o número do item na nota de venda original, NÃO o número do item nesta devolução. Opcional; acompanha ChaveAcessoReferenciada."},"nFCI":{"type":["string","null"],"description":"Número de controle da FCI - Ficha de Conteúdo de Importação"},"cBenef":{"type":["string","null"],"description":"Código de Beneficio Fiscal na UF"},"InformacaoAdicional":{"type":["string","null"],"description":"Informaçoes adicional"},"OrigemProduto":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8],"description":"Origem do produto (Tabela A da NF-e). Padrão para a maioria dos casos = 0 (nacional). Valores: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; 1 - Estrangeira - Importação direta, exceto a indicada no código 6; 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7; 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%; 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes; 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural; 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural; 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%","default":0},"CodTributacao":{"type":["string","null"],"description":"Código do grupo tributário pré-cadastrado no Painel. Quando informado, o sistema aplica automaticamente CFOP, CST, ICMS, IPI, PIS e COFINS do grupo, dispensando o preenchimento do bloco Imposto e do CFOP do item."},"Imposto":{"type":"object","properties":{"IBSCBS":{"type":["object","null"],"properties":{"CodClassificacaoTributaria":{"type":["string","null"],"description":"Código de Classificação Tributária (Padrão 000001)"},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo"},"AliquotaIBSUF":{"type":["number","null"],"description":"Alíquota do IBS de competência das UF"},"AliquotaIBSMun":{"type":["number","null"],"description":"Alíquota do IBS de competência do Município"},"AliquotaCBS":{"type":["number","null"],"description":"Alíquota da CBS"},"PercentualReducaoIBS":{"type":["number","null"],"description":"Percentual de redução da alíquota do IBS (pRedAliq de gIBSUF/gIBSMun), usado no grupo gRed dos CST 011/200/515. Fixo por cClassTrib na tabela oficial (ex.: 100 para 200003 alimentação/Anexo I, 60 para educação/saúde). Quando null, é preenchido automaticamente pela tabela oficial (TabelaReducaoIbsCbs)."},"PercentualReducaoCBS":{"type":["number","null"],"description":"Percentual de redução da alíquota da CBS (pRedAliq de gCBS). Pode divergir de PercentualReducaoIBS (ex.: 200025 = IBS 60 / CBS 100). Quando null, é preenchido automaticamente pela tabela oficial."},"PercentualDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (pDif do grupo gDif), usado nos CST 510/515. Informado pelo contribuinte - NÃO é fixo por cClassTrib. O valor diferido (vDif) é deduzido do IBS/CBS devido."}},"additionalProperties":false},"ICMS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"Código da Situação Tributária (CST) do ICMS, OU Código de Situação da Operação no Simples Nacional (CSOSN). Para empresas no Simples Nacional (CRT 1) ou MEI (CRT 4) use CSOSN: \"101\",\"102\",\"103\",\"201\",\"202\",\"203\",\"300\",\"400\",\"500\",\"900\". Para empresas em Regime Normal (CRT 3) use CST do ICMS: \"00\",\"10\",\"20\",\"30\",\"40\",\"41\",\"50\",\"51\",\"60\",\"70\",\"90\"."},"AliquotaICMS":{"type":["number","null"],"description":"Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201"},"AliquotaICMSST":{"type":["number","null"],"description":"Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201"},"AliquotaMVA":{"type":["number","null"],"description":"Alíquota - Obrigatório para situação tributária nº 201, 202 e 203"},"AliquotaCredito":{"type":["number","null"],"description":"Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201"},"RedICMS":{"type":["number","null"],"description":"Redução ICMS"},"RedICMSST":{"type":["number","null"],"description":"Redução ICMS ST"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"},"ValorIcms":{"type":["number","null"],"description":"Valor do Icms (Calculado Automaticamente quando não informado)"},"motivoDesoneracaoIcms":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,8,9,10,11,16,null],"description":"1 - Táxi;; 2 - Deficiente Físico;; 3 - Produtor Agropecuário;; 4 - Frotista / Locadora;; 5 - Diplomático / Consular;; 6 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 - CONTRAN e suas alterações);; 7 - SUFRAMA; 8 - Venda a Orgãos Publicos; 9 - Outros. (v2.0); 10 - Deficiente Condutor (Convênio ICMS 38/12). (v3.1); 11 - Deficiente não Condutor (Convênio ICMS 38/12). (v3.1); 16 - Olimpíadas Rio 2016"},"valorDesoneracaoIcms":{"type":["number","null"]},"aliquotaDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (Utilizado somente no CST 51)"},"modalidadeBcIcms":{"type":"integer","enum":[0,1,2,3],"description":"0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação"},"STRetido":{"type":["object","null"],"properties":{"BaseCalculo":{"type":["number","null"],"description":"vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior."},"AliquotaConsumidorFinal":{"type":["number","null"],"description":"pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP)."},"ValorICMSSubstituto":{"type":["number","null"],"description":"vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior."},"ValorICMSST":{"type":["number","null"],"description":"vICMSSTRet - Valor do ICMS-ST retido na operação anterior. Opcional: quando não informado, é calculado por (BaseCalculo x AliquotaConsumidorFinal / 100 - ValorICMSSubstituto). Informe o valor fiel da nota de entrada quando ele divergir da fórmula padrão."},"BaseCalculoFCP":{"type":["number","null"],"description":"vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior."},"AliquotaFCP":{"type":["number","null"],"description":"pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100."},"PercentualReducaoBaseEfetiva":{"type":["number","null"],"description":"pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final)."},"BaseCalculoEfetiva":{"type":["number","null"],"description":"vBCEfet - Base de cálculo efetiva (consumidor final). Opcional: quando não informada, é calculada por (ValorTotal + frete + seguro + outras despesas - desconto) x (1 - PercentualReducaoBaseEfetiva/100). Informe o valor fiel quando a composição da base divergir."},"AliquotaEfetiva":{"type":["number","null"],"description":"pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100."}},"additionalProperties":false,"description":"Grupo de ICMS-ST retido em operação anterior. Preencher SOMENTE em CST 60 ou CSOSN 500 (revenda de mercadoria cujo ICMS-ST já foi retido por substituição tributária). Quando informado, prevalece sobre a estimativa automática derivada da configuração de ST do produto."},"AliquotaAdRemRetido":{"type":["number","null"],"description":"adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente)."},"QuantidadeMonoRetido":{"type":["number","null"],"description":"qBCMonoRet - Quantidade tributada retida anteriormente (em unidade de medida da legislação). Opcional no CST 61. Quando não informada, assume a quantidade comercial do item."},"ValorIcmsMonoRetido":{"type":["number","null"],"description":"vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido."}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"IPI":{"type":["object","null"],"properties":{"CodEnquadramento":{"type":"string","description":"Código de Enquadramento Legal do IPI - EXATAMENTE 3 dígitos (com zeros à esquerda se necessário). Para a maioria dos casos não imunes/suspensos use \"999\" (tributação normal sem enquadramento especial). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"CodSituacaoTributaria":{"type":"string","description":"CST do IPI. Valores: \"00\",\"49\",\"50\",\"99\" (saída tributada/não tributada/isenta/outras saídas) ou \"01\",\"02\",\"03\",\"04\",\"05\",\"51\",\"52\",\"53\",\"54\",\"55\" (entradas - usar conforme o caso). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"Aliquota":{"type":"number","description":"Aliquota do IPI"},"ValorIpiDevolvido":{"type":"number","description":"Valor do IPI devolvido"},"PercentualMercadoriaDevolvida":{"type":"number","description":"Percentual da mercadoria devolvida"}},"additionalProperties":false,"required":["CodEnquadramento","CodSituacaoTributaria"]},"PIS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do PIS (Tabela II - Situação Tributária do PIS). Valores válidos: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\" (entradas) e \"49\",\"50\",\"51\",\"52\",\"53\",\"54\",\"55\",\"56\",\"60\",\"61\",\"62\",\"63\",\"64\",\"65\",\"66\",\"67\",\"70\",\"71\",\"72\",\"73\",\"74\",\"75\",\"98\",\"99\" (saídas/outras). O CST precisa ser compatível com o tipo de NF (entrada quando CFOP começa com 1/2/3, saída quando começa com 5/6/7)."},"Aliquota":{"type":"number","description":"Aliquota do PIS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"COFINS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do COFINS (mesma tabela do PIS - Tabela II). Geralmente é o MESMO valor usado no PIS. O CST precisa ser compatível com o tipo de NF (entrada/saída) conforme o CFOP do item."},"Aliquota":{"type":"number","description":"Aliquota do COFINS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"Importacao":{"type":["object","null"],"properties":{"BaseCalculo":{"type":"number"},"DespesasAduaneiras":{"type":"number"},"Valor":{"type":"number"},"ValorIOF":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false,"description":"Tributação do item (ICMS / IPI / PIS / COFINS / IBSCBS / Importação). OBRIGATÓRIO a menos que CodTributacao esteja preenchido - nesse caso pode omitir este bloco. Para NF-e (modelo 55): ICMS + IPI + PIS + COFINS são todos obrigatórios e validados em conjunto. Para NFC-e (modelo 65): ICMS + PIS + COFINS obrigatórios; IPI dispensado."},"Combustivel":{"type":["object","null"],"properties":{"CodProdutoANP":{"type":["string","null"]},"DescricaoProdutoANP":{"type":["string","null"]},"UFConsumo":{"type":["string","null"]}},"additionalProperties":false},"DeclaracaoImportacao":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"],"description":"Número do Documento de Importação (DI, DSI, DIRE, ...)"},"DataRegistro":{"type":"string","description":"Data de Registro do documento de importação"},"LocalDesenbaraco":{"type":["string","null"],"description":"Local de Desembaraço Aduaneiro"},"UfDesenbaraco":{"type":["string","null"],"description":"Sigla da UF onde ocorreu o Desembaraço Aduaneiro"},"DataDesenbaraco":{"type":"string","description":"Data do Desembaraço Aduaneiro"},"TipoViaTransporte":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12],"description":"Via de transporte internacional informada na Declaração de Importação (DI) Valores: 1 - Marítima; 2 - Fluvial; 3 - Lacustre; 4 - Aérea; 5 - Postal; 6 - Ferroviária; 7 - Rodoviária; 8 - Conduto / Rede Transmissão; 9 - Meios Próprios; 10 - Entrada / Saída ficta; 11 - Courier; 12 - Handcarry"},"ValorAFRMM":{"type":["number","null"],"description":"Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante"},"TipoIntermedio":{"type":"integer","enum":[1,2,3],"description":"Forma de importação quanto a intermediação Valores: 1 - Importação por conta própria; 2 - Importação por conta e ordem; 3 - Importação por encomenda"},"Cnpj":{"type":["string","null"],"description":"CNPJ do adquirente ou do encomendante"},"Uf":{"type":["string","null"],"description":"Sigla da UF do adquirente ou do encomendante"},"CodExportador":{"type":["string","null"],"description":"Código do Exportador"},"CodFabricante":{"type":["string","null"],"description":"Código do Fabricante Extrangeiro"}},"additionalProperties":false},"Rastros":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroLote":{"type":["string","null"],"description":"Número do lote do produto (1-20 caracteres)"},"QuantidadeLote":{"type":"number","description":"Quantidade de produto no lote"},"DataFabricacao":{"type":"string","description":"Data de fabricação/produção"},"DataValidade":{"type":"string","description":"Data de validade"},"CodigoAgregacao":{"type":["string","null"],"description":"Código de agregação (opcional)"}},"additionalProperties":false},"description":"Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas."},"Agropecuaria":{"type":["object","null"],"properties":{"Defensivos":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroReceituario":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres)."},"CpfResponsavelTecnico":{"type":"string","description":"CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável."}},"additionalProperties":false,"required":["NumeroReceituario","CpfResponsavelTecnico"]},"description":"Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico."},"GuiaTransito":{"type":["object","null"],"properties":{"TipoGuia":{"type":"integer","enum":[1,2,3,4,5,6,7],"description":"Tipo da guia de trânsito. Valores: 1 - GTA (Guia de Trânsito Animal); 2 - TTA (Termo de Trânsito Animal); 3 - DTA (Documento de Transferência Animal); 4 - ATV (Autorização de Trânsito Vegetal); 5 - PTV (Permissão de Trânsito Vegetal); 6 - GTV (Guia de Trânsito Vegetal); 7 - Guia Florestal (DOF, SisFlora-PA/MT, SIAM-MG)"},"UfGuia":{"type":"string","description":"Sigla da UF emissora da guia (2 caracteres)."},"SerieGuia":{"type":["string","null"],"description":"Série da guia (1-9 dígitos). Opcional."},"NumeroGuia":{"type":"string","description":"Número da guia (1-9 dígitos)."}},"additionalProperties":false,"required":["TipoGuia","UfGuia","NumeroGuia"],"description":"Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal."}},"additionalProperties":false,"description":"Informações de produtos agropecuários e florestais (NT 2024.003 - Grupo ZF). Obrigatório a partir de 01/03/2026 quando o NCM cair em: 01XXXXXX / 0301XXXX (animais vivos - GuiaTransito), 06-12XXXX (vegetais primários - GuiaTransito, UFs ainda inativas), 3808.52 a 3808.99 (defensivos - Defensivos). Já obrigatório em BA, GO, MA, MT para NCM 0102XXXX (bovinos) desde 01/10/2025."}},"additionalProperties":false,"required":["NmProduto","CodProdutoServico","NCM","Quantidade","UnidadeComercial","ValorUnitario","ValorTotal","CFOP","OrigemProduto","Imposto"]}}},"additionalProperties":false}},{"name":"nfe_previsualizar","description":"Gera o DANFE em PDF como pré-visualização, sem enviar para a SEFAZ. Útil para conferência visual antes de emitir.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"notaFiscal":{"type":["object","null"],"properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação"},"ModeloDocumento":{"type":"integer","enum":[55,65],"description":"Código do modelo do Documento Fiscal (Padrão 55) Valores: 55 - NF-e; 65 - NFC-e","default":55},"Lote":{"type":["integer","null"],"description":"Lote da Nota Fiscal"},"nFInfos":{"type":["array","null"],"items":{"type":"object","properties":{"Serie":{"type":["integer","null"],"description":"Série da nota Fiscal"},"Numero":{"type":["integer","null"],"description":"Número da nota fiscal"},"Lote":{"type":["integer","null"],"description":"Lote da Nota Fiscal"},"DataEntradaSaida":{"type":["string","null"],"description":"Data e Hora da saída ou de entrada da produto/serviço"},"DataEmissao":{"type":["string","null"],"description":"Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)"},"Codigo":{"type":["string","null"],"description":"B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e."},"Justificativa":{"type":["string","null"],"description":"Utilizar quando o tipo de emissão for diferente normal"},"NFReferencia":{"type":["array","null"],"items":{"type":"string"},"description":"Notas fiscal de Referência"},"NFPagamentoAntecipado":{"type":["array","null"],"items":{"type":"string"},"description":"Grupo de notas de antecipação de pagamento (gPagAntecipado - Reforma Tributária)."},"IndicadorPresenca":{"type":"integer","enum":[0,1,2,3,4,5,9],"description":"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.","default":9},"Intermediador":{"type":["object","null"],"properties":{"Cnpj":{"type":"string","description":"CNPJ do intermediador da transação (marketplace/plataforma de terceiros). Obrigatório."},"IdCadIntTran":{"type":"string","description":"Identificação do vendedor no site do intermediador (usuário/login cadastrado). Obrigatório."}},"additionalProperties":false,"required":["Cnpj","IdCadIntTran"],"description":"Dados do intermediador/marketplace (site ou plataforma de terceiros)."},"ConsumidorFinal":{"type":"boolean","description":"Indica operação com Consumidor final (NFCe de ser 1 Validar!)"},"CalcularIBPT":{"type":"boolean","description":"Indica operação com Consumidor final (NFCe de ser 1 Validar!)","default":true},"NaturezaOperacao":{"type":"string","description":"Descrição da natureza da operação (máx 60 caracteres). Exemplos: \"Venda de mercadoria\", \"Remessa para industrialização\", \"Devolução de venda\"."},"ModeloDocumento":{"type":"integer","enum":[55,65],"description":"Código do modelo do Documento Fiscal. Valores: 55 - NF-e (B2B / com destinatário CPF/CNPJ identificado); 65 - NFC-e (consumidor final / varejo)","default":55},"Finalidade":{"type":"integer","enum":[1,2,3,4,5,6],"description":"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","default":1},"TipoDanfe":{"type":["integer","null"],"enum":[0,1,2,3,4,5,6,null],"description":"Formato de impressão do DANFE (tag tpImp da NF-e). Não informado = padrão atual (1-Retrato para NF-e, 4 para NFC-e). Valores: 0 - Sem geração de DANFE; 1 - DANFE normal, Retrato (padrão NF-e); 2 - DANFE normal, Paisagem; 3 - DANFE Simplificado; 4 - DANFE NFC-e (padrão NFC-e; somente modelo 65); 5 - DANFE NFC-e em mensagem eletrônica (somente modelo 65); 6 - DANFE Simplificado Tipo 2 (NT 2026.002/2026.003, Ajuste SINIEF 13/26; somente modelo 55) - NF-e de varejo em operação típica de NFC-e, impressa em bobina com QR Code. Exige operação interna (CFOP 5xxx), consumidor final, finalidade 1-Normal, saída, sem notas referenciadas e IndicadorPresenca 1, 4 ou 5."},"TpNFDebito":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,null],"description":"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 notas fiscais não processadas na apuração; 4 - Multa e juros; 5 - Transferência de crédito de sucessão; 6 - Pagamento antecipado; 7 - Perda em estoque"},"TpNFCredito":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"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 por recusa total na entrega ou por não localização do destinatário; 4 - Redução de valores; 5 - Transferência de crédito na sucessão; 6 - Retorno por recusa parcial na entrega"},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"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)","default":2},"Observacao":{"type":["string","null"]},"ObservacaoFisco":{"type":["string","null"]},"IdentificadorInterno":{"type":["string","null"]},"EnviarEmail":{"type":"boolean"},"Cliente":{"type":["object","null"],"properties":{"CpfCnpj":{"type":"string","description":"CPF (11 dígitos) ou CNPJ (14 dígitos) do destinatário. Aceita com ou sem máscara - o sistema normaliza. Obrigatório para NF-e (modelo 55). Em operações de exportação (CFOP iniciado em 3/7) pode ter de 5 a 20 caracteres."},"NmCliente":{"type":"string","description":"Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55)."},"IndicadorIe":{"type":"integer","enum":[1,2,9],"description":"Indicador de Inscrição Estadual. Para NFC-e (modelo 65) DEVE ser 9. Para NF-e (modelo 55) aceita 1, 2 ou 9. Valores: 1 - Contribuinte ICMS (informar a IE do destinatário); 2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS; 9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS","default":9},"Ie":{"type":["string","null"]},"IsUf":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"required":["CpfCnpj","NmCliente"],"description":"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)."},"Produtos":{"type":"array","items":{"type":"object","properties":{"NmProduto":{"type":"string","description":"Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\"."},"CodProdutoServico":{"type":"string","description":"Código/SKU INTERNO do produto no cadastro da empresa (1-60 caracteres alfanuméricos). NÃO usar NCM, CFOP, EAN, GTIN nem códigos da Receita aqui - cada um tem campo próprio (NCM, CFOP, EAN). Exemplos válidos: \"PROD-001\", \"DETIPE500\", \"SKU12345\". Se a empresa não usa SKU interno, repita o EAN ou use \"1\"."},"EAN":{"type":["string","null"],"description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras (8, 12, 13 ou 14 dígitos). Quando o produto não tem GTIN cadastrado, informe a string \"SEM GTIN\" (literal). Não usar como código interno."},"NCM":{"type":"string","description":"Código NCM com exatamente 8 dígitos (Nomenclatura Comum do Mercosul). Identifica a classificação fiscal do produto na Receita. NÃO é o código interno - código interno vai em CodProdutoServico. Para serviços ou itens sem produto físico (transferência de crédito, etc.), use \"00000000\"."},"CEST":{"type":["string","null"],"description":"Código CEST (7 dígitos). Obrigatório quando o CST/CSOSN do ICMS indicar substituição tributária (rejeição 806 da SEFAZ). Consulte a tabela CEST oficial pelo NCM do produto."},"Quantidade":{"type":"number","description":"Quantidade comercial do produto. Aceita de 0 a 4 casas decimais e até 11 inteiros. Deve ser maior que zero (exceto para finalidade 2 - Complementar e 3 - Ajuste)."},"QuantidadeTributavel":{"type":["number","null"],"description":"Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros."},"UnidadeComercial":{"type":"string","description":"Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\"."},"UnidadeComercialTributavel":{"type":["string","null"],"description":"Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial."},"ValorDesconto":{"type":"number","description":"Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal)."},"ValorUnitario":{"type":"number","description":"Valor unitário do produto (>= 0). Aceita até 10 casas decimais."},"ValorUnitarioTributavel":{"type":["number","null"],"description":"Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario."},"ValorTotal":{"type":"number","description":"Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0."},"ValorSeguro":{"type":["number","null"],"description":"Valor Seguro"},"ValorFrete":{"type":["number","null"],"description":"Valor Frete"},"ValorOutrasDespesas":{"type":["number","null"],"description":"Valor Outras Despesas"},"CFOP":{"type":"integer","description":"Código Fiscal de Operações e Prestações (CFOP). Exatamente 4 dígitos. Primeiro dígito indica a natureza: 1/2/3 = entrada (interna/interestadual/exterior), 5/6/7 = saída (interna/interestadual/exterior). Para NFC-e (modelo 65) só são aceitos: 5101, 5102, 5103, 5104, 5115, 5405, 5656, 5667, 5933 (rejeição 725)."},"NItemPed":{"type":["integer","null"],"description":"Número do item do Pedido de Compra"},"xPed":{"type":["string","null"],"description":"Número do Pedido de Compra"},"ChaveAcessoReferenciada":{"type":["string","null"],"description":"Chave de acesso (44 dígitos) da NF-e ORIGINAL que este item está devolvendo. Usado apenas em NF-e de devolução (Finalidade = 4, Reforma Tributária / NT 2025.002). Quando preenchida, o item é referenciado pelo grupo DFeReferenciado (por item) em vez do NFReferencia (nível nota) - os dois não podem coexistir."},"NItemReferenciado":{"type":["integer","null"],"description":"Número do item (nItem) na NF-e ORIGINAL a que este item de devolução corresponde. É o número do item na nota de venda original, NÃO o número do item nesta devolução. Opcional; acompanha ChaveAcessoReferenciada."},"nFCI":{"type":["string","null"],"description":"Número de controle da FCI - Ficha de Conteúdo de Importação"},"cBenef":{"type":["string","null"],"description":"Código de Beneficio Fiscal na UF"},"InformacaoAdicional":{"type":["string","null"],"description":"Informaçoes adicional"},"OrigemProduto":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8],"description":"Origem do produto (Tabela A da NF-e). Padrão para a maioria dos casos = 0 (nacional). Valores: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; 1 - Estrangeira - Importação direta, exceto a indicada no código 6; 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7; 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%; 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes; 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural; 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural; 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%","default":0},"CodTributacao":{"type":["string","null"],"description":"Código do grupo tributário pré-cadastrado no Painel. Quando informado, o sistema aplica automaticamente CFOP, CST, ICMS, IPI, PIS e COFINS do grupo, dispensando o preenchimento do bloco Imposto e do CFOP do item."},"Imposto":{"type":"object","properties":{"IBSCBS":{"type":["object","null"],"properties":{"CodClassificacaoTributaria":{"type":["string","null"],"description":"Código de Classificação Tributária (Padrão 000001)"},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo"},"AliquotaIBSUF":{"type":["number","null"],"description":"Alíquota do IBS de competência das UF"},"AliquotaIBSMun":{"type":["number","null"],"description":"Alíquota do IBS de competência do Município"},"AliquotaCBS":{"type":["number","null"],"description":"Alíquota da CBS"},"PercentualReducaoIBS":{"type":["number","null"],"description":"Percentual de redução da alíquota do IBS (pRedAliq de gIBSUF/gIBSMun), usado no grupo gRed dos CST 011/200/515. Fixo por cClassTrib na tabela oficial (ex.: 100 para 200003 alimentação/Anexo I, 60 para educação/saúde). Quando null, é preenchido automaticamente pela tabela oficial (TabelaReducaoIbsCbs)."},"PercentualReducaoCBS":{"type":["number","null"],"description":"Percentual de redução da alíquota da CBS (pRedAliq de gCBS). Pode divergir de PercentualReducaoIBS (ex.: 200025 = IBS 60 / CBS 100). Quando null, é preenchido automaticamente pela tabela oficial."},"PercentualDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (pDif do grupo gDif), usado nos CST 510/515. Informado pelo contribuinte - NÃO é fixo por cClassTrib. O valor diferido (vDif) é deduzido do IBS/CBS devido."}},"additionalProperties":false},"ICMS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"Código da Situação Tributária (CST) do ICMS, OU Código de Situação da Operação no Simples Nacional (CSOSN). Para empresas no Simples Nacional (CRT 1) ou MEI (CRT 4) use CSOSN: \"101\",\"102\",\"103\",\"201\",\"202\",\"203\",\"300\",\"400\",\"500\",\"900\". Para empresas em Regime Normal (CRT 3) use CST do ICMS: \"00\",\"10\",\"20\",\"30\",\"40\",\"41\",\"50\",\"51\",\"60\",\"70\",\"90\"."},"AliquotaICMS":{"type":["number","null"],"description":"Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201"},"AliquotaICMSST":{"type":["number","null"],"description":"Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201"},"AliquotaMVA":{"type":["number","null"],"description":"Alíquota - Obrigatório para situação tributária nº 201, 202 e 203"},"AliquotaCredito":{"type":["number","null"],"description":"Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201"},"RedICMS":{"type":["number","null"],"description":"Redução ICMS"},"RedICMSST":{"type":["number","null"],"description":"Redução ICMS ST"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"},"ValorIcms":{"type":["number","null"],"description":"Valor do Icms (Calculado Automaticamente quando não informado)"},"motivoDesoneracaoIcms":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,8,9,10,11,16,null],"description":"1 - Táxi;; 2 - Deficiente Físico;; 3 - Produtor Agropecuário;; 4 - Frotista / Locadora;; 5 - Diplomático / Consular;; 6 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 - CONTRAN e suas alterações);; 7 - SUFRAMA; 8 - Venda a Orgãos Publicos; 9 - Outros. (v2.0); 10 - Deficiente Condutor (Convênio ICMS 38/12). (v3.1); 11 - Deficiente não Condutor (Convênio ICMS 38/12). (v3.1); 16 - Olimpíadas Rio 2016"},"valorDesoneracaoIcms":{"type":["number","null"]},"aliquotaDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (Utilizado somente no CST 51)"},"modalidadeBcIcms":{"type":"integer","enum":[0,1,2,3],"description":"0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação"},"STRetido":{"type":["object","null"],"properties":{"BaseCalculo":{"type":["number","null"],"description":"vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior."},"AliquotaConsumidorFinal":{"type":["number","null"],"description":"pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP)."},"ValorICMSSubstituto":{"type":["number","null"],"description":"vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior."},"ValorICMSST":{"type":["number","null"],"description":"vICMSSTRet - Valor do ICMS-ST retido na operação anterior. Opcional: quando não informado, é calculado por (BaseCalculo x AliquotaConsumidorFinal / 100 - ValorICMSSubstituto). Informe o valor fiel da nota de entrada quando ele divergir da fórmula padrão."},"BaseCalculoFCP":{"type":["number","null"],"description":"vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior."},"AliquotaFCP":{"type":["number","null"],"description":"pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100."},"PercentualReducaoBaseEfetiva":{"type":["number","null"],"description":"pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final)."},"BaseCalculoEfetiva":{"type":["number","null"],"description":"vBCEfet - Base de cálculo efetiva (consumidor final). Opcional: quando não informada, é calculada por (ValorTotal + frete + seguro + outras despesas - desconto) x (1 - PercentualReducaoBaseEfetiva/100). Informe o valor fiel quando a composição da base divergir."},"AliquotaEfetiva":{"type":["number","null"],"description":"pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100."}},"additionalProperties":false,"description":"Grupo de ICMS-ST retido em operação anterior. Preencher SOMENTE em CST 60 ou CSOSN 500 (revenda de mercadoria cujo ICMS-ST já foi retido por substituição tributária). Quando informado, prevalece sobre a estimativa automática derivada da configuração de ST do produto."},"AliquotaAdRemRetido":{"type":["number","null"],"description":"adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente)."},"QuantidadeMonoRetido":{"type":["number","null"],"description":"qBCMonoRet - Quantidade tributada retida anteriormente (em unidade de medida da legislação). Opcional no CST 61. Quando não informada, assume a quantidade comercial do item."},"ValorIcmsMonoRetido":{"type":["number","null"],"description":"vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido."}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"IPI":{"type":["object","null"],"properties":{"CodEnquadramento":{"type":"string","description":"Código de Enquadramento Legal do IPI - EXATAMENTE 3 dígitos (com zeros à esquerda se necessário). Para a maioria dos casos não imunes/suspensos use \"999\" (tributação normal sem enquadramento especial). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"CodSituacaoTributaria":{"type":"string","description":"CST do IPI. Valores: \"00\",\"49\",\"50\",\"99\" (saída tributada/não tributada/isenta/outras saídas) ou \"01\",\"02\",\"03\",\"04\",\"05\",\"51\",\"52\",\"53\",\"54\",\"55\" (entradas - usar conforme o caso). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."},"Aliquota":{"type":"number","description":"Aliquota do IPI"},"ValorIpiDevolvido":{"type":"number","description":"Valor do IPI devolvido"},"PercentualMercadoriaDevolvida":{"type":"number","description":"Percentual da mercadoria devolvida"}},"additionalProperties":false,"required":["CodEnquadramento","CodSituacaoTributaria"]},"PIS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do PIS (Tabela II - Situação Tributária do PIS). Valores válidos: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\" (entradas) e \"49\",\"50\",\"51\",\"52\",\"53\",\"54\",\"55\",\"56\",\"60\",\"61\",\"62\",\"63\",\"64\",\"65\",\"66\",\"67\",\"70\",\"71\",\"72\",\"73\",\"74\",\"75\",\"98\",\"99\" (saídas/outras). O CST precisa ser compatível com o tipo de NF (entrada quando CFOP começa com 1/2/3, saída quando começa com 5/6/7)."},"Aliquota":{"type":"number","description":"Aliquota do PIS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"COFINS":{"type":["object","null"],"properties":{"CodSituacaoTributaria":{"type":"string","description":"CST do COFINS (mesma tabela do PIS - Tabela II). Geralmente é o MESMO valor usado no PIS. O CST precisa ser compatível com o tipo de NF (entrada/saída) conforme o CFOP do item."},"Aliquota":{"type":"number","description":"Aliquota do COFINS"},"BaseCalculo":{"type":["number","null"],"description":"Base de Cálculo (Quando não informado, é o valor dos produtos)"}},"additionalProperties":false,"required":["CodSituacaoTributaria"]},"Importacao":{"type":["object","null"],"properties":{"BaseCalculo":{"type":"number"},"DespesasAduaneiras":{"type":"number"},"Valor":{"type":"number"},"ValorIOF":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false,"description":"Tributação do item (ICMS / IPI / PIS / COFINS / IBSCBS / Importação). OBRIGATÓRIO a menos que CodTributacao esteja preenchido - nesse caso pode omitir este bloco. Para NF-e (modelo 55): ICMS + IPI + PIS + COFINS são todos obrigatórios e validados em conjunto. Para NFC-e (modelo 65): ICMS + PIS + COFINS obrigatórios; IPI dispensado."},"Combustivel":{"type":["object","null"],"properties":{"CodProdutoANP":{"type":["string","null"]},"DescricaoProdutoANP":{"type":["string","null"]},"UFConsumo":{"type":["string","null"]}},"additionalProperties":false},"DeclaracaoImportacao":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"],"description":"Número do Documento de Importação (DI, DSI, DIRE, ...)"},"DataRegistro":{"type":"string","description":"Data de Registro do documento de importação"},"LocalDesenbaraco":{"type":["string","null"],"description":"Local de Desembaraço Aduaneiro"},"UfDesenbaraco":{"type":["string","null"],"description":"Sigla da UF onde ocorreu o Desembaraço Aduaneiro"},"DataDesenbaraco":{"type":"string","description":"Data do Desembaraço Aduaneiro"},"TipoViaTransporte":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12],"description":"Via de transporte internacional informada na Declaração de Importação (DI) Valores: 1 - Marítima; 2 - Fluvial; 3 - Lacustre; 4 - Aérea; 5 - Postal; 6 - Ferroviária; 7 - Rodoviária; 8 - Conduto / Rede Transmissão; 9 - Meios Próprios; 10 - Entrada / Saída ficta; 11 - Courier; 12 - Handcarry"},"ValorAFRMM":{"type":["number","null"],"description":"Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante"},"TipoIntermedio":{"type":"integer","enum":[1,2,3],"description":"Forma de importação quanto a intermediação Valores: 1 - Importação por conta própria; 2 - Importação por conta e ordem; 3 - Importação por encomenda"},"Cnpj":{"type":["string","null"],"description":"CNPJ do adquirente ou do encomendante"},"Uf":{"type":["string","null"],"description":"Sigla da UF do adquirente ou do encomendante"},"CodExportador":{"type":["string","null"],"description":"Código do Exportador"},"CodFabricante":{"type":["string","null"],"description":"Código do Fabricante Extrangeiro"}},"additionalProperties":false},"Rastros":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroLote":{"type":["string","null"],"description":"Número do lote do produto (1-20 caracteres)"},"QuantidadeLote":{"type":"number","description":"Quantidade de produto no lote"},"DataFabricacao":{"type":"string","description":"Data de fabricação/produção"},"DataValidade":{"type":"string","description":"Data de validade"},"CodigoAgregacao":{"type":["string","null"],"description":"Código de agregação (opcional)"}},"additionalProperties":false},"description":"Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas."},"Agropecuaria":{"type":["object","null"],"properties":{"Defensivos":{"type":["array","null"],"items":{"type":"object","properties":{"NumeroReceituario":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres)."},"CpfResponsavelTecnico":{"type":"string","description":"CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável."}},"additionalProperties":false,"required":["NumeroReceituario","CpfResponsavelTecnico"]},"description":"Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico."},"GuiaTransito":{"type":["object","null"],"properties":{"TipoGuia":{"type":"integer","enum":[1,2,3,4,5,6,7],"description":"Tipo da guia de trânsito. Valores: 1 - GTA (Guia de Trânsito Animal); 2 - TTA (Termo de Trânsito Animal); 3 - DTA (Documento de Transferência Animal); 4 - ATV (Autorização de Trânsito Vegetal); 5 - PTV (Permissão de Trânsito Vegetal); 6 - GTV (Guia de Trânsito Vegetal); 7 - Guia Florestal (DOF, SisFlora-PA/MT, SIAM-MG)"},"UfGuia":{"type":"string","description":"Sigla da UF emissora da guia (2 caracteres)."},"SerieGuia":{"type":["string","null"],"description":"Série da guia (1-9 dígitos). Opcional."},"NumeroGuia":{"type":"string","description":"Número da guia (1-9 dígitos)."}},"additionalProperties":false,"required":["TipoGuia","UfGuia","NumeroGuia"],"description":"Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal."}},"additionalProperties":false,"description":"Informações de produtos agropecuários e florestais (NT 2024.003 - Grupo ZF). Obrigatório a partir de 01/03/2026 quando o NCM cair em: 01XXXXXX / 0301XXXX (animais vivos - GuiaTransito), 06-12XXXX (vegetais primários - GuiaTransito, UFs ainda inativas), 3808.52 a 3808.99 (defensivos - Defensivos). Já obrigatório em BA, GO, MA, MT para NCM 0102XXXX (bovinos) desde 01/10/2025."}},"additionalProperties":false,"required":["NmProduto","CodProdutoServico","NCM","Quantidade","UnidadeComercial","ValorUnitario","ValorTotal","CFOP","OrigemProduto","Imposto"]},"description":"Itens da nota fiscal. Mínimo 1 item."},"Pagamentos":{"type":["array","null"],"items":{"type":"object","properties":{"IndicadorPagamento":{"type":"integer","description":"0 - A vista, 1 - Prazo"},"Desconto":{"type":"number"},"Descricao":{"type":["string","null"]},"FormaPagamento":{"type":["string","null"],"enum":["01","02","03","04","05","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","90","91","99",null],"description":"01 - Dinheiro; 02 - Cheque; 03 - Cartão de Crédito; 04 - Cartão de Débito; 05 - Cartão da Loja (Private Label), Crediário Digital, Outros Crediários; 10 - Vale Alimentação; 11 - Vale Refeição; 12 - Vale Presente; 13 - Vale Combustível; 14 - Duplicata Mercantil; 15 - Boleto Bancário; 16 - Depósito Bancário; 17 - Pagamento Instantâneo (PIX) - Dinâmico; 18 - Transferência Bancária, Carteira Digital; 19 - Programa de fidelidade, cashback, crédito virtual; 20 - Pagamento Instantâneo (PIX) - Estático; 21 - Crédito em Loja; 22 - Pagamento Eletrônico não Informado - falha de hardware; 23 - Pagamento Instantâneo (PIX) - Automático; 24 - TEF Book Transfer; 90 - Sem pagamento; 91 - Pagamento Posterior; 99 - Outros"},"VlPago":{"type":"number"},"VlTroco":{"type":"number"},"DataPagamento":{"type":["string","null"],"description":"Data do pagamento (dPag - NT 2023.004). Opcional."},"CNPJPagamento":{"type":["string","null"],"description":"CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (CNPJPag - NT 2023.004). Informar junto com UFPagamento (os dois ou nenhum). Opcional."},"UFPagamento":{"type":["string","null"],"description":"UF do estabelecimento onde o pagamento foi processado (UFPag - NT 2023.004). Opcional."},"TipoIntegracao":{"type":"boolean","description":"Pagamento integrado com automação?"},"CNPJCredenciadora":{"type":["string","null"]},"BandeiraOperadora":{"type":["string","null"],"enum":["01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","99",null],"description":"01 - Visa; 02 - Mastercard; 03 - American Express; 04 - Sorocred; 05 - Diners Club; 06 - Elo; 07 - Hipercard; 08 - Aura; 09 - Cabal; 10 - Alelo; 11 - Banes Card; 12 - CalCard; 13 - Credz; 14 - Discover; 15 - GoodCard; 16 - GreenCard; 17 - Hiper; 18 - JcB; 19 - Mais; 20 - MaxVan; 21 - Policard; 22 - RedeCompras; 23 - Sodexo; 24 - ValeCard; 25 - Verocheque; 26 - VR; 27 - Ticket; 99 - Outros"},"NumeroAutorizacao":{"type":["string","null"],"description":"Número de autorização da operação (cAut). Para PIX, informar o EndToEndId (e2eid) da transação."},"CNPJRecebedor":{"type":["string","null"],"description":"CNPJ do beneficiário do pagamento (CNPJReceb - NT 2023.004). Opcional."},"IdTerminalPagamento":{"type":["string","null"],"description":"Identificador do terminal de pagamento (idTermPag - NT 2023.004). Opcional, 1-40 caracteres."}},"additionalProperties":false},"description":"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 \"90\" (sem pagamento)."},"Cobranca":{"type":["object","null"],"properties":{"Fatura":{"type":["object","null"],"properties":{"Numero":{"type":["string","null"]},"Valor":{"type":"number"},"Desconto":{"type":"number"},"ValorLiquido":{"type":"number"}},"additionalProperties":false},"Parcelas":{"type":["array","null"],"items":{"type":"object","properties":{"Vencimento":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Valor":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false},"Transporte":{"type":["object","null"],"properties":{"ModalidadeFrete":{"type":"integer","enum":[0,1,2,3,4,9],"description":"0 - Contratação do Frete por conta do Remetente (CIF); 1 - Contratação do Frete por conta do Destinatário (FOB); 2 - Contratação do Frete por conta de Terceiros; 3 - Transporte Próprio por conta do Remetente; 4 - Transporte Próprio por conta do Destinatário; 9 - Sem Ocorrência de Transporte"},"NmTransportador":{"type":["string","null"]},"CNPJ":{"type":["string","null"]},"NmMunicipio":{"type":["string","null"]},"DsEndereco":{"type":["string","null"]},"IE":{"type":["string","null"]},"UF":{"type":["string","null"]},"Vagao":{"type":["string","null"]},"Balsa":{"type":["string","null"]},"Veiculo":{"type":["object","null"],"properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false},"Reboque":{"type":["array","null"],"items":{"type":"object","properties":{"Placa":{"type":["string","null"]},"UF":{"type":["string","null"]},"RNTC":{"type":["string","null"]}},"additionalProperties":false}},"Volumes":{"type":["array","null"],"items":{"type":"object","properties":{"Numero":{"type":["string","null"]},"QuantidadeVolume":{"type":"integer"},"Especie":{"type":["string","null"]},"Marca":{"type":["string","null"]},"PesoBruto":{"type":"number"},"PesoLiquido":{"type":"number"},"Lacres":{"type":["array","null"],"items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false},"Exporta":{"type":["object","null"],"properties":{"LocalDespacho":{"type":["string","null"],"description":"Descrição do local de despacho"},"UFSaidaPais":{"type":["string","null"],"description":"Sigla da UF de Embarque ou de transposição de fronteira"},"LocalEmbarqueTransp":{"type":["string","null"],"description":"Descrição do Local de Embarque ou de transposição de fronteira"}},"additionalProperties":false},"Entrega":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Retencoes":{"type":["object","null"],"properties":{"BaseCalculoIRRF":{"type":["number","null"],"description":"Base de cálculo do IRRF"},"ValorIRRF":{"type":["number","null"],"description":"Valor retido do IRRF"},"ValorRetidoPIS":{"type":["number","null"],"description":"Valor retido de PIS"},"ValorRetidoCOFINS":{"type":["number","null"],"description":"Valor retido de COFINS"},"ValorRetidoCSLL":{"type":["number","null"],"description":"Valor retido de CSLL"},"BaseCalculoRetencaoPrevidencia":{"type":["number","null"],"description":"Base de cálculo da retenção da Previdência Social"},"ValorRetencaoPrevidencia":{"type":["number","null"],"description":"Valor da retenção da Previdência Social"}},"additionalProperties":false,"description":"Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML."},"ValorFrete":{"type":["number","null"],"description":"Valor total do frete da nota. Quando informado, é distribuído proporcionalmente entre os itens (proporção pelo ValorTotal de cada item), SUBSTITUINDO o ValorFrete informado em cada produto. Não informado (nulo) = o frete de cada item é usado como enviado."},"ValorTotal":{"type":["number","null"],"description":"Valor total esperado da nota (vNF), usado apenas para validação. Quando informado e diferente do valor total calculado (produtos - descontos + frete + seguro + outras despesas + impostos que compõem o total), a emissão é bloqueada e o erro detalha o cálculo. Não informado (nulo) = sem validação."}},"additionalProperties":false,"required":["IndicadorPresenca","NaturezaOperacao","ModeloDocumento","Finalidade","TipoAmbiente","Produtos"]}}},"additionalProperties":false,"description":"NF-e / NFC-e (modelo 55/65). Usado quando TipoEnvio = 1. Gera o DANFE/XML de pré-visualização."},"cte":{"type":["object","null"],"properties":{"Codigo":{"type":["integer","null"]},"Lote":{"type":["integer","null"]},"Serie":{"type":["integer","null"]},"Numero":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"ModeloDocumento":{"type":"integer","enum":[57,67],"description":"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)","default":57},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal)"},"TipoCte":{"type":"integer","enum":[0,1,2,3],"description":"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"},"Retira":{"type":"boolean"},"DtEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Cfop":{"type":"integer","description":"CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída."},"NaturezaOperacao":{"type":"string","description":"Descrição da natureza da operação (ex: \"Prestação de serviço de transporte\")."},"Observacao":{"type":["string","null"]},"Modal":{"type":"object","properties":{"Tipo":{"type":"integer","enum":[1,2,3,4,5,6],"description":"Modal do CT-e: Valores: 1 - Rodoviário; 2 - Aéreo; 3 - Aquaviário; 4 - Ferroviário; 5 - Dutoviário; 6 - Multimodal","default":1},"Rodoviario":{"type":["object","null"],"properties":{"OCCs":{"type":["array","null"],"items":{"type":"object","properties":{"Serie":{"type":["string","null"]},"Numero":{"type":"integer"},"DtEmissaoColeta":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Emissor":{"type":["object","null"],"properties":{"Cnpj":{"type":["string","null"],"description":"CNPJ do emissor da OCC"},"Ie":{"type":["string","null"],"description":"Inscrição estadual do emissor"},"CodigoInternoOCC":{"type":["string","null"],"description":"Código interno da OCC na empresa emissora"},"Uf":{"type":["string","null"],"description":"Estado do emissor da OCC"},"Telefone":{"type":["string","null"],"description":"Telefone do emissor da OCC"}},"additionalProperties":false}},"additionalProperties":false},"description":"Lista de coletas realizadas para compor o frete."}},"additionalProperties":false}},"additionalProperties":false,"description":"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."},"Carga":{"type":"object","properties":{"ValorTotal":{"type":"number","description":"Valor total da carga. (vCarga)"},"ProdutoPredominante":{"type":["string","null"],"description":"Nome do Produto Predominante. (proPred)"},"Detalhes":{"type":["array","null"],"items":{"type":"object","properties":{"CodUnidadeMedida":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Código da Unidade de Medida (cUnid) Valores: 0 - Metro Cúbico (M3); 1 - Quilograma (KG); 2 - Tonelada (TON); 3 - Unidade (UNIDADE); 4 - Litros (LITROS); 5 - MMBTU (MMBTU)"},"Quantidade":{"type":"number","description":"Quantidade da Carga (qCarga). Ex: 10000"},"TipoMedida":{"type":["string","null"],"description":"Tipo de Medida. (tpMed). Ex: \"quilos gramas\""}},"additionalProperties":false},"description":"Detalhes das quantidades da carga. (infQ)"},"Documentos":{"type":["array","null"],"items":{"type":"object","properties":{"Chave":{"type":["string","null"]},"PIN":{"type":["string","null"]}},"additionalProperties":false},"description":"Documentos fiscais que acompanham a carga. (infNFe)"},"OutrosDocumentos":{"type":["array","null"],"items":{"type":"object","properties":{"TipoDocumento":{"type":"integer","enum":[0,10,59,65,99],"description":"Tipo do documento originário. (tpDoc) Valores: 0 - Declaração; 10 - Dutoviário; 59 - CF-e SAT; 65 - NFC-e; 99 - Outros (exige Descricao)"},"Descricao":{"type":["string","null"],"description":"Descrição do documento. Obrigatória quando TipoDocumento = 99. (descOutros)"},"Numero":{"type":["string","null"],"description":"Número do documento. (nDoc)"},"DtEmissao":{"type":["string","null"],"description":"Data de emissão do documento. (dEmi)"},"Valor":{"type":["number","null"],"description":"Valor do documento fiscal. (vDocFisc)"},"DtPrevisao":{"type":["string","null"],"description":"Data prevista de entrega. (dPrev)"}},"additionalProperties":false,"description":"Outros documentos que acompanham a carga, quando não há NF/NF-e (ex.: mudança, C2C). Mapeia para infDoc/infOutros do CT-e."},"description":"Outros documentos que acompanham a carga quando não há NF-e (ex.: declaração de mudança, C2C). (infOutros)"}},"additionalProperties":false,"description":"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."},"Imposto":{"type":["object","null"],"properties":{"ICMS":{"type":["object","null"],"properties":{"CST":{"type":["string","null"],"description":"Código de Situação Tributária (CST) do ICMS. (Ex: 00, 20, 40, 41, 51, 60, 90, etc.) Para empresas do Simples Nacional, é usando o 90 automáticamente."},"BaseCalculo":{"type":"number","description":"Base de Cálculo do ICMS. (vBC)"},"Aliquota":{"type":"number","description":"Alíquota do ICMS (em percentual). (pICMS)"},"Valor":{"type":"number","description":"Valor do ICMS. (vICMS)"},"PercentualReducaoBaseCalculo":{"type":["number","null"],"description":"Percentual de Redução da Base de Cálculo. (pRedBC) Usado nos CSTs 20 e 90."},"AliquotaOutraUF":{"type":["number","null"],"description":"Alíquota do ICMS devido a Outra UF. (pICMSOutraUF) Usado no CST OutraUF."},"ValorICMSOutraUF":{"type":["number","null"],"description":"Valor do ICMS devido a Outra UF. (vICMSOutraUF) Usado no CST OutraUF."}},"additionalProperties":false,"description":"Informações do ICMS"},"ValorTotalTributos":{"type":["number","null"],"description":"Valor total dos tributos federais e estaduais, aproximado conforme Lei 12.741/12."},"InformacoesAdicionaisFisco":{"type":["string","null"],"description":"Informações Adicionais de Interesse do Fisco."},"Difal":{"type":["object","null"],"properties":{"BaseCalculoUfDestino":{"type":"number","description":"Base de Cálculo do ICMS na UF de Destino. (vBCUFFim)"},"PercentualFCPUfDestino":{"type":"number","description":"Percentual do Fundo de Combate à Pobreza (FCP) na UF de destino. (pFCPUFFim)"},"AliquotaICMSUfDestino":{"type":"number","description":"Alíquota interna da UF de destino para o ICMS. (pICMSUFFim)"},"AliquotaInterestadual":{"type":"number","description":"Alíquota interestadual das UF envolvidas. (pICMSInter)"},"PercentualPartilhaICMS":{"type":"number","description":"Percentual de Partilha do ICMS (Ex: 80, 20, 0, etc.). (pICMSInterPart)"},"ValorFCPUfDestino":{"type":"number","description":"Valor do Fundo de Combate à Pobreza (FCP) na UF de destino. (vFCPUFFim)"},"ValorICMSUfDestino":{"type":"number","description":"Valor total do ICMS devido à UF de destino (já com o FCP). (vICMSUFFim)"},"ValorICMSUfInicio":{"type":"number","description":"Valor do ICMS devido à UF de origem (Início). (vICMSUFIni)"}},"additionalProperties":false,"description":"Informações sobre o ICMS Partilha (DIFAL/ICMS UF Fim)."},"TributosFederal":{"type":["object","null"],"properties":{"ValorPis":{"type":["number","null"],"description":"Valor do PIS retido. (vPIS)"},"ValorCofins":{"type":["number","null"],"description":"Valor do COFINS retido. (vCOFINS)"},"ValorIr":{"type":["number","null"],"description":"Valor do Imposto de Renda retido. (vIR)"},"ValorInss":{"type":["number","null"],"description":"Valor do INSS retido. (vINSS)"},"ValorCsll":{"type":["number","null"],"description":"Valor da CSLL retida. (vCSLL)"}},"additionalProperties":false,"description":"Lista de PIS e COFINS (Tributos Federais)."},"IBSCBS":{"type":["object","null"],"properties":{"CodClassificacaoTributaria":{"type":["string","null"],"description":"Código de Classificação Tributária do IBS/CBS (cClassTrib). O CST é derivado dos 3 primeiros dígitos. Quando vazio, assume \"000001\"."},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo do IBS/CBS (vBC). Quando null, usa o valor total da prestação."},"AliquotaIBSUF":{"type":["number","null"],"description":"Alíquota do IBS de competência das UF (pIBSUF)."},"AliquotaIBSMun":{"type":["number","null"],"description":"Alíquota do IBS de competência do Município (pIBSMun)."},"AliquotaCBS":{"type":["number","null"],"description":"Alíquota da CBS (pCBS)."},"PercentualReducaoIBS":{"type":["number","null"],"description":"Percentual de redução da alíquota do IBS (pRedAliq de gRed), usado nos CST 011/200/515. Quando null, não aplica redução."},"PercentualReducaoCBS":{"type":["number","null"],"description":"Percentual de redução da alíquota da CBS (pRedAliq de gRed). Pode divergir de PercentualReducaoIBS."},"PercentualDiferimento":{"type":["number","null"],"description":"Percentual de diferimento (pDif de gDif), usado nos CST 510/515."}},"additionalProperties":false,"description":"Informações do IBS/CBS (Reforma Tributária - NT 2025.001). Quando preenchido, gera o grupo imp/IBSCBS no XML do CT-e."}},"additionalProperties":false},"Servico":{"type":"object","properties":{"Tipo":{"type":"integer","enum":[0,1,2,3,4,6,7,8],"description":"Tipo do Serviço: Valores: 0 - Normal; 1 - Subcontratação; 2 - Redespacho; 3 - Redespacho Intermediário; 4 - Serviço Vinculado ao Multimodal; 6 - Transporte de Pessoas; 7 - Transporte de Valores; 8 - Excesso de Bagagem"},"CodMunicipioInicio":{"type":"integer","description":"Código IBGE do município do início do transporte"},"MunicipioInicio":{"type":["string","null"],"description":"Nome do município do início do transporte"},"CodMunicipioFim":{"type":"integer","description":"Código IBGE do município do destino o transporte"},"MunicipioFim":{"type":["string","null"],"description":"Nome do município do destino do transporte"},"ValorPrestacao":{"type":"number","description":"O valor total cobrado pela prestação do serviço de transporte."},"ValorReceber":{"type":"number","description":"O valor líquido a receber pelo transportador."},"Componentes":{"type":["array","null"],"items":{"type":"object","properties":{"Nome":{"type":["string","null"]},"Valor":{"type":"number"}},"additionalProperties":false},"description":"Lista de componentes que detalham como o valor total do frete foi formado."}},"additionalProperties":false,"description":"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."},"Tomador":{"type":["object","null"],"properties":{"IndicadorIe":{"type":"integer","enum":[1,2,9],"description":"Indicador de IE: Valores: 1 - Contribuinte do ICMS; 2 - Contribuinte isento de inscrição; 9 - Não contribuinte"},"TipoTomador":{"type":"integer","enum":[0,1,2,3,4],"description":"Tipo do participante do CT-e: Valores: 0 - Remetente; 1 - Expedidor; 2 - Recebedor; 3 - Destinatário; 4 - Outros (Informar dados Tomador)"},"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Destinatario":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Remetente":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false},"Expedidor":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"]},"Nome":{"type":["string","null"]},"NomeFantasia":{"type":["string","null"]},"Ie":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"required":["ModeloDocumento","TipoAmbiente","TipoCte","Cfop","NaturezaOperacao","Modal","Carga","Servico"],"description":"CT-e (modelo 57/67). Usado quando TipoEnvio = 1. Gera o DACTE/XML de pré-visualização."},"mdfe":{"type":["object","null"],"properties":{"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação","default":1},"identificadorInterno":{"type":["string","null"]},"codigo":{"type":["integer","null"]},"lote":{"type":["integer","null"]},"numero":{"type":["integer","null"]},"serie":{"type":["integer","null"]},"tipoEmitente":{"type":"integer","enum":[1,2],"description":"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)","default":2},"DataEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"ufCarregamento":{"type":"string","description":"UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...)."},"ufDescarregamento":{"type":"string","description":"UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...)."},"observacao":{"type":["string","null"]},"observacaoFisco":{"type":["string","null"]},"modalidade":{"type":"integer","enum":[1,2,3,4],"description":"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)","default":1},"valor":{"type":"number","description":"Valor total das mercadorias transportadas. DEVE ser > 0."},"peso":{"type":"number","description":"Peso bruto total das mercadorias em KG. DEVE ser > 0."},"Rodoviario":{"type":["object","null"],"properties":{"tipoRodado":{"type":"integer","enum":[1,2,3,4,5,6],"description":"Tipo de Rodado (Padrão 1) Valores: 1 - Truck; 2 - Toco; 3 - Cavalo Mecânico; 4 - VAN; 5 - Utilitário; 6 - Outros"},"tipoCarroceria":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Tipo de Carroceria (Padrão 1) Valores: 0 - Não aplicavel; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider"},"placa":{"type":["string","null"]},"renavam":{"type":["string","null"]},"uf":{"type":["string","null"]},"tara":{"type":"integer","description":"Tara em KG"},"capKG":{"type":["integer","null"],"description":"Capacidade em KG do veículo de tração. Opcional."},"capM3":{"type":["integer","null"],"description":"Capacidade em M3 do veículo de tração. Opcional."},"CIOT":{"type":["object","null"],"properties":{"codigo":{"type":["string","null"]},"cnpj":{"type":["string","null"]}},"additionalProperties":false},"condutores":{"type":["array","null"],"items":{"type":"object","properties":{"nome":{"type":["string","null"]},"cpf":{"type":["string","null"]}},"additionalProperties":false}},"reboques":{"type":["array","null"],"items":{"type":"object","properties":{"placa":{"type":["string","null"],"description":"Placa do reboque (sem máscara)."},"renavam":{"type":["string","null"]},"uf":{"type":["string","null"],"description":"UF de licenciamento do reboque (sigla de 2 letras)."},"tara":{"type":["integer","null"],"description":"Tara em KG"},"capKG":{"type":["integer","null"]},"capM3":{"type":["integer","null"]},"tipoCarroceria":{"type":"integer","enum":[0,1,2,3,4,5],"description":"Tipo de Carroceria Valores: 0 - Não aplicável; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider"}},"additionalProperties":false},"description":"Lista de veículos de reboque acoplados à tração. Opcional - se nulo/vazio,"},"contratantes":{"type":["array","null"],"items":{"type":"object","properties":{"cpfCnpj":{"type":["string","null"],"description":"CPF, CNPJ ou identificador estrangeiro do contratante do transporte."},"nome":{"type":["string","null"],"description":"Razão social ou nome do contratante."},"nroContrato":{"type":["string","null"],"description":"Número do contrato do transportador com o contratante, para prestações continuadas."},"vContratoGlobal":{"type":["number","null"],"description":"Valor global do contrato. Usar somente no pagamento a prazo."}},"additionalProperties":false},"description":"Contratantes do serviço de transporte (grupo infANTT/infContratante)."},"valePedagio":{"type":["object","null"],"properties":{"dispositivos":{"type":["array","null"],"items":{"type":"object","properties":{"cnpjFornecedor":{"type":["string","null"],"description":"CNPJ da empresa fornecedora do vale-pedágio."},"cpfCnpjPagador":{"type":["string","null"],"description":"CPF ou CNPJ do responsável pelo pagamento. Informar quando não for o emitente do MDF-e."},"numeroComprovante":{"type":["string","null"],"description":"Número do comprovante de compra."},"valor":{"type":"number","description":"Valor do vale-pedágio."},"tipo":{"type":["string","null"],"description":"Tipo do vale-pedágio: 01 - TAG, 02 - Cupom, 03 - Cartão."}},"additionalProperties":false},"description":"Dispositivos do vale-pedágio."},"categoriaCombinacaoVeicular":{"type":["string","null"],"description":"Categoria de combinação veicular (02 a 14, conforme número de eixos)."}},"additionalProperties":false,"description":"Vale-pedágio (grupo infANTT/valePed)."},"pagamentos":{"type":["array","null"],"items":{"type":"object","properties":{"cpfCnpjResponsavel":{"type":["string","null"],"description":"CPF, CNPJ ou identificador estrangeiro do responsável pelo pagamento do frete."},"nomeResponsavel":{"type":["string","null"],"description":"Razão social ou nome do responsável pelo pagamento."},"componentes":{"type":["array","null"],"items":{"type":"object","properties":{"tipo":{"type":["string","null"],"description":"Tipo do componente: 01 - Vale-Pedágio; 02 - Impostos, taxas e contribuições; 03 - Despesas; 99 - Outros."},"valor":{"type":"number","description":"Valor do componente."},"descricao":{"type":["string","null"],"description":"Descrição do componente (usar quando tipo = 99)."}},"additionalProperties":false},"description":"Componentes do pagamento do frete."},"valorContrato":{"type":"number","description":"Valor total do contrato."},"altoDesempenho":{"type":"boolean","description":"Operação de transporte de alto desempenho (frota dedicada/fidelizada)."},"indicadorPagamento":{"type":"integer","description":"Forma de pagamento: 0 - à vista; 1 - a prazo."},"valorAdiantamento":{"type":["number","null"],"description":"Valor do adiantamento (usar apenas em pagamento a prazo)."},"anteciparAdiantamento":{"type":"boolean","description":"Concordância em antecipar o adiantamento."},"parcelas":{"type":["array","null"],"items":{"type":"object","properties":{"numero":{"type":"integer","description":"Número da parcela."},"vencimento":{"type":["string","null"],"description":"Data de vencimento da parcela."},"valor":{"type":["number","null"],"description":"Valor da parcela."}},"additionalProperties":false},"description":"Parcelas do pagamento (informar somente se a prazo)."},"tipoAntecipacao":{"type":["integer","null"],"description":"Permissão de antecipação das parcelas: 0 - não permite; 1 - permite; 2 - permite mediante confirmação."},"infoBancaria":{"type":["object","null"],"properties":{"codBanco":{"type":["string","null"],"description":"Número do banco. Informar junto com a agência (ou use cnpjInstituicaoPagamento, ou pix)."},"codAgencia":{"type":["string","null"],"description":"Número da agência bancária."},"cnpjInstituicaoPagamento":{"type":["string","null"],"description":"CNPJ da instituição de pagamento eletrônico do frete (alternativa ao banco/agência)."},"pix":{"type":["string","null"],"description":"Chave PIX para recebimento do frete (alternativa ao banco/agência)."}},"additionalProperties":false,"description":"Informações bancárias para recebimento do frete."}},"additionalProperties":false},"description":"Informações de pagamento do frete (grupo infANTT/infPag)."}},"additionalProperties":false,"description":"Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1."},"Aereo":{"type":["object","null"],"properties":{"nacionalidade":{"type":["string","null"]},"matricula":{"type":["string","null"]},"numeroVoo":{"type":["string","null"]},"aerodromoEmbarque":{"type":["string","null"]},"aerodromoDestino":{"type":["string","null"]},"dataVoo":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"}},"additionalProperties":false},"Aquaviario":{"type":["object","null"],"properties":{"cnpjAgencia":{"type":["string","null"]},"tipoEmbarcacao":{"type":"integer"},"codEmbarcacao":{"type":["string","null"]},"nomeEmbarcacao":{"type":["string","null"]},"numeroViagem":{"type":["string","null"]},"codPortoEmbarque":{"type":["string","null"]},"codPortoDestino":{"type":["string","null"]}},"additionalProperties":false},"Ferroviario":{"type":["object","null"],"properties":{"prefixo":{"type":["string","null"]},"DataLiberacao":{"type":"string","description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"origem":{"type":["string","null"]},"destino":{"type":["string","null"]},"quantidadeVagoes":{"type":"integer"},"Vagoes":{"type":["array","null"],"items":{"type":"object","properties":{"serie":{"type":"integer"},"numero":{"type":"integer"},"sequencia":{"type":["integer","null"]},"toneladaUtil":{"type":"number"},"pesoBc":{"type":"number","description":"Peso Base de Cálculo de Frete em Toneladas"},"pesoReal":{"type":"number","description":"Peso Real em Toneladas"}},"additionalProperties":false}}},"additionalProperties":false},"seguros":{"type":["array","null"],"items":{"type":"object","properties":{"indicadorResponsavel":{"type":"integer","enum":[1,2],"description":"Identificação do Ambiente (Padrão 1) Valores: 1 - Emitente do MDF-e; 2 - Responsável pela contratação","default":1},"cpfCnpjResponsavel":{"type":["string","null"],"description":"CPF ou CNPJ do responsável pela contratação do seguro. Informar somente quando indicadorResponsavel = 2 (responsável pela contratação); se for o próprio emitente do MDF-e, o CNPJ da empresa é utilizado automaticamente."},"cnpjSegurador":{"type":["string","null"],"description":"CNPJ da seguradora (somente dígitos)."},"nomeSegurador":{"type":["string","null"],"description":"Razão social / nome da seguradora."},"numeroApolice":{"type":["string","null"],"description":"Número da apólice de seguro. Obrigatório para modal rodoviário no MDF-e versão 3.00."},"numerosAverbacao":{"type":["array","null"],"items":{"type":"string"},"description":"Lista de números de averbação do seguro (0..N). Opcional."}},"additionalProperties":false}},"carregamentos":{"type":["array","null"],"items":{"type":"object","properties":{"codMunicipio":{"type":"integer"},"municipio":{"type":["string","null"]}},"additionalProperties":false}},"descarregamentos":{"type":["array","null"],"items":{"type":"object","properties":{"codMunicipio":{"type":"integer"},"municipio":{"type":["string","null"]},"chaveDfe":{"type":["string","null"]},"transportePerigosos":{"type":["array","null"],"items":{"type":"object","properties":{"codigoONU":{"type":["string","null"]},"quantidade":{"type":"number"}},"additionalProperties":false}}},"additionalProperties":false}},"percursoUfs":{"type":["array","null"],"items":{"type":"string"}},"produtoPredominante":{"type":["object","null"],"properties":{"tpCarga":{"type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11],"description":"Tipo de Carga (Resolução ANTT 5.849/2019). Valor de 1 a 11. Valores: 1 - Granel sólido; 2 - Granel líquido; 3 - Frigorificada; 4 - Conteinerizada; 5 - Carga Geral; 6 - Neogranel; 7 - Perigosa (granel sólido); 8 - Perigosa (granel líquido); 9 - Perigosa (carga frigorificada); 10 - Perigosa (conteinerizada); 11 - Perigosa (carga geral)"},"descricao":{"type":["string","null"],"description":"Descrição do produto predominante (1 a 120 caracteres)."},"cEan":{"type":["string","null"],"description":"GTIN/EAN do produto. Opcional. Use \"SEM GTIN\" se não houver."},"ncm":{"type":["string","null"],"description":"Código NCM do produto. Opcional. Aceita 2 ou 8 dígitos."},"infLotacao":{"type":["object","null"],"properties":{"localCarrega":{"type":["object","null"],"properties":{"cep":{"type":["string","null"],"description":"CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados."},"latitude":{"type":["string","null"],"description":"Latitude. Informe junto com longitude quando não houver CEP."},"longitude":{"type":["string","null"],"description":"Longitude. Informe junto com latitude quando não houver CEP."}},"additionalProperties":false,"description":"Local de carregamento da lotação. Informe CEP OU (latitude + longitude)."},"localDescarrega":{"type":["object","null"],"properties":{"cep":{"type":["string","null"],"description":"CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados."},"latitude":{"type":["string","null"],"description":"Latitude. Informe junto com longitude quando não houver CEP."},"longitude":{"type":["string","null"],"description":"Longitude. Informe junto com latitude quando não houver CEP."}},"additionalProperties":false,"description":"Local de descarregamento da lotação. Informe CEP OU (latitude + longitude)."}},"additionalProperties":false,"description":"Informações de carga lotação. Opcional - só preencha quando o MDF-e for de carga lotação."}},"additionalProperties":false,"description":"Produto predominante transportado. Opcional."}},"additionalProperties":false,"required":["tipoAmbiente","tipoEmitente","ufCarregamento","ufDescarregamento","modalidade","valor","peso"],"description":"MDF-e (modelo 58). Usado quando TipoEnvio = 1. Gera o DAMDFE/XML de pré-visualização."},"dce":{"type":["object","null"],"properties":{"Codigo":{"type":["integer","null"]},"Lote":{"type":["integer","null"]},"Serie":{"type":["integer","null"]},"Numero":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste)"},"TipoEmitente":{"type":"integer","enum":[0,1,2,3,4],"description":"Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios)","default":3},"XOrgaoFisco":{"type":["string","null"],"description":"Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0)"},"UfFisco":{"type":["string","null"],"description":"Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora."},"ModalidadeTransporte":{"type":"integer","enum":[0,1,2],"description":"Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora","default":2},"CnpjTransportadora":{"type":["string","null"],"description":"CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora."},"SiteMarketplace":{"type":["string","null"],"description":"URL do site do marketplace (obrigatório quando TipoEmitente=1)"},"Remetente":{"type":"object","properties":{"CpfCnpj":{"type":["string","null"],"description":"CPF ou CNPJ"},"Nome":{"type":["string","null"],"description":"Nome ou Razão Social"},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe)."},"Destinatario":{"type":"object","properties":{"CpfCnpj":{"type":["string","null"],"description":"CPF ou CNPJ"},"Nome":{"type":["string","null"],"description":"Nome ou Razão Social"},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo."},"Itens":{"type":"array","items":{"type":"object","properties":{"Descricao":{"type":"string","description":"Descrição do produto/conteúdo (1-120 caracteres). Obrigatória."},"NCM":{"type":["string","null"],"description":"Código NCM. Quando informado deve ter 2 ou 8 dígitos. Opcional na DC-e."},"Quantidade":{"type":["number","null"],"description":"Quantidade do item."},"ValorUnitario":{"type":["number","null"],"description":"Valor unitário do item."},"ValorTotal":{"type":"number","description":"Valor total do item. Deve ser > 0."},"InformacoesAdicionais":{"type":["string","null"],"description":"Informações adicionais do produto (opcional, até 500 caracteres)"}},"additionalProperties":false,"required":["Descricao","ValorTotal"]},"description":"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)."},"ValorTotal":{"type":["number","null"],"description":"Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0."},"InformacoesComplementares":{"type":["string","null"],"description":"Informações complementares (opcional, até 5000 caracteres)."},"InformacoesAdicionaisFisco":{"type":["string","null"],"description":"Informações adicionais de interesse do fisco (opcional, até 2000 caracteres)."},"DeclaracaoContribuinteICMS":{"type":"string","description":"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":{"type":"string","description":"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.\""}},"additionalProperties":false,"required":["TipoAmbiente","Remetente","Destinatario","Itens","DeclaracaoContribuinteICMS","DeclaracaoCrimeTributario"],"description":"DC-e (modelo 99). Usado quando TipoEnvio = 1. Gera o DACE/XML de pré-visualização."},"nfse":{"type":["object","null"],"properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste)"},"Lote":{"type":["integer","null"]},"nFSInfo":{"type":"array","items":{"type":"object","properties":{"EnviarEmail":{"type":"boolean"},"SerieRps":{"type":["string","null"]},"NumeroRps":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"DataCompetencia":{"type":["string","null"],"description":"Data de competência do serviço. Se não informado, usa a data de emissão. Não pode ser anterior a 1 ano da data atual."},"DataEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Tomador":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"],"description":"Documento de identificação do tomador."},"NmTomador":{"type":["string","null"]},"Im":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Dados do tomador (cliente do serviço). Obrigatório quando a prefeitura exige identificação do tomador (a maioria dos municípios). Para tomador no exterior (Endereco.CodPais != 1058) o CpfCnpj pode ser NIF estrangeiro ou ficar vazio."},"Intermediario":{"type":["object","null"],"properties":{"RzSocial":{"type":["string","null"]},"CPFCNPJ":{"type":["string","null"]},"InscricaoMunicipal":{"type":["string","null"]}},"additionalProperties":false},"ConstrucaoCivil":{"type":["object","null"],"properties":{"CodObra":{"type":["string","null"],"description":"Número da obra: CNO (Cadastro Nacional de Obras) ou CEI do INSS. Até 30 caracteres."},"Art":{"type":["string","null"],"description":"Documento de responsabilidade técnica (ART, RRT, DRT). Vai em infoCompl/idDocTec."},"Cib":{"type":["string","null"],"description":"Código do Cadastro Imobiliário Brasileiro (8 caracteres). Só no leiaute 1.01."},"InscricaoImobiliaria":{"type":["string","null"],"description":"Inscrição imobiliária fiscal do imóvel na prefeitura. Opcional, complementa o identificador."},"EnderecoObra":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false,"description":"Endereço da obra (CEP, Logradouro, Numero, Complemento, Bairro). Usado quando não há CodObra nem Cib."}},"additionalProperties":false,"description":"Dados da obra (grupo obra do DPS nacional). Obrigatório para os serviços 07.02, 07.04, 07.05, 07.06, 07.07, 07.08, 07.17, 07.19 e 14.14 (E0370). Basta UM identificador, nesta prioridade: CodObra, Cib, EnderecoObra. Sem nenhum deles, nesses serviços, usa-se o endereço do tomador como local da obra."},"Servico":{"type":"object","properties":{"Descricao":{"type":["string","null"]},"InformacoesComplementares":{"type":["string","null"],"description":"Informações complementares da NFS-e nacional (infoCompl/xInfComp, até 2000 caracteres). Sai no DANFSe."},"DocumentoReferencia":{"type":["string","null"],"description":"Documento de referência (infoCompl/docRef, até 255 caracteres): contrato, proposta, NF referenciada etc."},"NumeroPedido":{"type":["string","null"],"description":"Número do pedido do tomador (infoCompl/xPed, até 60 caracteres)."},"ItemListaServico":{"type":"string","description":"Código do serviço prestado. OBRIGATÓRIO. O significado depende do provedor do município (IdProvedorNFSe):"},"RegimeEspecialTributacao":{"type":"integer","enum":[0,1,2,3,4,5,6],"description":"0 - Sem Regime Especial; 1 - Microempresa municipal; 2 - Estimativa; 3 - Sociedade de profissionais; 4 - Cooperativa; 5 - MEI - Simples Nacional; 6 - ME EPP - Simples Nacional"},"NaturezaOperacao":{"type":"integer","description":"Alguns municípios possui códigos específicos, para mais informações, veja a documentação:"},"IncentivadorCultural":{"type":"boolean","description":"Incentio Cultural?"},"IncentivoFiscal":{"type":"boolean","description":"Incentivo Fiscal?"},"IssRetido":{"type":"boolean","description":"Iss Retido?"},"CodTributacaoMunicipio":{"type":["string","null"],"description":"Código de tributação do município"},"CodigoCnae":{"type":["string","null"],"description":"Código CNAE (Classificação Nacional de Atividades Econômicas)"},"CodNBS":{"type":["string","null"],"description":"Código NBS (Nomenclatura Brasileira de Serviços)."},"ExigibilidadeISS":{"type":"integer","enum":[1,2,3,4,5,6,7],"description":"Exigibilidade ISS (Padrão 1) Valores: 1 - Exigível; 2 - Não incidência; 3 - Isenção; 4 - Exportação; 5 - Imunidade; 6 - Exigibilidade Suspensa por Decisão Judicia; 7 - Exigibilidade Suspensa por Processo Administrativo","default":1},"CodMunicipioIncidencia":{"type":["string","null"],"description":"Código do municipio da incedência do serviço (Padrão - Município do Prestador)"},"CodMunicipioPrestacao":{"type":["string","null"],"description":"Código do municipio da prestação do serviço (Padrão - Município do Prestador)"},"Valores":{"type":["object","null"],"properties":{"ValorServico":{"type":"number","description":"Valor total do serviço prestado. DEVE ser maior que 0."},"ValorInss":{"type":"number"},"Aliquota":{"type":"number","description":"Alíquota do ISS (%)."},"AliquotaSimplesNacional":{"type":["number","null"],"description":"Alíquota do Simples Nacional (%). Preenche o pTotTribSN (percentual total aproximado dos tributos) da NFS-e nacional - equivale à opção \"Informar alíquota do Simples Nacional\" do emissor nacional. Usada por optantes ME/EPP e MEI. Independente de Aliquota (ISS)."},"DescontoCondicionado":{"type":"number"},"DescontoIncondicionado":{"type":"number"},"OutrasRetencoes":{"type":"number"},"ValorDeducoes":{"type":"number"},"TotalTributos":{"type":"number"},"AliquotaIr":{"type":["number","null"]}},"additionalProperties":false,"required":["ValorServico"]},"IBSCBS":{"type":["object","null"],"properties":{"CodClassTrib":{"type":["string","null"],"description":"Código de Classificação Tributária (cClassTrib, 6 dígitos). Os 3 primeiros são o CST. Padrão 000001."},"CodIndicadorOperacao":{"type":["string","null"],"description":"Código Indicador da Operação (cIndOp, 6 dígitos)."},"EnderecoImovel":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false,"description":"Endereço do imóvel onde o serviço foi prestado. Obrigatório (grupo imovel na DPS) quando o cIndOp é de operação sobre bem imóvel (020101/020201/020301) É um endereço próprio da operação (NÃO o do tomador); se ficar vazio nesses casos, cai no endereço do tomador."},"InscricaoImobiliariaImovel":{"type":["string","null"],"description":"Inscrição imobiliária fiscal (IPTU) do imóvel - opcional, dentro do grupo imovel."},"IndicadorUsoFinal":{"type":"integer","enum":[0,1],"description":"Indica operação de uso ou consumo pessoal (indFinal, art. 57). Valores: 0 - Não (padrão); 1 - Sim"},"IndicadorDestinatario":{"type":"integer","enum":[0,1],"description":"Indicador do destinatário dos serviços (indDest). Valores: 0 - O destinatário é o próprio tomador/adquirente (padrão); 1 - O destinatário não é o próprio adquirente (caso com intermediário)"},"TipoOperacao":{"type":["integer","null"],"enum":[1,2,3,4,5,null],"description":"Tipo de Operação (tpOper). Obrigatório para os serviços da LC 116/2003 25.05, 15.09, 17.12 e 10.05 (senão a prefeitura recusa com E0903). Se null nesses casos, assume 5 (fornecimento e recebimento concomitantes). Valores: 1 - Fornecimento com pagamento posterior; 2 - Recebimento do pagamento com fornecimento já realizado; 3 - Fornecimento com pagamento já realizado; 4 - Recebimento do pagamento com fornecimento posterior; 5 - Fornecimento e recebimento do pagamento concomitantes"},"AliqIbsUf":{"type":["number","null"],"description":"Alíquota do IBS Estadual (pIBSUF) em %. Se null, usa 0,10% (padrão de teste 2025-2026)."},"AliqIbsMun":{"type":["number","null"],"description":"Alíquota do IBS Municipal (pIBSMun) em %. Se null, usa 0% (padrão de teste 2025-2026)."},"AliqCbs":{"type":["number","null"],"description":"Alíquota da CBS (pCBS) em %. Se null, usa 0,90% (padrão de teste 2025-2026)."},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo do IBS/CBS (vBC). Se null, usa ValorServico - DescontoIncondicionado."}},"additionalProperties":false},"ConfiguracaoImposto":{"type":["object","null"],"properties":{"IncidePis":{"type":"boolean","description":"Indide 0,65% de PIS caso o valor for maior que R$215,05"},"IncideCofins":{"type":"boolean","description":"Indide 3,00% de COFINS caso o valor for maior que R$215,05"},"IncideCsll":{"type":"boolean","description":"Indide 1,00% de CSLL caso o valor for maior que R$215,05"},"IncideIr":{"type":"boolean","description":"Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR caso o valor for maior que R$666,66"},"ForcarIncidenciaPis":{"type":"boolean","description":"Indide 0,65% de PIS independente do valor"},"ForcarIncidenciaCofins":{"type":"boolean","description":"Indide 3,00% de COFINS independente do valor"},"ForcarIncidenciaCsll":{"type":"boolean","description":"Indide 1,00% de CSLL independente do valor"},"ForcarIncidenciaIr":{"type":"boolean","description":"Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR independente do valor"},"DestacarPisCofins":{"type":"boolean","description":"Destaca na NFS-e (padrão nacional) o PIS/COFINS de apuração própria do prestador (grupo piscofins: CST 01, alíquotas e valores), sem retenção pelo tomador e sem abater o valor líquido. Alíquotas conforme o regime da empresa: Lucro Real 1,65% / 7,60%, demais 0,65% / 3,00%. Somente empresas do Regime Normal (CRT 3). Pode ser combinado com as retenções acima (tpRetPisCofins passa a refletir o que foi retido)."},"RegimePisCofins":{"type":["integer","null"],"description":"Regime de apuração do PIS/COFINS usado nas alíquotas do grupo piscofins: 1 = Cumulativo (0,65% / 3,00%), 2 = Não cumulativo (1,65% / 7,60%). Vazio = pelo regime cadastrado na empresa (Lucro Real = não cumulativo, demais = cumulativo). Útil para receitas que a Lei 10.833/2003 art. 10 mantém no cumulativo mesmo no Lucro Real (software, hospitais e clínicas, etc.)."}},"additionalProperties":false},"ComercioExterior":{"type":["object","null"],"properties":{"ModoPrestacao":{"type":["integer","null"],"enum":[1,2,3,4,null],"description":"Modo de prestação do serviço (mdPrestacao). Padrão 1. Valores: 1 - Transfronteiriço; 2 - Consumo no Brasil; 3 - Presença comercial no exterior; 4 - Movimento temporário de pessoas físicas"},"VinculoPrestador":{"type":["integer","null"],"enum":[0,1,2,3,4,5,6,null],"description":"Vínculo entre prestador e tomador (vincPrest). Padrão 0. Valores: 0 - Sem vínculo; 1 - Controlada; 2 - Controladora; 3 - Coligada; 4 - Matriz; 5 - Filial ou sucursal; 6 - Outro vínculo"},"CodMoeda":{"type":["integer","null"],"description":"Código da moeda estrangeira (tpMoeda), ISO 4217 numérico de 3 dígitos. Padrão 840 (USD). Ex: 840 = Dólar americano, 978 = Euro, 826 = Libra esterlina."},"ValorMoedaEstrangeira":{"type":["number","null"],"description":"Valor do serviço na moeda estrangeira informada (vServMoeda). Se não informado, usa o ValorServico (valor em reais) - recomenda-se informar o valor real na moeda."},"ApoioPrestador":{"type":["integer","null"],"enum":[1,2,null],"description":"Mecanismo de apoio/fomento ao comércio exterior pelo prestador (mecAFComexP). Padrão 1. Valores: 1 - Nenhum; 2 - ACC; 3 - ACE; 4 - BNDES-Exim Pós; 5 - BNDES-Exim Pré; 6 - FGE; 7 - PROEX Equalização; 8 - PROEX Financiamento"},"ApoioTomador":{"type":["integer","null"],"description":"Mecanismo de apoio/fomento ao comércio exterior pelo tomador (mecAFComexT). Padrão 1."},"MovimentacaoTemporariaBens":{"type":["integer","null"],"enum":[1,2,3,null],"description":"Movimentação temporária de bens (movTempBens). Padrão 1. Valores: 1 - Não; 2 - Vinculada à Declaração de Importação; 3 - Vinculada à Declaração de Exportação"},"NumeroDI":{"type":["string","null"],"description":"Número da Declaração de Importação (nDI). Opcional."},"NumeroRE":{"type":["string","null"],"description":"Número do Registro de Exportação (nRE). Opcional."},"CompartilharMDIC":{"type":["integer","null"],"enum":[0,1,null],"description":"Compartilhar as informações da NFS-e com o MDIC/Secretaria de Comércio Exterior (mdic). Padrão 0. Valores: 0 - Não enviar; 1 - Enviar"}},"additionalProperties":false,"description":"Informações de comércio exterior (grupo comExt do leiaute nacional). Se ExigibilidadeISS = 4 e este objeto não for enviado, valores padrão são aplicados (modo Transfronteiriço, sem vínculo, sem mecanismo de apoio, moeda USD, valor = ValorServico)."}},"additionalProperties":false,"required":["ItemListaServico"],"description":"Dados do serviço prestado. OBRIGATÓRIO. Exige ao menos: ItemListaServico (item LC 116/2003 no provedor municipal, ou Código de Tributação Nacional cTribNac no ambiente nacional - ver ItemListaServico) e Valores.ValorServico > 0."}},"additionalProperties":false,"required":["Servico"]},"description":"Lista de NFS-e a emitir no lote. Mínimo 1 item."}},"additionalProperties":false,"required":["TipoAmbiente","nFSInfo"],"description":"NFS-e. Usado quando TipoEnvio = 1. Gera o DANFSe/XML de pré-visualização (sem validade jurídica)."},"Base64Xml":{"type":["string","null"]},"TipoArquivo":{"type":"integer","enum":[0,1],"description":"Tipo do arquivo que deseja pré-visualizar (Padrão - 0) Valores: 0 - XML; 1 - PDF"},"TipoEnvio":{"type":"integer","enum":[0,1],"description":"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":{"type":"boolean","description":"Mostrar tarja \"SEM VALOR FISCAL - PRÉ-VISUALIZAÇÃO\" (Padrão - Verdadeiro) Somente para o tipo de arquivo PDF e se um dos serviços de emissão estiver ativo para a empresa","default":true}},"additionalProperties":false}},{"name":"nfenercom_emitir","description":"Envia a NF-EnerCom (Nota Fiscal de Energia Comercializada) para autorização na SEFAZ.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"modeloDocumento":{"type":"integer","enum":[6,21,22],"description":"Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação"},"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação"},"identificadorInterno":{"type":["string","null"],"description":"Código de controle interno unico da venda. Evita duplicidades, caso configurado."},"serie":{"type":["string","null"],"description":"Série da nota fiscal. Quando não informado é controlado pelo Painel"},"numero":{"type":["integer","null"],"description":"Número da nota fiscal. Quando não informado é controlado pelo Painel"},"situacao":{"type":"integer","enum":[1,2,3,4],"description":"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","default":4},"valorTotalFatura":{"type":"number","description":"Valor total da fatura comercial. Deve ser > 0."},"dataEmissao":{"type":"string","description":"Data de emissão do documento. Obrigatória."},"comunicao":{"type":["object","null"],"properties":{"tipoUtilizacao":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"Tipo de Utilização Valores: 1 - Telefonia; 2 - Comunicação de dados; 3 - TV por assinatura; 4 - Provimento de acesso à internet; 5 - Multimídia; 6 - Outros"},"tipoAssinante":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"Tipo de Assinate Valores: 1 - Comercial/Industrial; 2 - Poder público; 3 - Residencial/Pessoa física; 4 - Público; 5 - Semi-público; 6 - Outros"}},"additionalProperties":false,"description":"Informações referente a nota de comunicação e Telecomunicação"},"energia":{"type":["object","null"],"properties":{"classeConsumo":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,8,null],"description":"Código Classe de Consumo Valores: 1 - Comercial; 2 - Consumo próprio; 3 - Iluminação pública; 4 - Industrial; 5 - Poder público; 6 - Residencial; 7 - Rural; 8 - Serviço Público"},"subClasseConsumo":{"type":["integer","null"],"description":"Código da subclasse de consumo de energia elétrica."},"grupoTensao":{"type":["integer","null"],"description":"Código do grupo de tensão"},"tarifaAplicada":{"type":["number","null"]},"dataLeituraAnterior":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"dataLeituraAtual":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"}},"additionalProperties":false,"description":"Informações referente a nota de Energia"},"destinatario":{"type":"object","properties":{"codigo":{"type":["string","null"],"description":"Código interno que identifica o destinatário"},"cpfCnpj":{"type":["string","null"],"description":"CFP ou CNPJ"},"ie":{"type":["string","null"],"description":"Inscrição Estadual"},"razaoSocial":{"type":["string","null"],"description":"Razão Social"},"endereco":{"type":["object","null"],"properties":{"cep":{"type":["string","null"]},"logradouro":{"type":["string","null"]},"complemento":{"type":["string","null"]},"numero":{"type":["string","null"]},"bairro":{"type":["string","null"]},"codMunicipio":{"type":["string","null"]},"municipio":{"type":["string","null"]},"uf":{"type":["string","null"]},"codPais":{"type":"integer","default":1058},"pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"contato":{"type":["object","null"],"properties":{"telefone":{"type":["string","null"]},"email":{"type":["string","null"]},"fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Informações do destinatário (cliente). OBRIGATÓRIO."},"produtos":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":["string","null"],"description":"Código interno que identifica item"},"descricao":{"type":["string","null"],"description":"Descrição do item"},"codClassificacao":{"type":["string","null"],"description":"Código de classificação do serviço"},"cfop":{"type":"integer","description":"Código CFOP"},"unidadeMedida":{"type":["string","null"],"description":"Unidade de Medida"},"quantidade":{"type":"number","description":"Quantidade de itens"},"valor":{"type":"number","description":"Valor unitário do item"},"desconto":{"type":["number","null"],"description":"Desconto total aplicado no item"},"outrasDespesas":{"type":["number","null"],"description":"Acréscimos e Despesas Acessórias"},"aliqIcms":{"type":"number","description":"Alíquota de Icms"},"aliqPis":{"type":"number","description":"Alíquota de PIS"},"aliqCofins":{"type":"number","description":"Alíquota de Cofins"},"codTributacao":{"type":["string","null"],"description":"Código do grupo tributário cadastrado no Painel, para automação de impostos"}},"additionalProperties":false},"description":"Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP."}},"required":["modeloDocumento","tipoAmbiente","valorTotalFatura","dataEmissao","destinatario","produtos"],"additionalProperties":false}},{"name":"nfenercom_gerar_arquivo","description":"Gera o arquivo da Nota Fiscal de Energia (NF-EnerCom). Pré-requisito para nfenercom_emitir.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"tipoGeracao":{"type":"integer","enum":[1,2],"description":"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\""},"mes":{"type":["integer","null"],"description":"Mês de emissão das notas (1-12). Obrigatório quando tipoGeracao = 1."},"ano":{"type":["integer","null"],"description":"Ano de emissão das notas (4 dígitos). Obrigatório quando tipoGeracao = 1."},"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação"},"notas":{"type":["array","null"],"items":{"type":"object","properties":{"modeloDocumento":{"type":"integer","enum":[6,21,22],"description":"Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação"},"tipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação"},"identificadorInterno":{"type":["string","null"],"description":"Código de controle interno unico da venda. Evita duplicidades, caso configurado."},"serie":{"type":["string","null"],"description":"Série da nota fiscal. Quando não informado é controlado pelo Painel"},"numero":{"type":["integer","null"],"description":"Número da nota fiscal. Quando não informado é controlado pelo Painel"},"situacao":{"type":"integer","enum":[1,2,3,4],"description":"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","default":4},"valorTotalFatura":{"type":"number","description":"Valor total da fatura comercial. Deve ser > 0."},"dataEmissao":{"type":"string","description":"Data de emissão do documento. Obrigatória."},"comunicao":{"type":["object","null"],"properties":{"tipoUtilizacao":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"Tipo de Utilização Valores: 1 - Telefonia; 2 - Comunicação de dados; 3 - TV por assinatura; 4 - Provimento de acesso à internet; 5 - Multimídia; 6 - Outros"},"tipoAssinante":{"type":["integer","null"],"enum":[1,2,3,4,5,6,null],"description":"Tipo de Assinate Valores: 1 - Comercial/Industrial; 2 - Poder público; 3 - Residencial/Pessoa física; 4 - Público; 5 - Semi-público; 6 - Outros"}},"additionalProperties":false,"description":"Informações referente a nota de comunicação e Telecomunicação"},"energia":{"type":["object","null"],"properties":{"classeConsumo":{"type":["integer","null"],"enum":[1,2,3,4,5,6,7,8,null],"description":"Código Classe de Consumo Valores: 1 - Comercial; 2 - Consumo próprio; 3 - Iluminação pública; 4 - Industrial; 5 - Poder público; 6 - Residencial; 7 - Rural; 8 - Serviço Público"},"subClasseConsumo":{"type":["integer","null"],"description":"Código da subclasse de consumo de energia elétrica."},"grupoTensao":{"type":["integer","null"],"description":"Código do grupo de tensão"},"tarifaAplicada":{"type":["number","null"]},"dataLeituraAnterior":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"dataLeituraAtual":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"}},"additionalProperties":false,"description":"Informações referente a nota de Energia"},"destinatario":{"type":"object","properties":{"codigo":{"type":["string","null"],"description":"Código interno que identifica o destinatário"},"cpfCnpj":{"type":["string","null"],"description":"CFP ou CNPJ"},"ie":{"type":["string","null"],"description":"Inscrição Estadual"},"razaoSocial":{"type":["string","null"],"description":"Razão Social"},"endereco":{"type":["object","null"],"properties":{"cep":{"type":["string","null"]},"logradouro":{"type":["string","null"]},"complemento":{"type":["string","null"]},"numero":{"type":["string","null"]},"bairro":{"type":["string","null"]},"codMunicipio":{"type":["string","null"]},"municipio":{"type":["string","null"]},"uf":{"type":["string","null"]},"codPais":{"type":"integer","default":1058},"pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"contato":{"type":["object","null"],"properties":{"telefone":{"type":["string","null"]},"email":{"type":["string","null"]},"fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Informações do destinatário (cliente). OBRIGATÓRIO."},"produtos":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":["string","null"],"description":"Código interno que identifica item"},"descricao":{"type":["string","null"],"description":"Descrição do item"},"codClassificacao":{"type":["string","null"],"description":"Código de classificação do serviço"},"cfop":{"type":"integer","description":"Código CFOP"},"unidadeMedida":{"type":["string","null"],"description":"Unidade de Medida"},"quantidade":{"type":"number","description":"Quantidade de itens"},"valor":{"type":"number","description":"Valor unitário do item"},"desconto":{"type":["number","null"],"description":"Desconto total aplicado no item"},"outrasDespesas":{"type":["number","null"],"description":"Acréscimos e Despesas Acessórias"},"aliqIcms":{"type":"number","description":"Alíquota de Icms"},"aliqPis":{"type":"number","description":"Alíquota de PIS"},"aliqCofins":{"type":"number","description":"Alíquota de Cofins"},"codTributacao":{"type":["string","null"],"description":"Código do grupo tributário cadastrado no Painel, para automação de impostos"}},"additionalProperties":false},"description":"Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP."}},"additionalProperties":false,"required":["modeloDocumento","tipoAmbiente","valorTotalFatura","dataEmissao","destinatario","produtos"]},"description":"Notas Fiscais de Energia/Comunicação/Telecomunicação a incluir no arquivo. Obrigatório quando tipoGeracao = 2."}},"required":["tipoGeracao","tipoAmbiente"],"additionalProperties":false}},{"name":"nfse_consultar","description":"Consulta status e dados de uma NFS-e já enviada por número, série e ambiente.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"codLote":{"type":["string","null"],"description":"Código do lote"},"Rps":{"type":["array","null"],"items":{"type":"integer"},"description":"Rps para retornar (Se não enviar retorna todos)"}},"additionalProperties":false}},{"name":"nfse_emitir","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste)"},"Lote":{"type":["integer","null"]},"nFSInfo":{"type":"array","items":{"type":"object","properties":{"EnviarEmail":{"type":"boolean"},"SerieRps":{"type":["string","null"]},"NumeroRps":{"type":["integer","null"]},"IdentificadorInterno":{"type":["string","null"]},"DataCompetencia":{"type":["string","null"],"description":"Data de competência do serviço. Se não informado, usa a data de emissão. Não pode ser anterior a 1 ano da data atual."},"DataEmissao":{"type":["string","null"],"description":"Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"},"Tomador":{"type":["object","null"],"properties":{"CpfCnpj":{"type":["string","null"],"description":"Documento de identificação do tomador."},"NmTomador":{"type":["string","null"]},"Im":{"type":["string","null"]},"Endereco":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false},"Contato":{"type":["object","null"],"properties":{"Telefone":{"type":["string","null"]},"Email":{"type":["string","null"]},"Fax":{"type":["string","null"]}},"additionalProperties":false}},"additionalProperties":false,"description":"Dados do tomador (cliente do serviço). Obrigatório quando a prefeitura exige identificação do tomador (a maioria dos municípios). Para tomador no exterior (Endereco.CodPais != 1058) o CpfCnpj pode ser NIF estrangeiro ou ficar vazio."},"Intermediario":{"type":["object","null"],"properties":{"RzSocial":{"type":["string","null"]},"CPFCNPJ":{"type":["string","null"]},"InscricaoMunicipal":{"type":["string","null"]}},"additionalProperties":false},"ConstrucaoCivil":{"type":["object","null"],"properties":{"CodObra":{"type":["string","null"],"description":"Número da obra: CNO (Cadastro Nacional de Obras) ou CEI do INSS. Até 30 caracteres."},"Art":{"type":["string","null"],"description":"Documento de responsabilidade técnica (ART, RRT, DRT). Vai em infoCompl/idDocTec."},"Cib":{"type":["string","null"],"description":"Código do Cadastro Imobiliário Brasileiro (8 caracteres). Só no leiaute 1.01."},"InscricaoImobiliaria":{"type":["string","null"],"description":"Inscrição imobiliária fiscal do imóvel na prefeitura. Opcional, complementa o identificador."},"EnderecoObra":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false,"description":"Endereço da obra (CEP, Logradouro, Numero, Complemento, Bairro). Usado quando não há CodObra nem Cib."}},"additionalProperties":false,"description":"Dados da obra (grupo obra do DPS nacional). Obrigatório para os serviços 07.02, 07.04, 07.05, 07.06, 07.07, 07.08, 07.17, 07.19 e 14.14 (E0370). Basta UM identificador, nesta prioridade: CodObra, Cib, EnderecoObra. Sem nenhum deles, nesses serviços, usa-se o endereço do tomador como local da obra."},"Servico":{"type":"object","properties":{"Descricao":{"type":["string","null"]},"InformacoesComplementares":{"type":["string","null"],"description":"Informações complementares da NFS-e nacional (infoCompl/xInfComp, até 2000 caracteres). Sai no DANFSe."},"DocumentoReferencia":{"type":["string","null"],"description":"Documento de referência (infoCompl/docRef, até 255 caracteres): contrato, proposta, NF referenciada etc."},"NumeroPedido":{"type":["string","null"],"description":"Número do pedido do tomador (infoCompl/xPed, até 60 caracteres)."},"ItemListaServico":{"type":"string","description":"Código do serviço prestado. OBRIGATÓRIO. O significado depende do provedor do município (IdProvedorNFSe):"},"RegimeEspecialTributacao":{"type":"integer","enum":[0,1,2,3,4,5,6],"description":"0 - Sem Regime Especial; 1 - Microempresa municipal; 2 - Estimativa; 3 - Sociedade de profissionais; 4 - Cooperativa; 5 - MEI - Simples Nacional; 6 - ME EPP - Simples Nacional"},"NaturezaOperacao":{"type":"integer","description":"Alguns municípios possui códigos específicos, para mais informações, veja a documentação:"},"IncentivadorCultural":{"type":"boolean","description":"Incentio Cultural?"},"IncentivoFiscal":{"type":"boolean","description":"Incentivo Fiscal?"},"IssRetido":{"type":"boolean","description":"Iss Retido?"},"CodTributacaoMunicipio":{"type":["string","null"],"description":"Código de tributação do município"},"CodigoCnae":{"type":["string","null"],"description":"Código CNAE (Classificação Nacional de Atividades Econômicas)"},"CodNBS":{"type":["string","null"],"description":"Código NBS (Nomenclatura Brasileira de Serviços)."},"ExigibilidadeISS":{"type":"integer","enum":[1,2,3,4,5,6,7],"description":"Exigibilidade ISS (Padrão 1) Valores: 1 - Exigível; 2 - Não incidência; 3 - Isenção; 4 - Exportação; 5 - Imunidade; 6 - Exigibilidade Suspensa por Decisão Judicia; 7 - Exigibilidade Suspensa por Processo Administrativo","default":1},"CodMunicipioIncidencia":{"type":["string","null"],"description":"Código do municipio da incedência do serviço (Padrão - Município do Prestador)"},"CodMunicipioPrestacao":{"type":["string","null"],"description":"Código do municipio da prestação do serviço (Padrão - Município do Prestador)"},"Valores":{"type":["object","null"],"properties":{"ValorServico":{"type":"number","description":"Valor total do serviço prestado. DEVE ser maior que 0."},"ValorInss":{"type":"number"},"Aliquota":{"type":"number","description":"Alíquota do ISS (%)."},"AliquotaSimplesNacional":{"type":["number","null"],"description":"Alíquota do Simples Nacional (%). Preenche o pTotTribSN (percentual total aproximado dos tributos) da NFS-e nacional - equivale à opção \"Informar alíquota do Simples Nacional\" do emissor nacional. Usada por optantes ME/EPP e MEI. Independente de Aliquota (ISS)."},"DescontoCondicionado":{"type":"number"},"DescontoIncondicionado":{"type":"number"},"OutrasRetencoes":{"type":"number"},"ValorDeducoes":{"type":"number"},"TotalTributos":{"type":"number"},"AliquotaIr":{"type":["number","null"]}},"additionalProperties":false,"required":["ValorServico"]},"IBSCBS":{"type":["object","null"],"properties":{"CodClassTrib":{"type":["string","null"],"description":"Código de Classificação Tributária (cClassTrib, 6 dígitos). Os 3 primeiros são o CST. Padrão 000001."},"CodIndicadorOperacao":{"type":["string","null"],"description":"Código Indicador da Operação (cIndOp, 6 dígitos)."},"EnderecoImovel":{"type":["object","null"],"properties":{"Cep":{"type":["string","null"]},"Logradouro":{"type":["string","null"]},"Complemento":{"type":["string","null"]},"Numero":{"type":["string","null"]},"Bairro":{"type":["string","null"]},"CodMunicipio":{"type":["string","null"]},"Municipio":{"type":["string","null"]},"Uf":{"type":["string","null"]},"CodPais":{"type":"integer","default":1058},"Pais":{"type":["string","null"],"default":"BRASIL"}},"additionalProperties":false,"description":"Endereço do imóvel onde o serviço foi prestado. Obrigatório (grupo imovel na DPS) quando o cIndOp é de operação sobre bem imóvel (020101/020201/020301) É um endereço próprio da operação (NÃO o do tomador); se ficar vazio nesses casos, cai no endereço do tomador."},"InscricaoImobiliariaImovel":{"type":["string","null"],"description":"Inscrição imobiliária fiscal (IPTU) do imóvel - opcional, dentro do grupo imovel."},"IndicadorUsoFinal":{"type":"integer","enum":[0,1],"description":"Indica operação de uso ou consumo pessoal (indFinal, art. 57). Valores: 0 - Não (padrão); 1 - Sim"},"IndicadorDestinatario":{"type":"integer","enum":[0,1],"description":"Indicador do destinatário dos serviços (indDest). Valores: 0 - O destinatário é o próprio tomador/adquirente (padrão); 1 - O destinatário não é o próprio adquirente (caso com intermediário)"},"TipoOperacao":{"type":["integer","null"],"enum":[1,2,3,4,5,null],"description":"Tipo de Operação (tpOper). Obrigatório para os serviços da LC 116/2003 25.05, 15.09, 17.12 e 10.05 (senão a prefeitura recusa com E0903). Se null nesses casos, assume 5 (fornecimento e recebimento concomitantes). Valores: 1 - Fornecimento com pagamento posterior; 2 - Recebimento do pagamento com fornecimento já realizado; 3 - Fornecimento com pagamento já realizado; 4 - Recebimento do pagamento com fornecimento posterior; 5 - Fornecimento e recebimento do pagamento concomitantes"},"AliqIbsUf":{"type":["number","null"],"description":"Alíquota do IBS Estadual (pIBSUF) em %. Se null, usa 0,10% (padrão de teste 2025-2026)."},"AliqIbsMun":{"type":["number","null"],"description":"Alíquota do IBS Municipal (pIBSMun) em %. Se null, usa 0% (padrão de teste 2025-2026)."},"AliqCbs":{"type":["number","null"],"description":"Alíquota da CBS (pCBS) em %. Se null, usa 0,90% (padrão de teste 2025-2026)."},"BaseCalculo":{"type":["number","null"],"description":"Base de cálculo do IBS/CBS (vBC). Se null, usa ValorServico - DescontoIncondicionado."}},"additionalProperties":false},"ConfiguracaoImposto":{"type":["object","null"],"properties":{"IncidePis":{"type":"boolean","description":"Indide 0,65% de PIS caso o valor for maior que R$215,05"},"IncideCofins":{"type":"boolean","description":"Indide 3,00% de COFINS caso o valor for maior que R$215,05"},"IncideCsll":{"type":"boolean","description":"Indide 1,00% de CSLL caso o valor for maior que R$215,05"},"IncideIr":{"type":"boolean","description":"Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR caso o valor for maior que R$666,66"},"ForcarIncidenciaPis":{"type":"boolean","description":"Indide 0,65% de PIS independente do valor"},"ForcarIncidenciaCofins":{"type":"boolean","description":"Indide 3,00% de COFINS independente do valor"},"ForcarIncidenciaCsll":{"type":"boolean","description":"Indide 1,00% de CSLL independente do valor"},"ForcarIncidenciaIr":{"type":"boolean","description":"Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR independente do valor"},"DestacarPisCofins":{"type":"boolean","description":"Destaca na NFS-e (padrão nacional) o PIS/COFINS de apuração própria do prestador (grupo piscofins: CST 01, alíquotas e valores), sem retenção pelo tomador e sem abater o valor líquido. Alíquotas conforme o regime da empresa: Lucro Real 1,65% / 7,60%, demais 0,65% / 3,00%. Somente empresas do Regime Normal (CRT 3). Pode ser combinado com as retenções acima (tpRetPisCofins passa a refletir o que foi retido)."},"RegimePisCofins":{"type":["integer","null"],"description":"Regime de apuração do PIS/COFINS usado nas alíquotas do grupo piscofins: 1 = Cumulativo (0,65% / 3,00%), 2 = Não cumulativo (1,65% / 7,60%). Vazio = pelo regime cadastrado na empresa (Lucro Real = não cumulativo, demais = cumulativo). Útil para receitas que a Lei 10.833/2003 art. 10 mantém no cumulativo mesmo no Lucro Real (software, hospitais e clínicas, etc.)."}},"additionalProperties":false},"ComercioExterior":{"type":["object","null"],"properties":{"ModoPrestacao":{"type":["integer","null"],"enum":[1,2,3,4,null],"description":"Modo de prestação do serviço (mdPrestacao). Padrão 1. Valores: 1 - Transfronteiriço; 2 - Consumo no Brasil; 3 - Presença comercial no exterior; 4 - Movimento temporário de pessoas físicas"},"VinculoPrestador":{"type":["integer","null"],"enum":[0,1,2,3,4,5,6,null],"description":"Vínculo entre prestador e tomador (vincPrest). Padrão 0. Valores: 0 - Sem vínculo; 1 - Controlada; 2 - Controladora; 3 - Coligada; 4 - Matriz; 5 - Filial ou sucursal; 6 - Outro vínculo"},"CodMoeda":{"type":["integer","null"],"description":"Código da moeda estrangeira (tpMoeda), ISO 4217 numérico de 3 dígitos. Padrão 840 (USD). Ex: 840 = Dólar americano, 978 = Euro, 826 = Libra esterlina."},"ValorMoedaEstrangeira":{"type":["number","null"],"description":"Valor do serviço na moeda estrangeira informada (vServMoeda). Se não informado, usa o ValorServico (valor em reais) - recomenda-se informar o valor real na moeda."},"ApoioPrestador":{"type":["integer","null"],"enum":[1,2,null],"description":"Mecanismo de apoio/fomento ao comércio exterior pelo prestador (mecAFComexP). Padrão 1. Valores: 1 - Nenhum; 2 - ACC; 3 - ACE; 4 - BNDES-Exim Pós; 5 - BNDES-Exim Pré; 6 - FGE; 7 - PROEX Equalização; 8 - PROEX Financiamento"},"ApoioTomador":{"type":["integer","null"],"description":"Mecanismo de apoio/fomento ao comércio exterior pelo tomador (mecAFComexT). Padrão 1."},"MovimentacaoTemporariaBens":{"type":["integer","null"],"enum":[1,2,3,null],"description":"Movimentação temporária de bens (movTempBens). Padrão 1. Valores: 1 - Não; 2 - Vinculada à Declaração de Importação; 3 - Vinculada à Declaração de Exportação"},"NumeroDI":{"type":["string","null"],"description":"Número da Declaração de Importação (nDI). Opcional."},"NumeroRE":{"type":["string","null"],"description":"Número do Registro de Exportação (nRE). Opcional."},"CompartilharMDIC":{"type":["integer","null"],"enum":[0,1,null],"description":"Compartilhar as informações da NFS-e com o MDIC/Secretaria de Comércio Exterior (mdic). Padrão 0. Valores: 0 - Não enviar; 1 - Enviar"}},"additionalProperties":false,"description":"Informações de comércio exterior (grupo comExt do leiaute nacional). Se ExigibilidadeISS = 4 e este objeto não for enviado, valores padrão são aplicados (modo Transfronteiriço, sem vínculo, sem mecanismo de apoio, moeda USD, valor = ValorServico)."}},"additionalProperties":false,"required":["ItemListaServico"],"description":"Dados do serviço prestado. OBRIGATÓRIO. Exige ao menos: ItemListaServico (item LC 116/2003 no provedor municipal, ou Código de Tributação Nacional cTribNac no ambiente nacional - ver ItemListaServico) e Valores.ValorServico > 0."}},"additionalProperties":false,"required":["Servico"]},"description":"Lista de NFS-e a emitir no lote. Mínimo 1 item."}},"required":["TipoAmbiente","nFSInfo"],"additionalProperties":false}},{"name":"nota_listar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"TipoAmbiente":{"type":"integer","enum":[1,2],"description":"Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação","default":1},"TipoDocumentoFiscal":{"type":"integer","enum":[0,1],"description":"Tipo do documento fiscal (Padrão 0 - Entrada) Valores: 0 - Entradas; 1 - Saídas"},"DtInicio":{"type":"string","description":"Data inicial da busca"},"DtFim":{"type":"string","description":"Data final da busca"},"IdentificadorInterno":{"type":["string","null"],"description":"Busca notas que possui o código interno informado (somente saídas)"},"TipoParticipacao":{"type":"integer","enum":[0,1,2],"description":"Como a empresa participa das notas de entrada (Padrão 0 - Destinatário). Somente para TipoDocumentoFiscal = 0. Valores: 0 - Destinatário (comportamento padrão); 1 - Transportadora (NF-e onde a empresa é citada como transportadora ou terceiro autorizado); 2 - Ambos"}},"additionalProperties":false}},{"name":"produto_consultar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Termo":{"type":["string","null"]},"TipoBusca":{"type":["string","null"]},"Limite":{"type":["integer","null"]},"Offset":{"type":["integer","null"]}},"additionalProperties":false}},{"name":"produto_criar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"Codigo":{"type":"string"},"Descricao":{"type":"string"},"UnidadeMedidaVendaSigla":{"type":"string","maxLength":10},"UnidadeMedidaCompraSigla":{"type":["string","null"],"maxLength":10},"FatorConversao":{"type":["number","null"]},"Ncm":{"type":["string","null"]},"Cest":{"type":["string","null"]},"Ean":{"type":["string","null"]},"ValorUnitarioVenda":{"type":"number"},"QuantidadeEstoque":{"type":["number","null"]}},"required":["Codigo","Descricao","UnidadeMedidaVendaSigla","ValorUnitarioVenda"],"additionalProperties":false}},{"name":"produto_editar","description":"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).","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"Codigo":{"type":"string"},"Descricao":{"type":"string"},"UnidadeMedidaVendaSigla":{"type":"string","maxLength":10},"UnidadeMedidaCompraSigla":{"type":["string","null"],"maxLength":10},"FatorConversao":{"type":["number","null"]},"Ncm":{"type":["string","null"]},"Cest":{"type":["string","null"]},"Ean":{"type":["string","null"]},"ValorUnitarioVenda":{"type":"number"},"QuantidadeEstoque":{"type":["number","null"]}},"required":["Codigo","Descricao","UnidadeMedidaVendaSigla","ValorUnitarioVenda"],"additionalProperties":false}},{"name":"sefaz_status","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"ModeloDocumento":{"type":"integer","enum":[55,65],"description":"Modelo do documento fiscal usado para determinar o webservice de status da SEFAZ (Padrão 55). Valores: 55 - NF-e; 65 - NFC-e","default":55}},"additionalProperties":false}},{"name":"tributacao_consultar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Termo":{"type":["string","null"]},"Tipo":{"type":["integer","null"]},"Cfop":{"type":["integer","null"]},"Limite":{"type":["integer","null"]},"Offset":{"type":["integer","null"]}},"additionalProperties":false}},{"name":"tributacao_criar","description":"Cadastra uma nova regra de tributacao (CFOP + CSTs + aliquotas). Tipo 1=NFe, 2=NFCe, 3=Energia/Comunicacao. CstIbsCbs e obrigatorio (Reforma Tributaria).","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"Tipo":{"type":"integer"},"Cfop":{"type":"integer"},"Descricao":{"type":"string"},"Observacao":{"type":["string","null"]},"CstIcms":{"type":["string","null"]},"AliqIcms":{"type":"number"},"AliqReducao":{"type":["number","null"]},"AliqDiferimento":{"type":["number","null"]},"CstPis":{"type":["string","null"]},"AliqPis":{"type":"number"},"CstCofins":{"type":["string","null"]},"AliqCofins":{"type":"number"},"CstIpi":{"type":["string","null"]},"AliqIpi":{"type":["number","null"]},"EnquadramentoIpi":{"type":["string","null"]},"CstIbsCbs":{"type":["string","null"]},"AliqIbsUf":{"type":["number","null"]},"AliqIbsMun":{"type":["number","null"]},"AliqCbs":{"type":["number","null"]},"CodBeneficioFiscal":{"type":["string","null"]},"ApiCode":{"type":["string","null"]},"AutoAliq":{"type":"boolean"}},"required":["Cfop","Descricao"],"additionalProperties":false}},{"name":"tributacao_editar","description":"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.","write_action":false,"price_micros":0,"input_schema":{"type":"object","properties":{"Id":{"type":["integer","null"]},"Tipo":{"type":"integer"},"Cfop":{"type":"integer"},"Descricao":{"type":"string"},"Observacao":{"type":["string","null"]},"CstIcms":{"type":["string","null"]},"AliqIcms":{"type":"number"},"AliqReducao":{"type":["number","null"]},"AliqDiferimento":{"type":["number","null"]},"CstPis":{"type":["string","null"]},"AliqPis":{"type":"number"},"CstCofins":{"type":["string","null"]},"AliqCofins":{"type":"number"},"CstIpi":{"type":["string","null"]},"AliqIpi":{"type":["number","null"]},"EnquadramentoIpi":{"type":["string","null"]},"CstIbsCbs":{"type":["string","null"]},"AliqIbsUf":{"type":["number","null"]},"AliqIbsMun":{"type":["number","null"]},"AliqCbs":{"type":["number","null"]},"CodBeneficioFiscal":{"type":["string","null"]},"ApiCode":{"type":["string","null"]},"AutoAliq":{"type":"boolean"}},"required":["Cfop","Descricao"],"additionalProperties":false}}],"scan":{"score":81,"grade":"B","scanned_at":"2026-09-27T05:28:40.405Z","report":{"scannerVersion":"0.1.9","scannedAt":"2026-09-27T05:28:40.402Z","components":{"code":{"score":-1,"max":25,"notes":["remote-only server, no package to scan"]},"reliability":{"score":20,"max":20,"notes":["remote reachable in 1579ms"]},"poisoning":{"score":15,"max":15,"notes":["34 tool descriptions checked"]},"auth":{"score":8,"max":15,"notes":["API key sent as a header"]},"maintenance":{"score":8,"max":15,"notes":["last push 106 days ago"]},"identity":{"score":10,"max":10,"notes":["registry namespace matches repository owner","GitHub account older than a year","website matches verified namespace"]}},"findings":[],"inputs":{"probes":[{"url":"https://api.brasilnfe.com.br/services/Mcp","reachable":true,"authRequired":false,"latencyMs":1579,"serverInfo":{"name":"BrasilNFe MCP","version":"1.0.0"}}],"packages":[],"repo":{"found":true,"owner":"BrasilNFe","repo":"brasilnfe-mcp","archived":false,"pushedAt":"2026-06-12T19:57:34Z","stars":0,"forks":0,"openIssues":0,"ownerType":"Organization","ownerAvatarUrl":"https://avatars.githubusercontent.com/u/158516579?v=4","ownerCreatedAt":"2024-02-01T20:14:41Z","license":"NOASSERTION"},"icon":{"url":"https://www.brasilnfe.com.br/assets/Isotipo-Brasil-NFei-ico.ico","source":"site","width":256,"height":256},"presence":{"stars":0,"forks":0,"downloadsWeek":null,"license":"NOASSERTION","lastPushAt":"2026-06-12T19:57:34.000Z","score":14}}}},"grade_history":[],"reviews":[]}