ListarNcmsViewModel
objectDados para a listagem de NCMs.
* 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).
Example
ListarNcmsViewModelListPaginationResponse
object * Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray[object]
Dados para a listagem de NCMs.
* Additional properties are NOT allowed.
Show Child Parameters
Example
ListarNotasFiscaisServicoViewModel
objectDados de listagem de notas fiscais de serviço eletrônicas (NFS-e Nacional).
* Additional properties are NOT allowed.
idstring(uuid)
Identificador interno da nota fiscal de serviço.
codigoErpstring
Identificador da operação no ERP.
tipoAmbientestring
Tipo de ambiente da SEFAZ.
Allowed values:ProducaoHomologacao
tipoEmissorstring
Tipo do emitente da DPS (tpEmit).
Allowed values:PrestadorTomadorIntermediario
seriestring
Série da DPS.
numeroDpsinteger(int64)
Número sequencial da DPS.
numeroNfseinteger(int64)
Número sequencial da NFS-e gerado pelo ADN. Disponível após autorização.
chaveNfsestring
Chave da NFS-e. Disponível após autorização pelo ADN.
statusstring
Status da nota fiscal de serviço.
Allowed values:PendenteAutorizadaCanceladaRejeitadaEmCancelamentoSubstituidaInutilizada
dataEmissaostring(date-time)
Data e hora de emissão da DPS.
dataCompetenciastring
Mês de competência da prestação do serviço (formato “AAAA-MM”).
dataAutorizacaostring(date-time)
Data e hora de autorização pelo ADN.
dataCancelamentostring(date-time)
Data e hora de cancelamento.
justificativaCancelamentostring
Justificativa do cancelamento.
documentoPrestadorstring
Documento (CPF ou CNPJ) do prestador do serviço.
nomePrestadorstring
Nome ou Razão Social do prestador do serviço.
documentoTomadorstring
Documento (CPF ou CNPJ) do tomador do serviço.
nomeTomadorstring
Nome ou Razão Social do tomador do serviço.
descricaoServicostring
Descrição do serviço prestado.
valorServiconumber(double)
Valor do serviço prestado.
ultimoCstatinteger(int32)
Último código de status retornado pela sefaz.
mensagemSefazstring
Última mensagem retornada pelo ADN.
protocoloAutorizacaostring
Protocolo de autorização emitido pelo ADN.
Example
ListarNotasFiscaisServicoViewModelListPaginationResponse
object * Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray[object]
Dados de listagem de notas fiscais de serviço eletrônicas (NFS-e Nacional).
* Additional properties are NOT allowed.
Show Child Parameters
Example
ListarNotasFiscaisViewModel
objectDados de listagem de notas fiscais eletrônicas (NFe e NFCe).
* Additional properties are NOT allowed.
idstring(uuid)
Identificador interno do documento fiscal.
codigoErpstring
Identificador da operação fiscal no ERP.
chaveAcessostring
Chave de acesso do documento fiscal.
modeloNotaFiscalstring
Modelo de nota fiscal.
Allowed values:NfeNfce
naturezaOperacaostring
Natureza da operação.
numeroDocumentostring
Numero do documento fiscal.
seriestring
Série do documento fiscal.
tipoAmbientestring
Tipo de ambiente da SEFAZ.
Allowed values:ProducaoHomologacao
tipoOperacaostring
Tipo de operação.
Allowed values:EntradaSaida
indicadorPresencastring
Indicador de presença na operação.
Allowed values:NaoSeAplicaOperacaoPresencialOperacaoNaoPresencialInternetOperacaoNaoPresencialTeleatendimentoNfceEntregaDomicilioNaoPresencialOutros
consumidorFinalboolean
Indica se a operação foi destinada a consumidor final ou não.
tipoIdDestinostring
Tipo de destino da nota fiscal.
Allowed values:OperacaoInternaOperacaoInterestadualOperacaoExterior
documentoParticipantestring
Documento do participante.
nomeParticipantestring
Nome do participante.
valorDocumentonumber(double)
Valor do documento.
dataEmissaostring(date-time)
Data de emissão do documento.
dataSaidaEntradastring(date-time)
Data de saída/entrada.
dataCancelamentostring(date-time)
Data de cancelamento do documento.
statusstring
Status do documento eletrônico.
Allowed values:PendenteAutorizadaCanceladaInutilizadaRejeitadaDenegadaEmCancelamentoEmContingenciaSubstituida
ultimoCstatinteger(int32)
Último código de status retornado pela sefaz.
mensagemSefazstring
Última mensagem retornada pela sefaz.
modalidadeFretestring
Modalidade de frete.
Allowed values:CifFobFretePorContaDeTerceirosTransporteProprioRemetenteTransporteProprioDestinatarioSemOcorrenciaDeTransporte
cnpjTransportadorstring
CNPJ do transportador.
nomeTransportadorstring
Nome do transportador.
cnpjIntermediadorstring
CNPJ do intermediador.
identificadorIntermediadorstring
Identificador do intermediador.
modoEmissaostring
Modo de emissão da nota fiscal.
Allowed values:EmissaoCompletaEmissaoSimplificadaEmissaoAutomatica
modoContingenciaOfflineboolean
Indica se a nota fiscal foi emitida em modo de contingencia offline ou não.
dataHoraEntradaContingenciastring(date-time)
Data e hora de entrada em contingência offline.
justificativaContingenciastring
Justificativa de entrada em contingência offline.
Example