InscricaoEstadualEmissorViewModel
objectDados da inscrição estadual do emissor.
* Additional properties are NOT allowed.
inscricaoEstadualstring
Número da Inscrição Estadual do emissor.
nomestring
Nome na inscrição estadual.
enderecoobject
Dados do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
Example
ItemNfceAutomaticaInputModel
objectDados do item da NFe Automática.
* Additional properties are NOT allowed.
codigoInternostringrequired
Código interno do produto 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
fabricacaoPropriaboolean
Indica se o produto é de fabricação própria. (Default: false)
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.
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
ItemNfceAutomaticaProdutoEspecificoInputModel
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
ItemNfceImpostoInputModel
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.
• ModalidadeBaseIcms (Enum): Modalidade de determinação da base ICMS.
• BaseIcms (decimal): Valor da base de cálculo do ICMS.
• AliquotaIcms (decimal): Alíquota do imposto ICMS.
• ValorIcms (decimal): Valor do ICMS resultante.
• BaseFcp (decimal): Valor da base de cálculo do FCP.
• AliquotaFcp (decimal): Alíquota do FCP.
• ValorFcp (decimal): Valor do FCP resultante.
CST 20 - Tributado com redução de base de cálculo:
• Cst: 20.
• 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.
• CodigoBeneficio (string): Código de benefício fiscal.
• BaseFcp (decimal): Base de cálculo do FCP.
• AliquotaFcp (decimal): Alíquota do FCP.
• ValorFcp (decimal): Valor do FCP resultante.
CST 40 e 41 - Isenta ou Não Tributada:
• Cst: (40 ou 41).
• MotivoDesoneracao (Enum): Motivo da desoneração do ICMS.
• ValorIcmsDesonerado (decimal): Valor do ICMS desonerado.
• CodigoBeneficio (string): Código de benefício fiscal.
CST 60 - Cobrado anteriormente por substituição tributária:
• Cst: 60.
Dicionário de Enumeradores:
• ModalidadeBaseIcmsNotaFiscalModelEnum:
MargemValorAgregado = Margem Valor Agregado (%).
PrecoPauta = Pauta (Valor).
PrecoTabeladoMax = Preço Tabelado Máx. (valor).
ValorDaOperacao = Valor da operação.
• 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 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 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.
* 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
ItemNfceInputModel
objectDados do item da NFe .
* Additional properties are NOT allowed.
codigoInternostringrequired
Código interno do produto 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.
impostosobject
Dados do imposto 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