Clickfin

Referência da API
Portal oficial
DELETE/service/{serviceId}

Excluir um serviço

Marca o serviço como excluído e o oculta das listagens e seletores. A exclusão é bloqueada (400) quando houver contrato, NFS-e, conta a receber ou vencimento ativo vinculado; registros já excluídos logicamente não bloqueiam (uma NFS-e cancelada continua bloqueando). A API não oferece restauração. O serviço deve pertencer ao licenciado e à empresa selecionada no token; caso contrário, retorna 404, inclusive para serviço de outra empresa do mesmo licenciado. Se a empresa da sessão tiver sido excluída ou deixado de pertencer ao licenciado, a gravação retorna 401 SERVICE.DELETE.NOT_AUTHORIZED. Requer perfil de Administrador.

AcessoChave de API · services:write
Parâmetros1
Respostas7

Parâmetros

  • serviceIdpath

    ID do serviço a ser excluído (24 caracteres; um ID inexistente responde 404).

Respostas

200Sucesso

Serviço excluído com sucesso.

400Erro

Serviço com contrato, NFS-e, conta a receber ou vencimento vinculado, ou empresa não selecionada no token.

401Erro

Token ausente, inválido ou expirado, ou empresa da sessão excluída ou fora do licenciado no momento da gravação (SERVICE.DELETE.NOT_AUTHORIZED).

403Erro

Acesso comercial do licenciado bloqueado ou usuário sem perfil de Administrador.

404Erro

Serviço não encontrado, excluído, de outra empresa ou de outro licenciado.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.