addedInput schema / properties / cte
Added value: +{
+ "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"
+ ]
+}
addedInput schema / properties / dce
Added value: +{
+ "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"
+ ]
+}
addedInput schema / properties / mdfe
Added value: +{
+ "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"
+ ]
+}
changedInput schema / properties / mostrarTarjaPreVisualizacao / description
Previous value: -"Mostrar tarja \"SEM VALOR FISCAL - PRÉ-VISUALIZAÇÃO\" (Padrão - Verdadeiro) Somente para o tipo de arquivo 1 - PDF"New value: +"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"
addedInput schema / properties / nfse
Added value: +{
+ "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,
+ "properties": {
+ "Art": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "CodObra": {
+ "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": {
+ "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"
+ }
+ },
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "Descricao": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ ]
+}
addedInput schema / properties / notaFiscal / description
Added value: +"NF-e / NFC-e (modelo 55/65). Usado quando TipoEnvio = 1. Gera o DANFE/XML de pré-visualização."
addedInput schema / properties / notaFiscal / properties / nFInfos / items / properties / TipoDanfe
Added value: +{
+ "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"
+ ]
+}
