Documentação da API

POST /insert_category

Resumo

Este endpoint permite o cadastro de uma nova categoria para uma unidade específica do sistema.

---

Descrição

Use este endpoint para cadastrar categorias de receita ("in") ou despesa ("out") em uma unidade da plataforma. É necessário fornecer os tokens de acesso e da unidade, além das informações da categoria.

---

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
type	string	Sim	Tipo da categoria: "in" para receitas ou "out" para despesas.	"in"
id_token_category_master	string	Sim	Token da categoria pai (se for uma subcategoria).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
category	string	Sim	Nome da categoria a ser cadastrada.	13º Salário
note	string	Não	Observação ou descrição adicional sobre a categoria.	Despesas com o 13º salário do pessoal.

---

Exemplo de Requisição

Curl

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

---

Resposta

200 OK

Cadastro realizado com sucesso.

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

Erros Comuns

Status	Mensagem	Descrição
400	"Missing parameters"	Algum parâmetro obrigatório não foi enviado na requisição.
403	"Invalid data"	Token inválido ou não autorizado.
404	"Unit not found"	A unidade com o token fornecido não foi encontrada no sistema.
500	"Something went wrong. Please try again later."	Erro interno no servidor.

---

Observações

• As categorias cadastradas ficam atreladas à unidade informada.
• O campo category_master permite a criação de hierarquia entre categorias.
• Certifique-se de que os tokens utilizados estejam válidos e atualizados.