NFS-e - Obter detalhe do serviço CTN.
Retorna os dados completos de um serviço da Lista de Serviços do CTN (Código Tributário Nacional),
incluindo os códigos NBS associados, os indicadores de operação de NFS-e e as classificações tributárias vinculadas.
get
Path Parameters
codigoCtnstringrequired
Código do serviço conforme a Lista de Serviços do CTN.
Headers
DocumentoEmissorstring
Documento do emissor.
Response
Response
OK
ObterDetalheServicoCtnViewModel
Dados detalhados de um serviço da Lista de Serviços do CTN.
* Additional properties are NOT allowed.
codigoCtnstring | null
Código do serviço conforme a Lista de Serviços do CTN.
descricaostring | null
Descrição do serviço.
incidenciaIssstring
Incidência do ISS conforme a Lista de Serviços do CTN.
Allowed values:LocalPrestadorLocalPrestacaoLocalTomador
nbsarray | null[object]
Dados do NBS no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
indicadoresOperacaoNfsearray | null[object]
Dados do indicador de operação de NFS-e no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
cClassTribsarray | null[object]
Dados da classificação tributária no detalhe do Serviço CTN.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/ServicoCtn/{codigoCtn}/ObterDetalhe
Authentication
Path Parameters
Headers
NFS-e - Listar indicadores de operação.
Fornece uma listagem dos Indicadores de Operação de NFS-e (cIndOp),
utilizados no bloco IBS/CBS da Declaração de Prestação de Serviços (DPS) da reforma tributária.
🔍 FILTROS: A busca pode ser refinada por código, tipo de operação, característica ou local de fornecimento.
📑 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, tipo de operação, característica ou local de fornecimento).
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
ListarIndicadoresOperacaoNfseViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados de listagem de um indicador de operação de NFS-e.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/RecursosAdicionais/IndicadorOperacaoNfse/Listar
Authentication
Query Parameters
Headers
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