Clickfin

Referência da API
Portal oficial
DELETE/client/{clientId}

Excluir um cliente

Marca o cliente como excluído e o oculta das listagens, opções e consultas comuns. O cliente deve pertencer ao licenciado e à empresa selecionada no token; caso contrário, retorna 404. Se a empresa da sessão tiver sido excluída ou deixado de pertencer ao licenciado, retorna 401 CLIENT.DELETE.NOT_AUTHORIZED. A exclusão é bloqueada (400 CLIENT.DELETE.HAS_CONTRACTS ou CLIENT.DELETE.HAS_ACCOUNTS_RECEIVABLE) quando houver contrato, conta a receber ou vencimento ativo vinculado; registros financeiros já excluídos logicamente não bloqueiam. A operação não oferece restauração pela API e requer perfil de Administrador.

AcessoChave de API · clients:write
Parâmetros1
Respostas8

Parâmetros

  • clientIdpath

    ID do cliente a ser excluído.

Respostas

200Sucesso

Cliente excluído com sucesso.

400Erro

Empresa não selecionada no token.

401Erro

Erro de autenticação. O token não foi fornecido, é inválido ou expirou.

403Erro

Erro de autorização. O usuário não tem permissão de Administrador.

404Erro

Cliente não encontrado, já excluído, de outro licenciado (antes 403 CLIENT.DELETE.NOT_AUTHORIZED) ou de outra empresa.

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.

500Erro

Erro interno ao tentar excluir o cliente.

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.