Pular para o conteúdo
notemnotemDocumentação

Referência da API › Serviços

Consultar serviço

Devolve um serviço cadastrado na empresa.

GET/api/v1/empresas/{id}/servicos/{servico_id}

Use para conferir o código, a tributação e a retenção que esse serviço aplica nas notas. Serviço de outra empresa responde 404.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
servico_idtextono caminhoobrigatório
UUID (RFC 9562). Fora do padrão: 400 REQUISICAO_INVALIDA com campo igual ao nome do parâmetro. · UUID

Respostas

200 Serviço

Campos da resposta
idtexto
UUID
id_externotexto ou null
até 100 caracteres
nometexto
ativobooleano
Padrão: true
codigo_servicotexto
Formato: ^\d{6}$
descricao_servicotexto ou null
codigo_municipaltexto ou null
codigo_nbstexto ou null
Formato: ^\d{9}$
descricao_padraotexto
tributacao_isstexto
Valores: tributavel, imunidade, exportacao, nao_incidencia
tipo_imunidadetexto ou null
Valores: nao_informado, entes_federativos, templos, partidos_sindicatos_entidades, livros_jornais_papel, fonogramas_musicais
retencao_isstexto
Valores: nao_retido, retido_tomador, retido_intermediario
classificacao_ibscbsobjeto ou null
classificacao_ibscbs.codigo_classificacaotexto
Formato: ^\d{6}$
classificacao_ibscbs.csttexto ou null
classificacao_ibscbs.descricaotexto ou null
classificacao_ibscbs.indicador_operacaotexto ou null
Formato: ^\d{6}$
classificacao_ibscbs.consumidor_finalbooleano
Padrão: false
classificacao_ibscbs.atividade_simplestexto ou null
Somente ME/EPP. 10 só com 16.01; 11 só com 99.04.01; 12/13 só com 7.02 e 7.05. Enviada a partir do próximo leiaute. · Valores: 07, 08, 09, 10, 11, 12, 13, 14, 90
classificacao_ibscbs.situacaotexto
a_revisar = indicador retirado da tabela oficial · Valores: completa, pendente, a_revisar
indicador_operacao_ibscbstexto ou null
Obsoleto: use classificacao_ibscbs.indicador_operacao. Ainda aceito; se enviado junto com um valor diferente em classificacao_ibscbs, responde 422. · Obsoleto.
numero_beneficio_municipaltexto ou null

404 Erro no formato padrão

Limites

Valem também os limites gerais da chave. Veja Limites de uso.