Update Miscellaneous Deduction

patch

https://api.worklio.com/wep/companies/{companyId}/employees/{employeeId}/deductions/misc/{deductionId}

Update employee Miscellaneous Deduction

This endpoint can be called by all level users.

Path Params

companyId

int32

required

Company Id

employeeId

int32

required

Employee Id

deductionId

int32

required

Deduction Id

Body Params

Miscellaneous Deduction Entity

description

string | null

required

Description.

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

note

string | null

Note.

paymentMethod

int32

enum

Members:

0 - None ( None. )
1 - ACH ( via Direct Deposit. )

Allowed:

bankAccountNumber

string | null

Bank Account Number - only for ACH payment method

routingNumber

string | null

Bank Routing Number - only for ACH payment method

accountType

int32

enum

Members:

1 - Checking ( Checking. )
2 - Savings ( Savings. )

Allowed:

schedule

int32

enum

Members:

0 - AllPayPeriods ( All Pay Periods. )
1 - FirstEachMonth ( First Pay Period Each Month. )
2 - SecondEachMonth ( Second Pay Period Each Month. )
3 - ThirdEachMonth ( Third Pay Period Each Month. )
4 - FourthEachMonth ( Fourth Pay Period Each Month. )
5 - FifthEachMonth ( Fifth Pay Period Each Month. )
6 - LastEachMonth ( Last Pay Period Each Month. )
7 - SameNumberEachMonth ( Same Number of Periods Each Month. )
8 - FirstEachYear ( First Pay Period Each Year. )
9 - FirstEachQuarter ( First Pay Period Each Quarter. )
10 - FirstEachHalfYear ( First Pay Period Each Half Year. )

lifetimeGoal

double | null

≥ 0

LifetimeGoal.

annualLimit

double | null

≥ 0

AnnualLimit.

employeeDeduction

object

ContributionAmount_v10.

employerContribution

object

ContributionAmount_v10.

int32

Id.

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