Campos de Entrada

Campos/th> Obrigatório Preenchimento Objetivos do Campo Observação
operacao: Sim "S" - Saída ou "E" Entrada Identificar operação de Entrada ou de Saída
data: Sim Data da operação. Formato: "2023-10-03T16:57:54.890Z" Data da consulta da regra tributária
emitente:
emitente.cnae: Sim CNAE disponível no IBGE. Formato: 8546-7/59 ( com pontuação) ou seja, XXXX-X/X Identificação da atividade da empresa como Industrial, Comercio Atacadista ou Varejista por exemplo, utilizado principalmente para os beneficios fiscais, alíquotas diferenciadas e regras de substituição tributária. Podendo utilizar o CNAE genérico para as atividade de industrial, comércio atacadista e varejista (1111-1/11 - Industrial; 2222-2/22 - Comércio Atacadista; 3333-3/33 - Comércio Varejista)
emitente.cnaesSecundarios: Não CNAE disponível no IBGE. Formato: 8546-7/59 ( com pontuação) ou seja, XXXX-X/X Não utilizado no momento
emitente.uf: Sim UF do Brasil. Formato: "RJ"; "SP" Identificação da UF do emitente
emitente.codigoPais: Sim Código do País no Siscomex. Exemplo: "105" Brasil. Formato: apenas dígitos Identificação do País. Utilizado principalmente para identificação operações de importações quanto utilizado diferente de 105(Brasil). Considere o emitente sempre como o remetente da mercadoria ou emitente da nota fiscal.
emitente.contribuinteIpi: Sim true ou false Identificar se o emitente é contribuinte de IPI e consequentemente efetuou o destaque do IPI na nota fiscal quando devido
emitente.contribuinteIcms: Sim true ou false Identificar se o emitente é contribuinte de ICMS ou não.
emitente.regimePisCofins: Sim 1 - Cumulativo ou 2 - Não Cumulativo. Formato: "1" ou "2" Identificar o regime PIS/COFINS do emitente da nota fiscal por exemplo Documentação de Identificadores - findAllRegimePisCofins
emitente.regimeIcms: Sim 1 - Normal ou 2 - Simples Nacional. Formato: "1" ou "2" Identificar o regime do ICMS como Normal ou Simples Nacional Documentação de Identificadores - findAllRegimeIcms
destinatario:
destinatario.cnae: Sim;
Não obrigatório quando informado "operacao": "S", "contribuinteIcms": true, no destinatário e "consumidorFinal": true,
CNAE disponível no IBGE. Formato: 1629-3/01 ( com pontuação) ou seja, XXXX-X/X Identificação da atividade empresa como Industrial, Comercio Atacadista ou Varejista por exemplo, utilizado principalmente para os beneficios fiscais, alíquotas diferenciadas e regras de substituição tributária. Podendo utilizar o CNAE genérico para as atividade de industrial, comércio atacadista e varejista (1111-1/11 - Industrial; 2222-2/22 - Comércio Atacadista; 3333-3/33 - Comércio Varejista)
destinatario.cnaesSecundarios: Não CNAE disponível no IBGE. Formato: 1629-3/01 ( com pontuação) ou seja, XXXX-X/X Não utilizado no momento
destinatario.uf: Sim UF do Brasil. Formato: "RJ"; "SP" Identificação da UF do destinatário
destinatario.codigoPais: Sim Código do País no Siscomex. Exemplo: "105" Brasil. Formato: apenas dígitos Identificação do País. Utilizado principalmente para identificação as operações de exportação quanto utilizado diferente de 105(Brasil).
destinatario.contribuinteIpi: Sim true ou false Identificar se o destinatário é contribuinte de IPI e consequentemente pode efetuar o crédito de IPI em operação de entrada.
destinatario.contribuinteIcms: Sim true ou false Identificar se o destinatário é contribuinte de ICMS ou não, ainda que a mercadoria seja para consumidor final.
destinatario.regimePisCofins: Sim 1 - Cumulativo; 2 - Não Cumulativo. Formato: "1" ou "2". Identificar o regime PIS/COFINS do destinatário da nota fiscal por exemplo, principalmente para tomada de crédito no regime não cumulativo. Documentação de Identificadores - findAllRegimePisCofins
destinatario.regimeIcms: Sim 1 - Normal; 2 - Simples Nacional. Formato: "1" ou "2". Identificar o regime do ICMS como Normal ou Simples Nacional Documentação de Identificadores - findAllRegimeIcms
consumidorFinal: Sim true ou false Operação com consumidor Final sim ou não. Essa informação não caracteriza o destinatário como contribuinte do ICMS ("contribuinteIcms": true).
itens:
itens.ncm: Sim NCM da Tabela TIPI. Formato: 8 dígitos sem pontos. Exemplo: 73143100 NCM do produto da empresa. Não validamos se o NCM está correto ou vigente.
itens.ex: Não;
Obrigatório caso o NCM utilizado tenha EX/TIPI para o SKU da empresa
EX do NCM Ex-tarifário de IPI é uma exceção à regra de tributação incidente sobre determinado código da TIPI.
itens.cest: Não;
Obrigatório para os produtos enquadrados no Conv. 142/2018 e produtos com Substituição Tributária. Lembrando que o retorno da ST será somente para os produtos com CEST.
Formato: 13 dígitos sem pontos. Exemplo: 1005300 CEST de cada bem e mercadoria, ainda que a operação não esteja sujeita ao regime de substituição tributária conforme o Convênio ICMS 142/2018. Será utilizando principalmente no retorno da ST conforme a legislação de cada UF. Documentação de Identificadores - findAllCest
itens.todosEnquadramentos: Sim true ou false Para retorno de todas as tributações encontradas principalmente as diferenciadas como por exemplo isenção, redução e alíquotas diferenciadas. Caso seja false terá o retorno somente da regra geral, ou seja, sem as tributações diferenciadas
itens.verificaExcecao: Sim true ou false Demonstra as tributações diferenciadas como por exemplo, isenção, redução ou alíquotas diferenciadas sem apresentar quais para "todosEnquadramentos": false.
itens.enquadramentos: Não Código de enquadramento interno da Asis para os produtos com tributações diferenciadas. Apresentado no retorno das regras.
itens.dataEnquadramento: Não Data de enquadramento do código
itens.fabricacao: Sim 0 - Fabricação Própria ou 1 - Terceiros. Formato: Um dígito Identificar se o produto foi fabricado pela empresa ou adquirida de terceiro. Caso seja fabricação própria na operação saída será verificado a tributação do IPI.
itens.tipoItem: Sim Tipo do itens do Sped registro 0200, formato: Dois dígitos. Identificar o tipo de item da empresa conforme o Sped-Fiscal. Exemplo 04 para produtos acabado e consequentemente fabricados pela empresa, 00 - mercadoria para revenda ou seja adquirida de terceiros. Documentação de Identificadores - findAllTipos
itens.cstOrigem: Sim Tabela de CST Origem, formato um dígito Identificar a origem da mercadoria, como nacional ou importada por exemplo. Terá impacto principalmente nas operações interestaduais do ICMS e IPI para os produtos importados.
itens.cfop: Sim CFOP utilizado pelo Cliente para operação. Exemplo 5101 (Venda de produção do estabelecimento) CFOP de acordo com a operação praticada. Será utilizado principalmente para validar a natureza da operação praticada pela empresa com impacto na tributação do PIS/COFINS no crédito e débito.
itens.naturezaOperacao: Sim Tabela Natureza da Operação, Exemplo Código 0002 Venda de Mercadoria. Campo chave para identificação da operação como Venda, Compra ou Transferência e deverá estar compatível com a Operação (Entrada ou Saída) e tipo item. Documentação de Identificadores - findAllNaturezaOperacao
itens.valorTotal: Não Valor da Operação para efeito de exemplo de cálculo Valor para efeitos de simulação de cálculo e apresentação da base de cálculo e imposto conforme o caso.

