Update Benefit Plan

patch

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

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

Recent Requests

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

planId

int32

required

Benefit Plan Id

Body Params

Benefit Plan informations

name

string | null

required

Name.

paystubDescription

string | null

required

PaystubDescription.

medicalHighDeductible

boolean

MedicalHighDeductible.

retirementLoanPriority

int32

enum

RetirementLoanPriority_v10 enum

Members:

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

Allowed:

supplUnit

double | null

≥ 0

SupplUnit.

supplRoundingMode

int32

enum

SupplBenefitRoundingMode_v10 enum

Members:

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

Allowed:

supplCoverageType

int32

enum

SupplBenefitCoverageType_v10 enum

Members:

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

Allowed:

supplFlatCoverage

double | null

≥ 0

SupplFlatCoverage.

supplMultiplier

double | null

≥ 0

SupplMultiplier.

supplSalaryAt

int32

enum

SupplBenefitSalaryAt_v10 enum

Members:

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

Allowed:

supplSalaryPeriod

int32

enum

SupplBenefitSalaryPeriod_v10 enum

Members:

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

Allowed:

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Success