Pular para o conteúdo principal

Desativar contrato

POST /disable_contract​

Resumo​

Este endpoint permite desativar um contrato ativo em uma unidade específica.

Descrição​

Utilize este endpoint para desativar logicamente um contrato, alterando seu status para desativado. O contato deve existir e estar associado à unidade informada.

Requisição​

Body da Requisição​

O corpo deve ser um objeto JSON com os seguintes parâmetros:

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringSimToken identificador da unidade.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_contractstringSimToken identificador do contato a ser ativado.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Exemplo de Requisição​

Curl​

curl -X POST 'https://portal.fipli.pro/api/v1/disable_contract' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "id_token_contract": "<id_token_contract>"
}'

Resposta​

200 OK​

Desatição realizada com sucesso.

{
  "success": true,
  "message": "Contract disabled successfully.",
  "data": null
}

Erros Comuns​

StatusMensagemDescrição
400"Missing parameters"Algum parâmetro obrigatório (access_token, unit_token, id_token_contract) não foi enviado.
403"Invalid data"Token de autenticação inválido ou não autorizado.
500"Something went wrong. Please try again later."Erro interno no servidor.