Referência da API › Serviços
Cadastrar serviço
Cadastra um serviço que a empresa presta, com os códigos que vão na nota.
POST
/api/v1/empresas/{id}/servicosToda nota usa um serviço cadastrado. Informe o código nacional do serviço e, para o IBS/CBS, o código NBS e a classificação tributária.
Os códigos precisam existir nos catálogos oficiais. Use as operações do grupo Catálogos para encontrá-los.
Parâmetros
idEmpresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
Idempotency-KeyChave de idempotência (até 100 caracteres) aceita em POST, PATCH, PUT e DELETE; vale 24 h por integração e ambiente, exceto emissão, cancelamento, análise e substituição de notas (associação duradoura ao pedido). Mesmo conteúdo devolve a mesma resposta (cabeçalho Idempotent-Replayed true); conteúdo diferente devolve 409 IDEMPOTENCIA_CONFLITO. Obrigatória em emissão, cancelamento e substituição. · até 100 caracteres
Corpo da requisição
id_externoaté 100 caracteres
nomeativoPadrão:
truecodigo_servicoFormato:
^\d{6}$codigo_municipalcodigo_nbsFormato:
^\d{9}$descricao_padraotributacao_issValores:
tributavel, imunidade, exportacao, nao_incidenciatipo_imunidadeValores:
nao_informado, entes_federativos, templos, partidos_sindicatos_entidades, livros_jornais_papel, fonogramas_musicaisretencao_issValores:
nao_retido, retido_tomador, retido_intermediarioclassificacao_ibscbsclassificacao_ibscbs.codigo_classificacaoFormato:
^\d{6}$classificacao_ibscbs.indicador_operacaoFormato:
^\d{6}$classificacao_ibscbs.consumidor_finalPadrão:
falseclassificacao_ibscbs.atividade_simplesSomente 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, 90indicador_operacao_ibscbsObsoleto: use classificacao_ibscbs.indicador_operacao. Ainda aceito; se enviado junto com um valor diferente em classificacao_ibscbs, responde 422. · Obsoleto.
numero_beneficio_municipalRespostas
201 Serviço criado
Campos da resposta
idUUID
id_externoaté 100 caracteres
nomeativoPadrão:
truecodigo_servicoFormato:
^\d{6}$descricao_servicocodigo_municipalcodigo_nbsFormato:
^\d{9}$descricao_padraotributacao_issValores:
tributavel, imunidade, exportacao, nao_incidenciatipo_imunidadeValores:
nao_informado, entes_federativos, templos, partidos_sindicatos_entidades, livros_jornais_papel, fonogramas_musicaisretencao_issValores:
nao_retido, retido_tomador, retido_intermediarioclassificacao_ibscbsclassificacao_ibscbs.codigo_classificacaoFormato:
^\d{6}$classificacao_ibscbs.cstclassificacao_ibscbs.descricaoclassificacao_ibscbs.indicador_operacaoFormato:
^\d{6}$classificacao_ibscbs.consumidor_finalPadrão:
falseclassificacao_ibscbs.atividade_simplesSomente 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, 90classificacao_ibscbs.situacaoa_revisar = indicador retirado da tabela oficial · Valores:
completa, pendente, a_revisarindicador_operacao_ibscbsObsoleto: use classificacao_ibscbs.indicador_operacao. Ainda aceito; se enviado junto com um valor diferente em classificacao_ibscbs, responde 422. · Obsoleto.
numero_beneficio_municipal400 Erro no formato padrão
409 ID_EXTERNO_DUPLICADO
422 Erro no formato padrão
Limites
Valem também os limites gerais da chave. Veja Limites de uso.

