Billing - Grupos de Cobrança (Charge Groups)

Os Grupos de Cobrança permitem organizar múltiplas cobranças sob uma mesma categoria ou lote.

As rotas de grupos estão sob o prefixo billing/.

---

Listagem de Grupos

[GET] billing/charge-groups

Retorna uma lista paginada de grupos de cobrança da conta.

Query Params

Nome	Tipo	Obrigatório	Descrição
search	string	Não	Busca por nome do grupo
page	integer	Não	Página atual
per_page	integer	Não	Itens por página

Response (200 OK)

{
  "data": [
    {
      "charge_group_id": 1,
      "name": "Lote Janeiro 2024",
      "code": "A1B2C3D4",
      "slug": "lote-janeiro-2024-a1b2c3d4",
      "created_at": "2024-01-01 10:00:00"
    }
  ],
  "links": { ... },
  "meta": { ... }
}

---

Criar Grupo

[POST] billing/charge-groups

Cria um novo grupo de cobrança. O code e o slug são gerados automaticamente se não fornecidos.

Request Body

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome identificador do grupo
description	string	Não	Descrição detalhada
slug	string	Não	Slug personalizado (deve ser único)

Exemplo

{
  "name": "Mensalidades Esculares 2024",
  "description": "Lote referente as mensalidades do ano letivo de 2024"
}

---

Detalhes do Grupo

[GET] billing/charge-groups/\{id\}

Retorna as informações de um grupo específico.

---

Atualizar Grupo

[PUT] billing/charge-groups/\{id\}

Atualiza os dados de um grupo de cobrança.

---

Deletar Grupo

[DELETE] billing/charge-groups/\{id\}

Remove o grupo de cobrança (Soft Delete).