Saltar a contenido

Grupos

Qué es

Uno grupo Es un mecanismo de organización para agrupar entidades (locales de trabajo y/o usuarios) y facilitar filtros y gestión a escala. El caso más común es el Grupo de lugares, usado para seleccionar varios lugares de trabajo de una vez en informes y filtros de hoja.

Por qué esto importa en una integración

  • Permite crear "views" operativos: "Filial SP", "Equipe de ventas", "Regionales del Sur"
  • Facilita integración con jerarquías del ERP (regionales, centros de costo, unidades de negocio)
  • Reduce la necesidad de seleccionar elementos individuales al filtrar informes

Estructura

Grupos pueden contener: - Lugares de trabajo directamente - Otros grupos (estructura en árbol, como "pastas")

Text Only
1
2
3
4
5
6
Grupo: Filiais do Nordeste
├── Grupo: Bahia
│   ├── Local: Salvador - Centro
│   └── Local: Salvador - Litoral
└── Grupo: Pernambuco
    └── Local: Recife - Boa Viagem

Operaciones disponibles

Método Variable Descripción
GET /grupos/ Listar grupos
POST /grupos/ Crear grupo
GET /grupos/{id}/ Obtener grupo
PATCH /grupos/{id}/ Actualizar
DELETE /grupos/{id}/ Eliminar

Campos

Campo Tipo Obligatorio Descripción
id Integer ID interno
empregador_id Integer Gálatas ID del empleador
nome string Gálatas Nombre del grupo
descricao string Descripción
itens array Lugares y/o grupos hijos
is_active boolean Status

Ejemplo: Crear grupo

Solicitud

HTTP
1
2
3
4
5
6
7
8
9
POST /pontotel/api/v4/grupos/
Authorization: Bearer {token}
Content-Type: application/json

{
  "empregador_id": 42,
  "nome": "Filiais do Sul",
  "descricao": "Agrupa todos os locais das filiais da Região Sul"
}

Respuesta (201 Created)

JSON
1
2
3
4
5
6
7
8
{
  "id": 7,
  "empregador_id": 42,
  "nome": "Filiais do Sul",
  "descricao": "Agrupa todos os locais das filiais da Região Sul",
  "is_active": true,
  "itens": []
}