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. | b31643fc-a45f-448c-99ee-736a547f6989 |
unit_token | string | Sim | Token identificador da unidade. | e6988e9e-b0c1-410c-ae08-aed7c64ac71f |
token | string | Sim | Token identificador da categoria a ser atualizada. | a6927665-6d56-4839-ad23-37d48717da13 |
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 |
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": "b31643fc-a45f-448c-99ee-736a547f6989",
"unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
"token": "a6927665-6d56-4839-ad23-37d48717da13",
"category": "Nova Categoria",
"note": "Categoria atualizada para novo projeto",
"category_master": 123,
"type": "financeiro"
}'
Resposta
200 OK
Atualização realizada com sucesso.
{
"success": true,
"message": "Category updated successfully",
"data": {
"token": "a6927665-6d56-4839-ad23-37d48717da13"
}
}
Erros Comuns
| Status | Mensagem | Descrição |
|---|---|---|
400 | "Missing required parameters" | Algum parâmetro obrigatório (access_token, unit_token, token) não foi enviado. |
400 | "Invalid parameter: category_master must be a positive integer" | O parâmetro 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 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_masterdeve 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.