API Reference
Start typing to search…

Create Employee Benefit

post
https://api.worklio.com/wep/companies//employees//deductions/benefit

Create Employee Benefit Deduction.
Benefit Template working as default source of data. All items not filled in Employee Benefit Deduction model will be taken from Benefit Template (if templateId is used) Benefit Deductions and Benefit Templates are unconnected entities. From this reason you are not able to see which Benefit Template was used for create Benefit Deduction. Updates in Benefit Templates will not update Employee Benefit Deduction.
Be aware that started Payroll calculations will not take this change in affect. Payroll needs to be Discarded and Started again.
This endpoint can be called only by all user levels

Path Params
int32
required

Company Id

int32
required

Employee Id

Query Params
int32

Template Id

Body Params

Benefit Template Create Entity

string | null
required

Name.

date-time
required

StartDate. Data type is validated and must be Number

date-time | null

EndDate. Data type is validated and must be Number

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

int32
enum

DeductionTaxabilityType_v10 enum

Members:

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

Allowed:
double | null

AnnualLimit.

double | null

Coverage.

employeeDeduction
object

ContributionAmountCreate_v10.

employerContribution
object

ContributionAmountCreate_v10.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

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
Updated 7 months ago