Create Company Benefit

post

https://api.worklio.com/wep/companies/{companyId}/benefits

Create Company Benefit.
This endpoint can be called only by System and Admin level users.

Employee call will return Forbidden result even for Employee own company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company Id

Body Params

Company Benefit informations

name

string | null

required

Name.

benefitType

int32

enum

required

BenefitType_v10 enum

Members:

1 - Medical ( Medical Insurance. )
2 - Dental ( Dental Insurance. )
3 - Vision ( Vision Insurance. )
11 - STD ( Short-Term Disability Insurance. )
12 - LTD ( Long-Term Disability Insurance. )
13 - GTL ( Group Term Life Insurance. )
14 - VoluntaryLife ( Voluntary Life Insurance. )
19 - VoluntaryBenefits ( Voluntary Benefits. )
21 - FSAMedical ( FSA: Medical. )
22 - FSADependentCare ( FSA: Dependent Care. )
23 - FSALimited ( FSA: Limited. )
24 - HSA ( HSA. )
25 - Commuter ( Commuter. )
41 - Retirement401k ( 401(k). )
42 - Retirement403b ( 403(b). )
43 - Retirement408k ( 408(k). )
44 - Retirement457 ( 457. )
45 - Retirement501c ( 501(c). )
51 - SimpleIRA ( Simple IRA. )

effectiveDate

date-time

required

EffectiveDate. Data type is validated and must be Number

waitingPeriodDays

int32

required

Waiting Period Days.

waitingPeriodDaysER

int32 | null

ER Contribution Waiting Period Days.

waitingPeriodEnds

int32

enum

required

EligibilityCalcType_v10 enum

Members:

1 - UseProbationEnd ( End of Probation Period. )
2 - NextPolicyMonth ( 1st Day of Policy Month on or after The End of The Probation Period. )

Allowed:

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Success