Endpoint para gerenciamento de metas de vendas. Permite o cadastro em lote, atualização e consulta de metas por colaborador e período.
Importante: Não existe método DELETE para metas. Para remover uma meta, atualize o valor para
0.00, seguindo o mesmo comportamento do sistema online.
Estrutura da Resposta (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único da meta. |
| representada_id | Integer | Identificador único da representada. |
| colaborador_id | Integer | Identificador único do colaborador. |
| mes | Integer | Mês de referência da meta (1 a 12). |
| ano | Integer | Ano de referência da meta. |
| valor | Decimal | Valor da meta. |
Parâmetros de Envio (POST / PUT)
O corpo da requisição deve ser uma lista (array) de objetos com os seguintes campos:
| Campo | Tipo | Descrição |
|---|---|---|
| representada_id | Integer | Identificador da representada. Quando não informado, a meta será cadastrada para a representada associada à integração. |
| colaborador_id (obrigatório) | Integer | Identificador único do colaborador. |
| mes (obrigatório) | Integer | Mês de referência da meta (1 a 12). |
| ano (obrigatório) | Integer | Ano de referência da meta. |
| valor (obrigatório) | Decimal | Valor da meta (mínimo: 0). |
Validações
- O campo mes deve ser um valor entre 1 e 12.
- Só é permitido cadastrar ou alterar metas para o mês/ano atual ou futuro. Períodos passados são rejeitados.
- O colaborador_id deve pertencer a um colaborador ativo (não excluído) da empresa.