ContractPlus APIs | Bloquear/Desbloquear Contrato
1 min
Criado por Eduardo Martins Dos Santos em 28/08/2025 10:58
Atualizado por Eduardo Martins Dos Santos em 28/08/2025 11:11

❓Dúvida
Como bloquear ou desbloquear um contrato via API no sistema ContractPlus.

⚠️ Informação Importante

Um contrato, uma vez bloqueado, não poderá executar os processos de medições e faturamentos.

A API responsável por realizar o bloqueio/desbloqueio contratual é:

/api/contract/{id}/blockOrUnblock

🛠️ Procedimento

Para realizar o bloqueio/desbloqueio do contrato:

  1. No campo ID do contrato, informe o identificador do contrato.

  2. No campo Request Body, informe o motivo do bloqueio/desbloqueio (caso seja aplicável).

  3. Execute a API.

Se o processo for realizado com sucesso, será retornado o código: "200 - Contrato bloqueado/desbloqueado com sucesso", acompanhado do status do contrato no campo Response body.

Status do contrato pré-request:

Status do contratos pós-request:

📝 Índice de Códigos 

  • Codigo 204 → Contrato bloqueado/desbloqueado com sucesso: Acompanha o status do contrato no campo Response body.

  • Código 401 → Usuário não autorizado: O usuário não possui autorização e/ou licença de utilização.

  • Código 500 → Erro interno no servidor: Indica que ocorreu uma falha inesperada durante o processamento da requisição no servidor.

Este artigo foi útil para você?
Últimos artigos visitados