API Reference
Start typing to search…

Update Benefit Contribution

patch
https://api.worklio.com/wep/companies//benefits///contributions/

Update Benefit Contribution.
This endpoint can be called only by System and Admin level users.

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

Path Params
int32
required

Company Id

int32
required

Benefit Id

int32
required

Benefit Version Id

int32
required

Benefit Contribution Id

Body Params

Benefit Contribution informations

string | null
required

Name.

int32
enum
required

Contribution Type.

Members:

  • 1 - FlatAmount ( Flat Amount. )
  • 2 - Percentage ( Percentage. )
  • 3 - PercentageOfPlan ( Percentage of Plan. )
  • 4 - MultitierPercentage ( Multi-tier Percentage. )
  • 5 - EmployeeContribution ( Employee Contribution. )

Allowed:
double | null

Value1.

double | null

Value2.

double | null

Value3.

double | null

Value4.

double | null

Value5.

double | null

LimitedTo1.

double | null

LimitedTo2.

double | null

LimitedTo3.

double | null

LimitedTo4.

double | null

LimitedTo5.

boolean | null

Insurance_Rollover.

retirementTierData
array of objects | null

RetirementTierData.

retirementTierData
int32
enum

Contribution Spending Frequency.

Members:

  • 1 - PayPeriod ( Pay Period. )
  • 2 - Monthly ( Monthly. )
  • 3 - Quarterly ( Quarterly. )
  • 5 - Annually ( Annually. )
  • 6 - DeductionSchedule ( Deduction Schedule. )

Allowed:
Headers
string
Defaults to 1.0

The requested 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

Updated 7 months ago

Language
Credentials
Bearer
jwt
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain
Updated 7 months ago