NFS-e - Consultar benefício fiscal do município.
Consulta os detalhes de um benefício fiscal parametrizado no Ambiente Nacional NFS-e para o município informado,
incluindo tipo, percentuais de redução de base de cálculo ou alíquota diferenciada, serviços contemplados e período de vigência.
⚠️ ATENÇÃO: O código do município deve ser o código IBGE de 7 dígitos.
get
Path Parameters
codigoMunicipiostringrequired
Código IBGE do município.
codigoBeneficiostringrequired
Código do benefício fiscal.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ConsultarBeneficioNfseViewModel
Benefício fiscal vigente no município para o código informado.
* Additional properties are NOT allowed.
codigoBeneficiostring | null
Código do benefício fiscal.
descricaostring | null
Descrição do benefício fiscal.
dataInicioVigenciastring(date-time)
Data de início da vigência do benefício.
dataFimVigenciastring | null(date-time)
Data de fim da vigência do benefício, se houver.
tipoBeneficiointeger(int32)
Tipo do benefício fiscal.
tipoReducaoBCinteger | null(int32)
Tipo de redução da base de cálculo, se aplicável.
reducaoPercentualBCnumber | null(double)
Percentual de redução da base de cálculo, se aplicável.
aliquotaDiferenciadanumber | null(double)
Alíquota diferenciada aplicada pelo benefício, se houver.
restritoAoMunicipioboolean | null
Indica se o benefício é restrito ao município.
servicosarray | null[object]
Serviço contemplado pelo benefício fiscal e seu período de vigência.
* Additional properties are NOT allowed.
Show Child Parameters
contribuintesarray | null[string]
Lista de contribuintes contemplados pelo benefício, se houver restrição.
get/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Beneficio/{codigoBeneficio}/Consultar
Authentication
Path Parameters
Headers
AnaliseAplicativoDetalheViewModel
objectDetalhe da análise do aplicativo.
* Additional properties are NOT allowed.
quantidadeTotalEmissoresAtivosinteger(int32)
Quantidade total de emissores ativos.
quantidadeEmissoresHabilitadosNoPeriodointeger(int32)
Quantidade de emissores habilitados no período selecionado.
quantidadeEmissoresAtivosComCertificadoDigitalinteger(int32)
Quantidade total de emissores ativos com certificado digital.
quantidadeEmissoresAtivosComCertificadoDigitalValidointeger(int32)
Quantidade total de emissores ativos com certificado digital válido e em dia.
quantidadeEmissoresAtivosComCertificadoDigitalProximoDoVencimentointeger(int32)
Quantidade total de emissores ativos com certificado digital próximo do vencimento.
quantidadeEmissoresAtivosComCertificadoDigitalVencidointeger(int32)
Quantidade total de emissores ativos com certificado digital vencido.
quantidadeEmissoresAtivosSemCertificadoDigitalinteger(int32)
Quantidade total de emissores sem certificado digital.
quantidadeTotalNotasinteger(int32)
Quantidade total de notas processadas.
quantidadeTotalNotasAprovadasinteger(int32)
Quantidade total de notas com status aprovado.
quantidadeTotalNotasCanceladasinteger(int32)
Quantidade total de notas canceladas.
quantidadeTotalNotasRejeitadasinteger(int32)
Quantidade total de notas rejeitadas pela SEFAZ.
quantidadeTotalNotasPendentesinteger(int32)
Quantidade total de notas em processamento ou pendentes.
quantidadeTotalNotasEmContingenciainteger(int32)
Quantidade total de notas emitidas em regime de contingência.
quantidadeTotalNotasSubstituidasinteger(int32)
Quantidade total de notas que foram substituídas.
valorTotalNotasnumber(double)
Valor bruto total de todas as notas.
valorTotalNotasAprovadasnumber(double)
Valor total acumulado das notas aprovadas.
valorTotalNotasCanceladasnumber(double)
Valor total acumulado das notas canceladas.
valorTotalNotasRejeitadasnumber(double)
Valor total acumulado das notas rejeitadas.
valorTotalNotasPendentesnumber(double)
Valor total acumulado das notas pendentes.
valorTotalNotasEmContingencianumber(double)
Valor total acumulado das notas em contingência.
valorTotalNotasSubstituidasnumber(double)
Valor total acumulado das notas substituídas.
tempoMedioEmissaoNotasMilissegundosnumber(double)
Tempo médio de emissão das notas em milissegundos.
tempoMedioEmissaoNotasstring
Representação textual do tempo médio de emissão.
quantidadeConsultasCatalogoFiscalinteger(int32)
Quantidade de consultas realizadas ao catálogo fiscal.
quantidadeProdutosTributacaoAlteradainteger(int32)
Quantidade de produtos que tiveram a tributação alterada no período.
quantidadeConsultasCnpjAplicacaointeger(int32)
Quantidade de consultas de CNPJ realizadas via aplicação.
quantidadeConsultasCnpjEmissoresinteger(int32)
Quantidade de consultas de CNPJ realizadas pelos emissores.
Example
AnaliseAplicativoViewModel
objectDados de análise detalhada do aplicativo.
* Additional properties are NOT allowed.
idstring(uuid)
Identificador interno do aplicativo.
nomestring
Nome do aplicativo.
statusstring
Status de ativação do aplicativo.
Allowed values:InativoAtivo
consoleIdstring
Identificador do aplicativo no console.
dataCriacaostring(date-time)
Data de criação do aplicação no sistema.
ultimaAlteracaostring(date-time)
Data de última alteração dos dados da aplicação no sistema.
contratoobject
Dados do contrato adquirido pelo aplicativo.
* Additional properties are NOT allowed.
Show Child Parameters
bilhetagemobject
Dados de bilhetagem do aplicativo.
* Additional properties are NOT allowed.
Show Child Parameters
analiseobject
Detalhe da análise do aplicativo.
* Additional properties are NOT allowed.
Show Child Parameters
Example
AnaliseEmissorDetalheViewModel
objectDetalhe da análise do emissor.
* Additional properties are NOT allowed.
quantidadeTotalNotasinteger(int32)
Quantidade total de notas processadas.
quantidadeTotalNotasAprovadasinteger(int32)
Quantidade total de notas com status aprovado.
quantidadeTotalNotasCanceladasinteger(int32)
Quantidade total de notas canceladas.
quantidadeTotalNotasRejeitadasinteger(int32)
Quantidade total de notas rejeitadas pela SEFAZ.
quantidadeTotalNotasPendentesinteger(int32)
Quantidade total de notas em processamento ou pendentes.
quantidadeTotalNotasEmContingenciainteger(int32)
Quantidade total de notas emitidas em regime de contingência.
quantidadeTotalNotasSubstituidasinteger(int32)
Quantidade total de notas que foram substituídas.
valorTotalNotasnumber(double)
Valor bruto total de todas as notas.
valorTotalNotasAprovadasnumber(double)
Valor total acumulado das notas aprovadas.
valorTotalNotasCanceladasnumber(double)
Valor total acumulado das notas canceladas.
valorTotalNotasRejeitadasnumber(double)
Valor total acumulado das notas rejeitadas.
valorTotalNotasPendentesnumber(double)
Valor total acumulado das notas pendentes.
valorTotalNotasEmContingencianumber(double)
Valor total acumulado das notas em contingência.
valorTotalNotasSubstituidasnumber(double)
Valor total acumulado das notas substituídas.
tempoMedioEmissaoNotasMilissegundosnumber(double)
Tempo médio de emissão das notas em milissegundos.
tempoMedioEmissaoNotasstring
Representação textual do tempo médio de emissão.
quantidadeConsultasCatalogoFiscalinteger(int32)
Quantidade de consultas realizadas ao catálogo fiscal.
quantidadeProdutosTributacaoAlteradainteger(int32)
Quantidade de produtos que tiveram a tributação alterada no período.
quantidadeConsultasCnpjinteger(int32)
Quantidade de consultas de CNPJ realizadas pelo emissor.
Example
AnaliseEmissorViewModel
objectDados da análise do emissor.
* Additional properties are NOT allowed.
documentostring
Documento (CPF/CNPJ) do emissor.
tipoDocumentostring
Tipo de documento do emissor.
Allowed values:CpfCnpj
nomestring
Nome ou Razão Social do emissor.
nomeFantasiastring
Nome fantasia do emissor.
dataCriacaostring(date-time)
Data de criação do emissor no sistema.
ultimaAlteracaostring(date-time)
Data de última alteração dos dados do emissor no sistema.
statusstring
Status do emissor.
Allowed values:InativoAtivo
certificadoDigitalobject
Informações do certificado digital.
* Additional properties are NOT allowed.
Show Child Parameters
bilhetagemobject
Dados da bilhetagem do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
analiseobject
Detalhe da análise do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
Example