Campos de Saída

Campos Objetivos do Campo
grupo: ICMS
cst: CST da tributação
fundamento: Fundamento legal da Alíquota de ICMS
aliquota: Alíquota de ICMS com o FCP
aliquotaIcms: Alíquota de ICMS sem o FCP
aliquotaFcp: alíquota Fcp
valorBase: Base de Cálculo do ICMS
valorImposto: Valor do ICMS
idDescricao: ID da descrição do benefício
descricao: Descrição do benefício
alerta: Alerta
segmento: Segmento do benefício
cfopDeduzido: CFOP da operação
regraEspecifica: Resultado de regras específicas sim ou não
temExcecao: Tributação com exceções sim ou não
percentualReducao: Percentual da redução de base do ICMS
cargaTributariaReducao: Carga tributário do ICMS
fundamentoReducao: Fundamento legal da redução de base do ICMS
alertaReducao: Alerta da redução de base do ICMS
percentualDiferimento: Percentual de diferimento do ICMS
fundamentoDiferimento: Fundamento legal do diferimento do ICMS
alertaDiferimento: Alerta do diferimento do ICMS
cbenef: Cbenef dos benefícios do ICMS
vigenciaInicial: Vigência inicial da regra
vigenciaFinal: Vigência final da regra
stAntecipacao: ST Antecipação na UF Destino
stAliquota: Alíquota de ICMS com o FCP da Substituição Tributária
stAliquotaIcms: Alíquota de ICMS sem o FCP da Substituição Tributária
stAliquotaFcp: Alíquota FCP da Substituição Tributária
stFundamento: Fundamento legal da Substituição Tributária
stAlerta: Alerta da Substituição Tributária
stSegmento: Segmento da Substituição Tributária
stDescricao: Descrição do produto/cest na Substituição Tributária
stPercentualMva: Percentual do MVA
stPercentualReducao: Percentual de redução da Substituição Tributária
stCargaTributariaReducao: Carga Tributária da Substituição Tributária
stFundamentoReducao: Fundamento legal da redução de base da Substituição Tributária
stAlertaReducao: Alerta da redução de base da Substituição Tributária
stValorBase: Base de cálculo da Substituição Tributária
stValorImposto: Valor da Substituição Tributária com FCP
stValorImpostoIcms: Valor da Substituição Tributária sem FCP
stValorImpostoFcp: Valor da Substituição Tributária FCP
stRegraEspecifica: Resultado de regras específicas sim ou não
stVigenciaInicial: Vigência inicial da ST
stVigenciaFinal: Vigência final da ST
grupo: IPI
cst: CST da tributação
fundamento: Fundamento legal da Alíquota de ICMS
codEnquadramentoLegal: Código do Enquadramento legal do IPI
grupoCstLegal: Grupo CST do IPI
descricaoEnquadramentoLegal: Descrição do Enquadramento legal do IPI
aliquota: Alíquota do IPI
valorBase: Base de cálculo do IPI
valorImposto: Valor do IPI
regraEspecifica: Resultado de regras específicas sim ou não
vigenciaInicial: Vigência inicial do IPI
vigenciaFinal: Vigência final do IPI
grupo: PIS/COFINS
cst: CST da tributação
fundamento: Fundamento legal da Alíquota de ICMS
aliquota: Alíquota do PIS
valorBase: Base de cálculo do PIS/COFINS
valorImposto: Valor do PIS
regraEspecifica: Resultado de regras específicas sim ou não
temExcecao: Tributação com exceções sim ou não
vigenciaInicial: Vigência inicial do PIS/COFINS
vigenciaFinal: Vigência final do PIS/COFINS
cofinsAliquota: Alíquota do COFINS
cofinsValorImposto: Valor do COFINS
alteracoes: Alterações / Monitoramento
alteracoes.campo: Campo alterado
alteracoes.anterior: Informação anterior
alteracoes.atual: Informação atual
adicionado: Informação adicionada
removido: Informação removida