Beneficios
Listar Benefícios da Empresa
Retorna os benefícios configurados para a empresa. Use este endpoint antes de criar um pedido para obter os benefitIds necessários.
GET /benefits/v1/benefits
Parâmetros:
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
companyId | Sim | ID da empresa |
status | Não | active ou inactive |
name | Não | Nome ou parte do nome do benefício |
Exemplos:
Resposta (200):
| Campo | Descrição |
|---|---|
id | Guarde este valor — é o benefitId usado ao adicionar depósitos |
name | Nome do benefício |
status | active = aceita depósitos · inactive = desativado |
description | Descrição de onde e como o benefício pode ser utilizado |