Documentação da API

POST /list_group_categories

Resumo

Este endpoint permite listar todos os grupos de categorias ativos no sistema, filtrados por tipo de módulo.

---

Descrição

Utilize este endpoint para obter uma lista de grupos de categorias ativos, incluindo seus nomes, descrições e códigos, filtrados pelo tipo de módulo especificado. A requisição exige autenticação e associação com uma unidade específica.

---

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
type	string	Sim	Tipo de módulo para filtrar os grupos de categorias (ex.: in, out).	out

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/list_group_categories' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "type": "out"
}'

---

Resposta

200 OK

Lista de grupos de categorias retornada com sucesso.

{
  "success": true,
  "data": [
    {
      "name": "Despesas Operacionais",
      "description": "Categorias relacionadas a despesas operacionais da empresa",
      "code": 1
    },
    {
      "name": "Receitas",
      "description": "Categorias relacionadas a entradas financeiras",
      "code": 2
    }
  ]
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing parameters"	Algum parâmetro obrigatório (access_token, unit_token, type) 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.

---

Observações

• A lista retornada inclui apenas os grupos de categorias ativos (active: true) que correspondem ao tipo de módulo especificado no parâmetro type, ordenados por nome.
• Cada item na resposta contém:
  • name: Nome do grupo de categorias.
  • description: Descrição ou observação sobre o grupo.
  • code: Identificador único do grupo de categorias.
• A operação é realizada de forma transacional, garantindo a consistência dos dados no banco.
• Certifique-se de que os tokens estejam válidos e que a unidade exista no sistema.