Create Benefit Plan

post https://api.worklio.com/wep/companies/{companyId}/benefits/{benefitId}/{versionId}/plans

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

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

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company Id

benefitId

int32

required

Benefit Id

versionId

int32

required

Benefit Version Id

Body Params

Benefit Plan informations

name

string | null

required

Name.

paystubDescription

string | null

required

PaystubDescription.

medicalHighDeductible

boolean

MedicalHighDeductible.

retirementLoanPriority

int32

RetirementLoanPriority_v10 enum

Members:

0 - LoanPriorityOverElections ( Loan Priority Over Elections. )
1 - LoanOnlyRetirementPlansOnly ( Loan Only; Retirement Plans Only. )

supplUnit

double | null

≥ 0

SupplUnit.

supplRoundingMode

int32

SupplBenefitRoundingMode_v10 enum

Members:

1 - RoundUp ( Round Up. )
2 - RoundDown ( Round Down. )
3 - RoundToNearest ( Round to Nearest. )

supplCoverageType

int32

SupplBenefitCoverageType_v10 enum

Members:

1 - FlatAmount ( Flat Amount. )
2 - SalaryMultiplier ( Multiplier of Salary. )
3 - SelectableCoverage ( Selectable Coverage. )

supplFlatCoverage

double | null

≥ 0

SupplFlatCoverage.

supplMultiplier

double | null

≥ 0

SupplMultiplier.

supplSalaryAt

int32

SupplBenefitSalaryAt_v10 enum

Members:

1 - FirstOfEachMonth ( 1st Day Each Month. )
2 - RenewalDate ( Renewal Date. )

supplSalaryPeriod

int32

SupplBenefitSalaryPeriod_v10 enum

Members:

1 - Week ( Week. )
2 - Month ( Month. )
3 - Quarter ( Quarter. )
4 - Year ( Year. )

supplSalaryPerc

double | null

≥ 0

SupplSalaryPerc.

supplEEMin

double | null

≥ 0

SupplEEMin.

supplEEMax

double | null

≥ 0

SupplEEMax.

supplSMin

double | null

≥ 0

SupplSMin.

supplSMax

double | null

≥ 0

SupplSMax.

supplDMin

double | null

≥ 0

SupplDMin.

supplDMax

double | null

≥ 0

SupplDMax.

supplEEGuaranteed

double | null

≥ 0

SupplEEGuaranteed.

supplSGuaranteed

double | null

≥ 0

SupplSGuaranteed.

supplDGuaranteed

double | null

≥ 0

SupplDGuaranteed.

spAccAnnualLimit

double | null

≥ 0

SpAccAnnualLimit.

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

Response

Response body

object

int32

Id.

name

string | null

Name.

paystubDescription

string | null

PaystubDescription.

medicalHighDeductible

boolean

MedicalHighDeductible.

retirementLoanPriority

int32

RetirementLoanPriority_v10 enum

Members:

0 - LoanPriorityOverElections ( Loan Priority Over Elections. )
1 - LoanOnlyRetirementPlansOnly ( Loan Only; Retirement Plans Only. )

1

supplUnit

double | null

SupplUnit.

supplRoundingMode

int32

SupplBenefitRoundingMode_v10 enum

Members:

1 - RoundUp ( Round Up. )
2 - RoundDown ( Round Down. )
3 - RoundToNearest ( Round to Nearest. )

1 2 3

supplCoverageType

int32

SupplBenefitCoverageType_v10 enum

Members:

1 - FlatAmount ( Flat Amount. )
2 - SalaryMultiplier ( Multiplier of Salary. )
3 - SelectableCoverage ( Selectable Coverage. )

1 2 3

supplFlatCoverage

double | null

SupplFlatCoverage.

supplMultiplier

double | null

SupplMultiplier.

supplSalaryAt

int32

SupplBenefitSalaryAt_v10 enum

Members:

1 - FirstOfEachMonth ( 1st Day Each Month. )
2 - RenewalDate ( Renewal Date. )

1 2

supplSalaryPeriod

int32

SupplBenefitSalaryPeriod_v10 enum

Members:

1 - Week ( Week. )
2 - Month ( Month. )
3 - Quarter ( Quarter. )
4 - Year ( Year. )

1 2 3 4

supplSalaryPerc

double | null

SupplSalaryPerc.

supplEEMin

double | null

SupplEEMin.

supplEEMax

double | null

SupplEEMax.

supplSMin

double | null

SupplSMin.

supplSMax

double | null

SupplSMax.

supplDMin

double | null

SupplDMin.

supplDMax

double | null

SupplDMax.

supplEEGuaranteed

double | null

SupplEEGuaranteed.

supplSGuaranteed

double | null

SupplSGuaranteed.

supplDGuaranteed

double | null

SupplDGuaranteed.

spAccAnnualLimit

double | null

SpAccAnnualLimit.

benefitType

int32

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. )

1 2 3 11 12 13 14 19 21 22 23 24 25 41 42 43 44 45 51

Language

Credentials

Bearer

jwt


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.worklio.com/wep/companies//benefits///plans \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1.0' \
5
     --header 'content-type: application/*+json' \
6
     --header 'x-api-version: 1.0'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success