NFS-e - Obter parâmetros do município.

Retorna os parâmetros do município para emissão de NFS-e no Ambiente Nacional, incluindo dados do convênio
(aderência ao Ambiente Nacional, Emissor Nacional e MAN) e as retenções configuradas no município.

⚠️ 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.

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

ObterParametrosMunicipioNfseViewModel

Parâmetros do município para emissão de NFS-e.

* Additional properties are NOT allowed.
parametrosConvenioobject

Parâmetros do convênio do município com o Ambiente Nacional NFS-e.

* Additional properties are NOT allowed.
Show Child Parameters
retencoesobject

Detalhes das retenções configuradas no município.

* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Parametros
 

NFS-e - Consultar cadastro do CNPJ no CNC.

Consulta o cadastro do CNPJ no Cadastro Nacional de Contribuintes (CNC) do Ambiente Nacional NFS-e,
retornando a lista de registros municipais encontrados com as informações cadastrais, situação de emissão
e dados de endereço do contribuinte.

⚠️ 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.

cnpjstringrequired

CNPJ a ser consultado no CNC.

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

Cadastro municipal do contribuinte no CNC.

* Additional properties are NOT allowed.
origemDadosstring | null

Origem dos dados do cadastro.

codigoMunicipiointeger(int32)

Código IBGE do município.

tipoAmbienteinteger(int32)

Tipo de ambiente do cadastro.

idinteger(int32)

Identificador do cadastro.

codigoUFinteger(int32)

Código da UF.

infCadobject

Informações cadastrais do contribuinte no CNC.

* Additional properties are NOT allowed.
Show Child Parameters
dataHoraCadastrostring(date-time)

Data e hora do cadastro.

dataHoraAtualizacaostring(date-time)

Data e hora da última atualização do cadastro.

opcaoSimplesNacionalstring | null

Opção pelo Simples Nacional do contribuinte.

get/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Cnpj/{cnpj}/CadastroCnc
 

NFS-e - Obter alíquota de ISS do município.

Retorna as alíquotas de ISS vigentes para o serviço informado no município, conforme parametrização do Ambiente Nacional NFS-e.
As alíquotas são agrupadas por tipo de incidência e contêm o período de vigência de cada faixa.

⚠️ ATENÇÃO: O código do município deve ser o código IBGE de 7 dígitos. O código do serviço deve seguir a classificação da LC 116/2003.

get

Path Parameters

codigoMunicipiostringrequired

Código IBGE do município.

codigoServicostringrequired

Código do serviço (LC 116/2003).

Headers

DocumentoEmissorstring

Documento do emissor.

Response

OK

ObterAliquotaIssDoMunicipioNfseViewModel

Alíquota de ISS vigente do município para o serviço informado.

* Additional properties are NOT allowed.
incidenciastring | null

Tipo de incidência da alíquota.

aliquotanumber(double)

Valor percentual da alíquota de ISS.

dataInicioVigenciastring(date-time)

Data de início da vigência da alíquota.

dataFimVigenciastring | null(date-time)

Data de fim da vigência da alíquota, se houver.

get/api/v1/RecursosAdicionais/Nfse/Municipio/{codigoMunicipio}/Servico/{codigoServico}/AliquotaIss
 

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

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
 

AnaliseAplicativoDetalheViewModel

object

Detalhe 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