Server definition
- Hash
- sha256:1af5ee7aaf07a2b853bf2315f99f17b17b1a6790181ca3af168a7640ad145f2c
- What it is
- What a remote MCP server returned when asked what it offers: 34 tools
The blob, as servednamed by its sha256
{
"instructions": "Servidor MCP da BrasilNFe para emissão e consulta de documentos fiscais brasileiros (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e). Autentique-se com o token de empresa via header 'Authorization: Bearer <token>' ou 'Token: <token>'. Antes de emitir, leia 'brasilnfe://empresa/atual' para confirmar emitente/regime. Use 'sefaz_status' antes de operações em massa para verificar a SEFAZ. Use 'tipoAmbiente: 2' (homologação) para testes - nunca em produção real. Pré-visualização: sempre que o usuário pedir uma nota ou alterar qualquer dado dela (CFOP, itens, destinatário, valores), chame 'nfe_previsualizar' com a nota completa - o painel ao lado da conversa mostra o DANFE e o XML atualizados. Nunca chame 'nfe_emitir' sem que o usuário tenha visto a pré-visualização final e confirmado explicitamente a emissão nesta conversa; só então envie confirmacaoUsuario=true. Há prompts prontos (prompts/list) para fluxos comuns: emitir_nfe_simples, cancelar_nota, diagnostico_emissao, relatorio_periodo, carta_correcao.",
"tools": [
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Base64Logo": {
"type": [
"string",
"null"
]
},
"ChaveNF": {
"type": [
"string",
"null"
]
},
"Chaves": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"FileType": {
"default": 1,
"description": "Tipo do documento fiscal (Padrão 1 - XML) Valores: 1 - XML; 2 - DANFE",
"enum": [
1,
2
],
"type": "integer"
},
"TipoDocumentoFiscal": {
"default": 1,
"description": "Tipo do documento fiscal (Padrão 1 - Saída) Valores: 0 - Entrada; 1 - Saída",
"enum": [
0,
1
],
"type": "integer"
}
},
"type": "object"
},
"name": "arquivo_baixar",
"outputSchema": null
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ChaveNF": {
"description": "Chave de acesso da Nota Fiscal (44 dígitos) à qual o evento está vinculado.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"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.",
"type": [
"string",
"null"
]
},
"TipoArquivo": {
"description": "Tipo do arquivo do evento a ser retornado. Valores: 1 - XML do evento; 2 - PDF da Carta de Correção (CC-e)",
"enum": [
1,
2
],
"type": "integer"
}
},
"type": "object"
},
"name": "arquivo_baixar_evento",
"outputSchema": null
},
{
"description": "Exporta múltiplos arquivos (XML/PDF) de um período em um único ZIP base64. Útil para backup, contabilidade ou auditoria.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Chaves": {
"description": "Chaves pagar pegar notas fiscal especificas",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"DtFim": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"DtInicio": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"JuntarArquivosPDF": {
"description": "Anexar todas as notas fiscais retornadas em um unico arquivo PDF",
"type": "boolean"
},
"Situacoes": {
"description": "Filtra por situação. Vazio = todas (comportamento padrão). Combinável.",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"TipoAmbiente": {
"default": 1,
"description": "Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"TipoNota": {
"default": 1,
"description": "Tipo de ambiente (Padrão 1 - Saída) Valores: 1 - Saídas; 2 - Entradas; 3 - Saídas e Entradas",
"enum": [
1,
2,
3
],
"type": "integer"
},
"Type": {
"default": 1,
"description": "Tipo do documento fiscal (Padrão 1 - XML) Valores: 0 - PDF; 1 - XML; 2 - EXCEL",
"enum": [
0,
1,
2
],
"type": "integer"
},
"aplicarPlanoAjustes": {
"default": true,
"description": "Aplicar plano de ajustes de impostos",
"type": "boolean"
},
"cpfCnpjs": {
"description": "CPFs ou CNPJs dos clientes das notas",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"incluirCCe": {
"description": "Incluir carta de correção emitidas no periodo",
"type": "boolean"
}
},
"type": "object"
},
"name": "arquivo_baixar_periodo",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64FilesCompacted": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Quantidade": {
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"cpfCnpjIe": {
"type": [
"string",
"null"
]
},
"uf": {
"description": "UF do CPF, CNPJ, IE",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "cadastro_consultar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"cnaePrincipal": {
"type": [
"string",
"null"
]
},
"cpfCnpj": {
"type": [
"string",
"null"
]
},
"dataInicioAtividade": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"dataOcorrenciaBaixa": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"dataUltimaAlteracaoCadastral": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"fonte": {
"description": "Fonte dos dados: \"sefaz\" (Inscrição Estadual da SEFAZ estadual), \"receita\" (fallback na Receita Federal quando a UF não oferece a consulta ou o contribuinte não tem IE - comum em prestadores de serviço) ou \"indisponivel\".",
"type": [
"string",
"null"
]
},
"ie": {
"type": [
"string",
"null"
]
},
"ieAtual": {
"type": [
"string",
"null"
]
},
"ieUnica": {
"type": [
"string",
"null"
]
},
"indicadorCredenciamentoCTe": {
"description": "Indicador de contribuinte credenciado a emitir CT-e. Valores: 0 - Não credenciado para emissão da CT-e;; 1 - Credenciado;; 2 - Credenciado com obrigatoriedade para todas operações;; 3 - Credenciado com obrigatoriedade parcial;; 4 - a SEFAZ não fornece a informação. Este indicador significa apenas que o contribuinte é credenciado para emitir CT-e na SEFAZ consultada.",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"indicadorCredenciamentoNFe": {
"description": "Indicador de contribuinte credenciado a emitir NF-e. Valores: 0 - Não credenciado para emissão da NF-e;; 1 - Credenciado;; 2 - Credenciado com obrigatoriedade para todas operações;; 3 - Credenciado com obrigatoriedade parcial;; 4 - a SEFAZ não fornece a informação. Este indicador significa apenas que o contribuinte é credenciado para emitir NF-e na SEFAZ consultada.",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"mensagem": {
"description": "Mensagem explicativa do resultado: por que a IE não veio, qual fonte foi usada, e o aviso de que vazio NÃO significa CNPJ inativo. Fica vazio quando a SEFAZ retornou a Inscrição Estadual normalmente.",
"type": [
"string",
"null"
]
},
"nomeFantasia": {
"type": [
"string",
"null"
]
},
"razaoSocial": {
"type": [
"string",
"null"
]
},
"regimeApuracao": {
"type": [
"string",
"null"
]
},
"situacao": {
"description": "Situação do contribuinte: 0 - não habilitado; 1 - habilitado.",
"type": "integer"
},
"status": {
"description": "Status Consulta Valores: 0 - Não Encontrada;; 1 - Encontrada;",
"enum": [
0,
1
],
"type": "integer"
},
"ufConsultada": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Fontes": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"IncluirInativas": {
"type": "boolean"
},
"Limite": {
"type": [
"integer",
"null"
]
},
"Offset": {
"type": [
"integer",
"null"
]
},
"Termo": {
"type": [
"string",
"null"
]
},
"TipoBusca": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "cliente_consultar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"ConsultouBrasilApi": {
"type": "boolean"
},
"Limite": {
"type": "integer"
},
"Matches": {
"items": {
"additionalProperties": false,
"properties": {
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"integer",
"null"
]
},
"CodPais": {
"type": [
"integer",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Fonte": {
"type": [
"string",
"null"
]
},
"IdCliente": {
"type": [
"integer",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"type": [
"integer",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
},
"Score": {
"type": "number"
},
"Situacao": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Offset": {
"type": "integer"
},
"TermoNormalizado": {
"type": [
"string",
"null"
]
},
"TipoDetectado": {
"type": [
"string",
"null"
]
},
"TotalGeral": {
"type": "integer"
},
"TotalLocal": {
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ConsumidorFinal": {
"type": [
"boolean",
"null"
]
},
"CpfCnpj": {
"type": "string"
},
"Email": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"integer",
"null"
]
},
"CodPais": {
"type": [
"integer",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Im": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"type": [
"integer",
"null"
]
},
"Nome": {
"type": "string"
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"required": [
"CpfCnpj",
"Nome"
],
"type": "object"
},
"name": "cliente_criar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Cliente": {
"additionalProperties": false,
"properties": {
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"integer",
"null"
]
},
"CodPais": {
"type": [
"integer",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Fonte": {
"type": [
"string",
"null"
]
},
"IdCliente": {
"type": [
"integer",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"type": [
"integer",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
},
"Score": {
"type": "number"
},
"Situacao": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"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).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ConsumidorFinal": {
"type": [
"boolean",
"null"
]
},
"CpfCnpj": {
"type": "string"
},
"Email": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"integer",
"null"
]
},
"CodPais": {
"type": [
"integer",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Im": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"type": [
"integer",
"null"
]
},
"Nome": {
"type": "string"
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"required": [
"CpfCnpj",
"Nome"
],
"type": "object"
},
"name": "cliente_editar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Cliente": {
"additionalProperties": false,
"properties": {
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"integer",
"null"
]
},
"CodPais": {
"type": [
"integer",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Fonte": {
"type": [
"string",
"null"
]
},
"IdCliente": {
"type": [
"integer",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"type": [
"integer",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
},
"Score": {
"type": "number"
},
"Situacao": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Registra desacordo do tomador com um CT-e recebido (evento tipo 4 do CT-e). Prazo: 45 dias da emissão.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Chave": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"description": "Número sequencial do evento",
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"TipoAmbiente": {
"description": "Tipo do Documento Fiscal: Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
}
},
"type": "object"
},
"name": "cte_desacordo",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Carga": {
"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.",
"properties": {
"Detalhes": {
"description": "Detalhes das quantidades da carga. (infQ)",
"items": {
"additionalProperties": false,
"properties": {
"CodUnidadeMedida": {
"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)",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"Quantidade": {
"description": "Quantidade da Carga (qCarga). Ex: 10000",
"type": "number"
},
"TipoMedida": {
"description": "Tipo de Medida. (tpMed). Ex: \"quilos gramas\"",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Documentos": {
"description": "Documentos fiscais que acompanham a carga. (infNFe)",
"items": {
"additionalProperties": false,
"properties": {
"Chave": {
"type": [
"string",
"null"
]
},
"PIN": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"OutrosDocumentos": {
"description": "Outros documentos que acompanham a carga quando não há NF-e (ex.: declaração de mudança, C2C). (infOutros)",
"items": {
"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.",
"properties": {
"Descricao": {
"description": "Descrição do documento. Obrigatória quando TipoDocumento = 99. (descOutros)",
"type": [
"string",
"null"
]
},
"DtEmissao": {
"description": "Data de emissão do documento. (dEmi)",
"type": [
"string",
"null"
]
},
"DtPrevisao": {
"description": "Data prevista de entrega. (dPrev)",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número do documento. (nDoc)",
"type": [
"string",
"null"
]
},
"TipoDocumento": {
"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)",
"enum": [
0,
10,
59,
65,
99
],
"type": "integer"
},
"Valor": {
"description": "Valor do documento fiscal. (vDocFisc)",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"ProdutoPredominante": {
"description": "Nome do Produto Predominante. (proPred)",
"type": [
"string",
"null"
]
},
"ValorTotal": {
"description": "Valor total da carga. (vCarga)",
"type": "number"
}
},
"type": "object"
},
"Cfop": {
"description": "CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída.",
"type": "integer"
},
"Codigo": {
"type": [
"integer",
"null"
]
},
"Destinatario": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DtEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"Expedidor": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"Imposto": {
"additionalProperties": false,
"properties": {
"Difal": {
"additionalProperties": false,
"description": "Informações sobre o ICMS Partilha (DIFAL/ICMS UF Fim).",
"properties": {
"AliquotaICMSUfDestino": {
"description": "Alíquota interna da UF de destino para o ICMS. (pICMSUFFim)",
"type": "number"
},
"AliquotaInterestadual": {
"description": "Alíquota interestadual das UF envolvidas. (pICMSInter)",
"type": "number"
},
"BaseCalculoUfDestino": {
"description": "Base de Cálculo do ICMS na UF de Destino. (vBCUFFim)",
"type": "number"
},
"PercentualFCPUfDestino": {
"description": "Percentual do Fundo de Combate à Pobreza (FCP) na UF de destino. (pFCPUFFim)",
"type": "number"
},
"PercentualPartilhaICMS": {
"description": "Percentual de Partilha do ICMS (Ex: 80, 20, 0, etc.). (pICMSInterPart)",
"type": "number"
},
"ValorFCPUfDestino": {
"description": "Valor do Fundo de Combate à Pobreza (FCP) na UF de destino. (vFCPUFFim)",
"type": "number"
},
"ValorICMSUfDestino": {
"description": "Valor total do ICMS devido à UF de destino (já com o FCP). (vICMSUFFim)",
"type": "number"
},
"ValorICMSUfInicio": {
"description": "Valor do ICMS devido à UF de origem (Início). (vICMSUFIni)",
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"IBSCBS": {
"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.",
"properties": {
"AliquotaCBS": {
"description": "Alíquota da CBS (pCBS).",
"type": [
"number",
"null"
]
},
"AliquotaIBSMun": {
"description": "Alíquota do IBS de competência do Município (pIBSMun).",
"type": [
"number",
"null"
]
},
"AliquotaIBSUF": {
"description": "Alíquota do IBS de competência das UF (pIBSUF).",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo do IBS/CBS (vBC). Quando null, usa o valor total da prestação.",
"type": [
"number",
"null"
]
},
"CodClassificacaoTributaria": {
"description": "Código de Classificação Tributária do IBS/CBS (cClassTrib). O CST é derivado dos 3 primeiros dígitos. Quando vazio, assume \"000001\".",
"type": [
"string",
"null"
]
},
"PercentualDiferimento": {
"description": "Percentual de diferimento (pDif de gDif), usado nos CST 510/515.",
"type": [
"number",
"null"
]
},
"PercentualReducaoCBS": {
"description": "Percentual de redução da alíquota da CBS (pRedAliq de gRed). Pode divergir de PercentualReducaoIBS.",
"type": [
"number",
"null"
]
},
"PercentualReducaoIBS": {
"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.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ICMS": {
"additionalProperties": false,
"description": "Informações do ICMS",
"properties": {
"Aliquota": {
"description": "Alíquota do ICMS (em percentual). (pICMS)",
"type": "number"
},
"AliquotaOutraUF": {
"description": "Alíquota do ICMS devido a Outra UF. (pICMSOutraUF) Usado no CST OutraUF.",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de Cálculo do ICMS. (vBC)",
"type": "number"
},
"CST": {
"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.",
"type": [
"string",
"null"
]
},
"PercentualReducaoBaseCalculo": {
"description": "Percentual de Redução da Base de Cálculo. (pRedBC) Usado nos CSTs 20 e 90.",
"type": [
"number",
"null"
]
},
"Valor": {
"description": "Valor do ICMS. (vICMS)",
"type": "number"
},
"ValorICMSOutraUF": {
"description": "Valor do ICMS devido a Outra UF. (vICMSOutraUF) Usado no CST OutraUF.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"InformacoesAdicionaisFisco": {
"description": "Informações Adicionais de Interesse do Fisco.",
"type": [
"string",
"null"
]
},
"TributosFederal": {
"additionalProperties": false,
"description": "Lista de PIS e COFINS (Tributos Federais).",
"properties": {
"ValorCofins": {
"description": "Valor do COFINS retido. (vCOFINS)",
"type": [
"number",
"null"
]
},
"ValorCsll": {
"description": "Valor da CSLL retida. (vCSLL)",
"type": [
"number",
"null"
]
},
"ValorInss": {
"description": "Valor do INSS retido. (vINSS)",
"type": [
"number",
"null"
]
},
"ValorIr": {
"description": "Valor do Imposto de Renda retido. (vIR)",
"type": [
"number",
"null"
]
},
"ValorPis": {
"description": "Valor do PIS retido. (vPIS)",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorTotalTributos": {
"description": "Valor total dos tributos federais e estaduais, aproximado conforme Lei 12.741/12.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Lote": {
"type": [
"integer",
"null"
]
},
"Modal": {
"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.",
"properties": {
"Rodoviario": {
"additionalProperties": false,
"properties": {
"OCCs": {
"description": "Lista de coletas realizadas para compor o frete.",
"items": {
"additionalProperties": false,
"properties": {
"DtEmissaoColeta": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"Emissor": {
"additionalProperties": false,
"properties": {
"Cnpj": {
"description": "CNPJ do emissor da OCC",
"type": [
"string",
"null"
]
},
"CodigoInternoOCC": {
"description": "Código interno da OCC na empresa emissora",
"type": [
"string",
"null"
]
},
"Ie": {
"description": "Inscrição estadual do emissor",
"type": [
"string",
"null"
]
},
"Telefone": {
"description": "Telefone do emissor da OCC",
"type": [
"string",
"null"
]
},
"Uf": {
"description": "Estado do emissor da OCC",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Numero": {
"type": "integer"
},
"Serie": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Tipo": {
"default": 1,
"description": "Modal do CT-e: Valores: 1 - Rodoviário; 2 - Aéreo; 3 - Aquaviário; 4 - Ferroviário; 5 - Dutoviário; 6 - Multimodal",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
},
"type": "object"
},
"ModeloDocumento": {
"default": 57,
"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)",
"enum": [
57,
67
],
"type": "integer"
},
"NaturezaOperacao": {
"description": "Descrição da natureza da operação (ex: \"Prestação de serviço de transporte\").",
"type": "string"
},
"Numero": {
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Remetente": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Retira": {
"type": "boolean"
},
"Serie": {
"type": [
"integer",
"null"
]
},
"Servico": {
"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.",
"properties": {
"CodMunicipioFim": {
"description": "Código IBGE do município do destino o transporte",
"type": "integer"
},
"CodMunicipioInicio": {
"description": "Código IBGE do município do início do transporte",
"type": "integer"
},
"Componentes": {
"description": "Lista de componentes que detalham como o valor total do frete foi formado.",
"items": {
"additionalProperties": false,
"properties": {
"Nome": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"MunicipioFim": {
"description": "Nome do município do destino do transporte",
"type": [
"string",
"null"
]
},
"MunicipioInicio": {
"description": "Nome do município do início do transporte",
"type": [
"string",
"null"
]
},
"Tipo": {
"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",
"enum": [
0,
1,
2,
3,
4,
6,
7,
8
],
"type": "integer"
},
"ValorPrestacao": {
"description": "O valor total cobrado pela prestação do serviço de transporte.",
"type": "number"
},
"ValorReceber": {
"description": "O valor líquido a receber pelo transportador.",
"type": "number"
}
},
"type": "object"
},
"TipoAmbiente": {
"description": "Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoCte": {
"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",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"Tomador": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"description": "Indicador de IE: Valores: 1 - Contribuinte do ICMS; 2 - Contribuinte isento de inscrição; 9 - Não contribuinte",
"enum": [
1,
2,
9
],
"type": "integer"
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
},
"TipoTomador": {
"description": "Tipo do participante do CT-e: Valores: 0 - Remetente; 1 - Expedidor; 2 - Recebedor; 3 - Destinatário; 4 - Outros (Informar dados Tomador)",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"ModeloDocumento",
"TipoAmbiente",
"TipoCte",
"Cfop",
"NaturezaOperacao",
"Modal",
"Carga",
"Servico"
],
"type": "object"
},
"name": "cte_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"base64DACTe": {
"type": [
"string",
"null"
]
},
"base64Xml": {
"type": [
"string",
"null"
]
},
"chave": {
"type": [
"string",
"null"
]
},
"erros": {
"description": "Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.",
"items": {
"additionalProperties": false,
"properties": {
"codigo": {
"description": "Código do erro/rejeição (quando houver).",
"type": [
"string",
"null"
]
},
"correcao": {
"description": "Sugestão de correção, quando disponível.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do erro.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"numero": {
"type": "integer"
},
"serie": {
"type": "integer"
},
"status": {
"description": "Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).",
"type": "integer"
},
"tipoAmbiente": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"CnpjTransportadora": {
"description": "CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora.",
"type": [
"string",
"null"
]
},
"Codigo": {
"type": [
"integer",
"null"
]
},
"DeclaracaoContribuinteICMS": {
"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.\"",
"type": "string"
},
"DeclaracaoCrimeTributario": {
"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.\"",
"type": "string"
},
"Destinatario": {
"additionalProperties": false,
"description": "Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo.",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "CPF ou CNPJ",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Nome": {
"description": "Nome ou Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"InformacoesAdicionaisFisco": {
"description": "Informações adicionais de interesse do fisco (opcional, até 2000 caracteres).",
"type": [
"string",
"null"
]
},
"InformacoesComplementares": {
"description": "Informações complementares (opcional, até 5000 caracteres).",
"type": [
"string",
"null"
]
},
"Itens": {
"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).",
"items": {
"additionalProperties": false,
"properties": {
"Descricao": {
"description": "Descrição do produto/conteúdo (1-120 caracteres). Obrigatória.",
"type": "string"
},
"InformacoesAdicionais": {
"description": "Informações adicionais do produto (opcional, até 500 caracteres)",
"type": [
"string",
"null"
]
},
"NCM": {
"description": "Código NCM. Quando informado deve ter 2 ou 8 dígitos. Opcional na DC-e.",
"type": [
"string",
"null"
]
},
"Quantidade": {
"description": "Quantidade do item.",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"description": "Valor total do item. Deve ser > 0.",
"type": "number"
},
"ValorUnitario": {
"description": "Valor unitário do item.",
"type": [
"number",
"null"
]
}
},
"required": [
"Descricao",
"ValorTotal"
],
"type": "object"
},
"type": "array"
},
"Lote": {
"type": [
"integer",
"null"
]
},
"ModalidadeTransporte": {
"default": 2,
"description": "Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora",
"enum": [
0,
1,
2
],
"type": "integer"
},
"Numero": {
"type": [
"integer",
"null"
]
},
"Remetente": {
"additionalProperties": false,
"description": "Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe).",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "CPF ou CNPJ",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Nome": {
"description": "Nome ou Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Serie": {
"type": [
"integer",
"null"
]
},
"SiteMarketplace": {
"description": "URL do site do marketplace (obrigatório quando TipoEmitente=1)",
"type": [
"string",
"null"
]
},
"TipoAmbiente": {
"description": "Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoEmitente": {
"default": 3,
"description": "Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios)",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"UfFisco": {
"description": "Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora.",
"type": [
"string",
"null"
]
},
"ValorTotal": {
"description": "Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0.",
"type": [
"number",
"null"
]
},
"XOrgaoFisco": {
"description": "Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0)",
"type": [
"string",
"null"
]
}
},
"required": [
"TipoAmbiente",
"Remetente",
"Destinatario",
"Itens",
"DeclaracaoContribuinteICMS",
"DeclaracaoCrimeTributario"
],
"type": "object"
},
"name": "dce_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"base64DACE": {
"type": [
"string",
"null"
]
},
"base64Xml": {
"type": [
"string",
"null"
]
},
"chave": {
"type": [
"string",
"null"
]
},
"erros": {
"description": "Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.",
"items": {
"additionalProperties": false,
"properties": {
"codigo": {
"description": "Código do erro/rejeição (quando houver).",
"type": [
"string",
"null"
]
},
"correcao": {
"description": "Sugestão de correção, quando disponível.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do erro.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"numero": {
"type": "integer"
},
"protocolo": {
"type": [
"string",
"null"
]
},
"serie": {
"type": "integer"
},
"status": {
"description": "Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).",
"type": "integer"
},
"tipoAmbiente": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
{
"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).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ChaveNF": {
"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.",
"type": "string"
},
"CodCancelamentoNFSe": {
"default": 1,
"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",
"enum": [
1,
2,
3,
9
],
"type": "integer"
},
"CpfCnpjRemetenteDCe": {
"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).",
"type": [
"string",
"null"
]
},
"DataEvento": {
"description": "Data do evento de cancelamento do documento (Caso não for enviado é considerada a data e hora atual)",
"type": [
"string",
"null"
]
},
"Justificativa": {
"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).",
"type": "string"
},
"NumeroNFSe": {
"description": "Número da NFS-e a ser cancelada",
"type": [
"string",
"null"
]
},
"NumeroProtocolo": {
"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.",
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"description": "Número sequencial do evento",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"default": 1,
"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",
"enum": [
1,
2
],
"type": "integer"
},
"TipoDocumento": {
"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)",
"enum": [
0,
1
],
"type": "integer"
}
},
"required": [
"ChaveNF",
"Justificativa",
"TipoAmbiente",
"TipoDocumento"
],
"type": "object"
},
"name": "evento_cancelar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ChaveNF": {
"description": "Chave de acesso de 44 dígitos da NF-e ou CT-e a corrigir.",
"type": "string"
},
"Correcao": {
"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.",
"type": [
"string",
"null"
]
},
"Correcoes": {
"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.",
"items": {
"additionalProperties": false,
"properties": {
"Campo": {
"type": [
"string",
"null"
]
},
"Grupo": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"NumeroSequencial": {
"description": "Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível.",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"default": 1,
"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",
"enum": [
1,
2
],
"type": "integer"
}
},
"required": [
"TipoAmbiente",
"ChaveNF"
],
"type": "object"
},
"name": "evento_carta_correcao",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Justificativa": {
"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\").",
"type": "string"
},
"ModeloDocumento": {
"description": "Código do modelo do Documento Fiscal a inutilizar. Valores: 55 - NF-e; 65 - NFC-e; 57 - CT-e",
"enum": [
55,
65,
57
],
"type": "integer"
},
"NumeracaoFinal": {
"description": "Final da faixa numérica a inutilizar. Deve ser >= NumeracaoInicial.",
"type": "integer"
},
"NumeracaoInicial": {
"description": "Início da faixa numérica a inutilizar. Deve ser > 0 e <= NumeracaoFinal.",
"type": "integer"
},
"Serie": {
"description": "Série referente ao modelo do documento. Deve ser > 0.",
"type": "integer"
},
"TipoAmbiente": {
"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)",
"enum": [
1,
2
],
"type": "integer"
}
},
"required": [
"TipoAmbiente",
"ModeloDocumento",
"Serie",
"Justificativa",
"NumeracaoInicial",
"NumeracaoFinal"
],
"type": "object"
},
"name": "evento_inutilizar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Chave": {
"description": "Chave de acesso de 44 dígitos da NF-e a manifestar.",
"type": "string"
},
"Justificativa": {
"description": "Justificativa. OBRIGATÓRIA quando TipoManifestacao = 4 (mínimo 15 caracteres). Para outros tipos pode omitir.",
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"description": "Número sequencial do evento (1 a 20). Se omitido, o sistema usa o próximo disponível.",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"default": 1,
"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",
"enum": [
1,
2
],
"type": "integer"
},
"TipoManifestacao": {
"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)",
"enum": [
1,
2,
3,
4
],
"type": "integer"
}
},
"required": [
"Chave",
"TipoAmbiente",
"TipoManifestacao"
],
"type": "object"
},
"name": "evento_manifestar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"description": "Gera o arquivo FCI (Ficha de Conteúdo de Importação) requerido para produtos com conteúdo importado em operações interestaduais.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Produtos": {
"description": "Produtos para gerar os registros do arquivo FCI",
"items": {
"additionalProperties": false,
"properties": {
"Codigo": {
"description": "Código interno que identifica a mercadoria no estabelecimento",
"type": [
"string",
"null"
]
},
"Descricao": {
"description": "Descrição da Mercadoria",
"type": [
"string",
"null"
]
},
"Gtin": {
"description": "Código Global Trade Item Number, se houver",
"type": [
"string",
"null"
]
},
"Ncm": {
"description": "Código baseado na tabela da Nomenclatura Comum do MERCOSUL",
"type": [
"string",
"null"
]
},
"PercentualImportado": {
"description": "Percentual do conteúdo de importação informado pelo contribuinte (Obrigatório caso não for informado o Valor Importado)",
"type": [
"number",
"null"
]
},
"UnidadeMedida": {
"description": "Unidade a que se refere o valor de saída da mercadoria",
"type": [
"string",
"null"
]
},
"ValorImportado": {
"description": "Valor da parcela importada do exterior (Obrigatório caso não for informado o Percentual Importado)",
"type": [
"number",
"null"
]
},
"ValorSaida": {
"description": "Valor de saída (comercialização) da mercadoria",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Transmitir": {
"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.",
"type": "boolean"
},
"ValidarCodigos": {
"default": true,
"description": "Quando verdadeiro retorna erro caso envie produtos com código repetido",
"type": "boolean"
}
},
"type": "object"
},
"name": "fci_gerar",
"outputSchema": null
},
{
"description": "Verifica a saúde da API BrasilNFe (status, timestamp, versão). Não recebe parâmetros.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "health",
"outputSchema": null
},
{
"description": "Simula o cálculo de impostos (ICMS, PIS, COFINS, IPI, ST) sobre uma lista de produtos sem emitir nota. Útil para precificação.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Capacity": {
"type": "integer"
},
"Count": {
"type": "integer"
}
},
"type": "object"
},
"name": "imposto_calcular",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Impostos": {
"additionalProperties": false,
"properties": {
"BaseCalculoICMS": {
"type": "number"
},
"BaseCalculoICMSST": {
"type": "number"
},
"ValorCOFINS": {
"type": "number"
},
"ValorFCP": {
"type": "number"
},
"ValorFCPST": {
"type": "number"
},
"ValorFCPSTRetido": {
"type": "number"
},
"ValorICMS": {
"type": "number"
},
"ValorICMSDesoneracao": {
"type": "number"
},
"ValorICMSST": {
"type": "number"
},
"ValorIPI": {
"type": "number"
},
"ValorImportacao": {
"type": "number"
},
"ValorPIS": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"Total": {
"additionalProperties": false,
"properties": {
"ValorDesconto": {
"type": "number"
},
"ValorDespesasAcessorias": {
"type": "number"
},
"ValorFrete": {
"type": "number"
},
"ValorProdutos": {
"type": "number"
},
"ValorSeguro": {
"type": "number"
},
"ValorTotal": {
"type": "number"
},
"ValorTributosAproximados": {
"type": "number"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Aereo": {
"additionalProperties": false,
"properties": {
"aerodromoDestino": {
"type": [
"string",
"null"
]
},
"aerodromoEmbarque": {
"type": [
"string",
"null"
]
},
"dataVoo": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"matricula": {
"type": [
"string",
"null"
]
},
"nacionalidade": {
"type": [
"string",
"null"
]
},
"numeroVoo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Aquaviario": {
"additionalProperties": false,
"properties": {
"cnpjAgencia": {
"type": [
"string",
"null"
]
},
"codEmbarcacao": {
"type": [
"string",
"null"
]
},
"codPortoDestino": {
"type": [
"string",
"null"
]
},
"codPortoEmbarque": {
"type": [
"string",
"null"
]
},
"nomeEmbarcacao": {
"type": [
"string",
"null"
]
},
"numeroViagem": {
"type": [
"string",
"null"
]
},
"tipoEmbarcacao": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"DataEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"Ferroviario": {
"additionalProperties": false,
"properties": {
"DataLiberacao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"Vagoes": {
"items": {
"additionalProperties": false,
"properties": {
"numero": {
"type": "integer"
},
"pesoBc": {
"description": "Peso Base de Cálculo de Frete em Toneladas",
"type": "number"
},
"pesoReal": {
"description": "Peso Real em Toneladas",
"type": "number"
},
"sequencia": {
"type": [
"integer",
"null"
]
},
"serie": {
"type": "integer"
},
"toneladaUtil": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"destino": {
"type": [
"string",
"null"
]
},
"origem": {
"type": [
"string",
"null"
]
},
"prefixo": {
"type": [
"string",
"null"
]
},
"quantidadeVagoes": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"Rodoviario": {
"additionalProperties": false,
"description": "Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1.",
"properties": {
"CIOT": {
"additionalProperties": false,
"properties": {
"cnpj": {
"type": [
"string",
"null"
]
},
"codigo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"capKG": {
"description": "Capacidade em KG do veículo de tração. Opcional.",
"type": [
"integer",
"null"
]
},
"capM3": {
"description": "Capacidade em M3 do veículo de tração. Opcional.",
"type": [
"integer",
"null"
]
},
"condutores": {
"items": {
"additionalProperties": false,
"properties": {
"cpf": {
"type": [
"string",
"null"
]
},
"nome": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"contratantes": {
"description": "Contratantes do serviço de transporte (grupo infANTT/infContratante).",
"items": {
"additionalProperties": false,
"properties": {
"cpfCnpj": {
"description": "CPF, CNPJ ou identificador estrangeiro do contratante do transporte.",
"type": [
"string",
"null"
]
},
"nome": {
"description": "Razão social ou nome do contratante.",
"type": [
"string",
"null"
]
},
"nroContrato": {
"description": "Número do contrato do transportador com o contratante, para prestações continuadas.",
"type": [
"string",
"null"
]
},
"vContratoGlobal": {
"description": "Valor global do contrato. Usar somente no pagamento a prazo.",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"pagamentos": {
"description": "Informações de pagamento do frete (grupo infANTT/infPag).",
"items": {
"additionalProperties": false,
"properties": {
"altoDesempenho": {
"description": "Operação de transporte de alto desempenho (frota dedicada/fidelizada).",
"type": "boolean"
},
"anteciparAdiantamento": {
"description": "Concordância em antecipar o adiantamento.",
"type": "boolean"
},
"componentes": {
"description": "Componentes do pagamento do frete.",
"items": {
"additionalProperties": false,
"properties": {
"descricao": {
"description": "Descrição do componente (usar quando tipo = 99).",
"type": [
"string",
"null"
]
},
"tipo": {
"description": "Tipo do componente: 01 - Vale-Pedágio; 02 - Impostos, taxas e contribuições; 03 - Despesas; 99 - Outros.",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor do componente.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"cpfCnpjResponsavel": {
"description": "CPF, CNPJ ou identificador estrangeiro do responsável pelo pagamento do frete.",
"type": [
"string",
"null"
]
},
"indicadorPagamento": {
"description": "Forma de pagamento: 0 - à vista; 1 - a prazo.",
"type": "integer"
},
"infoBancaria": {
"additionalProperties": false,
"description": "Informações bancárias para recebimento do frete.",
"properties": {
"cnpjInstituicaoPagamento": {
"description": "CNPJ da instituição de pagamento eletrônico do frete (alternativa ao banco/agência).",
"type": [
"string",
"null"
]
},
"codAgencia": {
"description": "Número da agência bancária.",
"type": [
"string",
"null"
]
},
"codBanco": {
"description": "Número do banco. Informar junto com a agência (ou use cnpjInstituicaoPagamento, ou pix).",
"type": [
"string",
"null"
]
},
"pix": {
"description": "Chave PIX para recebimento do frete (alternativa ao banco/agência).",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"nomeResponsavel": {
"description": "Razão social ou nome do responsável pelo pagamento.",
"type": [
"string",
"null"
]
},
"parcelas": {
"description": "Parcelas do pagamento (informar somente se a prazo).",
"items": {
"additionalProperties": false,
"properties": {
"numero": {
"description": "Número da parcela.",
"type": "integer"
},
"valor": {
"description": "Valor da parcela.",
"type": [
"number",
"null"
]
},
"vencimento": {
"description": "Data de vencimento da parcela.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"tipoAntecipacao": {
"description": "Permissão de antecipação das parcelas: 0 - não permite; 1 - permite; 2 - permite mediante confirmação.",
"type": [
"integer",
"null"
]
},
"valorAdiantamento": {
"description": "Valor do adiantamento (usar apenas em pagamento a prazo).",
"type": [
"number",
"null"
]
},
"valorContrato": {
"description": "Valor total do contrato.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"placa": {
"type": [
"string",
"null"
]
},
"reboques": {
"description": "Lista de veículos de reboque acoplados à tração. Opcional - se nulo/vazio,",
"items": {
"additionalProperties": false,
"properties": {
"capKG": {
"type": [
"integer",
"null"
]
},
"capM3": {
"type": [
"integer",
"null"
]
},
"placa": {
"description": "Placa do reboque (sem máscara).",
"type": [
"string",
"null"
]
},
"renavam": {
"type": [
"string",
"null"
]
},
"tara": {
"description": "Tara em KG",
"type": [
"integer",
"null"
]
},
"tipoCarroceria": {
"description": "Tipo de Carroceria Valores: 0 - Não aplicável; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"uf": {
"description": "UF de licenciamento do reboque (sigla de 2 letras).",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"renavam": {
"type": [
"string",
"null"
]
},
"tara": {
"description": "Tara em KG",
"type": "integer"
},
"tipoCarroceria": {
"description": "Tipo de Carroceria (Padrão 1) Valores: 0 - Não aplicavel; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"tipoRodado": {
"description": "Tipo de Rodado (Padrão 1) Valores: 1 - Truck; 2 - Toco; 3 - Cavalo Mecânico; 4 - VAN; 5 - Utilitário; 6 - Outros",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"uf": {
"type": [
"string",
"null"
]
},
"valePedagio": {
"additionalProperties": false,
"description": "Vale-pedágio (grupo infANTT/valePed).",
"properties": {
"categoriaCombinacaoVeicular": {
"description": "Categoria de combinação veicular (02 a 14, conforme número de eixos).",
"type": [
"string",
"null"
]
},
"dispositivos": {
"description": "Dispositivos do vale-pedágio.",
"items": {
"additionalProperties": false,
"properties": {
"cnpjFornecedor": {
"description": "CNPJ da empresa fornecedora do vale-pedágio.",
"type": [
"string",
"null"
]
},
"cpfCnpjPagador": {
"description": "CPF ou CNPJ do responsável pelo pagamento. Informar quando não for o emitente do MDF-e.",
"type": [
"string",
"null"
]
},
"numeroComprovante": {
"description": "Número do comprovante de compra.",
"type": [
"string",
"null"
]
},
"tipo": {
"description": "Tipo do vale-pedágio: 01 - TAG, 02 - Cupom, 03 - Cartão.",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor do vale-pedágio.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"carregamentos": {
"items": {
"additionalProperties": false,
"properties": {
"codMunicipio": {
"type": "integer"
},
"municipio": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"codigo": {
"type": [
"integer",
"null"
]
},
"descarregamentos": {
"items": {
"additionalProperties": false,
"properties": {
"chaveDfe": {
"type": [
"string",
"null"
]
},
"codMunicipio": {
"type": "integer"
},
"municipio": {
"type": [
"string",
"null"
]
},
"transportePerigosos": {
"items": {
"additionalProperties": false,
"properties": {
"codigoONU": {
"type": [
"string",
"null"
]
},
"quantidade": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"identificadorInterno": {
"type": [
"string",
"null"
]
},
"lote": {
"type": [
"integer",
"null"
]
},
"modalidade": {
"default": 1,
"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)",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"numero": {
"type": [
"integer",
"null"
]
},
"observacao": {
"type": [
"string",
"null"
]
},
"observacaoFisco": {
"type": [
"string",
"null"
]
},
"percursoUfs": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"peso": {
"description": "Peso bruto total das mercadorias em KG. DEVE ser > 0.",
"type": "number"
},
"produtoPredominante": {
"additionalProperties": false,
"description": "Produto predominante transportado. Opcional.",
"properties": {
"cEan": {
"description": "GTIN/EAN do produto. Opcional. Use \"SEM GTIN\" se não houver.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do produto predominante (1 a 120 caracteres).",
"type": [
"string",
"null"
]
},
"infLotacao": {
"additionalProperties": false,
"description": "Informações de carga lotação. Opcional - só preencha quando o MDF-e for de carga lotação.",
"properties": {
"localCarrega": {
"additionalProperties": false,
"description": "Local de carregamento da lotação. Informe CEP OU (latitude + longitude).",
"properties": {
"cep": {
"description": "CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados.",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "Latitude. Informe junto com longitude quando não houver CEP.",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "Longitude. Informe junto com latitude quando não houver CEP.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"localDescarrega": {
"additionalProperties": false,
"description": "Local de descarregamento da lotação. Informe CEP OU (latitude + longitude).",
"properties": {
"cep": {
"description": "CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados.",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "Latitude. Informe junto com longitude quando não houver CEP.",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "Longitude. Informe junto com latitude quando não houver CEP.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ncm": {
"description": "Código NCM do produto. Opcional. Aceita 2 ou 8 dígitos.",
"type": [
"string",
"null"
]
},
"tpCarga": {
"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)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"seguros": {
"items": {
"additionalProperties": false,
"properties": {
"cnpjSegurador": {
"description": "CNPJ da seguradora (somente dígitos).",
"type": [
"string",
"null"
]
},
"cpfCnpjResponsavel": {
"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.",
"type": [
"string",
"null"
]
},
"indicadorResponsavel": {
"default": 1,
"description": "Identificação do Ambiente (Padrão 1) Valores: 1 - Emitente do MDF-e; 2 - Responsável pela contratação",
"enum": [
1,
2
],
"type": "integer"
},
"nomeSegurador": {
"description": "Razão social / nome da seguradora.",
"type": [
"string",
"null"
]
},
"numeroApolice": {
"description": "Número da apólice de seguro. Obrigatório para modal rodoviário no MDF-e versão 3.00.",
"type": [
"string",
"null"
]
},
"numerosAverbacao": {
"description": "Lista de números de averbação do seguro (0..N). Opcional.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"serie": {
"type": [
"integer",
"null"
]
},
"tipoAmbiente": {
"default": 1,
"description": "Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"tipoEmitente": {
"default": 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)",
"enum": [
1,
2
],
"type": "integer"
},
"ufCarregamento": {
"description": "UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...).",
"type": "string"
},
"ufDescarregamento": {
"description": "UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...).",
"type": "string"
},
"valor": {
"description": "Valor total das mercadorias transportadas. DEVE ser > 0.",
"type": "number"
}
},
"required": [
"tipoAmbiente",
"tipoEmitente",
"ufCarregamento",
"ufDescarregamento",
"modalidade",
"valor",
"peso"
],
"type": "object"
},
"name": "mdfe_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"base64DAMDFe": {
"type": [
"string",
"null"
]
},
"base64Xml": {
"type": [
"string",
"null"
]
},
"chave": {
"type": [
"string",
"null"
]
},
"codRespostaSefaz": {
"type": "integer"
},
"numero": {
"type": "integer"
},
"status": {
"description": "1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote",
"enum": [
1,
2,
3
],
"type": "integer"
},
"tipoAmbiente": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"chave": {
"description": "Chave de acesso de 44 dígitos do MDF-e a encerrar.",
"type": "string"
},
"numeroSequencial": {
"description": "Número sequencial do evento. Se omitido, o sistema usa o próximo disponível.",
"type": [
"integer",
"null"
]
},
"protocolo": {
"description": "Protocolo de autorização do MDF-e original. Opcional - se omitido, o sistema localiza pela chave.",
"type": [
"string",
"null"
]
},
"tipoAmbiente": {
"default": 1,
"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",
"enum": [
1,
2
],
"type": "integer"
}
},
"required": [
"tipoAmbiente",
"chave"
],
"type": "object"
},
"name": "mdfe_encerrar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"description": "PDF do documento auxiliar do evento (ex.: Carta de Correcao) em Base64. Preenchido apenas quando o evento e autorizado e a nota existe na base. Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML do evento processado (procEventoNFe) em Base64. Preenchido apenas quando o evento e autorizado (cStat 135) e o documento e NF-e (modelo 55). Nulo nos demais casos.",
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"DsAmbiente": {
"type": [
"string",
"null"
]
},
"DsEvento": {
"type": [
"string",
"null"
]
},
"DsMotivo": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"NuProtocolo": {
"type": [
"string",
"null"
]
},
"NumeroSequencial": {
"type": "integer"
},
"Status": {
"description": "1 - Evento Processado; 2 - Aguardando processamento do evento; 3 - Ocorreu um erro ao processar o evento",
"enum": [
1,
2,
3
],
"type": "integer"
}
},
"type": "object"
}
},
{
"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. TRANSMITE DE VERDADE: só chame depois que o usuário aprovou a pré-visualização final (nfe_previsualizar) e confirmou a emissão; envie confirmacaoUsuario=true (conexões OAuth são recusadas sem ele).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"CalcularIBPT": {
"default": true,
"description": "Calcula o valor aproximado dos tributos (vTotTrib, tabela IBPT, Lei 12.741/2012). Padrão: verdadeiro.",
"type": "boolean"
},
"Cliente": {
"additionalProperties": false,
"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).",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"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.",
"type": "string"
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"default": 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",
"enum": [
1,
2,
9
],
"type": "integer"
},
"IsUf": {
"type": [
"string",
"null"
]
},
"NmCliente": {
"description": "Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55).",
"type": "string"
}
},
"required": [
"CpfCnpj",
"NmCliente"
],
"type": [
"object",
"null"
]
},
"Cobranca": {
"additionalProperties": false,
"properties": {
"Fatura": {
"additionalProperties": false,
"properties": {
"Desconto": {
"type": "number"
},
"Numero": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
},
"ValorLiquido": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"Parcelas": {
"items": {
"additionalProperties": false,
"properties": {
"Valor": {
"type": "number"
},
"Vencimento": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Codigo": {
"description": "B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.",
"type": [
"string",
"null"
]
},
"ConsumidorFinal": {
"description": "Indica operação com Consumidor final (NFCe de ser 1 Validar!)",
"type": "boolean"
},
"DataEmissao": {
"description": "Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)",
"type": [
"string",
"null"
]
},
"DataEntradaSaida": {
"description": "Data e Hora da saída ou de entrada da produto/serviço",
"type": [
"string",
"null"
]
},
"Entrega": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"EnviarEmail": {
"type": "boolean"
},
"Exporta": {
"additionalProperties": false,
"properties": {
"LocalDespacho": {
"description": "Descrição do local de despacho",
"type": [
"string",
"null"
]
},
"LocalEmbarqueTransp": {
"description": "Descrição do Local de Embarque ou de transposição de fronteira",
"type": [
"string",
"null"
]
},
"UFSaidaPais": {
"description": "Sigla da UF de Embarque ou de transposição de fronteira",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Finalidade": {
"default": 1,
"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",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"IndicadorPresenca": {
"default": 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.",
"enum": [
0,
1,
2,
3,
4,
5,
9
],
"type": "integer"
},
"Intermediador": {
"additionalProperties": false,
"description": "Dados do intermediador/marketplace (site ou plataforma de terceiros).",
"properties": {
"Cnpj": {
"description": "CNPJ do intermediador da transação (marketplace/plataforma de terceiros). Obrigatório.",
"type": "string"
},
"IdCadIntTran": {
"description": "Identificação do vendedor no site do intermediador (usuário/login cadastrado). Obrigatório.",
"type": "string"
}
},
"required": [
"Cnpj",
"IdCadIntTran"
],
"type": [
"object",
"null"
]
},
"Justificativa": {
"description": "Utilizar quando o tipo de emissão for diferente normal",
"type": [
"string",
"null"
]
},
"Lote": {
"description": "Lote da Nota Fiscal",
"type": [
"integer",
"null"
]
},
"ModeloDocumento": {
"default": 55,
"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)",
"enum": [
55,
65
],
"type": "integer"
},
"NFPagamentoAntecipado": {
"description": "Grupo de notas de antecipação de pagamento (gPagAntecipado - Reforma Tributária).",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"NFReferencia": {
"description": "Notas fiscal de Referência",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"NaturezaOperacao": {
"description": "Descrição da natureza da operação (máx 60 caracteres). Exemplos: \"Venda de mercadoria\", \"Remessa para industrialização\", \"Devolução de venda\".",
"type": "string"
},
"Numero": {
"description": "Número da nota fiscal",
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"ObservacaoFisco": {
"type": [
"string",
"null"
]
},
"Pagamentos": {
"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).",
"items": {
"additionalProperties": false,
"properties": {
"BandeiraOperadora": {
"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",
"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
],
"type": [
"string",
"null"
]
},
"CNPJCredenciadora": {
"type": [
"string",
"null"
]
},
"CNPJPagamento": {
"description": "CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (CNPJPag - NT 2023.004). Informar junto com UFPagamento (os dois ou nenhum). Opcional.",
"type": [
"string",
"null"
]
},
"CNPJRecebedor": {
"description": "CNPJ do beneficiário do pagamento (CNPJReceb - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"DataPagamento": {
"description": "Data do pagamento (dPag - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"Desconto": {
"type": "number"
},
"Descricao": {
"type": [
"string",
"null"
]
},
"FormaPagamento": {
"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",
"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
],
"type": [
"string",
"null"
]
},
"IdTerminalPagamento": {
"description": "Identificador do terminal de pagamento (idTermPag - NT 2023.004). Opcional, 1-40 caracteres.",
"type": [
"string",
"null"
]
},
"IndicadorPagamento": {
"description": "0 - A vista, 1 - Prazo",
"type": "integer"
},
"NumeroAutorizacao": {
"description": "Número de autorização da operação (cAut). Para PIX, informar o EndToEndId (e2eid) da transação.",
"type": [
"string",
"null"
]
},
"TipoIntegracao": {
"description": "Pagamento integrado com automação?",
"type": "boolean"
},
"UFPagamento": {
"description": "UF do estabelecimento onde o pagamento foi processado (UFPag - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"VlPago": {
"type": "number"
},
"VlTroco": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Produtos": {
"description": "Itens da nota fiscal. Mínimo 1 item.",
"items": {
"additionalProperties": false,
"properties": {
"Agropecuaria": {
"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.",
"properties": {
"Defensivos": {
"description": "Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico.",
"items": {
"additionalProperties": false,
"properties": {
"CpfResponsavelTecnico": {
"description": "CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável.",
"type": "string"
},
"NumeroReceituario": {
"description": "Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres).",
"type": "string"
}
},
"required": [
"NumeroReceituario",
"CpfResponsavelTecnico"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"GuiaTransito": {
"additionalProperties": false,
"description": "Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal.",
"properties": {
"NumeroGuia": {
"description": "Número da guia (1-9 dígitos).",
"type": "string"
},
"SerieGuia": {
"description": "Série da guia (1-9 dígitos). Opcional.",
"type": [
"string",
"null"
]
},
"TipoGuia": {
"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)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"UfGuia": {
"description": "Sigla da UF emissora da guia (2 caracteres).",
"type": "string"
}
},
"required": [
"TipoGuia",
"UfGuia",
"NumeroGuia"
],
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CEST": {
"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.",
"type": [
"string",
"null"
]
},
"CFOP": {
"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).",
"type": "integer"
},
"ChaveAcessoReferenciada": {
"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.",
"type": [
"string",
"null"
]
},
"CodProdutoServico": {
"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\".",
"type": "string"
},
"CodTributacao": {
"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.",
"type": [
"string",
"null"
]
},
"Combustivel": {
"additionalProperties": false,
"properties": {
"CodProdutoANP": {
"type": [
"string",
"null"
]
},
"DescricaoProdutoANP": {
"type": [
"string",
"null"
]
},
"UFConsumo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DeclaracaoImportacao": {
"additionalProperties": false,
"properties": {
"Cnpj": {
"description": "CNPJ do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"CodExportador": {
"description": "Código do Exportador",
"type": [
"string",
"null"
]
},
"CodFabricante": {
"description": "Código do Fabricante Extrangeiro",
"type": [
"string",
"null"
]
},
"DataDesenbaraco": {
"description": "Data do Desembaraço Aduaneiro",
"type": "string"
},
"DataRegistro": {
"description": "Data de Registro do documento de importação",
"type": "string"
},
"LocalDesenbaraco": {
"description": "Local de Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número do Documento de Importação (DI, DSI, DIRE, ...)",
"type": [
"string",
"null"
]
},
"TipoIntermedio": {
"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",
"enum": [
1,
2,
3
],
"type": "integer"
},
"TipoViaTransporte": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer"
},
"Uf": {
"description": "Sigla da UF do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"UfDesenbaraco": {
"description": "Sigla da UF onde ocorreu o Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"ValorAFRMM": {
"description": "Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"EAN": {
"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.",
"type": [
"string",
"null"
]
},
"Imposto": {
"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.",
"properties": {
"COFINS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do COFINS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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.",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IBSCBS": {
"additionalProperties": false,
"properties": {
"AliquotaCBS": {
"description": "Alíquota da CBS",
"type": [
"number",
"null"
]
},
"AliquotaIBSMun": {
"description": "Alíquota do IBS de competência do Município",
"type": [
"number",
"null"
]
},
"AliquotaIBSUF": {
"description": "Alíquota do IBS de competência das UF",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo",
"type": [
"number",
"null"
]
},
"CodClassificacaoTributaria": {
"description": "Código de Classificação Tributária (Padrão 000001)",
"type": [
"string",
"null"
]
},
"PercentualDiferimento": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoCBS": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoIBS": {
"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).",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ICMS": {
"additionalProperties": false,
"properties": {
"AliquotaAdRemRetido": {
"description": "adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente).",
"type": [
"number",
"null"
]
},
"AliquotaCredito": {
"description": "Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMS": {
"description": "Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMSST": {
"description": "Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaMVA": {
"description": "Alíquota - Obrigatório para situação tributária nº 201, 202 e 203",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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\".",
"type": "string"
},
"QuantidadeMonoRetido": {
"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.",
"type": [
"number",
"null"
]
},
"RedICMS": {
"description": "Redução ICMS",
"type": [
"number",
"null"
]
},
"RedICMSST": {
"description": "Redução ICMS ST",
"type": [
"number",
"null"
]
},
"STRetido": {
"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.",
"properties": {
"AliquotaConsumidorFinal": {
"description": "pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP).",
"type": [
"number",
"null"
]
},
"AliquotaEfetiva": {
"description": "pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100.",
"type": [
"number",
"null"
]
},
"AliquotaFCP": {
"description": "pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100.",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior.",
"type": [
"number",
"null"
]
},
"BaseCalculoEfetiva": {
"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.",
"type": [
"number",
"null"
]
},
"BaseCalculoFCP": {
"description": "vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior.",
"type": [
"number",
"null"
]
},
"PercentualReducaoBaseEfetiva": {
"description": "pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final).",
"type": [
"number",
"null"
]
},
"ValorICMSST": {
"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.",
"type": [
"number",
"null"
]
},
"ValorICMSSubstituto": {
"description": "vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorIcms": {
"description": "Valor do Icms (Calculado Automaticamente quando não informado)",
"type": [
"number",
"null"
]
},
"ValorIcmsMonoRetido": {
"description": "vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido.",
"type": [
"number",
"null"
]
},
"aliquotaDiferimento": {
"description": "Percentual de diferimento (Utilizado somente no CST 51)",
"type": [
"number",
"null"
]
},
"modalidadeBcIcms": {
"description": "0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"motivoDesoneracaoIcms": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
16,
null
],
"type": [
"integer",
"null"
]
},
"valorDesoneracaoIcms": {
"type": [
"number",
"null"
]
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IPI": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do IPI",
"type": "number"
},
"CodEnquadramento": {
"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).",
"type": "string"
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
},
"PercentualMercadoriaDevolvida": {
"description": "Percentual da mercadoria devolvida",
"type": "number"
},
"ValorIpiDevolvido": {
"description": "Valor do IPI devolvido",
"type": "number"
}
},
"required": [
"CodEnquadramento",
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"Importacao": {
"additionalProperties": false,
"properties": {
"BaseCalculo": {
"type": "number"
},
"DespesasAduaneiras": {
"type": "number"
},
"Valor": {
"type": "number"
},
"ValorIOF": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"PIS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do PIS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"InformacaoAdicional": {
"description": "Informaçoes adicional",
"type": [
"string",
"null"
]
},
"NCM": {
"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\".",
"type": "string"
},
"NItemPed": {
"description": "Número do item do Pedido de Compra",
"type": [
"integer",
"null"
]
},
"NItemReferenciado": {
"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.",
"type": [
"integer",
"null"
]
},
"NmProduto": {
"description": "Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\".",
"type": "string"
},
"OrigemProduto": {
"default": 0,
"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%",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer"
},
"Quantidade": {
"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).",
"type": "number"
},
"QuantidadeTributavel": {
"description": "Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros.",
"type": [
"number",
"null"
]
},
"Rastros": {
"description": "Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas.",
"items": {
"additionalProperties": false,
"properties": {
"CodigoAgregacao": {
"description": "Código de agregação (opcional)",
"type": [
"string",
"null"
]
},
"DataFabricacao": {
"description": "Data de fabricação/produção",
"type": "string"
},
"DataValidade": {
"description": "Data de validade",
"type": "string"
},
"NumeroLote": {
"description": "Número do lote do produto (1-20 caracteres)",
"type": [
"string",
"null"
]
},
"QuantidadeLote": {
"description": "Quantidade de produto no lote",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UnidadeComercial": {
"description": "Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\".",
"type": "string"
},
"UnidadeComercialTributavel": {
"description": "Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial.",
"type": [
"string",
"null"
]
},
"ValorDesconto": {
"description": "Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal).",
"type": "number"
},
"ValorFrete": {
"description": "Valor Frete",
"type": [
"number",
"null"
]
},
"ValorOutrasDespesas": {
"description": "Valor Outras Despesas",
"type": [
"number",
"null"
]
},
"ValorSeguro": {
"description": "Valor Seguro",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"description": "Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0.",
"type": "number"
},
"ValorUnitario": {
"description": "Valor unitário do produto (>= 0). Aceita até 10 casas decimais.",
"type": "number"
},
"ValorUnitarioTributavel": {
"description": "Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario.",
"type": [
"number",
"null"
]
},
"cBenef": {
"description": "Código de Beneficio Fiscal na UF",
"type": [
"string",
"null"
]
},
"nFCI": {
"description": "Número de controle da FCI - Ficha de Conteúdo de Importação",
"type": [
"string",
"null"
]
},
"xPed": {
"description": "Número do Pedido de Compra",
"type": [
"string",
"null"
]
}
},
"required": [
"NmProduto",
"CodProdutoServico",
"NCM",
"Quantidade",
"UnidadeComercial",
"ValorUnitario",
"ValorTotal",
"CFOP",
"OrigemProduto",
"Imposto"
],
"type": "object"
},
"type": "array"
},
"Retencoes": {
"additionalProperties": false,
"description": "Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML.",
"properties": {
"BaseCalculoIRRF": {
"description": "Base de cálculo do IRRF",
"type": [
"number",
"null"
]
},
"BaseCalculoRetencaoPrevidencia": {
"description": "Base de cálculo da retenção da Previdência Social",
"type": [
"number",
"null"
]
},
"ValorIRRF": {
"description": "Valor retido do IRRF",
"type": [
"number",
"null"
]
},
"ValorRetencaoPrevidencia": {
"description": "Valor da retenção da Previdência Social",
"type": [
"number",
"null"
]
},
"ValorRetidoCOFINS": {
"description": "Valor retido de COFINS",
"type": [
"number",
"null"
]
},
"ValorRetidoCSLL": {
"description": "Valor retido de CSLL",
"type": [
"number",
"null"
]
},
"ValorRetidoPIS": {
"description": "Valor retido de PIS",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Serie": {
"description": "Série da nota Fiscal",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"default": 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)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoDanfe": {
"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.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"TpNFCredito": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"TpNFDebito": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": [
"integer",
"null"
]
},
"Transporte": {
"additionalProperties": false,
"properties": {
"Balsa": {
"type": [
"string",
"null"
]
},
"CNPJ": {
"type": [
"string",
"null"
]
},
"DsEndereco": {
"type": [
"string",
"null"
]
},
"IE": {
"type": [
"string",
"null"
]
},
"ModalidadeFrete": {
"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",
"enum": [
0,
1,
2,
3,
4,
9
],
"type": "integer"
},
"NmMunicipio": {
"type": [
"string",
"null"
]
},
"NmTransportador": {
"type": [
"string",
"null"
]
},
"Reboque": {
"items": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"Vagao": {
"type": [
"string",
"null"
]
},
"Veiculo": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Volumes": {
"items": {
"additionalProperties": false,
"properties": {
"Especie": {
"type": [
"string",
"null"
]
},
"Lacres": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Marca": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"PesoBruto": {
"type": "number"
},
"PesoLiquido": {
"type": "number"
},
"QuantidadeVolume": {
"type": "integer"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorDesconto": {
"description": "Valor total do desconto da nota. Quando informado, é distribuído proporcionalmente entre os itens (proporção pelo ValorTotal de cada item), SUBSTITUINDO o ValorDesconto informado em cada produto. Não informado (nulo) = o desconto de cada item é usado como enviado.",
"type": [
"number",
"null"
]
},
"ValorFrete": {
"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.",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"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.",
"type": [
"number",
"null"
]
},
"confirmacaoUsuario": {
"description": "Envie true SOMENTE depois que o usuário viu a pré-visualização final e confirmou explicitamente a emissão nesta conversa. Obrigatório em conexões OAuth.",
"type": "boolean"
}
},
"required": [
"IndicadorPresenca",
"NaturezaOperacao",
"ModeloDocumento",
"Finalidade",
"TipoAmbiente",
"Produtos"
],
"type": "object"
},
"name": "nfe_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"type": [
"string",
"null"
]
},
"Base64Xml": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"ReturnNF": {
"additionalProperties": false,
"properties": {
"ChaveNF": {
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"CodTipoAmbiente": {
"type": "integer"
},
"Detalhes": {
"additionalProperties": false,
"properties": {
"valorCofins": {
"type": "number"
},
"valorIcms": {
"type": "number"
},
"valorIpi": {
"type": "number"
},
"valorNf": {
"type": "number"
},
"valorPis": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"DsStatusRespostaSefaz": {
"type": [
"string",
"null"
]
},
"DsTipoAmbiente": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": "integer"
},
"NumeroProtocolo": {
"type": [
"string",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Serie": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"CFOP": {
"description": "CFOP",
"type": "integer"
},
"Cliente": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"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.",
"type": "string"
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"default": 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",
"enum": [
1,
2,
9
],
"type": "integer"
},
"IsUf": {
"type": [
"string",
"null"
]
},
"NmCliente": {
"description": "Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55).",
"type": "string"
}
},
"required": [
"CpfCnpj",
"NmCliente"
],
"type": [
"object",
"null"
]
},
"Cobranca": {
"additionalProperties": false,
"properties": {
"Fatura": {
"additionalProperties": false,
"properties": {
"Desconto": {
"type": "number"
},
"Numero": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
},
"ValorLiquido": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"Parcelas": {
"items": {
"additionalProperties": false,
"properties": {
"Valor": {
"type": "number"
},
"Vencimento": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Codigo": {
"description": "Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.",
"type": [
"string",
"null"
]
},
"ImpostoComplementar": {
"additionalProperties": false,
"properties": {
"AliquotaICMS": {
"description": "Alíquota ICMS",
"type": "number"
},
"AliquotaICMSST": {
"description": "Alíquota ICMSST",
"type": "number"
},
"BaseCalculoICMS": {
"description": "Base de cálculo do ICMS complementar",
"type": "number"
},
"BaseCalculoICMSST": {
"description": "Base de cálculo do ICMSST complementar",
"type": "number"
},
"BaseCalculoIPI": {
"description": "Base de cálculo do IPI",
"type": "number"
},
"CodSituacaoTributaria": {
"description": "Código da Situação Tributária (CST)",
"type": [
"string",
"null"
]
},
"ValorICMS": {
"description": "Valor do complemento do ICMS",
"type": "number"
},
"ValorICMSST": {
"description": "Valor do complemento do ICMSST",
"type": "number"
},
"ValorIPI": {
"description": "Valor do complemento do IPI",
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"Lote": {
"description": "Lote da Nota Fiscal",
"type": [
"integer",
"null"
]
},
"NFReferencia": {
"description": "Notas fiscal de Referência",
"type": [
"string",
"null"
]
},
"NaturezaOperacao": {
"description": "Descrição da Natureza da Operação",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número da nota fiscal",
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"ObservacaoFisco": {
"type": [
"string",
"null"
]
},
"Produtos": {
"items": {
"additionalProperties": false,
"properties": {
"Agropecuaria": {
"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.",
"properties": {
"Defensivos": {
"description": "Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico.",
"items": {
"additionalProperties": false,
"properties": {
"CpfResponsavelTecnico": {
"description": "CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável.",
"type": "string"
},
"NumeroReceituario": {
"description": "Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres).",
"type": "string"
}
},
"required": [
"NumeroReceituario",
"CpfResponsavelTecnico"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"GuiaTransito": {
"additionalProperties": false,
"description": "Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal.",
"properties": {
"NumeroGuia": {
"description": "Número da guia (1-9 dígitos).",
"type": "string"
},
"SerieGuia": {
"description": "Série da guia (1-9 dígitos). Opcional.",
"type": [
"string",
"null"
]
},
"TipoGuia": {
"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)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"UfGuia": {
"description": "Sigla da UF emissora da guia (2 caracteres).",
"type": "string"
}
},
"required": [
"TipoGuia",
"UfGuia",
"NumeroGuia"
],
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CEST": {
"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.",
"type": [
"string",
"null"
]
},
"CFOP": {
"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).",
"type": "integer"
},
"ChaveAcessoReferenciada": {
"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.",
"type": [
"string",
"null"
]
},
"CodProdutoServico": {
"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\".",
"type": "string"
},
"CodTributacao": {
"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.",
"type": [
"string",
"null"
]
},
"Combustivel": {
"additionalProperties": false,
"properties": {
"CodProdutoANP": {
"type": [
"string",
"null"
]
},
"DescricaoProdutoANP": {
"type": [
"string",
"null"
]
},
"UFConsumo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DeclaracaoImportacao": {
"additionalProperties": false,
"properties": {
"Cnpj": {
"description": "CNPJ do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"CodExportador": {
"description": "Código do Exportador",
"type": [
"string",
"null"
]
},
"CodFabricante": {
"description": "Código do Fabricante Extrangeiro",
"type": [
"string",
"null"
]
},
"DataDesenbaraco": {
"description": "Data do Desembaraço Aduaneiro",
"type": "string"
},
"DataRegistro": {
"description": "Data de Registro do documento de importação",
"type": "string"
},
"LocalDesenbaraco": {
"description": "Local de Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número do Documento de Importação (DI, DSI, DIRE, ...)",
"type": [
"string",
"null"
]
},
"TipoIntermedio": {
"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",
"enum": [
1,
2,
3
],
"type": "integer"
},
"TipoViaTransporte": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer"
},
"Uf": {
"description": "Sigla da UF do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"UfDesenbaraco": {
"description": "Sigla da UF onde ocorreu o Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"ValorAFRMM": {
"description": "Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"EAN": {
"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.",
"type": [
"string",
"null"
]
},
"Imposto": {
"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.",
"properties": {
"COFINS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do COFINS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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.",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IBSCBS": {
"additionalProperties": false,
"properties": {
"AliquotaCBS": {
"description": "Alíquota da CBS",
"type": [
"number",
"null"
]
},
"AliquotaIBSMun": {
"description": "Alíquota do IBS de competência do Município",
"type": [
"number",
"null"
]
},
"AliquotaIBSUF": {
"description": "Alíquota do IBS de competência das UF",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo",
"type": [
"number",
"null"
]
},
"CodClassificacaoTributaria": {
"description": "Código de Classificação Tributária (Padrão 000001)",
"type": [
"string",
"null"
]
},
"PercentualDiferimento": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoCBS": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoIBS": {
"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).",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ICMS": {
"additionalProperties": false,
"properties": {
"AliquotaAdRemRetido": {
"description": "adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente).",
"type": [
"number",
"null"
]
},
"AliquotaCredito": {
"description": "Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMS": {
"description": "Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMSST": {
"description": "Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaMVA": {
"description": "Alíquota - Obrigatório para situação tributária nº 201, 202 e 203",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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\".",
"type": "string"
},
"QuantidadeMonoRetido": {
"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.",
"type": [
"number",
"null"
]
},
"RedICMS": {
"description": "Redução ICMS",
"type": [
"number",
"null"
]
},
"RedICMSST": {
"description": "Redução ICMS ST",
"type": [
"number",
"null"
]
},
"STRetido": {
"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.",
"properties": {
"AliquotaConsumidorFinal": {
"description": "pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP).",
"type": [
"number",
"null"
]
},
"AliquotaEfetiva": {
"description": "pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100.",
"type": [
"number",
"null"
]
},
"AliquotaFCP": {
"description": "pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100.",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior.",
"type": [
"number",
"null"
]
},
"BaseCalculoEfetiva": {
"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.",
"type": [
"number",
"null"
]
},
"BaseCalculoFCP": {
"description": "vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior.",
"type": [
"number",
"null"
]
},
"PercentualReducaoBaseEfetiva": {
"description": "pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final).",
"type": [
"number",
"null"
]
},
"ValorICMSST": {
"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.",
"type": [
"number",
"null"
]
},
"ValorICMSSubstituto": {
"description": "vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorIcms": {
"description": "Valor do Icms (Calculado Automaticamente quando não informado)",
"type": [
"number",
"null"
]
},
"ValorIcmsMonoRetido": {
"description": "vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido.",
"type": [
"number",
"null"
]
},
"aliquotaDiferimento": {
"description": "Percentual de diferimento (Utilizado somente no CST 51)",
"type": [
"number",
"null"
]
},
"modalidadeBcIcms": {
"description": "0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"motivoDesoneracaoIcms": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
16,
null
],
"type": [
"integer",
"null"
]
},
"valorDesoneracaoIcms": {
"type": [
"number",
"null"
]
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IPI": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do IPI",
"type": "number"
},
"CodEnquadramento": {
"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).",
"type": "string"
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
},
"PercentualMercadoriaDevolvida": {
"description": "Percentual da mercadoria devolvida",
"type": "number"
},
"ValorIpiDevolvido": {
"description": "Valor do IPI devolvido",
"type": "number"
}
},
"required": [
"CodEnquadramento",
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"Importacao": {
"additionalProperties": false,
"properties": {
"BaseCalculo": {
"type": "number"
},
"DespesasAduaneiras": {
"type": "number"
},
"Valor": {
"type": "number"
},
"ValorIOF": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"PIS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do PIS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"InformacaoAdicional": {
"description": "Informaçoes adicional",
"type": [
"string",
"null"
]
},
"NCM": {
"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\".",
"type": "string"
},
"NItemPed": {
"description": "Número do item do Pedido de Compra",
"type": [
"integer",
"null"
]
},
"NItemReferenciado": {
"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.",
"type": [
"integer",
"null"
]
},
"NmProduto": {
"description": "Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\".",
"type": "string"
},
"OrigemProduto": {
"default": 0,
"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%",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer"
},
"Quantidade": {
"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).",
"type": "number"
},
"QuantidadeTributavel": {
"description": "Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros.",
"type": [
"number",
"null"
]
},
"Rastros": {
"description": "Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas.",
"items": {
"additionalProperties": false,
"properties": {
"CodigoAgregacao": {
"description": "Código de agregação (opcional)",
"type": [
"string",
"null"
]
},
"DataFabricacao": {
"description": "Data de fabricação/produção",
"type": "string"
},
"DataValidade": {
"description": "Data de validade",
"type": "string"
},
"NumeroLote": {
"description": "Número do lote do produto (1-20 caracteres)",
"type": [
"string",
"null"
]
},
"QuantidadeLote": {
"description": "Quantidade de produto no lote",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UnidadeComercial": {
"description": "Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\".",
"type": "string"
},
"UnidadeComercialTributavel": {
"description": "Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial.",
"type": [
"string",
"null"
]
},
"ValorDesconto": {
"description": "Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal).",
"type": "number"
},
"ValorFrete": {
"description": "Valor Frete",
"type": [
"number",
"null"
]
},
"ValorOutrasDespesas": {
"description": "Valor Outras Despesas",
"type": [
"number",
"null"
]
},
"ValorSeguro": {
"description": "Valor Seguro",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"description": "Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0.",
"type": "number"
},
"ValorUnitario": {
"description": "Valor unitário do produto (>= 0). Aceita até 10 casas decimais.",
"type": "number"
},
"ValorUnitarioTributavel": {
"description": "Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario.",
"type": [
"number",
"null"
]
},
"cBenef": {
"description": "Código de Beneficio Fiscal na UF",
"type": [
"string",
"null"
]
},
"nFCI": {
"description": "Número de controle da FCI - Ficha de Conteúdo de Importação",
"type": [
"string",
"null"
]
},
"xPed": {
"description": "Número do Pedido de Compra",
"type": [
"string",
"null"
]
}
},
"required": [
"NmProduto",
"CodProdutoServico",
"NCM",
"Quantidade",
"UnidadeComercial",
"ValorUnitario",
"ValorTotal",
"CFOP",
"OrigemProduto",
"Imposto"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"Serie": {
"description": "Série da nota Fiscal",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"description": "Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"TipoComplemento": {
"default": 1,
"description": "Tipo de complemento Valores: 0 - Complementar quantidade ou valor; 1 - Complementar impostos",
"enum": [
0,
1
],
"type": "integer"
},
"Transporte": {
"additionalProperties": false,
"properties": {
"Balsa": {
"type": [
"string",
"null"
]
},
"CNPJ": {
"type": [
"string",
"null"
]
},
"DsEndereco": {
"type": [
"string",
"null"
]
},
"IE": {
"type": [
"string",
"null"
]
},
"ModalidadeFrete": {
"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",
"enum": [
0,
1,
2,
3,
4,
9
],
"type": "integer"
},
"NmMunicipio": {
"type": [
"string",
"null"
]
},
"NmTransportador": {
"type": [
"string",
"null"
]
},
"Reboque": {
"items": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"Vagao": {
"type": [
"string",
"null"
]
},
"Veiculo": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Volumes": {
"items": {
"additionalProperties": false,
"properties": {
"Especie": {
"type": [
"string",
"null"
]
},
"Lacres": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Marca": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"PesoBruto": {
"type": "number"
},
"PesoLiquido": {
"type": "number"
},
"QuantidadeVolume": {
"type": "integer"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"name": "nfe_emitir_complementar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"type": [
"string",
"null"
]
},
"Base64Xml": {
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"ReturnNF": {
"additionalProperties": false,
"properties": {
"ChaveNF": {
"type": [
"string",
"null"
]
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"CodTipoAmbiente": {
"type": "integer"
},
"Detalhes": {
"additionalProperties": false,
"properties": {
"valorCofins": {
"type": "number"
},
"valorIcms": {
"type": "number"
},
"valorIpi": {
"type": "number"
},
"valorNf": {
"type": "number"
},
"valorPis": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"DsStatusRespostaSefaz": {
"type": [
"string",
"null"
]
},
"DsTipoAmbiente": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": "integer"
},
"NumeroProtocolo": {
"type": [
"string",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Serie": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"description": "Gera o DANFE em PDF e o XML como pré-visualização, sem enviar para a SEFAZ. Envie a nota completa em 'notaFiscal' (mesmo formato de nfe_emitir) com TipoEnvio=1 e TipoArquivo=2 (PDF + XML juntos). O resultado abre num painel ao lado da conversa: chame de novo a cada alteração pedida pelo usuário (CFOP, itens, destinatário, valores) para o painel refletir a nota atual. Erros de validação voltam em 'Error'/'Avisos'.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Base64Xml": {
"type": [
"string",
"null"
]
},
"TipoArquivo": {
"description": "Tipo do arquivo que deseja pré-visualizar (Padrão - 0) Valores: 0 - XML; 1 - PDF; 2 - PDF em Base64File e XML em Base64Xml na mesma chamada",
"enum": [
0,
1,
2
],
"type": "integer"
},
"TipoEnvio": {
"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",
"enum": [
0,
1
],
"type": "integer"
},
"cte": {
"additionalProperties": false,
"description": "CT-e (modelo 57/67). Usado quando TipoEnvio = 1. Gera o DACTE/XML de pré-visualização.",
"properties": {
"Carga": {
"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.",
"properties": {
"Detalhes": {
"description": "Detalhes das quantidades da carga. (infQ)",
"items": {
"additionalProperties": false,
"properties": {
"CodUnidadeMedida": {
"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)",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"Quantidade": {
"description": "Quantidade da Carga (qCarga). Ex: 10000",
"type": "number"
},
"TipoMedida": {
"description": "Tipo de Medida. (tpMed). Ex: \"quilos gramas\"",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Documentos": {
"description": "Documentos fiscais que acompanham a carga. (infNFe)",
"items": {
"additionalProperties": false,
"properties": {
"Chave": {
"type": [
"string",
"null"
]
},
"PIN": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"OutrosDocumentos": {
"description": "Outros documentos que acompanham a carga quando não há NF-e (ex.: declaração de mudança, C2C). (infOutros)",
"items": {
"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.",
"properties": {
"Descricao": {
"description": "Descrição do documento. Obrigatória quando TipoDocumento = 99. (descOutros)",
"type": [
"string",
"null"
]
},
"DtEmissao": {
"description": "Data de emissão do documento. (dEmi)",
"type": [
"string",
"null"
]
},
"DtPrevisao": {
"description": "Data prevista de entrega. (dPrev)",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número do documento. (nDoc)",
"type": [
"string",
"null"
]
},
"TipoDocumento": {
"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)",
"enum": [
0,
10,
59,
65,
99
],
"type": "integer"
},
"Valor": {
"description": "Valor do documento fiscal. (vDocFisc)",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"ProdutoPredominante": {
"description": "Nome do Produto Predominante. (proPred)",
"type": [
"string",
"null"
]
},
"ValorTotal": {
"description": "Valor total da carga. (vCarga)",
"type": "number"
}
},
"type": "object"
},
"Cfop": {
"description": "CFOP de 4 dígitos. Primeiro dígito: 1/2/3 = entrada, 5/6/7 = saída.",
"type": "integer"
},
"Codigo": {
"type": [
"integer",
"null"
]
},
"Destinatario": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DtEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"Expedidor": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"Imposto": {
"additionalProperties": false,
"properties": {
"Difal": {
"additionalProperties": false,
"description": "Informações sobre o ICMS Partilha (DIFAL/ICMS UF Fim).",
"properties": {
"AliquotaICMSUfDestino": {
"description": "Alíquota interna da UF de destino para o ICMS. (pICMSUFFim)",
"type": "number"
},
"AliquotaInterestadual": {
"description": "Alíquota interestadual das UF envolvidas. (pICMSInter)",
"type": "number"
},
"BaseCalculoUfDestino": {
"description": "Base de Cálculo do ICMS na UF de Destino. (vBCUFFim)",
"type": "number"
},
"PercentualFCPUfDestino": {
"description": "Percentual do Fundo de Combate à Pobreza (FCP) na UF de destino. (pFCPUFFim)",
"type": "number"
},
"PercentualPartilhaICMS": {
"description": "Percentual de Partilha do ICMS (Ex: 80, 20, 0, etc.). (pICMSInterPart)",
"type": "number"
},
"ValorFCPUfDestino": {
"description": "Valor do Fundo de Combate à Pobreza (FCP) na UF de destino. (vFCPUFFim)",
"type": "number"
},
"ValorICMSUfDestino": {
"description": "Valor total do ICMS devido à UF de destino (já com o FCP). (vICMSUFFim)",
"type": "number"
},
"ValorICMSUfInicio": {
"description": "Valor do ICMS devido à UF de origem (Início). (vICMSUFIni)",
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"IBSCBS": {
"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.",
"properties": {
"AliquotaCBS": {
"description": "Alíquota da CBS (pCBS).",
"type": [
"number",
"null"
]
},
"AliquotaIBSMun": {
"description": "Alíquota do IBS de competência do Município (pIBSMun).",
"type": [
"number",
"null"
]
},
"AliquotaIBSUF": {
"description": "Alíquota do IBS de competência das UF (pIBSUF).",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo do IBS/CBS (vBC). Quando null, usa o valor total da prestação.",
"type": [
"number",
"null"
]
},
"CodClassificacaoTributaria": {
"description": "Código de Classificação Tributária do IBS/CBS (cClassTrib). O CST é derivado dos 3 primeiros dígitos. Quando vazio, assume \"000001\".",
"type": [
"string",
"null"
]
},
"PercentualDiferimento": {
"description": "Percentual de diferimento (pDif de gDif), usado nos CST 510/515.",
"type": [
"number",
"null"
]
},
"PercentualReducaoCBS": {
"description": "Percentual de redução da alíquota da CBS (pRedAliq de gRed). Pode divergir de PercentualReducaoIBS.",
"type": [
"number",
"null"
]
},
"PercentualReducaoIBS": {
"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.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ICMS": {
"additionalProperties": false,
"description": "Informações do ICMS",
"properties": {
"Aliquota": {
"description": "Alíquota do ICMS (em percentual). (pICMS)",
"type": "number"
},
"AliquotaOutraUF": {
"description": "Alíquota do ICMS devido a Outra UF. (pICMSOutraUF) Usado no CST OutraUF.",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de Cálculo do ICMS. (vBC)",
"type": "number"
},
"CST": {
"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.",
"type": [
"string",
"null"
]
},
"PercentualReducaoBaseCalculo": {
"description": "Percentual de Redução da Base de Cálculo. (pRedBC) Usado nos CSTs 20 e 90.",
"type": [
"number",
"null"
]
},
"Valor": {
"description": "Valor do ICMS. (vICMS)",
"type": "number"
},
"ValorICMSOutraUF": {
"description": "Valor do ICMS devido a Outra UF. (vICMSOutraUF) Usado no CST OutraUF.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"InformacoesAdicionaisFisco": {
"description": "Informações Adicionais de Interesse do Fisco.",
"type": [
"string",
"null"
]
},
"TributosFederal": {
"additionalProperties": false,
"description": "Lista de PIS e COFINS (Tributos Federais).",
"properties": {
"ValorCofins": {
"description": "Valor do COFINS retido. (vCOFINS)",
"type": [
"number",
"null"
]
},
"ValorCsll": {
"description": "Valor da CSLL retida. (vCSLL)",
"type": [
"number",
"null"
]
},
"ValorInss": {
"description": "Valor do INSS retido. (vINSS)",
"type": [
"number",
"null"
]
},
"ValorIr": {
"description": "Valor do Imposto de Renda retido. (vIR)",
"type": [
"number",
"null"
]
},
"ValorPis": {
"description": "Valor do PIS retido. (vPIS)",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorTotalTributos": {
"description": "Valor total dos tributos federais e estaduais, aproximado conforme Lei 12.741/12.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Lote": {
"type": [
"integer",
"null"
]
},
"Modal": {
"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.",
"properties": {
"Rodoviario": {
"additionalProperties": false,
"properties": {
"OCCs": {
"description": "Lista de coletas realizadas para compor o frete.",
"items": {
"additionalProperties": false,
"properties": {
"DtEmissaoColeta": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"Emissor": {
"additionalProperties": false,
"properties": {
"Cnpj": {
"description": "CNPJ do emissor da OCC",
"type": [
"string",
"null"
]
},
"CodigoInternoOCC": {
"description": "Código interno da OCC na empresa emissora",
"type": [
"string",
"null"
]
},
"Ie": {
"description": "Inscrição estadual do emissor",
"type": [
"string",
"null"
]
},
"Telefone": {
"description": "Telefone do emissor da OCC",
"type": [
"string",
"null"
]
},
"Uf": {
"description": "Estado do emissor da OCC",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Numero": {
"type": "integer"
},
"Serie": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Tipo": {
"default": 1,
"description": "Modal do CT-e: Valores: 1 - Rodoviário; 2 - Aéreo; 3 - Aquaviário; 4 - Ferroviário; 5 - Dutoviário; 6 - Multimodal",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
},
"type": "object"
},
"ModeloDocumento": {
"default": 57,
"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)",
"enum": [
57,
67
],
"type": "integer"
},
"NaturezaOperacao": {
"description": "Descrição da natureza da operação (ex: \"Prestação de serviço de transporte\").",
"type": "string"
},
"Numero": {
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Remetente": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Retira": {
"type": "boolean"
},
"Serie": {
"type": [
"integer",
"null"
]
},
"Servico": {
"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.",
"properties": {
"CodMunicipioFim": {
"description": "Código IBGE do município do destino o transporte",
"type": "integer"
},
"CodMunicipioInicio": {
"description": "Código IBGE do município do início do transporte",
"type": "integer"
},
"Componentes": {
"description": "Lista de componentes que detalham como o valor total do frete foi formado.",
"items": {
"additionalProperties": false,
"properties": {
"Nome": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"MunicipioFim": {
"description": "Nome do município do destino do transporte",
"type": [
"string",
"null"
]
},
"MunicipioInicio": {
"description": "Nome do município do início do transporte",
"type": [
"string",
"null"
]
},
"Tipo": {
"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",
"enum": [
0,
1,
2,
3,
4,
6,
7,
8
],
"type": "integer"
},
"ValorPrestacao": {
"description": "O valor total cobrado pela prestação do serviço de transporte.",
"type": "number"
},
"ValorReceber": {
"description": "O valor líquido a receber pelo transportador.",
"type": "number"
}
},
"type": "object"
},
"TipoAmbiente": {
"description": "Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão real, irreversível); 2 - Homologação (teste, sem valor fiscal)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoCte": {
"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",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"Tomador": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"description": "Indicador de IE: Valores: 1 - Contribuinte do ICMS; 2 - Contribuinte isento de inscrição; 9 - Não contribuinte",
"enum": [
1,
2,
9
],
"type": "integer"
},
"Nome": {
"type": [
"string",
"null"
]
},
"NomeFantasia": {
"type": [
"string",
"null"
]
},
"TipoTomador": {
"description": "Tipo do participante do CT-e: Valores: 0 - Remetente; 1 - Expedidor; 2 - Recebedor; 3 - Destinatário; 4 - Outros (Informar dados Tomador)",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"ModeloDocumento",
"TipoAmbiente",
"TipoCte",
"Cfop",
"NaturezaOperacao",
"Modal",
"Carga",
"Servico"
],
"type": [
"object",
"null"
]
},
"dce": {
"additionalProperties": false,
"description": "DC-e (modelo 99). Usado quando TipoEnvio = 1. Gera o DACE/XML de pré-visualização.",
"properties": {
"CnpjTransportadora": {
"description": "CNPJ da transportadora que leva a carga. Opcional. Quando informado, é usado no XML; quando vazio, mantém o CNPJ da empresa emissora.",
"type": [
"string",
"null"
]
},
"Codigo": {
"type": [
"integer",
"null"
]
},
"DeclaracaoContribuinteICMS": {
"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.\"",
"type": "string"
},
"DeclaracaoCrimeTributario": {
"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.\"",
"type": "string"
},
"Destinatario": {
"additionalProperties": false,
"description": "Destinatário do pacote. OBRIGATÓRIO. Exige Endereco completo.",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "CPF ou CNPJ",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Nome": {
"description": "Nome ou Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"InformacoesAdicionaisFisco": {
"description": "Informações adicionais de interesse do fisco (opcional, até 2000 caracteres).",
"type": [
"string",
"null"
]
},
"InformacoesComplementares": {
"description": "Informações complementares (opcional, até 5000 caracteres).",
"type": [
"string",
"null"
]
},
"Itens": {
"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).",
"items": {
"additionalProperties": false,
"properties": {
"Descricao": {
"description": "Descrição do produto/conteúdo (1-120 caracteres). Obrigatória.",
"type": "string"
},
"InformacoesAdicionais": {
"description": "Informações adicionais do produto (opcional, até 500 caracteres)",
"type": [
"string",
"null"
]
},
"NCM": {
"description": "Código NCM. Quando informado deve ter 2 ou 8 dígitos. Opcional na DC-e.",
"type": [
"string",
"null"
]
},
"Quantidade": {
"description": "Quantidade do item.",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"description": "Valor total do item. Deve ser > 0.",
"type": "number"
},
"ValorUnitario": {
"description": "Valor unitário do item.",
"type": [
"number",
"null"
]
}
},
"required": [
"Descricao",
"ValorTotal"
],
"type": "object"
},
"type": "array"
},
"Lote": {
"type": [
"integer",
"null"
]
},
"ModalidadeTransporte": {
"default": 2,
"description": "Modalidade de transporte: Valores: 0 - Correios; 1 - Conta própria; 2 - Transportadora",
"enum": [
0,
1,
2
],
"type": "integer"
},
"Numero": {
"type": [
"integer",
"null"
]
},
"Remetente": {
"additionalProperties": false,
"description": "Pessoa física/jurídica que está enviando o pacote. OBRIGATÓRIO. Exige Endereco completo (validado por ValidaPessoaDCe).",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "CPF ou CNPJ",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Nome": {
"description": "Nome ou Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"Serie": {
"type": [
"integer",
"null"
]
},
"SiteMarketplace": {
"description": "URL do site do marketplace (obrigatório quando TipoEmitente=1)",
"type": [
"string",
"null"
]
},
"TipoAmbiente": {
"description": "Tipo de ambiente. Valores: 1 - Produção (emissão real); 2 - Homologação (teste)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoEmitente": {
"default": 3,
"description": "Tipo do emitente: Valores: 0 - App Fisco; 1 - Marketplace; 2 - Emissor próprio; 3 - Transportadora; 4 - ECT (Correios)",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"UfFisco": {
"description": "Sigla da UF do órgão fiscalizador (obrigatório quando TipoEmitente=0). Se não preenchido, usa a UF da empresa emissora.",
"type": [
"string",
"null"
]
},
"ValorTotal": {
"description": "Valor total declarado da DC-e. Se omitido, soma dos ValorTotal dos itens. Deve ser > 0.",
"type": [
"number",
"null"
]
},
"XOrgaoFisco": {
"description": "Nome do órgão fiscalizador (obrigatório quando TipoEmitente=0)",
"type": [
"string",
"null"
]
}
},
"required": [
"TipoAmbiente",
"Remetente",
"Destinatario",
"Itens",
"DeclaracaoContribuinteICMS",
"DeclaracaoCrimeTributario"
],
"type": [
"object",
"null"
]
},
"mdfe": {
"additionalProperties": false,
"description": "MDF-e (modelo 58). Usado quando TipoEnvio = 1. Gera o DAMDFE/XML de pré-visualização.",
"properties": {
"Aereo": {
"additionalProperties": false,
"properties": {
"aerodromoDestino": {
"type": [
"string",
"null"
]
},
"aerodromoEmbarque": {
"type": [
"string",
"null"
]
},
"dataVoo": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"matricula": {
"type": [
"string",
"null"
]
},
"nacionalidade": {
"type": [
"string",
"null"
]
},
"numeroVoo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Aquaviario": {
"additionalProperties": false,
"properties": {
"cnpjAgencia": {
"type": [
"string",
"null"
]
},
"codEmbarcacao": {
"type": [
"string",
"null"
]
},
"codPortoDestino": {
"type": [
"string",
"null"
]
},
"codPortoEmbarque": {
"type": [
"string",
"null"
]
},
"nomeEmbarcacao": {
"type": [
"string",
"null"
]
},
"numeroViagem": {
"type": [
"string",
"null"
]
},
"tipoEmbarcacao": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"DataEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"Ferroviario": {
"additionalProperties": false,
"properties": {
"DataLiberacao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"Vagoes": {
"items": {
"additionalProperties": false,
"properties": {
"numero": {
"type": "integer"
},
"pesoBc": {
"description": "Peso Base de Cálculo de Frete em Toneladas",
"type": "number"
},
"pesoReal": {
"description": "Peso Real em Toneladas",
"type": "number"
},
"sequencia": {
"type": [
"integer",
"null"
]
},
"serie": {
"type": "integer"
},
"toneladaUtil": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"destino": {
"type": [
"string",
"null"
]
},
"origem": {
"type": [
"string",
"null"
]
},
"prefixo": {
"type": [
"string",
"null"
]
},
"quantidadeVagoes": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"Rodoviario": {
"additionalProperties": false,
"description": "Dados do transporte rodoviário (placa 7 caracteres, condutores com CPF/nome, UF do veículo). OBRIGATÓRIO quando modalidade = 1.",
"properties": {
"CIOT": {
"additionalProperties": false,
"properties": {
"cnpj": {
"type": [
"string",
"null"
]
},
"codigo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"capKG": {
"description": "Capacidade em KG do veículo de tração. Opcional.",
"type": [
"integer",
"null"
]
},
"capM3": {
"description": "Capacidade em M3 do veículo de tração. Opcional.",
"type": [
"integer",
"null"
]
},
"condutores": {
"items": {
"additionalProperties": false,
"properties": {
"cpf": {
"type": [
"string",
"null"
]
},
"nome": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"contratantes": {
"description": "Contratantes do serviço de transporte (grupo infANTT/infContratante).",
"items": {
"additionalProperties": false,
"properties": {
"cpfCnpj": {
"description": "CPF, CNPJ ou identificador estrangeiro do contratante do transporte.",
"type": [
"string",
"null"
]
},
"nome": {
"description": "Razão social ou nome do contratante.",
"type": [
"string",
"null"
]
},
"nroContrato": {
"description": "Número do contrato do transportador com o contratante, para prestações continuadas.",
"type": [
"string",
"null"
]
},
"vContratoGlobal": {
"description": "Valor global do contrato. Usar somente no pagamento a prazo.",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"pagamentos": {
"description": "Informações de pagamento do frete (grupo infANTT/infPag).",
"items": {
"additionalProperties": false,
"properties": {
"altoDesempenho": {
"description": "Operação de transporte de alto desempenho (frota dedicada/fidelizada).",
"type": "boolean"
},
"anteciparAdiantamento": {
"description": "Concordância em antecipar o adiantamento.",
"type": "boolean"
},
"componentes": {
"description": "Componentes do pagamento do frete.",
"items": {
"additionalProperties": false,
"properties": {
"descricao": {
"description": "Descrição do componente (usar quando tipo = 99).",
"type": [
"string",
"null"
]
},
"tipo": {
"description": "Tipo do componente: 01 - Vale-Pedágio; 02 - Impostos, taxas e contribuições; 03 - Despesas; 99 - Outros.",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor do componente.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"cpfCnpjResponsavel": {
"description": "CPF, CNPJ ou identificador estrangeiro do responsável pelo pagamento do frete.",
"type": [
"string",
"null"
]
},
"indicadorPagamento": {
"description": "Forma de pagamento: 0 - à vista; 1 - a prazo.",
"type": "integer"
},
"infoBancaria": {
"additionalProperties": false,
"description": "Informações bancárias para recebimento do frete.",
"properties": {
"cnpjInstituicaoPagamento": {
"description": "CNPJ da instituição de pagamento eletrônico do frete (alternativa ao banco/agência).",
"type": [
"string",
"null"
]
},
"codAgencia": {
"description": "Número da agência bancária.",
"type": [
"string",
"null"
]
},
"codBanco": {
"description": "Número do banco. Informar junto com a agência (ou use cnpjInstituicaoPagamento, ou pix).",
"type": [
"string",
"null"
]
},
"pix": {
"description": "Chave PIX para recebimento do frete (alternativa ao banco/agência).",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"nomeResponsavel": {
"description": "Razão social ou nome do responsável pelo pagamento.",
"type": [
"string",
"null"
]
},
"parcelas": {
"description": "Parcelas do pagamento (informar somente se a prazo).",
"items": {
"additionalProperties": false,
"properties": {
"numero": {
"description": "Número da parcela.",
"type": "integer"
},
"valor": {
"description": "Valor da parcela.",
"type": [
"number",
"null"
]
},
"vencimento": {
"description": "Data de vencimento da parcela.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"tipoAntecipacao": {
"description": "Permissão de antecipação das parcelas: 0 - não permite; 1 - permite; 2 - permite mediante confirmação.",
"type": [
"integer",
"null"
]
},
"valorAdiantamento": {
"description": "Valor do adiantamento (usar apenas em pagamento a prazo).",
"type": [
"number",
"null"
]
},
"valorContrato": {
"description": "Valor total do contrato.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"placa": {
"type": [
"string",
"null"
]
},
"reboques": {
"description": "Lista de veículos de reboque acoplados à tração. Opcional - se nulo/vazio,",
"items": {
"additionalProperties": false,
"properties": {
"capKG": {
"type": [
"integer",
"null"
]
},
"capM3": {
"type": [
"integer",
"null"
]
},
"placa": {
"description": "Placa do reboque (sem máscara).",
"type": [
"string",
"null"
]
},
"renavam": {
"type": [
"string",
"null"
]
},
"tara": {
"description": "Tara em KG",
"type": [
"integer",
"null"
]
},
"tipoCarroceria": {
"description": "Tipo de Carroceria Valores: 0 - Não aplicável; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"uf": {
"description": "UF de licenciamento do reboque (sigla de 2 letras).",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"renavam": {
"type": [
"string",
"null"
]
},
"tara": {
"description": "Tara em KG",
"type": "integer"
},
"tipoCarroceria": {
"description": "Tipo de Carroceria (Padrão 1) Valores: 0 - Não aplicavel; 1 - Aberta; 2 - Fechado Baú; 3 - Granelera; 4 - Porta Container; 5 - Sider",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"tipoRodado": {
"description": "Tipo de Rodado (Padrão 1) Valores: 1 - Truck; 2 - Toco; 3 - Cavalo Mecânico; 4 - VAN; 5 - Utilitário; 6 - Outros",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"uf": {
"type": [
"string",
"null"
]
},
"valePedagio": {
"additionalProperties": false,
"description": "Vale-pedágio (grupo infANTT/valePed).",
"properties": {
"categoriaCombinacaoVeicular": {
"description": "Categoria de combinação veicular (02 a 14, conforme número de eixos).",
"type": [
"string",
"null"
]
},
"dispositivos": {
"description": "Dispositivos do vale-pedágio.",
"items": {
"additionalProperties": false,
"properties": {
"cnpjFornecedor": {
"description": "CNPJ da empresa fornecedora do vale-pedágio.",
"type": [
"string",
"null"
]
},
"cpfCnpjPagador": {
"description": "CPF ou CNPJ do responsável pelo pagamento. Informar quando não for o emitente do MDF-e.",
"type": [
"string",
"null"
]
},
"numeroComprovante": {
"description": "Número do comprovante de compra.",
"type": [
"string",
"null"
]
},
"tipo": {
"description": "Tipo do vale-pedágio: 01 - TAG, 02 - Cupom, 03 - Cartão.",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor do vale-pedágio.",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"carregamentos": {
"items": {
"additionalProperties": false,
"properties": {
"codMunicipio": {
"type": "integer"
},
"municipio": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"codigo": {
"type": [
"integer",
"null"
]
},
"descarregamentos": {
"items": {
"additionalProperties": false,
"properties": {
"chaveDfe": {
"type": [
"string",
"null"
]
},
"codMunicipio": {
"type": "integer"
},
"municipio": {
"type": [
"string",
"null"
]
},
"transportePerigosos": {
"items": {
"additionalProperties": false,
"properties": {
"codigoONU": {
"type": [
"string",
"null"
]
},
"quantidade": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"identificadorInterno": {
"type": [
"string",
"null"
]
},
"lote": {
"type": [
"integer",
"null"
]
},
"modalidade": {
"default": 1,
"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)",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"numero": {
"type": [
"integer",
"null"
]
},
"observacao": {
"type": [
"string",
"null"
]
},
"observacaoFisco": {
"type": [
"string",
"null"
]
},
"percursoUfs": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"peso": {
"description": "Peso bruto total das mercadorias em KG. DEVE ser > 0.",
"type": "number"
},
"produtoPredominante": {
"additionalProperties": false,
"description": "Produto predominante transportado. Opcional.",
"properties": {
"cEan": {
"description": "GTIN/EAN do produto. Opcional. Use \"SEM GTIN\" se não houver.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do produto predominante (1 a 120 caracteres).",
"type": [
"string",
"null"
]
},
"infLotacao": {
"additionalProperties": false,
"description": "Informações de carga lotação. Opcional - só preencha quando o MDF-e for de carga lotação.",
"properties": {
"localCarrega": {
"additionalProperties": false,
"description": "Local de carregamento da lotação. Informe CEP OU (latitude + longitude).",
"properties": {
"cep": {
"description": "CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados.",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "Latitude. Informe junto com longitude quando não houver CEP.",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "Longitude. Informe junto com latitude quando não houver CEP.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"localDescarrega": {
"additionalProperties": false,
"description": "Local de descarregamento da lotação. Informe CEP OU (latitude + longitude).",
"properties": {
"cep": {
"description": "CEP do local (8 dígitos). Quando informado, latitude/longitude são ignorados.",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "Latitude. Informe junto com longitude quando não houver CEP.",
"type": [
"string",
"null"
]
},
"longitude": {
"description": "Longitude. Informe junto com latitude quando não houver CEP.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ncm": {
"description": "Código NCM do produto. Opcional. Aceita 2 ou 8 dígitos.",
"type": [
"string",
"null"
]
},
"tpCarga": {
"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)",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"type": "integer"
}
},
"type": [
"object",
"null"
]
},
"seguros": {
"items": {
"additionalProperties": false,
"properties": {
"cnpjSegurador": {
"description": "CNPJ da seguradora (somente dígitos).",
"type": [
"string",
"null"
]
},
"cpfCnpjResponsavel": {
"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.",
"type": [
"string",
"null"
]
},
"indicadorResponsavel": {
"default": 1,
"description": "Identificação do Ambiente (Padrão 1) Valores: 1 - Emitente do MDF-e; 2 - Responsável pela contratação",
"enum": [
1,
2
],
"type": "integer"
},
"nomeSegurador": {
"description": "Razão social / nome da seguradora.",
"type": [
"string",
"null"
]
},
"numeroApolice": {
"description": "Número da apólice de seguro. Obrigatório para modal rodoviário no MDF-e versão 3.00.",
"type": [
"string",
"null"
]
},
"numerosAverbacao": {
"description": "Lista de números de averbação do seguro (0..N). Opcional.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"serie": {
"type": [
"integer",
"null"
]
},
"tipoAmbiente": {
"default": 1,
"description": "Tipo de ambiente. IMPORTANTE: passe explicitamente. Para testes use 2. Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"tipoEmitente": {
"default": 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)",
"enum": [
1,
2
],
"type": "integer"
},
"ufCarregamento": {
"description": "UF de carregamento (origem). Sigla de 2 letras (SP, RJ, MG...).",
"type": "string"
},
"ufDescarregamento": {
"description": "UF de descarregamento (destino). Sigla de 2 letras (SP, RJ, MG...).",
"type": "string"
},
"valor": {
"description": "Valor total das mercadorias transportadas. DEVE ser > 0.",
"type": "number"
}
},
"required": [
"tipoAmbiente",
"tipoEmitente",
"ufCarregamento",
"ufDescarregamento",
"modalidade",
"valor",
"peso"
],
"type": [
"object",
"null"
]
},
"mostrarTarjaPreVisualizacao": {
"default": true,
"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",
"type": "boolean"
},
"nfse": {
"additionalProperties": false,
"description": "NFS-e. Usado quando TipoEnvio = 1. Gera o DANFSe/XML de pré-visualização (sem validade jurídica).",
"properties": {
"Lote": {
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"description": "Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste)",
"enum": [
1,
2
],
"type": "integer"
},
"nFSInfo": {
"description": "Lista de NFS-e a emitir no lote. Mínimo 1 item.",
"items": {
"additionalProperties": false,
"properties": {
"ConstrucaoCivil": {
"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.",
"properties": {
"Art": {
"description": "Documento de responsabilidade técnica (ART, RRT, DRT). Vai em infoCompl/idDocTec.",
"type": [
"string",
"null"
]
},
"Cib": {
"description": "Código do Cadastro Imobiliário Brasileiro (8 caracteres). Só no leiaute 1.01.",
"type": [
"string",
"null"
]
},
"CodObra": {
"description": "Número da obra: CNO (Cadastro Nacional de Obras) ou CEI do INSS. Até 30 caracteres.",
"type": [
"string",
"null"
]
},
"EnderecoObra": {
"additionalProperties": false,
"description": "Endereço da obra (CEP, Logradouro, Numero, Complemento, Bairro). Usado quando não há CodObra nem Cib.",
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"InscricaoImobiliaria": {
"description": "Inscrição imobiliária fiscal do imóvel na prefeitura. Opcional, complementa o identificador.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DataCompetencia": {
"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.",
"type": [
"string",
"null"
]
},
"DataEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"EnviarEmail": {
"type": "boolean"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"Intermediario": {
"additionalProperties": false,
"properties": {
"CPFCNPJ": {
"type": [
"string",
"null"
]
},
"InscricaoMunicipal": {
"type": [
"string",
"null"
]
},
"RzSocial": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"NumeroRps": {
"type": [
"integer",
"null"
]
},
"SerieRps": {
"type": [
"string",
"null"
]
},
"Servico": {
"additionalProperties": false,
"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.",
"properties": {
"CodMunicipioIncidencia": {
"description": "Código do municipio da incedência do serviço (Padrão - Município do Prestador)",
"type": [
"string",
"null"
]
},
"CodMunicipioPrestacao": {
"description": "Código do municipio da prestação do serviço (Padrão - Município do Prestador)",
"type": [
"string",
"null"
]
},
"CodNBS": {
"description": "Código NBS (Nomenclatura Brasileira de Serviços).",
"type": [
"string",
"null"
]
},
"CodTributacaoMunicipio": {
"description": "Código de tributação do município",
"type": [
"string",
"null"
]
},
"CodigoCnae": {
"description": "Código CNAE (Classificação Nacional de Atividades Econômicas)",
"type": [
"string",
"null"
]
},
"ComercioExterior": {
"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).",
"properties": {
"ApoioPrestador": {
"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",
"enum": [
1,
2,
null
],
"type": [
"integer",
"null"
]
},
"ApoioTomador": {
"description": "Mecanismo de apoio/fomento ao comércio exterior pelo tomador (mecAFComexT). Padrão 1.",
"type": [
"integer",
"null"
]
},
"CodMoeda": {
"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.",
"type": [
"integer",
"null"
]
},
"CompartilharMDIC": {
"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",
"enum": [
0,
1,
null
],
"type": [
"integer",
"null"
]
},
"ModoPrestacao": {
"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",
"enum": [
1,
2,
3,
4,
null
],
"type": [
"integer",
"null"
]
},
"MovimentacaoTemporariaBens": {
"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",
"enum": [
1,
2,
3,
null
],
"type": [
"integer",
"null"
]
},
"NumeroDI": {
"description": "Número da Declaração de Importação (nDI). Opcional.",
"type": [
"string",
"null"
]
},
"NumeroRE": {
"description": "Número do Registro de Exportação (nRE). Opcional.",
"type": [
"string",
"null"
]
},
"ValorMoedaEstrangeira": {
"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.",
"type": [
"number",
"null"
]
},
"VinculoPrestador": {
"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",
"enum": [
0,
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ConfiguracaoImposto": {
"additionalProperties": false,
"properties": {
"DestacarPisCofins": {
"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).",
"type": "boolean"
},
"ForcarIncidenciaCofins": {
"description": "Indide 3,00% de COFINS independente do valor",
"type": "boolean"
},
"ForcarIncidenciaCsll": {
"description": "Indide 1,00% de CSLL independente do valor",
"type": "boolean"
},
"ForcarIncidenciaIr": {
"description": "Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR independente do valor",
"type": "boolean"
},
"ForcarIncidenciaPis": {
"description": "Indide 0,65% de PIS independente do valor",
"type": "boolean"
},
"IncideCofins": {
"description": "Indide 3,00% de COFINS caso o valor for maior que R$215,05",
"type": "boolean"
},
"IncideCsll": {
"description": "Indide 1,00% de CSLL caso o valor for maior que R$215,05",
"type": "boolean"
},
"IncideIr": {
"description": "Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR caso o valor for maior que R$666,66",
"type": "boolean"
},
"IncidePis": {
"description": "Indide 0,65% de PIS caso o valor for maior que R$215,05",
"type": "boolean"
},
"RegimePisCofins": {
"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.).",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"DocumentoReferencia": {
"description": "Documento de referência (infoCompl/docRef, até 255 caracteres): contrato, proposta, NF referenciada etc.",
"type": [
"string",
"null"
]
},
"ExigibilidadeISS": {
"default": 1,
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"IBSCBS": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"description": "Alíquota da CBS (pCBS) em %. Se null, usa 0,90% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"AliqIbsMun": {
"description": "Alíquota do IBS Municipal (pIBSMun) em %. Se null, usa 0% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"description": "Alíquota do IBS Estadual (pIBSUF) em %. Se null, usa 0,10% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo do IBS/CBS (vBC). Se null, usa ValorServico - DescontoIncondicionado.",
"type": [
"number",
"null"
]
},
"CodClassTrib": {
"description": "Código de Classificação Tributária (cClassTrib, 6 dígitos). Os 3 primeiros são o CST. Padrão 000001.",
"type": [
"string",
"null"
]
},
"CodIndicadorOperacao": {
"description": "Código Indicador da Operação (cIndOp, 6 dígitos).",
"type": [
"string",
"null"
]
},
"EnderecoImovel": {
"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.",
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IndicadorDestinatario": {
"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)",
"enum": [
0,
1
],
"type": "integer"
},
"IndicadorUsoFinal": {
"description": "Indica operação de uso ou consumo pessoal (indFinal, art. 57). Valores: 0 - Não (padrão); 1 - Sim",
"enum": [
0,
1
],
"type": "integer"
},
"InscricaoImobiliariaImovel": {
"description": "Inscrição imobiliária fiscal (IPTU) do imóvel - opcional, dentro do grupo imovel.",
"type": [
"string",
"null"
]
},
"TipoOperacao": {
"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",
"enum": [
1,
2,
3,
4,
5,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IncentivadorCultural": {
"description": "Incentio Cultural?",
"type": "boolean"
},
"IncentivoFiscal": {
"description": "Incentivo Fiscal?",
"type": "boolean"
},
"InformacoesComplementares": {
"description": "Informações complementares da NFS-e nacional (infoCompl/xInfComp, até 2000 caracteres). Sai no DANFSe.",
"type": [
"string",
"null"
]
},
"IssRetido": {
"description": "Iss Retido?",
"type": "boolean"
},
"ItemListaServico": {
"description": "Código do serviço prestado. OBRIGATÓRIO. O significado depende do provedor do município (IdProvedorNFSe):",
"type": "string"
},
"NaturezaOperacao": {
"description": "Alguns municípios possui códigos específicos, para mais informações, veja a documentação:",
"type": "integer"
},
"NumeroPedido": {
"description": "Número do pedido do tomador (infoCompl/xPed, até 60 caracteres).",
"type": [
"string",
"null"
]
},
"RegimeEspecialTributacao": {
"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",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"Valores": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Alíquota do ISS (%).",
"type": "number"
},
"AliquotaIr": {
"type": [
"number",
"null"
]
},
"AliquotaSimplesNacional": {
"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).",
"type": [
"number",
"null"
]
},
"DescontoCondicionado": {
"type": "number"
},
"DescontoIncondicionado": {
"type": "number"
},
"OutrasRetencoes": {
"type": "number"
},
"TotalTributos": {
"type": "number"
},
"ValorDeducoes": {
"type": "number"
},
"ValorInss": {
"type": "number"
},
"ValorServico": {
"description": "Valor total do serviço prestado. DEVE ser maior que 0.",
"type": "number"
}
},
"required": [
"ValorServico"
],
"type": [
"object",
"null"
]
}
},
"required": [
"ItemListaServico"
],
"type": "object"
},
"Tomador": {
"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.",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "Documento de identificação do tomador.",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Im": {
"type": [
"string",
"null"
]
},
"NmTomador": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"Servico"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"TipoAmbiente",
"nFSInfo"
],
"type": [
"object",
"null"
]
},
"notaFiscal": {
"additionalProperties": false,
"description": "NF-e / NFC-e (modelo 55/65). Usado quando TipoEnvio = 1. Gera o DANFE/XML de pré-visualização.",
"properties": {
"Lote": {
"description": "Lote da Nota Fiscal",
"type": [
"integer",
"null"
]
},
"ModeloDocumento": {
"default": 55,
"description": "Código do modelo do Documento Fiscal (Padrão 55) Valores: 55 - NF-e; 65 - NFC-e",
"enum": [
55,
65
],
"type": "integer"
},
"TipoAmbiente": {
"description": "Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"nFInfos": {
"items": {
"additionalProperties": false,
"properties": {
"CalcularIBPT": {
"default": true,
"description": "Calcula o valor aproximado dos tributos (vTotTrib, tabela IBPT, Lei 12.741/2012). Padrão: verdadeiro.",
"type": "boolean"
},
"Cliente": {
"additionalProperties": false,
"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).",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"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.",
"type": "string"
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"IndicadorIe": {
"default": 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",
"enum": [
1,
2,
9
],
"type": "integer"
},
"IsUf": {
"type": [
"string",
"null"
]
},
"NmCliente": {
"description": "Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55).",
"type": "string"
}
},
"required": [
"CpfCnpj",
"NmCliente"
],
"type": [
"object",
"null"
]
},
"Cobranca": {
"additionalProperties": false,
"properties": {
"Fatura": {
"additionalProperties": false,
"properties": {
"Desconto": {
"type": "number"
},
"Numero": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
},
"ValorLiquido": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"Parcelas": {
"items": {
"additionalProperties": false,
"properties": {
"Valor": {
"type": "number"
},
"Vencimento": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Codigo": {
"description": "B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.",
"type": [
"string",
"null"
]
},
"ConsumidorFinal": {
"description": "Indica operação com Consumidor final (NFCe de ser 1 Validar!)",
"type": "boolean"
},
"DataEmissao": {
"description": "Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)",
"type": [
"string",
"null"
]
},
"DataEntradaSaida": {
"description": "Data e Hora da saída ou de entrada da produto/serviço",
"type": [
"string",
"null"
]
},
"Entrega": {
"additionalProperties": false,
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"EnviarEmail": {
"type": "boolean"
},
"Exporta": {
"additionalProperties": false,
"properties": {
"LocalDespacho": {
"description": "Descrição do local de despacho",
"type": [
"string",
"null"
]
},
"LocalEmbarqueTransp": {
"description": "Descrição do Local de Embarque ou de transposição de fronteira",
"type": [
"string",
"null"
]
},
"UFSaidaPais": {
"description": "Sigla da UF de Embarque ou de transposição de fronteira",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Finalidade": {
"default": 1,
"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",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"IndicadorPresenca": {
"default": 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.",
"enum": [
0,
1,
2,
3,
4,
5,
9
],
"type": "integer"
},
"Intermediador": {
"additionalProperties": false,
"description": "Dados do intermediador/marketplace (site ou plataforma de terceiros).",
"properties": {
"Cnpj": {
"description": "CNPJ do intermediador da transação (marketplace/plataforma de terceiros). Obrigatório.",
"type": "string"
},
"IdCadIntTran": {
"description": "Identificação do vendedor no site do intermediador (usuário/login cadastrado). Obrigatório.",
"type": "string"
}
},
"required": [
"Cnpj",
"IdCadIntTran"
],
"type": [
"object",
"null"
]
},
"Justificativa": {
"description": "Utilizar quando o tipo de emissão for diferente normal",
"type": [
"string",
"null"
]
},
"Lote": {
"description": "Lote da Nota Fiscal",
"type": [
"integer",
"null"
]
},
"ModeloDocumento": {
"default": 55,
"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)",
"enum": [
55,
65
],
"type": "integer"
},
"NFPagamentoAntecipado": {
"description": "Grupo de notas de antecipação de pagamento (gPagAntecipado - Reforma Tributária).",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"NFReferencia": {
"description": "Notas fiscal de Referência",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"NaturezaOperacao": {
"description": "Descrição da natureza da operação (máx 60 caracteres). Exemplos: \"Venda de mercadoria\", \"Remessa para industrialização\", \"Devolução de venda\".",
"type": "string"
},
"Numero": {
"description": "Número da nota fiscal",
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"ObservacaoFisco": {
"type": [
"string",
"null"
]
},
"Pagamentos": {
"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).",
"items": {
"additionalProperties": false,
"properties": {
"BandeiraOperadora": {
"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",
"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
],
"type": [
"string",
"null"
]
},
"CNPJCredenciadora": {
"type": [
"string",
"null"
]
},
"CNPJPagamento": {
"description": "CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (CNPJPag - NT 2023.004). Informar junto com UFPagamento (os dois ou nenhum). Opcional.",
"type": [
"string",
"null"
]
},
"CNPJRecebedor": {
"description": "CNPJ do beneficiário do pagamento (CNPJReceb - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"DataPagamento": {
"description": "Data do pagamento (dPag - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"Desconto": {
"type": "number"
},
"Descricao": {
"type": [
"string",
"null"
]
},
"FormaPagamento": {
"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",
"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
],
"type": [
"string",
"null"
]
},
"IdTerminalPagamento": {
"description": "Identificador do terminal de pagamento (idTermPag - NT 2023.004). Opcional, 1-40 caracteres.",
"type": [
"string",
"null"
]
},
"IndicadorPagamento": {
"description": "0 - A vista, 1 - Prazo",
"type": "integer"
},
"NumeroAutorizacao": {
"description": "Número de autorização da operação (cAut). Para PIX, informar o EndToEndId (e2eid) da transação.",
"type": [
"string",
"null"
]
},
"TipoIntegracao": {
"description": "Pagamento integrado com automação?",
"type": "boolean"
},
"UFPagamento": {
"description": "UF do estabelecimento onde o pagamento foi processado (UFPag - NT 2023.004). Opcional.",
"type": [
"string",
"null"
]
},
"VlPago": {
"type": "number"
},
"VlTroco": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Produtos": {
"description": "Itens da nota fiscal. Mínimo 1 item.",
"items": {
"additionalProperties": false,
"properties": {
"Agropecuaria": {
"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.",
"properties": {
"Defensivos": {
"description": "Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico.",
"items": {
"additionalProperties": false,
"properties": {
"CpfResponsavelTecnico": {
"description": "CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável.",
"type": "string"
},
"NumeroReceituario": {
"description": "Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres).",
"type": "string"
}
},
"required": [
"NumeroReceituario",
"CpfResponsavelTecnico"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"GuiaTransito": {
"additionalProperties": false,
"description": "Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal.",
"properties": {
"NumeroGuia": {
"description": "Número da guia (1-9 dígitos).",
"type": "string"
},
"SerieGuia": {
"description": "Série da guia (1-9 dígitos). Opcional.",
"type": [
"string",
"null"
]
},
"TipoGuia": {
"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)",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"UfGuia": {
"description": "Sigla da UF emissora da guia (2 caracteres).",
"type": "string"
}
},
"required": [
"TipoGuia",
"UfGuia",
"NumeroGuia"
],
"type": [
"object",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CEST": {
"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.",
"type": [
"string",
"null"
]
},
"CFOP": {
"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).",
"type": "integer"
},
"ChaveAcessoReferenciada": {
"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.",
"type": [
"string",
"null"
]
},
"CodProdutoServico": {
"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\".",
"type": "string"
},
"CodTributacao": {
"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.",
"type": [
"string",
"null"
]
},
"Combustivel": {
"additionalProperties": false,
"properties": {
"CodProdutoANP": {
"type": [
"string",
"null"
]
},
"DescricaoProdutoANP": {
"type": [
"string",
"null"
]
},
"UFConsumo": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DeclaracaoImportacao": {
"additionalProperties": false,
"properties": {
"Cnpj": {
"description": "CNPJ do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"CodExportador": {
"description": "Código do Exportador",
"type": [
"string",
"null"
]
},
"CodFabricante": {
"description": "Código do Fabricante Extrangeiro",
"type": [
"string",
"null"
]
},
"DataDesenbaraco": {
"description": "Data do Desembaraço Aduaneiro",
"type": "string"
},
"DataRegistro": {
"description": "Data de Registro do documento de importação",
"type": "string"
},
"LocalDesenbaraco": {
"description": "Local de Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"Numero": {
"description": "Número do Documento de Importação (DI, DSI, DIRE, ...)",
"type": [
"string",
"null"
]
},
"TipoIntermedio": {
"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",
"enum": [
1,
2,
3
],
"type": "integer"
},
"TipoViaTransporte": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer"
},
"Uf": {
"description": "Sigla da UF do adquirente ou do encomendante",
"type": [
"string",
"null"
]
},
"UfDesenbaraco": {
"description": "Sigla da UF onde ocorreu o Desembaraço Aduaneiro",
"type": [
"string",
"null"
]
},
"ValorAFRMM": {
"description": "Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"EAN": {
"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.",
"type": [
"string",
"null"
]
},
"Imposto": {
"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.",
"properties": {
"COFINS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do COFINS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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.",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IBSCBS": {
"additionalProperties": false,
"properties": {
"AliquotaCBS": {
"description": "Alíquota da CBS",
"type": [
"number",
"null"
]
},
"AliquotaIBSMun": {
"description": "Alíquota do IBS de competência do Município",
"type": [
"number",
"null"
]
},
"AliquotaIBSUF": {
"description": "Alíquota do IBS de competência das UF",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo",
"type": [
"number",
"null"
]
},
"CodClassificacaoTributaria": {
"description": "Código de Classificação Tributária (Padrão 000001)",
"type": [
"string",
"null"
]
},
"PercentualDiferimento": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoCBS": {
"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.",
"type": [
"number",
"null"
]
},
"PercentualReducaoIBS": {
"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).",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ICMS": {
"additionalProperties": false,
"properties": {
"AliquotaAdRemRetido": {
"description": "adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente).",
"type": [
"number",
"null"
]
},
"AliquotaCredito": {
"description": "Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMS": {
"description": "Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaICMSST": {
"description": "Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201",
"type": [
"number",
"null"
]
},
"AliquotaMVA": {
"description": "Alíquota - Obrigatório para situação tributária nº 201, 202 e 203",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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\".",
"type": "string"
},
"QuantidadeMonoRetido": {
"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.",
"type": [
"number",
"null"
]
},
"RedICMS": {
"description": "Redução ICMS",
"type": [
"number",
"null"
]
},
"RedICMSST": {
"description": "Redução ICMS ST",
"type": [
"number",
"null"
]
},
"STRetido": {
"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.",
"properties": {
"AliquotaConsumidorFinal": {
"description": "pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP).",
"type": [
"number",
"null"
]
},
"AliquotaEfetiva": {
"description": "pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100.",
"type": [
"number",
"null"
]
},
"AliquotaFCP": {
"description": "pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100.",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior.",
"type": [
"number",
"null"
]
},
"BaseCalculoEfetiva": {
"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.",
"type": [
"number",
"null"
]
},
"BaseCalculoFCP": {
"description": "vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior.",
"type": [
"number",
"null"
]
},
"PercentualReducaoBaseEfetiva": {
"description": "pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final).",
"type": [
"number",
"null"
]
},
"ValorICMSST": {
"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.",
"type": [
"number",
"null"
]
},
"ValorICMSSubstituto": {
"description": "vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior.",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorIcms": {
"description": "Valor do Icms (Calculado Automaticamente quando não informado)",
"type": [
"number",
"null"
]
},
"ValorIcmsMonoRetido": {
"description": "vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido.",
"type": [
"number",
"null"
]
},
"aliquotaDiferimento": {
"description": "Percentual de diferimento (Utilizado somente no CST 51)",
"type": [
"number",
"null"
]
},
"modalidadeBcIcms": {
"description": "0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"motivoDesoneracaoIcms": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
16,
null
],
"type": [
"integer",
"null"
]
},
"valorDesoneracaoIcms": {
"type": [
"number",
"null"
]
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"IPI": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do IPI",
"type": "number"
},
"CodEnquadramento": {
"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).",
"type": "string"
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
},
"PercentualMercadoriaDevolvida": {
"description": "Percentual da mercadoria devolvida",
"type": "number"
},
"ValorIpiDevolvido": {
"description": "Valor do IPI devolvido",
"type": "number"
}
},
"required": [
"CodEnquadramento",
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
},
"Importacao": {
"additionalProperties": false,
"properties": {
"BaseCalculo": {
"type": "number"
},
"DespesasAduaneiras": {
"type": "number"
},
"Valor": {
"type": "number"
},
"ValorIOF": {
"type": "number"
}
},
"type": [
"object",
"null"
]
},
"PIS": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Aliquota do PIS",
"type": "number"
},
"BaseCalculo": {
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)",
"type": [
"number",
"null"
]
},
"CodSituacaoTributaria": {
"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).",
"type": "string"
}
},
"required": [
"CodSituacaoTributaria"
],
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"InformacaoAdicional": {
"description": "Informaçoes adicional",
"type": [
"string",
"null"
]
},
"NCM": {
"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\".",
"type": "string"
},
"NItemPed": {
"description": "Número do item do Pedido de Compra",
"type": [
"integer",
"null"
]
},
"NItemReferenciado": {
"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.",
"type": [
"integer",
"null"
]
},
"NmProduto": {
"description": "Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\".",
"type": "string"
},
"OrigemProduto": {
"default": 0,
"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%",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer"
},
"Quantidade": {
"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).",
"type": "number"
},
"QuantidadeTributavel": {
"description": "Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros.",
"type": [
"number",
"null"
]
},
"Rastros": {
"description": "Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas.",
"items": {
"additionalProperties": false,
"properties": {
"CodigoAgregacao": {
"description": "Código de agregação (opcional)",
"type": [
"string",
"null"
]
},
"DataFabricacao": {
"description": "Data de fabricação/produção",
"type": "string"
},
"DataValidade": {
"description": "Data de validade",
"type": "string"
},
"NumeroLote": {
"description": "Número do lote do produto (1-20 caracteres)",
"type": [
"string",
"null"
]
},
"QuantidadeLote": {
"description": "Quantidade de produto no lote",
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UnidadeComercial": {
"description": "Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\".",
"type": "string"
},
"UnidadeComercialTributavel": {
"description": "Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial.",
"type": [
"string",
"null"
]
},
"ValorDesconto": {
"description": "Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal).",
"type": "number"
},
"ValorFrete": {
"description": "Valor Frete",
"type": [
"number",
"null"
]
},
"ValorOutrasDespesas": {
"description": "Valor Outras Despesas",
"type": [
"number",
"null"
]
},
"ValorSeguro": {
"description": "Valor Seguro",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"description": "Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0.",
"type": "number"
},
"ValorUnitario": {
"description": "Valor unitário do produto (>= 0). Aceita até 10 casas decimais.",
"type": "number"
},
"ValorUnitarioTributavel": {
"description": "Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario.",
"type": [
"number",
"null"
]
},
"cBenef": {
"description": "Código de Beneficio Fiscal na UF",
"type": [
"string",
"null"
]
},
"nFCI": {
"description": "Número de controle da FCI - Ficha de Conteúdo de Importação",
"type": [
"string",
"null"
]
},
"xPed": {
"description": "Número do Pedido de Compra",
"type": [
"string",
"null"
]
}
},
"required": [
"NmProduto",
"CodProdutoServico",
"NCM",
"Quantidade",
"UnidadeComercial",
"ValorUnitario",
"ValorTotal",
"CFOP",
"OrigemProduto",
"Imposto"
],
"type": "object"
},
"type": "array"
},
"Retencoes": {
"additionalProperties": false,
"description": "Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML.",
"properties": {
"BaseCalculoIRRF": {
"description": "Base de cálculo do IRRF",
"type": [
"number",
"null"
]
},
"BaseCalculoRetencaoPrevidencia": {
"description": "Base de cálculo da retenção da Previdência Social",
"type": [
"number",
"null"
]
},
"ValorIRRF": {
"description": "Valor retido do IRRF",
"type": [
"number",
"null"
]
},
"ValorRetencaoPrevidencia": {
"description": "Valor da retenção da Previdência Social",
"type": [
"number",
"null"
]
},
"ValorRetidoCOFINS": {
"description": "Valor retido de COFINS",
"type": [
"number",
"null"
]
},
"ValorRetidoCSLL": {
"description": "Valor retido de CSLL",
"type": [
"number",
"null"
]
},
"ValorRetidoPIS": {
"description": "Valor retido de PIS",
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Serie": {
"description": "Série da nota Fiscal",
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"default": 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)",
"enum": [
1,
2
],
"type": "integer"
},
"TipoDanfe": {
"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.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"TpNFCredito": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"TpNFDebito": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
null
],
"type": [
"integer",
"null"
]
},
"Transporte": {
"additionalProperties": false,
"properties": {
"Balsa": {
"type": [
"string",
"null"
]
},
"CNPJ": {
"type": [
"string",
"null"
]
},
"DsEndereco": {
"type": [
"string",
"null"
]
},
"IE": {
"type": [
"string",
"null"
]
},
"ModalidadeFrete": {
"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",
"enum": [
0,
1,
2,
3,
4,
9
],
"type": "integer"
},
"NmMunicipio": {
"type": [
"string",
"null"
]
},
"NmTransportador": {
"type": [
"string",
"null"
]
},
"Reboque": {
"items": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"Vagao": {
"type": [
"string",
"null"
]
},
"Veiculo": {
"additionalProperties": false,
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Volumes": {
"items": {
"additionalProperties": false,
"properties": {
"Especie": {
"type": [
"string",
"null"
]
},
"Lacres": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Marca": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"PesoBruto": {
"type": "number"
},
"PesoLiquido": {
"type": "number"
},
"QuantidadeVolume": {
"type": "integer"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ValorDesconto": {
"description": "Valor total do desconto da nota. Quando informado, é distribuído proporcionalmente entre os itens (proporção pelo ValorTotal de cada item), SUBSTITUINDO o ValorDesconto informado em cada produto. Não informado (nulo) = o desconto de cada item é usado como enviado.",
"type": [
"number",
"null"
]
},
"ValorFrete": {
"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.",
"type": [
"number",
"null"
]
},
"ValorTotal": {
"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.",
"type": [
"number",
"null"
]
}
},
"required": [
"IndicadorPresenca",
"NaturezaOperacao",
"ModeloDocumento",
"Finalidade",
"TipoAmbiente",
"Produtos"
],
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"name": "nfe_previsualizar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64File": {
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "XML da pré-visualização. Preenchido somente quando TipoArquivo = 2.",
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Status": {
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Envia a NF-EnerCom (Nota Fiscal de Energia Comercializada) para autorização na SEFAZ.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"comunicao": {
"additionalProperties": false,
"description": "Informações referente a nota de comunicação e Telecomunicação",
"properties": {
"tipoAssinante": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"tipoUtilizacao": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"dataEmissao": {
"description": "Data de emissão do documento. Obrigatória.",
"type": "string"
},
"destinatario": {
"additionalProperties": false,
"description": "Informações do destinatário (cliente). OBRIGATÓRIO.",
"properties": {
"codigo": {
"description": "Código interno que identifica o destinatário",
"type": [
"string",
"null"
]
},
"contato": {
"additionalProperties": false,
"properties": {
"email": {
"type": [
"string",
"null"
]
},
"fax": {
"type": [
"string",
"null"
]
},
"telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"cpfCnpj": {
"description": "CFP ou CNPJ",
"type": [
"string",
"null"
]
},
"endereco": {
"additionalProperties": false,
"properties": {
"bairro": {
"type": [
"string",
"null"
]
},
"cep": {
"type": [
"string",
"null"
]
},
"codMunicipio": {
"type": [
"string",
"null"
]
},
"codPais": {
"default": 1058,
"type": "integer"
},
"complemento": {
"type": [
"string",
"null"
]
},
"logradouro": {
"type": [
"string",
"null"
]
},
"municipio": {
"type": [
"string",
"null"
]
},
"numero": {
"type": [
"string",
"null"
]
},
"pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ie": {
"description": "Inscrição Estadual",
"type": [
"string",
"null"
]
},
"razaoSocial": {
"description": "Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"energia": {
"additionalProperties": false,
"description": "Informações referente a nota de Energia",
"properties": {
"classeConsumo": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
null
],
"type": [
"integer",
"null"
]
},
"dataLeituraAnterior": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"dataLeituraAtual": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"grupoTensao": {
"description": "Código do grupo de tensão",
"type": [
"integer",
"null"
]
},
"subClasseConsumo": {
"description": "Código da subclasse de consumo de energia elétrica.",
"type": [
"integer",
"null"
]
},
"tarifaAplicada": {
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identificadorInterno": {
"description": "Código de controle interno unico da venda. Evita duplicidades, caso configurado.",
"type": [
"string",
"null"
]
},
"modeloDocumento": {
"description": "Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação",
"enum": [
6,
21,
22
],
"type": "integer"
},
"numero": {
"description": "Número da nota fiscal. Quando não informado é controlado pelo Painel",
"type": [
"integer",
"null"
]
},
"produtos": {
"description": "Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP.",
"items": {
"additionalProperties": false,
"properties": {
"aliqCofins": {
"description": "Alíquota de Cofins",
"type": "number"
},
"aliqIcms": {
"description": "Alíquota de Icms",
"type": "number"
},
"aliqPis": {
"description": "Alíquota de PIS",
"type": "number"
},
"cfop": {
"description": "Código CFOP",
"type": "integer"
},
"codClassificacao": {
"description": "Código de classificação do serviço",
"type": [
"string",
"null"
]
},
"codTributacao": {
"description": "Código do grupo tributário cadastrado no Painel, para automação de impostos",
"type": [
"string",
"null"
]
},
"codigo": {
"description": "Código interno que identifica item",
"type": [
"string",
"null"
]
},
"desconto": {
"description": "Desconto total aplicado no item",
"type": [
"number",
"null"
]
},
"descricao": {
"description": "Descrição do item",
"type": [
"string",
"null"
]
},
"outrasDespesas": {
"description": "Acréscimos e Despesas Acessórias",
"type": [
"number",
"null"
]
},
"quantidade": {
"description": "Quantidade de itens",
"type": "number"
},
"unidadeMedida": {
"description": "Unidade de Medida",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor unitário do item",
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"serie": {
"description": "Série da nota fiscal. Quando não informado é controlado pelo Painel",
"type": [
"string",
"null"
]
},
"situacao": {
"default": 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",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"tipoAmbiente": {
"description": "Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"valorTotalFatura": {
"description": "Valor total da fatura comercial. Deve ser > 0.",
"type": "number"
}
},
"required": [
"modeloDocumento",
"tipoAmbiente",
"valorTotalFatura",
"dataEmissao",
"destinatario",
"produtos"
],
"type": "object"
},
"name": "nfenercom_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"erros": {
"description": "Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.",
"items": {
"additionalProperties": false,
"properties": {
"codigo": {
"description": "Código do erro/rejeição (quando houver).",
"type": [
"string",
"null"
]
},
"correcao": {
"description": "Sugestão de correção, quando disponível.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do erro.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"status": {
"description": "Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).",
"type": "integer"
}
},
"type": "object"
}
},
{
"description": "Gera o arquivo da Nota Fiscal de Energia (NF-EnerCom). Pré-requisito para nfenercom_emitir.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ano": {
"description": "Ano de emissão das notas (4 dígitos). Obrigatório quando tipoGeracao = 1.",
"type": [
"integer",
"null"
]
},
"mes": {
"description": "Mês de emissão das notas (1-12). Obrigatório quando tipoGeracao = 1.",
"type": [
"integer",
"null"
]
},
"notas": {
"description": "Notas Fiscais de Energia/Comunicação/Telecomunicação a incluir no arquivo. Obrigatório quando tipoGeracao = 2.",
"items": {
"additionalProperties": false,
"properties": {
"comunicao": {
"additionalProperties": false,
"description": "Informações referente a nota de comunicação e Telecomunicação",
"properties": {
"tipoAssinante": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
},
"tipoUtilizacao": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"dataEmissao": {
"description": "Data de emissão do documento. Obrigatória.",
"type": "string"
},
"destinatario": {
"additionalProperties": false,
"description": "Informações do destinatário (cliente). OBRIGATÓRIO.",
"properties": {
"codigo": {
"description": "Código interno que identifica o destinatário",
"type": [
"string",
"null"
]
},
"contato": {
"additionalProperties": false,
"properties": {
"email": {
"type": [
"string",
"null"
]
},
"fax": {
"type": [
"string",
"null"
]
},
"telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"cpfCnpj": {
"description": "CFP ou CNPJ",
"type": [
"string",
"null"
]
},
"endereco": {
"additionalProperties": false,
"properties": {
"bairro": {
"type": [
"string",
"null"
]
},
"cep": {
"type": [
"string",
"null"
]
},
"codMunicipio": {
"type": [
"string",
"null"
]
},
"codPais": {
"default": 1058,
"type": "integer"
},
"complemento": {
"type": [
"string",
"null"
]
},
"logradouro": {
"type": [
"string",
"null"
]
},
"municipio": {
"type": [
"string",
"null"
]
},
"numero": {
"type": [
"string",
"null"
]
},
"pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ie": {
"description": "Inscrição Estadual",
"type": [
"string",
"null"
]
},
"razaoSocial": {
"description": "Razão Social",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"energia": {
"additionalProperties": false,
"description": "Informações referente a nota de Energia",
"properties": {
"classeConsumo": {
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
null
],
"type": [
"integer",
"null"
]
},
"dataLeituraAnterior": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"dataLeituraAtual": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"grupoTensao": {
"description": "Código do grupo de tensão",
"type": [
"integer",
"null"
]
},
"subClasseConsumo": {
"description": "Código da subclasse de consumo de energia elétrica.",
"type": [
"integer",
"null"
]
},
"tarifaAplicada": {
"type": [
"number",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identificadorInterno": {
"description": "Código de controle interno unico da venda. Evita duplicidades, caso configurado.",
"type": [
"string",
"null"
]
},
"modeloDocumento": {
"description": "Modelo do documento. Valores: 6 - Energia elétrica; 21 - Comunicação; 22 - Telecomunicação",
"enum": [
6,
21,
22
],
"type": "integer"
},
"numero": {
"description": "Número da nota fiscal. Quando não informado é controlado pelo Painel",
"type": [
"integer",
"null"
]
},
"produtos": {
"description": "Itens da nota (mínimo 1). Cada item exige codigo, descricao, unidadeMedida, quantidade, valor, CFOP.",
"items": {
"additionalProperties": false,
"properties": {
"aliqCofins": {
"description": "Alíquota de Cofins",
"type": "number"
},
"aliqIcms": {
"description": "Alíquota de Icms",
"type": "number"
},
"aliqPis": {
"description": "Alíquota de PIS",
"type": "number"
},
"cfop": {
"description": "Código CFOP",
"type": "integer"
},
"codClassificacao": {
"description": "Código de classificação do serviço",
"type": [
"string",
"null"
]
},
"codTributacao": {
"description": "Código do grupo tributário cadastrado no Painel, para automação de impostos",
"type": [
"string",
"null"
]
},
"codigo": {
"description": "Código interno que identifica item",
"type": [
"string",
"null"
]
},
"desconto": {
"description": "Desconto total aplicado no item",
"type": [
"number",
"null"
]
},
"descricao": {
"description": "Descrição do item",
"type": [
"string",
"null"
]
},
"outrasDespesas": {
"description": "Acréscimos e Despesas Acessórias",
"type": [
"number",
"null"
]
},
"quantidade": {
"description": "Quantidade de itens",
"type": "number"
},
"unidadeMedida": {
"description": "Unidade de Medida",
"type": [
"string",
"null"
]
},
"valor": {
"description": "Valor unitário do item",
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"serie": {
"description": "Série da nota fiscal. Quando não informado é controlado pelo Painel",
"type": [
"string",
"null"
]
},
"situacao": {
"default": 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",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"tipoAmbiente": {
"description": "Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"valorTotalFatura": {
"description": "Valor total da fatura comercial. Deve ser > 0.",
"type": "number"
}
},
"required": [
"modeloDocumento",
"tipoAmbiente",
"valorTotalFatura",
"dataEmissao",
"destinatario",
"produtos"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"tipoAmbiente": {
"description": "Tipo de ambiente. Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"tipoGeracao": {
"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\"",
"enum": [
1,
2
],
"type": "integer"
}
},
"required": [
"tipoGeracao",
"tipoAmbiente"
],
"type": "object"
},
"name": "nfenercom_gerar_arquivo",
"outputSchema": null
},
{
"description": "Consulta status e dados de uma NFS-e já enviada por número, série e ambiente.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Rps": {
"description": "Rps para retornar (Se não enviar retorna todos)",
"items": {
"type": "integer"
},
"type": [
"array",
"null"
]
},
"codLote": {
"description": "Código do lote",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "nfse_consultar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64XmlLote": {
"description": "Dados xml do lote, bytes em base64",
"type": [
"string",
"null"
]
},
"CodLote": {
"description": "Código atrelado ao lote; - Usado para busca de lotes",
"type": [
"string",
"null"
]
},
"CodTipoAmbiente": {
"description": "Código do ambiente de envio",
"type": "integer"
},
"DataRecebimento": {
"description": "Data de recebimento do lote;",
"type": [
"string",
"null"
]
},
"DsTipoAmbiente": {
"description": "Descrição do ambiente de envio",
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Lote": {
"description": "Número do lote enviado;",
"type": "integer"
},
"MunicipioEnvio": {
"description": "Municipio onde foi enviado",
"type": [
"string",
"null"
]
},
"Notas": {
"items": {
"additionalProperties": false,
"properties": {
"Base64Doc": {
"description": "Documento pdf da nfs, bytes em base64",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "Dados xml da nfs, bytes em base64",
"type": [
"string",
"null"
]
},
"Cancelada": {
"description": "Informa se a NFS-e encontra-se cancelada",
"type": "boolean"
},
"Chave": {
"description": "Chave da NFS-e",
"type": [
"string",
"null"
]
},
"CodVerificacao": {
"description": "Código de verificação da NFS-e",
"type": [
"string",
"null"
]
},
"CpfCnpjPrestador": {
"description": "Cpf ou Cnpj do Prestador",
"type": [
"string",
"null"
]
},
"CpfCnpjTomador": {
"description": "Cpf ou Cnpj do Tomador",
"type": [
"string",
"null"
]
},
"DtEmissao": {
"description": "Data da emissao da NFSe",
"type": "string"
},
"Erro": {
"description": "Descrição do erro caso a nota não for emitida",
"type": [
"string",
"null"
]
},
"IdentificadorInterno": {
"description": "Identificador interno da nfs (enviado pela API)",
"type": [
"string",
"null"
]
},
"NumeroNFSe": {
"description": "Número da NFS-e",
"type": [
"string",
"null"
]
},
"NumeroRPS": {
"description": "Número do RPS",
"type": "integer"
},
"Status": {
"description": "1 - NFSe Emitida; 3 - Erro ao emitir",
"enum": [
1,
3
],
"type": "integer"
},
"Valores": {
"additionalProperties": false,
"description": "Valores da NFS-e",
"properties": {
"Aliquota": {
"description": "Alíquota em %",
"type": "number"
},
"BaseCalculo": {
"description": "Base de cálculo",
"type": "number"
},
"ValorCOFINS": {
"description": "Valor COFINS",
"type": "number"
},
"ValorCSLL": {
"description": "Valor CSLL",
"type": "number"
},
"ValorIR": {
"description": "Valor IR",
"type": "number"
},
"ValorISS": {
"description": "Valor ISS",
"type": "number"
},
"ValorISSRetido": {
"description": "Valor ISS Retido",
"type": "number"
},
"ValorInss": {
"description": "Valor INSS retido (Contribuição Previdenciária - vRetCP no DPS nacional)",
"type": "number"
},
"ValorLiquido": {
"description": "Valor Líquido",
"type": "number"
},
"ValorPIS": {
"description": "Valor PIS",
"type": "number"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Protocolo": {
"description": "Número de protocolo do lote",
"type": [
"string",
"null"
]
},
"StatusLote": {
"description": "1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote; 4 - Ocorreu um erro ao analisar as informações do lote",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"TempoRequisicaoPrefeitura": {
"description": "Tempo total da transmissão para prefeitura em milisegundos",
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Lote": {
"type": [
"integer",
"null"
]
},
"TipoAmbiente": {
"description": "Identificação do ambiente da prefeitura/portal nacional. Valores: 1 - Produção (emissão REAL, com valor fiscal); 2 - Homologação (teste)",
"enum": [
1,
2
],
"type": "integer"
},
"nFSInfo": {
"description": "Lista de NFS-e a emitir no lote. Mínimo 1 item.",
"items": {
"additionalProperties": false,
"properties": {
"ConstrucaoCivil": {
"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.",
"properties": {
"Art": {
"description": "Documento de responsabilidade técnica (ART, RRT, DRT). Vai em infoCompl/idDocTec.",
"type": [
"string",
"null"
]
},
"Cib": {
"description": "Código do Cadastro Imobiliário Brasileiro (8 caracteres). Só no leiaute 1.01.",
"type": [
"string",
"null"
]
},
"CodObra": {
"description": "Número da obra: CNO (Cadastro Nacional de Obras) ou CEI do INSS. Até 30 caracteres.",
"type": [
"string",
"null"
]
},
"EnderecoObra": {
"additionalProperties": false,
"description": "Endereço da obra (CEP, Logradouro, Numero, Complemento, Bairro). Usado quando não há CodObra nem Cib.",
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"InscricaoImobiliaria": {
"description": "Inscrição imobiliária fiscal do imóvel na prefeitura. Opcional, complementa o identificador.",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"DataCompetencia": {
"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.",
"type": [
"string",
"null"
]
},
"DataEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": [
"string",
"null"
]
},
"EnviarEmail": {
"type": "boolean"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"Intermediario": {
"additionalProperties": false,
"properties": {
"CPFCNPJ": {
"type": [
"string",
"null"
]
},
"InscricaoMunicipal": {
"type": [
"string",
"null"
]
},
"RzSocial": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"NumeroRps": {
"type": [
"integer",
"null"
]
},
"SerieRps": {
"type": [
"string",
"null"
]
},
"Servico": {
"additionalProperties": false,
"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.",
"properties": {
"CodMunicipioIncidencia": {
"description": "Código do municipio da incedência do serviço (Padrão - Município do Prestador)",
"type": [
"string",
"null"
]
},
"CodMunicipioPrestacao": {
"description": "Código do municipio da prestação do serviço (Padrão - Município do Prestador)",
"type": [
"string",
"null"
]
},
"CodNBS": {
"description": "Código NBS (Nomenclatura Brasileira de Serviços).",
"type": [
"string",
"null"
]
},
"CodTributacaoMunicipio": {
"description": "Código de tributação do município",
"type": [
"string",
"null"
]
},
"CodigoCnae": {
"description": "Código CNAE (Classificação Nacional de Atividades Econômicas)",
"type": [
"string",
"null"
]
},
"ComercioExterior": {
"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).",
"properties": {
"ApoioPrestador": {
"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",
"enum": [
1,
2,
null
],
"type": [
"integer",
"null"
]
},
"ApoioTomador": {
"description": "Mecanismo de apoio/fomento ao comércio exterior pelo tomador (mecAFComexT). Padrão 1.",
"type": [
"integer",
"null"
]
},
"CodMoeda": {
"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.",
"type": [
"integer",
"null"
]
},
"CompartilharMDIC": {
"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",
"enum": [
0,
1,
null
],
"type": [
"integer",
"null"
]
},
"ModoPrestacao": {
"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",
"enum": [
1,
2,
3,
4,
null
],
"type": [
"integer",
"null"
]
},
"MovimentacaoTemporariaBens": {
"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",
"enum": [
1,
2,
3,
null
],
"type": [
"integer",
"null"
]
},
"NumeroDI": {
"description": "Número da Declaração de Importação (nDI). Opcional.",
"type": [
"string",
"null"
]
},
"NumeroRE": {
"description": "Número do Registro de Exportação (nRE). Opcional.",
"type": [
"string",
"null"
]
},
"ValorMoedaEstrangeira": {
"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.",
"type": [
"number",
"null"
]
},
"VinculoPrestador": {
"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",
"enum": [
0,
1,
2,
3,
4,
5,
6,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"ConfiguracaoImposto": {
"additionalProperties": false,
"properties": {
"DestacarPisCofins": {
"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).",
"type": "boolean"
},
"ForcarIncidenciaCofins": {
"description": "Indide 3,00% de COFINS independente do valor",
"type": "boolean"
},
"ForcarIncidenciaCsll": {
"description": "Indide 1,00% de CSLL independente do valor",
"type": "boolean"
},
"ForcarIncidenciaIr": {
"description": "Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR independente do valor",
"type": "boolean"
},
"ForcarIncidenciaPis": {
"description": "Indide 0,65% de PIS independente do valor",
"type": "boolean"
},
"IncideCofins": {
"description": "Indide 3,00% de COFINS caso o valor for maior que R$215,05",
"type": "boolean"
},
"IncideCsll": {
"description": "Indide 1,00% de CSLL caso o valor for maior que R$215,05",
"type": "boolean"
},
"IncideIr": {
"description": "Indide 1,50% (ou a alíquota informada em (Valores -> AliquotaIr)) de IR caso o valor for maior que R$666,66",
"type": "boolean"
},
"IncidePis": {
"description": "Indide 0,65% de PIS caso o valor for maior que R$215,05",
"type": "boolean"
},
"RegimePisCofins": {
"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.).",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"DocumentoReferencia": {
"description": "Documento de referência (infoCompl/docRef, até 255 caracteres): contrato, proposta, NF referenciada etc.",
"type": [
"string",
"null"
]
},
"ExigibilidadeISS": {
"default": 1,
"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",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"IBSCBS": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"description": "Alíquota da CBS (pCBS) em %. Se null, usa 0,90% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"AliqIbsMun": {
"description": "Alíquota do IBS Municipal (pIBSMun) em %. Se null, usa 0% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"description": "Alíquota do IBS Estadual (pIBSUF) em %. Se null, usa 0,10% (padrão de teste 2025-2026).",
"type": [
"number",
"null"
]
},
"BaseCalculo": {
"description": "Base de cálculo do IBS/CBS (vBC). Se null, usa ValorServico - DescontoIncondicionado.",
"type": [
"number",
"null"
]
},
"CodClassTrib": {
"description": "Código de Classificação Tributária (cClassTrib, 6 dígitos). Os 3 primeiros são o CST. Padrão 000001.",
"type": [
"string",
"null"
]
},
"CodIndicadorOperacao": {
"description": "Código Indicador da Operação (cIndOp, 6 dígitos).",
"type": [
"string",
"null"
]
},
"EnderecoImovel": {
"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.",
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IndicadorDestinatario": {
"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)",
"enum": [
0,
1
],
"type": "integer"
},
"IndicadorUsoFinal": {
"description": "Indica operação de uso ou consumo pessoal (indFinal, art. 57). Valores: 0 - Não (padrão); 1 - Sim",
"enum": [
0,
1
],
"type": "integer"
},
"InscricaoImobiliariaImovel": {
"description": "Inscrição imobiliária fiscal (IPTU) do imóvel - opcional, dentro do grupo imovel.",
"type": [
"string",
"null"
]
},
"TipoOperacao": {
"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",
"enum": [
1,
2,
3,
4,
5,
null
],
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"IncentivadorCultural": {
"description": "Incentio Cultural?",
"type": "boolean"
},
"IncentivoFiscal": {
"description": "Incentivo Fiscal?",
"type": "boolean"
},
"InformacoesComplementares": {
"description": "Informações complementares da NFS-e nacional (infoCompl/xInfComp, até 2000 caracteres). Sai no DANFSe.",
"type": [
"string",
"null"
]
},
"IssRetido": {
"description": "Iss Retido?",
"type": "boolean"
},
"ItemListaServico": {
"description": "Código do serviço prestado. OBRIGATÓRIO. O significado depende do provedor do município (IdProvedorNFSe):",
"type": "string"
},
"NaturezaOperacao": {
"description": "Alguns municípios possui códigos específicos, para mais informações, veja a documentação:",
"type": "integer"
},
"NumeroPedido": {
"description": "Número do pedido do tomador (infoCompl/xPed, até 60 caracteres).",
"type": [
"string",
"null"
]
},
"RegimeEspecialTributacao": {
"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",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"Valores": {
"additionalProperties": false,
"properties": {
"Aliquota": {
"description": "Alíquota do ISS (%).",
"type": "number"
},
"AliquotaIr": {
"type": [
"number",
"null"
]
},
"AliquotaSimplesNacional": {
"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).",
"type": [
"number",
"null"
]
},
"DescontoCondicionado": {
"type": "number"
},
"DescontoIncondicionado": {
"type": "number"
},
"OutrasRetencoes": {
"type": "number"
},
"TotalTributos": {
"type": "number"
},
"ValorDeducoes": {
"type": "number"
},
"ValorInss": {
"type": "number"
},
"ValorServico": {
"description": "Valor total do serviço prestado. DEVE ser maior que 0.",
"type": "number"
}
},
"required": [
"ValorServico"
],
"type": [
"object",
"null"
]
}
},
"required": [
"ItemListaServico"
],
"type": "object"
},
"Tomador": {
"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.",
"properties": {
"Contato": {
"additionalProperties": false,
"properties": {
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
},
"Telefone": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"CpfCnpj": {
"description": "Documento de identificação do tomador.",
"type": [
"string",
"null"
]
},
"Endereco": {
"additionalProperties": false,
"properties": {
"Bairro": {
"type": [
"string",
"null"
]
},
"Cep": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"CodPais": {
"default": 1058,
"type": "integer"
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Pais": {
"default": "BRASIL",
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"Im": {
"type": [
"string",
"null"
]
},
"NmTomador": {
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"Servico"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"TipoAmbiente",
"nFSInfo"
],
"type": "object"
},
"name": "nfse_emitir",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Base64XmlLote": {
"description": "Dados xml do lote, bytes em base64",
"type": [
"string",
"null"
]
},
"CodLote": {
"description": "Código atrelado ao lote; - Usado para busca de lotes",
"type": [
"string",
"null"
]
},
"CodTipoAmbiente": {
"description": "Código do ambiente de envio",
"type": "integer"
},
"DataRecebimento": {
"description": "Data de recebimento do lote;",
"type": [
"string",
"null"
]
},
"DsTipoAmbiente": {
"description": "Descrição do ambiente de envio",
"type": [
"string",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Lote": {
"description": "Número do lote enviado;",
"type": "integer"
},
"MunicipioEnvio": {
"description": "Municipio onde foi enviado",
"type": [
"string",
"null"
]
},
"Notas": {
"items": {
"additionalProperties": false,
"properties": {
"Base64Doc": {
"description": "Documento pdf da nfs, bytes em base64",
"type": [
"string",
"null"
]
},
"Base64Xml": {
"description": "Dados xml da nfs, bytes em base64",
"type": [
"string",
"null"
]
},
"Cancelada": {
"description": "Informa se a NFS-e encontra-se cancelada",
"type": "boolean"
},
"Chave": {
"description": "Chave da NFS-e",
"type": [
"string",
"null"
]
},
"CodVerificacao": {
"description": "Código de verificação da NFS-e",
"type": [
"string",
"null"
]
},
"CpfCnpjPrestador": {
"description": "Cpf ou Cnpj do Prestador",
"type": [
"string",
"null"
]
},
"CpfCnpjTomador": {
"description": "Cpf ou Cnpj do Tomador",
"type": [
"string",
"null"
]
},
"DtEmissao": {
"description": "Data da emissao da NFSe",
"type": "string"
},
"Erro": {
"description": "Descrição do erro caso a nota não for emitida",
"type": [
"string",
"null"
]
},
"IdentificadorInterno": {
"description": "Identificador interno da nfs (enviado pela API)",
"type": [
"string",
"null"
]
},
"NumeroNFSe": {
"description": "Número da NFS-e",
"type": [
"string",
"null"
]
},
"NumeroRPS": {
"description": "Número do RPS",
"type": "integer"
},
"Status": {
"description": "1 - NFSe Emitida; 3 - Erro ao emitir",
"enum": [
1,
3
],
"type": "integer"
},
"Valores": {
"additionalProperties": false,
"description": "Valores da NFS-e",
"properties": {
"Aliquota": {
"description": "Alíquota em %",
"type": "number"
},
"BaseCalculo": {
"description": "Base de cálculo",
"type": "number"
},
"ValorCOFINS": {
"description": "Valor COFINS",
"type": "number"
},
"ValorCSLL": {
"description": "Valor CSLL",
"type": "number"
},
"ValorIR": {
"description": "Valor IR",
"type": "number"
},
"ValorISS": {
"description": "Valor ISS",
"type": "number"
},
"ValorISSRetido": {
"description": "Valor ISS Retido",
"type": "number"
},
"ValorInss": {
"description": "Valor INSS retido (Contribuição Previdenciária - vRetCP no DPS nacional)",
"type": "number"
},
"ValorLiquido": {
"description": "Valor Líquido",
"type": "number"
},
"ValorPIS": {
"description": "Valor PIS",
"type": "number"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Protocolo": {
"description": "Número de protocolo do lote",
"type": [
"string",
"null"
]
},
"StatusLote": {
"description": "1 - Lote processado; 2 - Aguardando processamento; 3 - Ocorreu um erro ao processar o lote; 4 - Ocorreu um erro ao analisar as informações do lote",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"TempoRequisicaoPrefeitura": {
"description": "Tempo total da transmissão para prefeitura em milisegundos",
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"DtFim": {
"description": "Data final da busca",
"type": "string"
},
"DtInicio": {
"description": "Data inicial da busca",
"type": "string"
},
"IdentificadorInterno": {
"description": "Busca notas que possui o código interno informado (somente saídas)",
"type": [
"string",
"null"
]
},
"TipoAmbiente": {
"default": 1,
"description": "Tipo de ambiente (Padrão 1 - Produção) Valores: 1 - Produção; 2 - Homologação",
"enum": [
1,
2
],
"type": "integer"
},
"TipoDocumentoFiscal": {
"description": "Tipo do documento fiscal (Padrão 0 - Entrada) Valores: 0 - Entradas; 1 - Saídas",
"enum": [
0,
1
],
"type": "integer"
},
"TipoParticipacao": {
"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",
"enum": [
0,
1,
2
],
"type": "integer"
}
},
"type": "object"
},
"name": "nota_listar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em emissão bem-sucedida.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Error": {
"description": "Mensagem de erro da operação. Vazia (\"\") quando foi bem-sucedida.",
"type": [
"string",
"null"
]
},
"Notas": {
"items": {
"additionalProperties": false,
"properties": {
"Cfops": {
"type": [
"string",
"null"
]
},
"Chave": {
"type": [
"string",
"null"
]
},
"CnpjDestinatario": {
"type": [
"string",
"null"
]
},
"CnpjEmissor": {
"type": [
"string",
"null"
]
},
"CodLote": {
"type": [
"string",
"null"
]
},
"DigestValue": {
"type": [
"string",
"null"
]
},
"DtEmissao": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"DtRecebimento": {
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)",
"type": "string"
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"IeEmissor": {
"type": [
"string",
"null"
]
},
"ModeloDocumento": {
"description": "Modelo do documento fiscal Valores: 10 - Nota Fiscal de Serviço (NFS-e); 55 - Nota Fiscal Eletrônica (NF-e); 65 - 65 - Nota Fiscal de Consumidor (NFC-e); 57 - Conhecimento de Transporte Eletrônico (CT-e); 58 - Manifesto Eletrônico de Documentos Fiscais (MDF-e); 59 - Cupom Fiscal Eletrônico SAT (CFe SAT)",
"enum": [
10,
55,
65,
57,
58,
59
],
"type": "integer"
},
"NomeDestinatario": {
"type": [
"string",
"null"
]
},
"NomeEmissor": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": "integer"
},
"NumeroProtocolo": {
"type": [
"string",
"null"
]
},
"Serie": {
"type": [
"string",
"null"
]
},
"Status": {
"description": "Status da nota fiscal: Valores: 1 - Autorizado o uso; 2 - Documento Cancelado; 3 - Uso denegado",
"enum": [
1,
2,
3
],
"type": "integer"
},
"TipoParticipacao": {
"description": "Como a empresa participa da nota de entrada (somente TipoDocumentoFiscal = 0): Valores: 0 - Destinatário; 1 - Transportadora/terceiro citado na nota",
"enum": [
0,
1,
null
],
"type": [
"integer",
"null"
]
},
"Valor": {
"type": "number"
},
"ValorIcms": {
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Limite": {
"type": [
"integer",
"null"
]
},
"Offset": {
"type": [
"integer",
"null"
]
},
"Termo": {
"type": [
"string",
"null"
]
},
"TipoBusca": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "produto_consultar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Limite": {
"type": "integer"
},
"Matches": {
"items": {
"additionalProperties": false,
"properties": {
"Cest": {
"type": [
"string",
"null"
]
},
"Codigo": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Ean": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Ncm": {
"type": [
"string",
"null"
]
},
"QuantidadeEstoque": {
"type": [
"number",
"null"
]
},
"Score": {
"type": "number"
},
"UnidadeMedidaCompraSigla": {
"type": [
"string",
"null"
]
},
"UnidadeMedidaVendaSigla": {
"type": [
"string",
"null"
]
},
"ValorUnitarioVenda": {
"type": "number"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Offset": {
"type": "integer"
},
"TermoNormalizado": {
"type": [
"string",
"null"
]
},
"TipoDetectado": {
"type": [
"string",
"null"
]
},
"TotalGeral": {
"type": "integer"
},
"TotalLocal": {
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Cest": {
"type": [
"string",
"null"
]
},
"Codigo": {
"type": "string"
},
"Descricao": {
"type": "string"
},
"Ean": {
"type": [
"string",
"null"
]
},
"FatorConversao": {
"type": [
"number",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ncm": {
"type": [
"string",
"null"
]
},
"QuantidadeEstoque": {
"type": [
"number",
"null"
]
},
"UnidadeMedidaCompraSigla": {
"maxLength": 10,
"type": [
"string",
"null"
]
},
"UnidadeMedidaVendaSigla": {
"maxLength": 10,
"type": "string"
},
"ValorUnitarioVenda": {
"type": "number"
}
},
"required": [
"Codigo",
"Descricao",
"UnidadeMedidaVendaSigla",
"ValorUnitarioVenda"
],
"type": "object"
},
"name": "produto_criar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Produto": {
"additionalProperties": false,
"properties": {
"Cest": {
"type": [
"string",
"null"
]
},
"Codigo": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Ean": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Ncm": {
"type": [
"string",
"null"
]
},
"QuantidadeEstoque": {
"type": [
"number",
"null"
]
},
"Score": {
"type": "number"
},
"UnidadeMedidaCompraSigla": {
"type": [
"string",
"null"
]
},
"UnidadeMedidaVendaSigla": {
"type": [
"string",
"null"
]
},
"ValorUnitarioVenda": {
"type": "number"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"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).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Cest": {
"type": [
"string",
"null"
]
},
"Codigo": {
"type": "string"
},
"Descricao": {
"type": "string"
},
"Ean": {
"type": [
"string",
"null"
]
},
"FatorConversao": {
"type": [
"number",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ncm": {
"type": [
"string",
"null"
]
},
"QuantidadeEstoque": {
"type": [
"number",
"null"
]
},
"UnidadeMedidaCompraSigla": {
"maxLength": 10,
"type": [
"string",
"null"
]
},
"UnidadeMedidaVendaSigla": {
"maxLength": 10,
"type": "string"
},
"ValorUnitarioVenda": {
"type": "number"
}
},
"required": [
"Codigo",
"Descricao",
"UnidadeMedidaVendaSigla",
"ValorUnitarioVenda"
],
"type": "object"
},
"name": "produto_editar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Produto": {
"additionalProperties": false,
"properties": {
"Cest": {
"type": [
"string",
"null"
]
},
"Codigo": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Ean": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Ncm": {
"type": [
"string",
"null"
]
},
"QuantidadeEstoque": {
"type": [
"number",
"null"
]
},
"Score": {
"type": "number"
},
"UnidadeMedidaCompraSigla": {
"type": [
"string",
"null"
]
},
"UnidadeMedidaVendaSigla": {
"type": [
"string",
"null"
]
},
"ValorUnitarioVenda": {
"type": "number"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ModeloDocumento": {
"default": 55,
"description": "Modelo do documento fiscal usado para determinar o webservice de status da SEFAZ (Padrão 55). Valores: 55 - NF-e; 65 - NFC-e",
"enum": [
55,
65
],
"type": "integer"
}
},
"type": "object"
},
"name": "sefaz_status",
"outputSchema": {
"additionalProperties": false,
"properties": {
"CodEstadoEmitente": {
"type": "integer"
},
"CodStatusRespostaSefaz": {
"type": "integer"
},
"CodTipoAmbiente": {
"type": "integer"
},
"DsEstadoEmitente": {
"type": [
"string",
"null"
]
},
"DsStatusRespostaSefaz": {
"type": [
"string",
"null"
]
},
"DsTipoAmbiente": {
"type": [
"string",
"null"
]
},
"Versao": {
"type": [
"string",
"null"
]
},
"avisos": {
"description": "Avisos não bloqueantes. Pode vir preenchida mesmo em sucesso.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"erros": {
"description": "Lista de erros quando a operação falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.",
"items": {
"additionalProperties": false,
"properties": {
"codigo": {
"description": "Código do erro/rejeição (quando houver).",
"type": [
"string",
"null"
]
},
"correcao": {
"description": "Sugestão de correção, quando disponível.",
"type": [
"string",
"null"
]
},
"descricao": {
"description": "Descrição do erro.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"status": {
"description": "Status do resultado da operação: 1 = sucesso; 2 = erro (a lista erros é preenchida).",
"type": "integer"
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"Cfop": {
"type": [
"integer",
"null"
]
},
"Limite": {
"type": [
"integer",
"null"
]
},
"Offset": {
"type": [
"integer",
"null"
]
},
"Termo": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"name": "tributacao_consultar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Avisos": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"Limite": {
"type": "integer"
},
"Matches": {
"items": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"type": [
"number",
"null"
]
},
"AliqCofins": {
"type": "number"
},
"AliqIbsMun": {
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"type": [
"number",
"null"
]
},
"AliqIcms": {
"type": "number"
},
"AliqIpi": {
"type": [
"number",
"null"
]
},
"AliqPis": {
"type": "number"
},
"AliqReducao": {
"type": [
"number",
"null"
]
},
"ApiCode": {
"type": [
"string",
"null"
]
},
"AutoAliq": {
"type": "boolean"
},
"Cfop": {
"type": "integer"
},
"CstCofins": {
"type": [
"string",
"null"
]
},
"CstIbsCbs": {
"type": [
"string",
"null"
]
},
"CstIcms": {
"type": [
"string",
"null"
]
},
"CstIpi": {
"type": [
"string",
"null"
]
},
"CstPis": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": "integer"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"Offset": {
"type": "integer"
},
"Total": {
"type": "integer"
},
"TotalGeral": {
"type": "integer"
}
},
"type": "object"
}
},
{
"description": "Cadastra uma nova regra de tributacao (CFOP + CSTs + aliquotas). Tipo 1=NFe, 2=NFCe, 3=Energia/Comunicacao. CstIbsCbs e obrigatorio (Reforma Tributaria).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"type": [
"number",
"null"
]
},
"AliqCofins": {
"type": "number"
},
"AliqDiferimento": {
"type": [
"number",
"null"
]
},
"AliqIbsMun": {
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"type": [
"number",
"null"
]
},
"AliqIcms": {
"type": "number"
},
"AliqIpi": {
"type": [
"number",
"null"
]
},
"AliqPis": {
"type": "number"
},
"AliqReducao": {
"type": [
"number",
"null"
]
},
"ApiCode": {
"type": [
"string",
"null"
]
},
"AutoAliq": {
"type": "boolean"
},
"Cfop": {
"type": "integer"
},
"CodBeneficioFiscal": {
"type": [
"string",
"null"
]
},
"CstCofins": {
"type": [
"string",
"null"
]
},
"CstIbsCbs": {
"type": [
"string",
"null"
]
},
"CstIcms": {
"type": [
"string",
"null"
]
},
"CstIpi": {
"type": [
"string",
"null"
]
},
"CstPis": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": "string"
},
"EnquadramentoIpi": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": "integer"
}
},
"required": [
"Cfop",
"Descricao"
],
"type": "object"
},
"name": "tributacao_criar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Tributacao": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"type": [
"number",
"null"
]
},
"AliqCofins": {
"type": "number"
},
"AliqIbsMun": {
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"type": [
"number",
"null"
]
},
"AliqIcms": {
"type": "number"
},
"AliqIpi": {
"type": [
"number",
"null"
]
},
"AliqPis": {
"type": "number"
},
"AliqReducao": {
"type": [
"number",
"null"
]
},
"ApiCode": {
"type": [
"string",
"null"
]
},
"AutoAliq": {
"type": "boolean"
},
"Cfop": {
"type": "integer"
},
"CstCofins": {
"type": [
"string",
"null"
]
},
"CstIbsCbs": {
"type": [
"string",
"null"
]
},
"CstIcms": {
"type": [
"string",
"null"
]
},
"CstIpi": {
"type": [
"string",
"null"
]
},
"CstPis": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
},
{
"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.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"type": [
"number",
"null"
]
},
"AliqCofins": {
"type": "number"
},
"AliqDiferimento": {
"type": [
"number",
"null"
]
},
"AliqIbsMun": {
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"type": [
"number",
"null"
]
},
"AliqIcms": {
"type": "number"
},
"AliqIpi": {
"type": [
"number",
"null"
]
},
"AliqPis": {
"type": "number"
},
"AliqReducao": {
"type": [
"number",
"null"
]
},
"ApiCode": {
"type": [
"string",
"null"
]
},
"AutoAliq": {
"type": "boolean"
},
"Cfop": {
"type": "integer"
},
"CodBeneficioFiscal": {
"type": [
"string",
"null"
]
},
"CstCofins": {
"type": [
"string",
"null"
]
},
"CstIbsCbs": {
"type": [
"string",
"null"
]
},
"CstIcms": {
"type": [
"string",
"null"
]
},
"CstIpi": {
"type": [
"string",
"null"
]
},
"CstPis": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": "string"
},
"EnquadramentoIpi": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": "integer"
}
},
"required": [
"Cfop",
"Descricao"
],
"type": "object"
},
"name": "tributacao_editar",
"outputSchema": {
"additionalProperties": false,
"properties": {
"Erro": {
"type": [
"string",
"null"
]
},
"Id": {
"type": [
"integer",
"null"
]
},
"Ok": {
"type": "boolean"
},
"Tributacao": {
"additionalProperties": false,
"properties": {
"AliqCbs": {
"type": [
"number",
"null"
]
},
"AliqCofins": {
"type": "number"
},
"AliqIbsMun": {
"type": [
"number",
"null"
]
},
"AliqIbsUf": {
"type": [
"number",
"null"
]
},
"AliqIcms": {
"type": "number"
},
"AliqIpi": {
"type": [
"number",
"null"
]
},
"AliqPis": {
"type": "number"
},
"AliqReducao": {
"type": [
"number",
"null"
]
},
"ApiCode": {
"type": [
"string",
"null"
]
},
"AutoAliq": {
"type": "boolean"
},
"Cfop": {
"type": "integer"
},
"CstCofins": {
"type": [
"string",
"null"
]
},
"CstIbsCbs": {
"type": [
"string",
"null"
]
},
"CstIcms": {
"type": [
"string",
"null"
]
},
"CstIpi": {
"type": [
"string",
"null"
]
},
"CstPis": {
"type": [
"string",
"null"
]
},
"Descricao": {
"type": [
"string",
"null"
]
},
"Id": {
"type": "integer"
},
"Observacao": {
"type": [
"string",
"null"
]
},
"Tipo": {
"type": "integer"
}
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:1af5ee7aaf07a2b853bf2315f99f17b17b1a6790181ca3af168a7640ad145f2c | sha256sum