Raw schema
{
"type": "object",
"properties": {
"notaFiscal": {
"type": [
"object",
"null"
],
"properties": {
"TipoAmbiente": {
"type": "integer",
"enum": [
1,
2
],
"description": "Identificação do Ambiente Valores: 1 - Produção; 2 - Homologação"
},
"ModeloDocumento": {
"type": "integer",
"enum": [
55,
65
],
"description": "Código do modelo do Documento Fiscal (Padrão 55) Valores: 55 - NF-e; 65 - NFC-e",
"default": 55
},
"Lote": {
"type": [
"integer",
"null"
],
"description": "Lote da Nota Fiscal"
},
"nFInfos": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"Serie": {
"type": [
"integer",
"null"
],
"description": "Série da nota Fiscal"
},
"Numero": {
"type": [
"integer",
"null"
],
"description": "Número da nota fiscal"
},
"Lote": {
"type": [
"integer",
"null"
],
"description": "Lote da Nota Fiscal"
},
"DataEntradaSaida": {
"type": [
"string",
"null"
],
"description": "Data e Hora da saída ou de entrada da produto/serviço"
},
"DataEmissao": {
"type": [
"string",
"null"
],
"description": "Data e Hora da saída ou de entrada da produto/serviço (Envia a data atual caso não informada)"
},
"Codigo": {
"type": [
"string",
"null"
],
"description": "B03 - Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e."
},
"Justificativa": {
"type": [
"string",
"null"
],
"description": "Utilizar quando o tipo de emissão for diferente normal"
},
"NFReferencia": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Notas fiscal de Referência"
},
"IndicadorPresenca": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
9
],
"description": "Indicador de presença do comprador no estabelecimento comercial no momento da operação. Padrão sugerido para NF-e B2B = 9 (operação não presencial, outros). Para NFC-e varejo = 1 (presencial). Valores: 0 - Não se aplica; 1 - Operação presencial;; 2 - Operação não presencial, pela Internet;; 3 - Operação não presencial, Teleatendimento;; 4 - NFC-e em operação com entrega a domicílio;; 5 - Presencial fora do estabelecimento;; 9 - Operação não presencial, outros.",
"default": 9
},
"Intermediador": {
"type": [
"object",
"null"
],
"properties": {
"Cnpj": {
"type": "string",
"description": "CNPJ do intermediador da transação (marketplace/plataforma de terceiros). Obrigatório."
},
"IdCadIntTran": {
"type": "string",
"description": "Identificação do vendedor no site do intermediador (usuário/login cadastrado). Obrigatório."
}
},
"additionalProperties": false,
"required": [
"Cnpj",
"IdCadIntTran"
],
"description": "Dados do intermediador/marketplace (site ou plataforma de terceiros)."
},
"ConsumidorFinal": {
"type": "boolean",
"description": "Indica operação com Consumidor final (NFCe de ser 1 Validar!)"
},
"CalcularIBPT": {
"type": "boolean",
"description": "Indica operação com Consumidor final (NFCe de ser 1 Validar!)",
"default": true
},
"NaturezaOperacao": {
"type": "string",
"description": "Descrição da natureza da operação (máx 60 caracteres). Exemplos: \"Venda de mercadoria\", \"Remessa para industrialização\", \"Devolução de venda\"."
},
"ModeloDocumento": {
"type": "integer",
"enum": [
55,
65
],
"description": "Código do modelo do Documento Fiscal. Valores: 55 - NF-e (B2B / com destinatário CPF/CNPJ identificado); 65 - NFC-e (consumidor final / varejo)",
"default": 55
},
"Finalidade": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"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",
"default": 1
},
"TipoAmbiente": {
"type": "integer",
"enum": [
1,
2
],
"description": "Identificação do ambiente da SEFAZ. Valores: 1 - Produção (emissão REAL, com valor fiscal, irreversível); 2 - Homologação (teste, sem valor fiscal - use durante desenvolvimento e testes)",
"default": 2
},
"Observacao": {
"type": [
"string",
"null"
]
},
"ObservacaoFisco": {
"type": [
"string",
"null"
]
},
"IdentificadorInterno": {
"type": [
"string",
"null"
]
},
"EnviarEmail": {
"type": "boolean"
},
"Cliente": {
"type": [
"object",
"null"
],
"properties": {
"CpfCnpj": {
"type": "string",
"description": "CPF (11 dígitos) ou CNPJ (14 dígitos) do destinatário. Aceita com ou sem máscara - o sistema normaliza. Obrigatório para NF-e (modelo 55). Em operações de exportação (CFOP iniciado em 3/7) pode ter de 5 a 20 caracteres."
},
"NmCliente": {
"type": "string",
"description": "Nome/Razão Social do destinatário (máx 60 caracteres). Obrigatório para NF-e (modelo 55)."
},
"IndicadorIe": {
"type": "integer",
"enum": [
1,
2,
9
],
"description": "Indicador de Inscrição Estadual. Para NFC-e (modelo 65) DEVE ser 9. Para NF-e (modelo 55) aceita 1, 2 ou 9. Valores: 1 - Contribuinte ICMS (informar a IE do destinatário); 2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS; 9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS",
"default": 9
},
"Ie": {
"type": [
"string",
"null"
]
},
"IsUf": {
"type": [
"string",
"null"
]
},
"Endereco": {
"type": [
"object",
"null"
],
"properties": {
"Cep": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Bairro": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
},
"CodPais": {
"type": "integer",
"default": 1058
},
"Pais": {
"type": [
"string",
"null"
],
"default": "BRASIL"
}
},
"additionalProperties": false
},
"Contato": {
"type": [
"object",
"null"
],
"properties": {
"Telefone": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"CpfCnpj",
"NmCliente"
],
"description": "Destinatário da nota. OBRIGATÓRIO para NF-e (modelo 55). Para NFC-e (modelo 65) só é obrigatório quando IndicadorPresenca = 4 (entrega a domicílio). Quando informado para NF-e mod 55, exige: CpfCnpj, NmCliente, IndicadorIe (1/2/9), Endereco com Logradouro e UF (e CEP/Município/Bairro quando não exportação)."
},
"Produtos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NmProduto": {
"type": "string",
"description": "Descrição do produto (máx 120 caracteres). Exemplo: \"Detergente IPE 500ML\"."
},
"CodProdutoServico": {
"type": "string",
"description": "Código/SKU INTERNO do produto no cadastro da empresa (1-60 caracteres alfanuméricos). NÃO usar NCM, CFOP, EAN, GTIN nem códigos da Receita aqui - cada um tem campo próprio (NCM, CFOP, EAN). Exemplos válidos: \"PROD-001\", \"DETIPE500\", \"SKU12345\". Se a empresa não usa SKU interno, repita o EAN ou use \"1\"."
},
"EAN": {
"type": [
"string",
"null"
],
"description": "GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras (8, 12, 13 ou 14 dígitos). Quando o produto não tem GTIN cadastrado, informe a string \"SEM GTIN\" (literal). Não usar como código interno."
},
"NCM": {
"type": "string",
"description": "Código NCM com exatamente 8 dígitos (Nomenclatura Comum do Mercosul). Identifica a classificação fiscal do produto na Receita. NÃO é o código interno - código interno vai em CodProdutoServico. Para serviços ou itens sem produto físico (transferência de crédito, etc.), use \"00000000\"."
},
"CEST": {
"type": [
"string",
"null"
],
"description": "Código CEST (7 dígitos). Obrigatório quando o CST/CSOSN do ICMS indicar substituição tributária (rejeição 806 da SEFAZ). Consulte a tabela CEST oficial pelo NCM do produto."
},
"Quantidade": {
"type": "number",
"description": "Quantidade comercial do produto. Aceita de 0 a 4 casas decimais e até 11 inteiros. Deve ser maior que zero (exceto para finalidade 2 - Complementar e 3 - Ajuste)."
},
"QuantidadeTributavel": {
"type": [
"number",
"null"
],
"description": "Quantidade Comercial do produto tributável, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros."
},
"UnidadeComercial": {
"type": "string",
"description": "Unidade comercial / unidade de medida (máx 6 caracteres). Exemplos: \"UN\", \"PC\", \"KG\", \"L\", \"CX\", \"M2\"."
},
"UnidadeComercialTributavel": {
"type": [
"string",
"null"
],
"description": "Unidade comercial tributável (quando diferente da comercial - máx 6 caracteres). Geralmente igual a UnidadeComercial."
},
"ValorDesconto": {
"type": "number",
"description": "Valor do desconto aplicado no item (>= 0 e nunca maior que ValorTotal)."
},
"ValorUnitario": {
"type": "number",
"description": "Valor unitário do produto (>= 0). Aceita até 10 casas decimais."
},
"ValorUnitarioTributavel": {
"type": [
"number",
"null"
],
"description": "Valor unitário tributável (quando diferente do comercial). Geralmente igual a ValorUnitario."
},
"ValorTotal": {
"type": "number",
"description": "Valor total bruto do item (Quantidade * ValorUnitario). >= 0. Para finalidade 1 - Normal deve ser > 0."
},
"ValorSeguro": {
"type": [
"number",
"null"
],
"description": "Valor Seguro"
},
"ValorFrete": {
"type": [
"number",
"null"
],
"description": "Valor Frete"
},
"ValorOutrasDespesas": {
"type": [
"number",
"null"
],
"description": "Valor Outras Despesas"
},
"CFOP": {
"type": "integer",
"description": "Código Fiscal de Operações e Prestações (CFOP). Exatamente 4 dígitos. Primeiro dígito indica a natureza: 1/2/3 = entrada (interna/interestadual/exterior), 5/6/7 = saída (interna/interestadual/exterior). Para NFC-e (modelo 65) só são aceitos: 5101, 5102, 5103, 5104, 5115, 5405, 5656, 5667, 5933 (rejeição 725)."
},
"NItemPed": {
"type": [
"integer",
"null"
],
"description": "Número do item do Pedido de Compra"
},
"xPed": {
"type": [
"string",
"null"
],
"description": "Número do Pedido de Compra"
},
"ChaveAcessoReferenciada": {
"type": [
"string",
"null"
],
"description": "Chave de acesso (44 dígitos) da NF-e ORIGINAL que este item está devolvendo. Usado apenas em NF-e de devolução (Finalidade = 4, Reforma Tributária / NT 2025.002). Quando preenchida, o item é referenciado pelo grupo DFeReferenciado (por item) em vez do NFReferencia (nível nota) - os dois não podem coexistir."
},
"NItemReferenciado": {
"type": [
"integer",
"null"
],
"description": "Número do item (nItem) na NF-e ORIGINAL a que este item de devolução corresponde. É o número do item na nota de venda original, NÃO o número do item nesta devolução. Opcional; acompanha ChaveAcessoReferenciada."
},
"nFCI": {
"type": [
"string",
"null"
],
"description": "Número de controle da FCI - Ficha de Conteúdo de Importação"
},
"cBenef": {
"type": [
"string",
"null"
],
"description": "Código de Beneficio Fiscal na UF"
},
"InformacaoAdicional": {
"type": [
"string",
"null"
],
"description": "Informaçoes adicional"
},
"OrigemProduto": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"description": "Origem do produto (Tabela A da NF-e). Padrão para a maioria dos casos = 0 (nacional). Valores: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; 1 - Estrangeira - Importação direta, exceto a indicada no código 6; 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7; 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%; 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes; 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural; 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural; 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%",
"default": 0
},
"CodTributacao": {
"type": [
"string",
"null"
],
"description": "Código do grupo tributário pré-cadastrado no Painel. Quando informado, o sistema aplica automaticamente CFOP, CST, ICMS, IPI, PIS e COFINS do grupo, dispensando o preenchimento do bloco Imposto e do CFOP do item."
},
"Imposto": {
"type": "object",
"properties": {
"IBSCBS": {
"type": [
"object",
"null"
],
"properties": {
"CodClassificacaoTributaria": {
"type": [
"string",
"null"
],
"description": "Código de Classificação Tributária (Padrão 000001)"
},
"BaseCalculo": {
"type": [
"number",
"null"
],
"description": "Base de cálculo"
},
"AliquotaIBSUF": {
"type": [
"number",
"null"
],
"description": "Alíquota do IBS de competência das UF"
},
"AliquotaIBSMun": {
"type": [
"number",
"null"
],
"description": "Alíquota do IBS de competência do Município"
},
"AliquotaCBS": {
"type": [
"number",
"null"
],
"description": "Alíquota da CBS"
},
"PercentualReducaoIBS": {
"type": [
"number",
"null"
],
"description": "Percentual de redução da alíquota do IBS (pRedAliq de gIBSUF/gIBSMun), usado no grupo gRed dos CST 011/200/515. Fixo por cClassTrib na tabela oficial (ex.: 100 para 200003 alimentação/Anexo I, 60 para educação/saúde). Quando null, é preenchido automaticamente pela tabela oficial (TabelaReducaoIbsCbs)."
},
"PercentualReducaoCBS": {
"type": [
"number",
"null"
],
"description": "Percentual de redução da alíquota da CBS (pRedAliq de gCBS). Pode divergir de PercentualReducaoIBS (ex.: 200025 = IBS 60 / CBS 100). Quando null, é preenchido automaticamente pela tabela oficial."
},
"PercentualDiferimento": {
"type": [
"number",
"null"
],
"description": "Percentual de diferimento (pDif do grupo gDif), usado nos CST 510/515. Informado pelo contribuinte - NÃO é fixo por cClassTrib. O valor diferido (vDif) é deduzido do IBS/CBS devido."
}
},
"additionalProperties": false
},
"ICMS": {
"type": [
"object",
"null"
],
"properties": {
"CodSituacaoTributaria": {
"type": "string",
"description": "Código da Situação Tributária (CST) do ICMS, OU Código de Situação da Operação no Simples Nacional (CSOSN). Para empresas no Simples Nacional (CRT 1) ou MEI (CRT 4) use CSOSN: \"101\",\"102\",\"103\",\"201\",\"202\",\"203\",\"300\",\"400\",\"500\",\"900\". Para empresas em Regime Normal (CRT 3) use CST do ICMS: \"00\",\"10\",\"20\",\"30\",\"40\",\"41\",\"50\",\"51\",\"60\",\"70\",\"90\"."
},
"AliquotaICMS": {
"type": [
"number",
"null"
],
"description": "Alíquota ICMS - Obrigatório para situação tributária nº 101 e 201"
},
"AliquotaICMSST": {
"type": [
"number",
"null"
],
"description": "Alíquota ICMS ST - Obrigatório para situação tributária nº 101 e 201"
},
"AliquotaMVA": {
"type": [
"number",
"null"
],
"description": "Alíquota - Obrigatório para situação tributária nº 201, 202 e 203"
},
"AliquotaCredito": {
"type": [
"number",
"null"
],
"description": "Alíquota aplicável de cálculo de crédito - Obrigatório para situação tributária nº 101 e 201"
},
"RedICMS": {
"type": [
"number",
"null"
],
"description": "Redução ICMS"
},
"RedICMSST": {
"type": [
"number",
"null"
],
"description": "Redução ICMS ST"
},
"BaseCalculo": {
"type": [
"number",
"null"
],
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)"
},
"ValorIcms": {
"type": [
"number",
"null"
],
"description": "Valor do Icms (Calculado Automaticamente quando não informado)"
},
"motivoDesoneracaoIcms": {
"type": [
"integer",
"null"
],
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
16,
null
],
"description": "1 - Táxi;; 2 - Deficiente Físico;; 3 - Produtor Agropecuário;; 4 - Frotista / Locadora;; 5 - Diplomático / Consular;; 6 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações);; 7 - SUFRAMA; 8 - Venda a Orgãos Publicos; 9 - Outros. (v2.0); 10 - Deficiente Condutor (Convênio ICMS 38/12). (v3.1); 11 - Deficiente não Condutor (Convênio ICMS 38/12). (v3.1); 16 - Olimpíadas Rio 2016"
},
"valorDesoneracaoIcms": {
"type": [
"number",
"null"
]
},
"aliquotaDiferimento": {
"type": [
"number",
"null"
],
"description": "Percentual de diferimento (Utilizado somente no CST 51)"
},
"modalidadeBcIcms": {
"type": "integer",
"enum": [
0,
1,
2,
3
],
"description": "0 - Margem Valor Agregado (%); 1 - Pauta (valor); 2 - Preço Tabelado Máximo (valor); 3 - Valor da Operação"
},
"STRetido": {
"type": [
"object",
"null"
],
"properties": {
"BaseCalculo": {
"type": [
"number",
"null"
],
"description": "vBCSTRet - Base de cálculo do ICMS-ST retido na operação anterior."
},
"AliquotaConsumidorFinal": {
"type": [
"number",
"null"
],
"description": "pST - Alíquota suportada pelo consumidor final (alíquota interna do destino + FCP)."
},
"ValorICMSSubstituto": {
"type": [
"number",
"null"
],
"description": "vICMSSubstituto - Valor do ICMS próprio do substituto cobrado na operação anterior."
},
"ValorICMSST": {
"type": [
"number",
"null"
],
"description": "vICMSSTRet - Valor do ICMS-ST retido na operação anterior. Opcional: quando não informado, é calculado por (BaseCalculo x AliquotaConsumidorFinal / 100 - ValorICMSSubstituto). Informe o valor fiel da nota de entrada quando ele divergir da fórmula padrão."
},
"BaseCalculoFCP": {
"type": [
"number",
"null"
],
"description": "vBCFCPSTRet - Base de cálculo do FCP retido por ST na operação anterior."
},
"AliquotaFCP": {
"type": [
"number",
"null"
],
"description": "pFCPSTRet - Alíquota do FCP retido por ST na operação anterior. O valor (vFCPSTRet) é calculado automaticamente por BaseCalculoFCP x AliquotaFCP / 100."
},
"PercentualReducaoBaseEfetiva": {
"type": [
"number",
"null"
],
"description": "pRedBCEfet - Percentual de redução da base de cálculo efetiva (consumidor final)."
},
"BaseCalculoEfetiva": {
"type": [
"number",
"null"
],
"description": "vBCEfet - Base de cálculo efetiva (consumidor final). Opcional: quando não informada, é calculada por (ValorTotal + frete + seguro + outras despesas - desconto) x (1 - PercentualReducaoBaseEfetiva/100). Informe o valor fiel quando a composição da base divergir."
},
"AliquotaEfetiva": {
"type": [
"number",
"null"
],
"description": "pICMSEfet - Alíquota do ICMS efetiva (consumidor final). O valor (vICMSEfet) é calculado automaticamente por BaseCalculoEfetiva x AliquotaEfetiva / 100."
}
},
"additionalProperties": false,
"description": "Grupo de ICMS-ST retido em operação anterior. Preencher SOMENTE em CST 60 ou CSOSN 500 (revenda de mercadoria cujo ICMS-ST já foi retido por substituição tributária). Quando informado, prevalece sobre a estimativa automática derivada da configuração de ST do produto."
},
"AliquotaAdRemRetido": {
"type": [
"number",
"null"
],
"description": "adRemICMSRet - Alíquota ad rem do ICMS retido anteriormente. Obrigatório no CST 61 (tributação monofásica sobre combustíveis cobrada anteriormente)."
},
"QuantidadeMonoRetido": {
"type": [
"number",
"null"
],
"description": "qBCMonoRet - Quantidade tributada retida anteriormente (em unidade de medida da legislação). Opcional no CST 61. Quando não informada, assume a quantidade comercial do item."
},
"ValorIcmsMonoRetido": {
"type": [
"number",
"null"
],
"description": "vICMSMonoRet - Valor do ICMS retido anteriormente no CST 61. Opcional: quando não informado, é calculado por QuantidadeMonoRetido x AliquotaAdRemRetido."
}
},
"additionalProperties": false,
"required": [
"CodSituacaoTributaria"
]
},
"IPI": {
"type": [
"object",
"null"
],
"properties": {
"CodEnquadramento": {
"type": "string",
"description": "Código de Enquadramento Legal do IPI - EXATAMENTE 3 dígitos (com zeros à esquerda se necessário). Para a maioria dos casos não imunes/suspensos use \"999\" (tributação normal sem enquadramento especial). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."
},
"CodSituacaoTributaria": {
"type": "string",
"description": "CST do IPI. Valores: \"00\",\"49\",\"50\",\"99\" (saída tributada/não tributada/isenta/outras saídas) ou \"01\",\"02\",\"03\",\"04\",\"05\",\"51\",\"52\",\"53\",\"54\",\"55\" (entradas - usar conforme o caso). Obrigatório para NF-e (modelo 55). Dispensado para NFC-e (modelo 65)."
},
"Aliquota": {
"type": "number",
"description": "Aliquota do IPI"
},
"ValorIpiDevolvido": {
"type": "number",
"description": "Valor do IPI devolvido"
},
"PercentualMercadoriaDevolvida": {
"type": "number",
"description": "Percentual da mercadoria devolvida"
}
},
"additionalProperties": false,
"required": [
"CodEnquadramento",
"CodSituacaoTributaria"
]
},
"PIS": {
"type": [
"object",
"null"
],
"properties": {
"CodSituacaoTributaria": {
"type": "string",
"description": "CST do PIS (Tabela II - Situação Tributária do PIS). Valores válidos: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\" (entradas) e \"49\",\"50\",\"51\",\"52\",\"53\",\"54\",\"55\",\"56\",\"60\",\"61\",\"62\",\"63\",\"64\",\"65\",\"66\",\"67\",\"70\",\"71\",\"72\",\"73\",\"74\",\"75\",\"98\",\"99\" (saídas/outras). O CST precisa ser compatível com o tipo de NF (entrada quando CFOP começa com 1/2/3, saída quando começa com 5/6/7)."
},
"Aliquota": {
"type": "number",
"description": "Aliquota do PIS"
},
"BaseCalculo": {
"type": [
"number",
"null"
],
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)"
}
},
"additionalProperties": false,
"required": [
"CodSituacaoTributaria"
]
},
"COFINS": {
"type": [
"object",
"null"
],
"properties": {
"CodSituacaoTributaria": {
"type": "string",
"description": "CST do COFINS (mesma tabela do PIS - Tabela II). Geralmente é o MESMO valor usado no PIS. O CST precisa ser compatível com o tipo de NF (entrada/saída) conforme o CFOP do item."
},
"Aliquota": {
"type": "number",
"description": "Aliquota do COFINS"
},
"BaseCalculo": {
"type": [
"number",
"null"
],
"description": "Base de Cálculo (Quando não informado, é o valor dos produtos)"
}
},
"additionalProperties": false,
"required": [
"CodSituacaoTributaria"
]
},
"Importacao": {
"type": [
"object",
"null"
],
"properties": {
"BaseCalculo": {
"type": "number"
},
"DespesasAduaneiras": {
"type": "number"
},
"Valor": {
"type": "number"
},
"ValorIOF": {
"type": "number"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"description": "Tributação do item (ICMS / IPI / PIS / COFINS / IBSCBS / Importação). OBRIGATÓRIO a menos que CodTributacao esteja preenchido - nesse caso pode omitir este bloco. Para NF-e (modelo 55): ICMS + IPI + PIS + COFINS são todos obrigatórios e validados em conjunto. Para NFC-e (modelo 65): ICMS + PIS + COFINS obrigatórios; IPI dispensado."
},
"Combustivel": {
"type": [
"object",
"null"
],
"properties": {
"CodProdutoANP": {
"type": [
"string",
"null"
]
},
"DescricaoProdutoANP": {
"type": [
"string",
"null"
]
},
"UFConsumo": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"DeclaracaoImportacao": {
"type": [
"object",
"null"
],
"properties": {
"Numero": {
"type": [
"string",
"null"
],
"description": "Número do Documento de Importação (DI, DSI, DIRE, ...)"
},
"DataRegistro": {
"type": "string",
"description": "Data de Registro do documento de importação"
},
"LocalDesenbaraco": {
"type": [
"string",
"null"
],
"description": "Local de Desembaraço Aduaneiro"
},
"UfDesenbaraco": {
"type": [
"string",
"null"
],
"description": "Sigla da UF onde ocorreu o Desembaraço Aduaneiro"
},
"DataDesenbaraco": {
"type": "string",
"description": "Data do Desembaraço Aduaneiro"
},
"TipoViaTransporte": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"description": "Via de transporte internacional informada na Declaração de Importação (DI) Valores: 1 - Marítima; 2 - Fluvial; 3 - Lacustre; 4 - Aérea; 5 - Postal; 6 - Ferroviária; 7 - Rodoviária; 8 - Conduto / Rede Transmissão; 9 - Meios Próprios; 10 - Entrada / Saída ficta; 11 - Courier; 12 - Handcarry"
},
"ValorAFRMM": {
"type": [
"number",
"null"
],
"description": "Valor da AFRMM - Adicional ao Frete para Renovação da Marinha Mercante"
},
"TipoIntermedio": {
"type": "integer",
"enum": [
1,
2,
3
],
"description": "Forma de importação quanto a intermediação Valores: 1 - Importação por conta própria; 2 - Importação por conta e ordem; 3 - Importação por encomenda"
},
"Cnpj": {
"type": [
"string",
"null"
],
"description": "CNPJ do adquirente ou do encomendante"
},
"Uf": {
"type": [
"string",
"null"
],
"description": "Sigla da UF do adquirente ou do encomendante"
},
"CodExportador": {
"type": [
"string",
"null"
],
"description": "Código do Exportador"
},
"CodFabricante": {
"type": [
"string",
"null"
],
"description": "Código do Fabricante Extrangeiro"
}
},
"additionalProperties": false
},
"Rastros": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"NumeroLote": {
"type": [
"string",
"null"
],
"description": "Número do lote do produto (1-20 caracteres)"
},
"QuantidadeLote": {
"type": "number",
"description": "Quantidade de produto no lote"
},
"DataFabricacao": {
"type": "string",
"description": "Data de fabricação/produção"
},
"DataValidade": {
"type": "string",
"description": "Data de validade"
},
"CodigoAgregacao": {
"type": [
"string",
"null"
],
"description": "Código de agregação (opcional)"
}
},
"additionalProperties": false
},
"description": "Rastreabilidade do produto (lote, validade, fabricação). Comum para medicamentos, agrotóxicos, bebidas."
},
"Agropecuaria": {
"type": [
"object",
"null"
],
"properties": {
"Defensivos": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"NumeroReceituario": {
"type": "string",
"description": "Número da receita ou receituário do agrotóxico/defensivo agrícola (1-30 caracteres)."
},
"CpfResponsavelTecnico": {
"type": "string",
"description": "CPF (11 dígitos) do engenheiro agrônomo, florestal ou técnico agrícola responsável."
}
},
"additionalProperties": false,
"required": [
"NumeroReceituario",
"CpfResponsavelTecnico"
]
},
"description": "Defensivos agrícolas aplicados (0 a 20). Cada item exige NumeroReceituario e CpfResponsavelTecnico."
},
"GuiaTransito": {
"type": [
"object",
"null"
],
"properties": {
"TipoGuia": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"description": "Tipo da guia de trânsito. Valores: 1 - GTA (Guia de Trânsito Animal); 2 - TTA (Termo de Trânsito Animal); 3 - DTA (Documento de Transferência Animal); 4 - ATV (Autorização de Trânsito Vegetal); 5 - PTV (Permissão de Trânsito Vegetal); 6 - GTV (Guia de Trânsito Vegetal); 7 - Guia Florestal (DOF, SisFlora-PA/MT, SIAM-MG)"
},
"UfGuia": {
"type": "string",
"description": "Sigla da UF emissora da guia (2 caracteres)."
},
"SerieGuia": {
"type": [
"string",
"null"
],
"description": "Série da guia (1-9 dígitos). Opcional."
},
"NumeroGuia": {
"type": "string",
"description": "Número da guia (1-9 dígitos)."
}
},
"additionalProperties": false,
"required": [
"TipoGuia",
"UfGuia",
"NumeroGuia"
],
"description": "Guia de trânsito que autoriza o transporte sanitário do animal, vegetal ou produto florestal."
}
},
"additionalProperties": false,
"description": "Informações de produtos agropecuários e florestais (NT 2024.003 - Grupo ZF). Obrigatório a partir de 01/03/2026 quando o NCM cair em: 01XXXXXX / 0301XXXX (animais vivos - GuiaTransito), 06-12XXXX (vegetais primários - GuiaTransito, UFs ainda inativas), 3808.52 a 3808.99 (defensivos - Defensivos). Já obrigatório em BA, GO, MA, MT para NCM 0102XXXX (bovinos) desde 01/10/2025."
}
},
"additionalProperties": false,
"required": [
"NmProduto",
"CodProdutoServico",
"NCM",
"Quantidade",
"UnidadeComercial",
"ValorUnitario",
"ValorTotal",
"CFOP",
"OrigemProduto",
"Imposto"
]
},
"description": "Itens da nota fiscal. Mínimo 1 item."
},
"Pagamentos": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"IndicadorPagamento": {
"type": "integer",
"description": "0 - A vista, 1 - Prazo"
},
"Desconto": {
"type": "number"
},
"Descricao": {
"type": [
"string",
"null"
]
},
"FormaPagamento": {
"type": [
"string",
"null"
],
"enum": [
"01",
"02",
"03",
"04",
"05",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"90",
"91",
"99",
null
],
"description": "01 - Dinheiro; 02 - Cheque; 03 - Cartão de Crédito; 04 - Cartão de Débito; 05 - Cartão da Loja (Private Label), Crediário Digital, Outros Crediários; 10 - Vale Alimentação; 11 - Vale Refeição; 12 - Vale Presente; 13 - Vale Combustível; 14 - Duplicata Mercantil; 15 - Boleto Bancário; 16 - Depósito Bancário; 17 - Pagamento Instantâneo (PIX) - Dinâmico; 18 - Transferência Bancária, Carteira Digital; 19 - Programa de fidelidade, cashback, crédito virtual; 20 - Pagamento Instantâneo (PIX) - Estático; 21 - Crédito em Loja; 22 - Pagamento Eletrônico não Informado - falha de hardware; 23 - Pagamento Instantâneo (PIX) - Automático; 24 - TEF Book Transfer; 90 - Sem pagamento; 91 - Pagamento Posterior; 99 - Outros"
},
"VlPago": {
"type": "number"
},
"VlTroco": {
"type": "number"
},
"TipoIntegracao": {
"type": "boolean",
"description": "Pagamento integrado com automação?"
},
"CNPJCredenciadora": {
"type": [
"string",
"null"
]
},
"BandeiraOperadora": {
"type": [
"string",
"null"
],
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09",
"99",
null
],
"description": "01 - Visa; 02 - Mastercard; 03 - American Express; 04 - Sorocred; 05 - Diners Club; 06 - Elo; 07 - Hipercard; 08 - Aura; 09 - Cabal; 99 - Outros"
},
"NumeroAutorizacao": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"description": "Formas de pagamento. OBRIGATÓRIO quando Finalidade = 1 (Normal). Para finalidades 2/3/4 pode ficar vazio. Para NFC-e (mod 65) deve haver pelo menos um pagamento com FormaPagamento diferente de \"90\" (sem pagamento)."
},
"Cobranca": {
"type": [
"object",
"null"
],
"properties": {
"Fatura": {
"type": [
"object",
"null"
],
"properties": {
"Numero": {
"type": [
"string",
"null"
]
},
"Valor": {
"type": "number"
},
"Desconto": {
"type": "number"
},
"ValorLiquido": {
"type": "number"
}
},
"additionalProperties": false
},
"Parcelas": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"Vencimento": {
"type": [
"string",
"null"
],
"description": "Data/hora ISO 8601 (ex: 2026-07-22T13:45:00-03:00)"
},
"Valor": {
"type": "number"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Transporte": {
"type": [
"object",
"null"
],
"properties": {
"ModalidadeFrete": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
9
],
"description": "0 - Contratação do Frete por conta do Remetente (CIF); 1 - Contratação do Frete por conta do Destinatário (FOB); 2 - Contratação do Frete por conta de Terceiros; 3 - Transporte Próprio por conta do Remetente; 4 - Transporte Próprio por conta do Destinatário; 9 - Sem Ocorrência de Transporte"
},
"NmTransportador": {
"type": [
"string",
"null"
]
},
"CNPJ": {
"type": [
"string",
"null"
]
},
"NmMunicipio": {
"type": [
"string",
"null"
]
},
"DsEndereco": {
"type": [
"string",
"null"
]
},
"IE": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"Vagao": {
"type": [
"string",
"null"
]
},
"Balsa": {
"type": [
"string",
"null"
]
},
"Veiculo": {
"type": [
"object",
"null"
],
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"Reboque": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"Placa": {
"type": [
"string",
"null"
]
},
"UF": {
"type": [
"string",
"null"
]
},
"RNTC": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"Volumes": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"Numero": {
"type": [
"string",
"null"
]
},
"QuantidadeVolume": {
"type": "integer"
},
"Especie": {
"type": [
"string",
"null"
]
},
"Marca": {
"type": [
"string",
"null"
]
},
"PesoBruto": {
"type": "number"
},
"PesoLiquido": {
"type": "number"
},
"Lacres": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"Exporta": {
"type": [
"object",
"null"
],
"properties": {
"LocalDespacho": {
"type": [
"string",
"null"
],
"description": "Descrição do local de despacho"
},
"UFSaidaPais": {
"type": [
"string",
"null"
],
"description": "Sigla da UF de Embarque ou de transposição de fronteira"
},
"LocalEmbarqueTransp": {
"type": [
"string",
"null"
],
"description": "Descrição do Local de Embarque ou de transposição de fronteira"
}
},
"additionalProperties": false
},
"Entrega": {
"type": [
"object",
"null"
],
"properties": {
"CpfCnpj": {
"type": [
"string",
"null"
]
},
"Nome": {
"type": [
"string",
"null"
]
},
"Ie": {
"type": [
"string",
"null"
]
},
"Endereco": {
"type": [
"object",
"null"
],
"properties": {
"Cep": {
"type": [
"string",
"null"
]
},
"Logradouro": {
"type": [
"string",
"null"
]
},
"Complemento": {
"type": [
"string",
"null"
]
},
"Numero": {
"type": [
"string",
"null"
]
},
"Bairro": {
"type": [
"string",
"null"
]
},
"CodMunicipio": {
"type": [
"string",
"null"
]
},
"Municipio": {
"type": [
"string",
"null"
]
},
"Uf": {
"type": [
"string",
"null"
]
},
"CodPais": {
"type": "integer",
"default": 1058
},
"Pais": {
"type": [
"string",
"null"
],
"default": "BRASIL"
}
},
"additionalProperties": false
},
"Contato": {
"type": [
"object",
"null"
],
"properties": {
"Telefone": {
"type": [
"string",
"null"
]
},
"Email": {
"type": [
"string",
"null"
]
},
"Fax": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"Retencoes": {
"type": [
"object",
"null"
],
"properties": {
"BaseCalculoIRRF": {
"type": [
"number",
"null"
],
"description": "Base de cálculo do IRRF"
},
"ValorIRRF": {
"type": [
"number",
"null"
],
"description": "Valor retido do IRRF"
},
"ValorRetidoPIS": {
"type": [
"number",
"null"
],
"description": "Valor retido de PIS"
},
"ValorRetidoCOFINS": {
"type": [
"number",
"null"
],
"description": "Valor retido de COFINS"
},
"ValorRetidoCSLL": {
"type": [
"number",
"null"
],
"description": "Valor retido de CSLL"
},
"BaseCalculoRetencaoPrevidencia": {
"type": [
"number",
"null"
],
"description": "Base de cálculo da retenção da Previdência Social"
},
"ValorRetencaoPrevidencia": {
"type": [
"number",
"null"
],
"description": "Valor da retenção da Previdência Social"
}
},
"additionalProperties": false,
"description": "Retenções federais totais da nota (IRRF, PIS/COFINS/CSLL retidos, Previdência). Gera a tag retTrib no XML."
}
},
"additionalProperties": false,
"required": [
"IndicadorPresenca",
"NaturezaOperacao",
"ModeloDocumento",
"Finalidade",
"TipoAmbiente",
"Produtos"
]
}
}
},
"additionalProperties": false
},
"Base64Xml": {
"type": [
"string",
"null"
]
},
"TipoArquivo": {
"type": "integer",
"enum": [
0,
1
],
"description": "Tipo do arquivo que deseja pré-visualizar (Padrão - 0) Valores: 0 - XML; 1 - PDF"
},
"TipoEnvio": {
"type": "integer",
"enum": [
0,
1
],
"description": "Tipo do envio no qual será convertido para o tipo do arquivo informado (Padrão - 0) Valores: 0 - Base64 contendo as informações do XML; 1 - Objeto contendo as informações das notas fiscais"
},
"mostrarTarjaPreVisualizacao": {
"type": "boolean",
"description": "Mostrar tarja \"SEM VALOR FISCAL - PRÉ-VISUALIZAÇÃO\" (Padrão - Verdadeiro) Somente para o tipo de arquivo 1 - PDF",
"default": true
}
},
"additionalProperties": false
}