Create Child Support Deduction

post

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

Create employee Child Support Deduction.

This endpoint can be called by all level users.

Path Params

companyId

int32

required

Company Id

employeeId

int32

required

Employee Id

Body Params

Child Support 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.

issuingAuthority

string | null

IssuingAuthority.

receivedDate

date-time | null

required

ReceivedDate. Data type is validated and must be Number

caseNumber

string | null

required

CaseNumber.

fipsCode

string | null

required

FIPSCode.

state

string | null

required

State.

goal

double

≥ 0

Goal.

amount

double | null

required

≥ 0

Deduct Amount per Pay Period

percentageLimit

double | null

required

≥ 0

PercentageLimit.

exemptAmount

double | null

≥ 0

ExemptAmount.

inArrears

boolean

InArrears.

anotherChild

boolean

AnotherChild.

childPastDueSupport

double | null

≥ 0

ChildPastDueSupport.

stateDispRed

double | null

≥ 0

StateDispRed.

medicalChildSupport

boolean

MedicalChildSupport.

custodialParent

string | null

CustodialParent.

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

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

200Success