benefíciosvincular a um plano
POST
/v1/employees/:employeeId/benefitspermissão: manage_employeesVincular a um plano
Registra a adesão. Recusa plano arquivado e recusa uma segunda adesão aberta no mesmo plano. Os dois valores só entram quando esta pessoa paga diferente do catálogo.
parâmetros do caminho
- employeeIduuidobrigatório
- Id do funcionário.
corpo da requisição
- benefitPlanIduuidobrigatório
- Id do plano.
- startedOnstringobrigatório
- Primeiro dia, AAAA-MM-DD.
- endedOnstring | nullopcional
- Último dia, AAAA-MM-DD.
- employerCostnumber | nullopcional
- Custo próprio do empregador nesta adesão.
- employeeCostnumber | nullopcional
- Desconto próprio do funcionário nesta adesão.
- notestring | nullopcional
- Observação livre, até 500 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.
- 404not_foundO recurso não existe nesta organização.
- 409benefit_already_enrolledEssa pessoa já tem adesão aberta nesse plano.
- 409benefit_plan_archivedO plano está arquivado e não aceita adesão nova.
- 422invalid_inputUm campo não passou na validação; fields aponta qual.