NFS-e - Listar códigos NBS.
Fornece uma listagem dos códigos da Nomenclatura Brasileira de Serviços (NBS),
utilizados para a classificação fiscal de serviços na emissão de NFS-e.
🔍 FILTROS: A busca pode ser refinada por código ou descrição do serviço.
📑 PAGINAÇÃO: O retorno é paginado via parâmetros de offset e limit.
get
Query Parameters
buscastring
Filtrar por campo de busca genérico (código ou descrição).
offsetinteger(int32)
Quantidade de registros a serem pulados.
Default:1
limitinteger(int32)
Limite máximo de registros por página.
Default:10
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ListarNbsViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados de listagem de um código NBS (Nomenclatura Brasileira de Serviços).
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/Nbs/Listar
Authentication
Query Parameters
Headers
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
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
Authentication
Path Parameters
Headers
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
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
Authentication
Path Parameters
Headers
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
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
Authentication
Path Parameters
Headers
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