Ir para o conteúdo
prumo

benefícioseditar adesão

PATCH/v1/employee-benefits/:benefitIdpermissão: manage_employees

Editar adesão

Muda só o que vier no corpo. Encerrar é mandar endedOn; o fim não pode ser anterior ao início.

parâmetros do caminho

benefitIduuidobrigatório
Id da adesão.

corpo da requisição

benefitPlanIduuidopcional
Troca o plano da adesão.
startedOnstringopcional
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_plan_archivedO plano está arquivado e não aceita adesão nova.
  • 422invalid_inputUm campo não passou na validação; fields aponta qual.