Pular para conteúdo

Grupos

O que é

Um grupo é um mecanismo de organização para agrupar entidades (locais de trabalho e/ou usuários) e facilitar filtros e gestão em escala. O caso mais comum é o Grupo de Locais, usado para selecionar vários locais de trabalho de uma vez em relatórios e filtros de folha.

Por que isso importa numa integração

  • Permite criar "views" operacionais: "Filial SP", "Equipe de Vendas", "Regionais do Sul"
  • Facilita integração com hierarquias do ERP (regionais, centros de custo, unidades de negócio)
  • Reduz a necessidade de selecionar itens individualmente ao filtrar relatórios

Estrutura

Grupos podem conter: - Locais de trabalho diretamente - Outros grupos (estrutura em árvore, 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

Operações Disponíveis

Método Endpoint Descrição
GET /grupos/ Listar grupos
POST /grupos/ Criar grupo
GET /grupos/{id}/ Obter grupo
PATCH /grupos/{id}/ Atualizar
DELETE /grupos/{id}/ Remover

Campos

Campo Tipo Obrigatório Descrição
id integer — ID interno
empregador_id integer ✅ ID do empregador
nome string ✅ Nome do grupo
descricao string — Descrição
itens array — Locais e/ou grupos filhos
is_active boolean — Status

Exemplo: Criar Grupo

Requisição

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"
}

Resposta (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": []
}