ItemNfeProdutoEspecificoInputModel
objectModelo abstrato para os Dados de Produto Específico do item da nota fiscal.
O preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.
Medicamento:
• TipoProdutoEspecifico: Medicamento.
• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).
• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.
• ValorPmc (decimal): Preço Máximo ao Consumidor.
Dicionário de Enumeradores:
• TipoProdutoEspecificoNotaFiscalModelEnum:
Medicamento = Produtos farmacêuticos e medicamentos.
* Additional properties are NOT allowed.
tipoProdutoEspecificostringrequired
Tipos de produtos específicos para Nota Fiscal.
Allowed values:Medicamento
Example
ItemNfeRastroAutomaticaInputModel
objectDados de rastreabilidade do item da NFe Automática.
* Additional properties are NOT allowed.
numeroLotestringrequired
Número do lote do produto.
>= 1 characters<= 20 characters
quantidadeLotenumber(double)
Quantidade do lote.
> 0
dataFabricacaostring(date-time)required
Data de fabricação do lote.
>= 1 characters
dataValidadestring(date-time)required
Data de validade do lote.
>= 1 characters
Example
ItemNfeSimplificadaExportacaoInputModel
objectDados de exportação do item da nota fiscal.
* Additional properties are NOT allowed.
numeroDrawbackstringrequired
Número do ato concessório de Drawback.
>= 1 characters<= 11 characters
numeroRegistroExportacaoIndiretastringrequired
Número do Registro de Exportação.
>= 1 characters<= 12 characters
chaveNotaExportacaoIndiretastringrequired
Chave de Acesso da NF-e recebida para exportação.
Match pattern:^\d{44}$
>= 1 characters
quantidadeExportacaoIndiretanumber(double)required
Quantidade do item realmente exportado.
> 0
Example
ItemNfeSimplificadaImpostoInputModel
objectDados do imposto do item da nota fiscal.
* Additional properties are NOT allowed.
icmsobject
Modelo abstrato para a Tributação de ICMS da nota fiscal.
O preenchimento dos campos abaixo é condicional ao CST informado.
CST 00 - Tributado integralmente:
• Cst: 00.
• AliquotaIcms (decimal): Alíquota do imposto ICMS.
• AliquotaFcp (decimal): Alíquota do FCP.
CST 02 - Monofásica sobre Combustíveis:
• Cst: 02.
• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (valor por quantidade).
CST 10 - Tributada com cobrança de ICMS ST:
• Cst: 10.
• AliquotaIcms (decimal): Alíquota do ICMS próprio.
• Mva (decimal): Percentual da margem de valor adicionado (MVA).
• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota do imposto ICMS ST.
• AliquotaFcp (decimal): Alíquota do FCP próprio.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota do FCP ST.
CST 15 - Monofásica com retenção sobre Combustíveis:
• Cst: 15.
• AliquotaQuantidade (decimal): Alíquota ad rem do imposto (própria).
• AliquotaRetencaoQuantidade (decimal): Alíquota ad rem do imposto retido.
CST 20 - Tributado com redução de base de cálculo:
• Cst: 20.
• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.
• AliquotaIcms (decimal): Alíquota do imposto ICMS.
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.
• CodigoBeneficio (string): Código de benefício fiscal.
• AliquotaFcp (decimal): Alíquota do FCP.
CST 30 - Isenta/Não Tributada com cobrança de ICMS ST:
• Cst: 30.
• Mva (decimal): Percentual de MVA ST.
• ReducaoBaseSt (decimal): Percentual de redução de base ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota do imposto ICMS ST.
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.
• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.
• CodigoBeneficio (string): Código de benefício fiscal.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota do FCP ST.
CST 40, 41 e 50 - Isenta, Não Tributada ou Suspensão:
• Cst: (40, 41 ou 50).
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.
• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.
• CodigoBeneficio (string): Código de benefício fiscal.
CST 51 - Tributação com Diferimento:
• Cst: 51.
• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.
• AliquotaIcms (decimal): Alíquota do imposto ICMS.
• PercentualDiferimento (decimal): Percentual do diferimento aplicado.
• AliquotaFcp (decimal): Alíquota do FCP.
CST 53 - Monofásica sobre Combustíveis com Diferimento:
• Cst: 53.
• AliquotaQuantidadeDiferida (decimal): Alíquota ad rem diferida.
CST 60 - Cobrado anteriormente por substituição tributária:
• Cst: 60.
• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.
• AliquotaRetidoAnteriormente (decimal): Alíquota de ICMS retido anteriormente.
• ValorIcmsProprioSubstituto (decimal): Valor do ICMS próprio do Substituto.
• ValorIcmsRetidoAnteriormente (decimal): Valor do ICMS retido anteriormente.
• BaseFcpRetidoAnteriormente (decimal): Base de FCP retido anteriormente.
• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.
• ValorFcpRetidoAnteriormente (decimal): Valor de FCP retido anteriormente.
• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.
• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.
CST 61 - Monofásica sobre Combustíveis cobrada anteriormente:
• Cst: 61.
• AliquotaQuantidadeRetida (decimal): Alíquota ad rem retida anteriormente.
CST 70 - Redução de base e cobrança de ICMS ST:
• Cst: 70.
• ReducaoBaseIcms (decimal): Percentual de redução de base própria.
• AliquotaIcms (decimal): Alíquota do ICMS próprio.
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.
• DesoneracaoDeduzValorItem (boleano): Indica se a desoneração está deduzindo no valor do item.
• CodigoBeneficio (string): Código de benefício fiscal.
• Mva (decimal): Percentual de MVA ST.
• ReducaoBaseSt (decimal): Percentual de redução de base ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota do imposto ICMS ST.
• AliquotaFcp (decimal): Alíquota do FCP próprio.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota do FCP ST.
CST 90 - Outros:
• Cst: 90.
• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.
• BaseIcms (decimal): Valor da base de cálculo própria.
• ReducaoBaseIcms (decimal): Percentual de redução de base própria.
• AliquotaIcms (decimal): Alíquota do imposto próprio.
• ValorIcms (decimal): Valor do ICMS próprio resultante.
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• AliquotaDesoneracao (decimal): Alíquota aplicada para cálculo do valor de desoneração.
• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.
• ModalidadeBaseSt (Enum): Modalidade de determinação da base ST.
• Mva (decimal): Percentual de MVA ST.
• ReducaoBaseSt (decimal): Percentual de redução de base ST.
• BaseSt (decimal): Valor da base de cálculo do ICMS ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota do imposto ICMS ST.
• ValorSt (decimal): Valor do ICMS ST resultante.
• BaseFcp (decimal): Base de cálculo do FCP próprio.
• AliquotaFcp (decimal): Alíquota do FCP próprio.
• ValorFcp (decimal): Valor do FCP próprio.
• BaseFcpSt (decimal): Base de cálculo do FCP ST.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota do FCP ST.
• ValorFcpSt (decimal): Valor do FCP ST resultante.
Dicionário de Enumeradores:
• ModalidadeBaseIcmsNotaFiscalModelEnum:
MargemValorAgregado = Margem Valor Agregado (%).
PrecoPauta = Pauta (Valor).
PrecoTabeladoMax = Preço Tabelado Máx. (valor).
ValorDaOperacao = Valor da operação.
• ModalidadeBaseStNotaFiscalModelEnum:
PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.
ListaNegativa = Lista Negativa (valor).
ListaPositiva = Lista Positiva (valor).
ListaNeutra = Lista Neutra (valor).
MargemValorAgregado = Margem Valor Agregado (%).
PrecoPauta = Pauta (valor).
• MotivoDesoneracaoNotaFiscalModelEnum:
Taxi = Táxi.
DeficienteFisico = Deficiente físico.
ProdutorAgropecuario = Produtor agropecuário.
FrotistaLocadora = Frotista/Locadora.
DiplomaticoConsular = Diplomático/consular.
UtilitariosMotocicletasAmazoniaOcidental = Utilitários produzidos na amazônia ocidental.
SUFRAMA = SUFRAMA.
VendaOrgaoPublico = Venda a órgãos públicos.
Outros = Outros.
DeficienteCondutor = Deficiente condutor.
DeficienteNaoCondutor = Deficiente não condutor.
OrgaoDeFomentoDesenvolvimentoAgropecuario = Órgão de fomento e desenvolvimento agropecuário.
* Additional properties are NOT allowed.
Show Child Parameters
icmssnobject
Modelo abstrato para a Tributação de ICMSSN (Simples Nacional) da nota fiscal.
O preenchimento dos campos abaixo é condicional ao CSOSN informado.
CSOSN 101 - Tributada pelo Simples Nacional com permissão de crédito:
• Csosn: 101.
• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.
CSOSN 102 - Tributada pelo Simples Nacional sem permissão de crédito:
• Csosn: 102.
• Nota: Não exige campos adicionais de valores ou alíquotas.
CSOSN 103 - Isento:
• Csosn: 103.
• Nota: Não exige campos adicionais de valores ou alíquotas.
CSOSN 201 - Tributada pelo Simples com permissão de crédito e cobrança de ICMS ST:
• Csosn: 201.
• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.
• Mva (decimal): Percentual de MVA.
• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota de ICMS ST.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota de FCP ST.
CSOSN 202 - Tributada pelo Simples sem permissão de crédito com cobrança de ST:
• Csosn: 202.
• Mva (decimal): Percentual de MVA.
• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota de ICMS ST.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota de FCP ST.
CSOSN 203 - Isento com ST:
• Csosn: 203.
• Mva (decimal): Percentual de MVA.
• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.
• AliquotaIcmsDeducaoSt (decimal): Alíquota para dedução do ICMS no cálculo do ICMS ST (Utilizada para calcular o valor a ser deduzido do ICMS ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaSt (decimal): Alíquota de ICMS ST.
• AliquotaFcpDeducaoSt (decimal): Alíquota para dedução do FCP no cálculo do FCP ST (Utilizada para calcular o valor a ser deduzido do FCP ST quando o contribuinte for substituído e tiver direito à dedução).
• AliquotaFcpSt (decimal): Alíquota de FCP ST.
CSOSN 300 - Imune:
• Csosn: 300.
• Nota: Não exige campos adicionais de valores ou alíquotas.
CSOSN 400 - Não Tributada:
• Csosn: 400.
• Nota: Não exige campos adicionais de valores ou alíquotas.
CSOSN 500 - ICMS cobrado anteriormente por substituição tributária:
• Csosn: 500.
• BaseIcmsRetidoAnteriormente (decimal): Base de ICMS retido anteriormente.
• AliquotaConsumidorFinal (decimal): Alíquota suportada pelo consumidor final.
• ValorIcmsSubstituto (decimal): Valor do ICMS próprio do Substituto.
• ValorIcmsRetido (decimal): Valor do ICMS ST cobrado anteriormente.
• BaseFcpRetidoAnteriormente (decimal): Base do FCP retido anteriormente.
• AliquotaFcpRetidoAnteriormente (decimal): Alíquota de FCP retido anteriormente.
• ValorFcpRetidoAnteriormente (decimal): Valor do FCP retido anteriormente.
• PercentualReducaoBaseEfetivaIcmsRetido (decimal): Percentual de redução da base de ICMS efetiva se ouvesse a cobrança normal do ICMS.
• AliquotaEfetivaIcmsRetido (decimal): Alíquota de ICMS efetivo se ouvesse a cobrança normal do ICMS.
CSOSN 900 - Outros:
• Csosn: 900.
• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.
• BaseIcms (decimal): Valor da base de cálculo do ICMS.
• ReducaoBaseIcms (decimal): Percentual de redução de base ICMS.
• AliquotaIcms (decimal): Alíquota do imposto ICMS.
• ValorIcms (decimal): Valor do ICMS resultante.
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.
• ModalidadeBaseSt (Enum): Modalidade de base ICMS ST.
• Mva (decimal): Percentual de MVA ST.
• ReducaoBaseSt (decimal): Percentual de redução de base ICMS ST.
• BaseSt (decimal): Valor da base de cálculo de ICMS ST.
• AliquotaSt (decimal): Alíquota de ICMS ST.
• ValorSt (decimal): Valor de ICMS ST resultante.
• BaseFcpSt (decimal): Base de cálculo do FCP ST.
• AliquotaFcpSt (decimal): Alíquota do FCP ST.
• ValorFcpSt (decimal): Valor do FCP ST resultante.
• AliquotaCreditoSimples (decimal): Alíquota de crédito do simples nacional.
• ValorCreditoSimples (decimal): Valor de crédito do simples nacional.
Dicionário de Enumeradores:
• ModalidadeBaseIcmsNotaFiscalModelEnum:
MargemValorAgregado = Margem Valor Agregado (%).
PrecoPauta = Pauta (Valor).
PrecoTabeladoMax = Preço Tabelado Máx. (valor).
ValorDaOperacao = Valor da operação.
• ModalidadeBaseStNotaFiscalModelEnum:
PrecoTabeladoMaximoSugerido = Preço tabelado ou máximo sugerido.
ListaNegativa = Lista Negativa (valor).
ListaPositiva = Lista Positiva (valor).
ListaNeutra = Lista Neutra (valor).
MargemValorAgregado = Margem Valor Agregado (%).
PrecoPauta = Pauta (valor).
* Additional properties are NOT allowed.
Show Child Parameters
icmsUfDestobject
Informação do ICMS Interestadual destinado a consumidor final em outra UF.
* Additional properties are NOT allowed.
Show Child Parameters
issqnobject
Dados do ISSQN.
* Additional properties are NOT allowed.
Show Child Parameters
ipiobject
Dados da tributação IPI do item.
* Additional properties are NOT allowed.
Show Child Parameters
pisobjectrequired
Tributação de PIS.
* Additional properties are NOT allowed.
Show Child Parameters
cofinsobjectrequired
Dados da tributação COFINS.
* Additional properties are NOT allowed.
Show Child Parameters
ibsCbsobject
Dados do IBS e CSB na tributação do item da nota fiscal. (Reforma Tributária)
* Additional properties are NOT allowed.
Show Child Parameters
Example
ItemNfeSimplificadaInputModel
objectDados do item da NFe.
* Additional properties are NOT allowed.
tipoItemstring
Tipo do item da nota.
Allowed values:ProdutoServico
codigoInternostringrequired
Código interno do produto ou serviço no ERP.
>= 1 characters<= 60 characters
eanstring
EAN do produto.
descricaostringrequired
Descrição do produto.
>= 2 characters<= 120 characters
origemMercadoriastring
Origem da mercadoria.
Allowed values:NacionalEstrangeiraImportacaoDiretaEstrangeiraAdquiridaMercadoInternoNacionalConteudoImportacaoEntre40e70NacionalProducaoEmConformidadeNacionalConteudoImportacaoMenorQue40EstrangeiraImportacaoDiretaSemSimilarNacionalEstrangeiraAdquiridaMercadoInternoSemSimilarNacionalNacionalConteudoImportacaoSuperior70
ncmstringrequired
NCM do produto. Lista de NCMs válidos em api/v1/RecursosAdicionais/Ncm/Listar.
Match pattern:^\d{8}$
>= 1 characters
ceststring
Código Especificador da Substituição Tributária (CEST).
O CEST é utilizado para identificar mercadorias e bens passíveis de sujeição aos regimes de
substituição tributária e de antecipação do recolhimento do imposto.
🔍 DICA DE BUSCA: Para obter uma lista de códigos válidos, utilize o endpoint
api/v1/RecursosAdicionais/Cest/Listar. Além disso, ao consultar o detalhe de um NCM,
o sistema retornará automaticamente os CESTs associados àquela classificação fiscal.
nvestring
Codificação NVE - Nomenclatura de Valor Aduaneiro e Estatística. (Opcional)
exTipiinteger(int32)
Extensão da TIPI.
cfopstringrequired
CFOP do item. Lista de CFOPs válidos em api/v1/RecursosAdicionais/Cfop/Listar.
Match pattern:^\d{4}$
>= 1 characters
unidadestringrequired
Unidade comercializada.
>= 1 characters<= 6 characters
quantidadenumber(double)
Quantidade comercializada.
> 0
valorUnitarionumber(double)
Valor unitário do item.
>= 0
valorTotalBrutonumber(double)
Valor total bruto.
>= 0
valorTotalFretenumber(double)
Valor total de frete do item.
>= 0
valorTotalSeguronumber(double)
Valor total de seguro do item.
>= 0
valorTotalDescontonumber(double)
Valor total de descontos do item.
>= 0
valorTotalOutrosnumber(double)
Valor total de outras despesas do item.
>= 0
itemCompoeTotalNotaboolean
Indicador de item compõe o total da nota.
numeroPedidoComprastring
Número do pedido de compra.
itemPedidoComprainteger(int32)
Item de pedido de compra.
impostosobjectrequired
Dados do imposto do item da nota fiscal.
* Additional properties are NOT allowed.
Show Child Parameters
exportacaoobject
Dados de exportação do item da nota fiscal.
* Additional properties are NOT allowed.
Show Child Parameters
produtoEspecificoobject
Modelo abstrato para os Dados de Produto Específico do item da nota fiscal.
O preenchimento dos campos abaixo é condicional ao TipoProdutoEspecifico informado.
Medicamento:
• TipoProdutoEspecifico: Medicamento.
• CodigoAnvisa (string): Código de Produto da ANVISA (13 dígitos).
• MotivoIsensao (string): Texto explicativo do motivo da isenção da ANVISA.
• ValorPmc (decimal): Preço Máximo ao Consumidor.
Dicionário de Enumeradores:
• TipoProdutoEspecificoNotaFiscalModelEnum:
Medicamento = Produtos farmacêuticos e medicamentos.
* Additional properties are NOT allowed.
Show Child Parameters
Example