Create Benefit Template

post

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

Create new company Benefit Template.
Settings in template could be used later for creating new benefits deductions on Employee level.
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

Benefit Template Entity

name

string | null

required

Name.

startDate

date-time

required

StartDate. Data type is validated and must be Number

endDate

date-time | null

EndDate. Data type is validated and must be Number

deductionType

int32

enum

required

DeductionType_v10 enum

Members:

1 - Insurance_Medical ( Medical Insurance. )
2 - Insurance_Dental ( Dental Insurance. )
3 - Insurance_Vision ( Vision Insurance. )
11 - Suppl_STD ( Short-Term Disability. )
12 - Suppl_LTD ( Long-Term Disability. )
13 - Suppl_GTL ( Group Term Life. )
14 - Suppl_VoluntaryLife ( Voluntary Life. )
19 - Suppl_VoluntaryBenefit ( Voluntary Benefit. )
21 - Spend_FSAMedical ( Flexible Spending Account: Medical. )
22 - Spend_FSADependentCare ( Flexible Spending Account: Dependent Care. )
23 - Spend_FSALimited ( Flexible Spending Account: Limited. )
24 - Spend_HSA ( HSA - Health Savings Account. )
25 - Spend_Commuter ( Commuter. )
41 - Retire_401k ( 401(k). )
42 - Retire_403b ( 403(b). )
43 - Retire_408k ( 408(k). )
44 - Retire_457 ( 457. )
45 - Retire_501c ( 501(c). )
51 - Retire_SimpleIRA ( Simple IRA. )

taxability

int32

enum

DeductionTaxabilityType_v10 enum

Members:

1 - Pretax ( Pretax. )
2 - Aftertax ( Aftertax. )
3 - SCorp ( SCorp. )
4 - DomesticPartner ( DomesticPartner. )
5 - Roth ( Roth. )

Allowed:

annualLimit

double | null

AnnualLimit.

coverage

double | null

Coverage.

employeeDeduction

object

ContributionAmountCreate_v10.

employerContribution

object

ContributionAmountCreate_v10.

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