NcmViewModel
objectDados detalhados do NCM.
* Additional properties are NOT allowed.
codigoNcmstring
Código da Nomenclatura Comum do Mercosul.
extensaoTipiinteger(int32)
Código de extensão da TIPI (Tabela de Incidência do IPI).
descricaostring
Descrição completa da mercadoria ou serviço vinculada ao NCM.
inicioVigenciastring(date)
Data de início da vigência do código NCM.
Example:2025-03-31
fimVigenciastring(date)
Data de término da vigência (opcional).
tributosAproximadosarray[object]
Dados dos tributos aproximados vinculados a um NCM (Lei da Transparência).
* Additional properties are NOT allowed.
Show Child Parameters
cestsarray[object]
Dados do CEST do NCM.
* Additional properties are NOT allowed.
Show Child Parameters
Example
NfceAutomaticaInputModel
objectDados da nota fiscal eletrônica Automática.
* Additional properties are NOT allowed.
codigoErpstringrequired
Identificador da pré-venda no ERP.
>= 1 characters
seriestring
Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
numeroDocumentointeger(int64)
Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
naturezaOperacaostring
Descrição da natureza da operação.
indicadorPresencastring
Indicador de presença na operação.
Allowed values:OperacaoPresencialNfceEntregaDomicilio
tipoEmissaostring
Tipo de emissão de NFCe.
Allowed values:AutomaticaNormalContingenciaNfce
dataHoraEntradaContingenciastring(date-time)
Data e hora de entrada em contingência (Opcional).
justificativaContingenciastring
Justificativa de entrada em contingência (Opcional).
destinatarioobject
Dados do destinatário da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
enderecoEntregaobject
Dados de Endereço de Entrega para Nota Fiscal Eletrônica Automática.
* Additional properties are NOT allowed.
Show Child Parameters
enderecoRetiradaobject
Dados do endereço de retirada da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
itensarray[object]required
Dados do item da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
transporteobject
Dados de transporte para NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
cobrancaobject
Dados da cobrança da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
pagamentosobjectrequired
Dados dos pagamentos da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
informacaoAdicionalFiscostring
Informação adicional de interesse do fisco.
<= 2000 characters
informacaoComplementarstring
Informação complementar.
<= 5000 characters
valorTotalnumber(double)required
Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).
Example
NfceInputModel
objectDados da nota fiscal eletrônica simplificada.
* Additional properties are NOT allowed.
codigoErpstringrequired
Identificador da pré-venda no ERP.
>= 1 characters
seriestring
Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
numeroDocumentointeger(int64)
Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
naturezaOperacaostring
Descrição da natureza da operação.
indicadorPresencastring
Indicador de presença na operação.
Allowed values:OperacaoPresencialNfceEntregaDomicilio
tipoEmissaostring
Tipo de emissão de NFCe.
Allowed values:AutomaticaNormalContingenciaNfce
dataHoraEntradaContingenciastring(date-time)
Data e hora de entrada em contingência (Opcional).
justificativaContingenciastring
Justificativa de entrada em contingência (Opcional).
destinatarioobject
Dados do destinatário da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
enderecoEntregaobject
Dados de Endereço de Entrega para Nota Fiscal Eletrônica
* Additional properties are NOT allowed.
Show Child Parameters
enderecoRetiradaobject
Dados do endereço de retirada da NFe simplificada.
* Additional properties are NOT allowed.
Show Child Parameters
itensarray[object]required
Dados do item da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
transporteobject
Dados de transporte para NFe
* Additional properties are NOT allowed.
Show Child Parameters
pagamentosobjectrequired
Dados dos pagamentos da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
informacaoAdicionalFiscostring
Informação adicional de interesse do fisco.
<= 2000 characters
informacaoComplementarstring
Informação complementar.
<= 5000 characters
valorTotalnumber(double)required
Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).
Example
NfceSimplificadaInputModel
objectDados da nota fiscal eletrônica simplificada.
* Additional properties are NOT allowed.
codigoErpstringrequired
Identificador da pré-venda no ERP.
>= 1 characters
seriestring
Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
numeroDocumentointeger(int64)
Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
naturezaOperacaostring
Descrição da natureza da operação.
indicadorPresencastring
Indicador de presença na operação.
Allowed values:OperacaoPresencialNfceEntregaDomicilio
tipoEmissaostring
Tipo de emissão de NFCe.
Allowed values:AutomaticaNormalContingenciaNfce
dataHoraEntradaContingenciastring(date-time)
Data e hora de entrada em contingência (Opcional).
justificativaContingenciastring
Justificativa de entrada em contingência (Opcional).
destinatarioobject
Dados do destinatário da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
enderecoEntregaobject
Dados de Endereço de Entrega para Nota Fiscal Eletrônica
* Additional properties are NOT allowed.
Show Child Parameters
enderecoRetiradaobject
Dados do endereço de retirada da NFe simplificada.
* Additional properties are NOT allowed.
Show Child Parameters
itensarray[object]required
Dados do item da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
transporteobject
Dados de transporte para NFe
* Additional properties are NOT allowed.
Show Child Parameters
pagamentosobjectrequired
Dados dos pagamentos da NFe .
* Additional properties are NOT allowed.
Show Child Parameters
informacaoAdicionalFiscostring
Informação adicional de interesse do fisco.
<= 2000 characters
informacaoComplementarstring
Informação complementar.
<= 5000 characters
valorTotalnumber(double)required
Valor total do documento fiscal (Não incluir os impostos da reforma tributária: IBS, CBS e IS).
Example
NfeAutomaticaInputModel
objectDados da nota fiscal eletrônica Automática.
* Additional properties are NOT allowed.
codigoErpstringrequired
Identificador da pré-venda no ERP.
>= 1 characters
seriestring
Série do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
numeroDocumentointeger(int64)
Numero do documento fiscal (Informar somente se estiver configurado para geração numérica manual).
naturezaOperacaostring
Descrição da natureza da operação.
fluxoFiscalAutomaticostring
Fluxo fiscal para cálculo automático do tributo.
Allowed values:VendaConsumidorFinalRevendaBonificacaoTransferencia
indicadorPresencastring
Indicador de presença na operação.
Allowed values:NaoSeAplicaOperacaoPresencialOperacaoNaoPresencialInternetOperacaoNaoPresencialTeleatendimentoNaoPresencialOutros
tipoEmissaostring
Tipo de emissão de NFe.
Allowed values:AutomaticaNormalContingenciaFsdaContingenciaSvcanContingenciaSvcrs
dataHoraEntradaContingenciastring(date-time)
Data e hora de entrada em contingência (Opcional).
justificativaContingenciastring
Justificativa de entrada em contingência (Opcional).
dataSaidaEntradastring(date-time)
Data de saída/entrada.
destinatarioobjectrequired
Dados do destinatário da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
enderecoEntregaobject
Dados de Endereço de Entrega para Nota Fiscal Eletrônica Automática.
* Additional properties are NOT allowed.
Show Child Parameters
enderecoRetiradaobject
Dados do endereço de retirada da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
autXmlarray[object]
Documentos autorizados a capturar e visualizar a NFe.
* Additional properties are NOT allowed.
Show Child Parameters
itensarray[object]required
Dados do item da NFe Automática.
* Additional properties are NOT allowed.
Show Child Parameters
transporteobject
Dados de transporte para NFe.
* Additional properties are NOT allowed.
Show Child Parameters
cnpjIntermediadorstring
CNPJ do intermediador.
identificadorIntermediadorstring
Identificador do intermediador.
informacaoAdicionalFiscostring
Informação adicional de interesse do fisco.
<= 2000 characters
informacaoComplementarstring
Informação complementar.
<= 5000 characters
Example