Documentação da API

POST /update_category

Resumo

Este endpoint permite atualizar os dados de uma categoria existente em uma unidade específica.

---

Descrição

Utilize este endpoint para modificar informações de uma categoria, como nome, nota, categoria mestre ou tipo de módulo. A categoria deve existir e estar associada à unidade informada.

---

Requisição

Body da Requisição

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

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token identificador da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token	string	Sim	Token identificador da categoria a ser atualizada.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
category	string	Não	Nome da categoria a ser atualizado.	Nova Categoria
note	string	Não	Observação ou nota associada à categoria.	Categoria atualizada para novo projeto
id_token_category_master	integer	Não	ID da categoria mestre (deve ser um número inteiro positivo).	123
type	string	Não	Tipo de módulo da categoria.	financeiro

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/update_category' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "id_token": "<id_token>",
  "category": "<category>",
  "note": "<note>",
  "id_token_category_master": "<id_token_category_master>",
  "type": "<type>"
}'

---

Resposta

200 OK

Atualização realizada com sucesso.

{
  "success": true,
  "message": "Category updated successfully",
  "data": {
    "token": "<token>"
  }
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing required parameters"	Algum parâmetro obrigatório (access_token, unit_token, id_token) não foi enviado.
400	"Invalid parameter: id_token_category_master must be a positive integer"	O parâmetro id_token_category_master não é um número inteiro positivo.
400	"No fields provided to update"	Nenhum campo válido foi fornecido para atualização.
400	"Unit not found"	A unidade com o unit_token fornecido não foi encontrada.
400	"Category not found or not updated"	A categoria com o id_token fornecido não foi encontrada ou não foi atualizada.
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.

---

Observações

• Pelo menos um dos campos opcionais (category, note, category_master, type) deve ser fornecido para realizar a atualização.
• A atualização é realizada de forma transacional, garantindo a consistência dos dados no banco.
• O parâmetro category_master deve ser um número inteiro positivo, caso seja fornecido.
• Certifique-se de que os tokens estejam válidos e que a unidade exista no sistema.