benefícioscadastrar plano
POST
/v1/benefit-planspermissão: manage_employeesCadastrar plano
Cria um plano no catálogo da organização. O nome não se repete dentro da mesma organização. Os dois valores são o padrão que a adesão herda quando não traz valor próprio.
corpo da requisição
- namestringobrigatório
- Nome do plano, até 120 caracteres.
- categoryhealth_plan | dental_plan | life_insurance | meal_voucher | food_voucher | transport_voucher | childcare | education | gym | fuel | otherobrigatório
- Categoria do benefício.
- providerstring | nullopcional
- Operadora ou fornecedor.
- employerCostnumberopcional
- Custo mensal do empregador. Padrão 0.
- employeeCostnumberopcional
- Desconto mensal do funcionário. Padrão 0.
- notesstring | nullopcional
- Observação livre, até 1000 caracteres.
erros deste endpoint
- 401not_authenticatedA chave não veio, não existe mais ou foi revogada.
- 403not_allowedA chave não tem manage_employees.
- 409benefit_plan_name_takenJá existe um plano com esse nome nesta organização.
- 422invalid_inputUm campo não passou na validação; fields aponta qual.