Create Contractor Deduction Template

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

companyID
string
required
ID of company

contractorID
string
required
ID of contractor

custom_name
string
required
Human-readable name for the deduction template

deduction_type
string
enum
required
garnishment,miscellaneous

Allowed:
garnishment,miscellaneous

effective_start_date
string
required
Date the template should start become effective

effective_end_date
string
Date the template should become ineffective

external_id
string
contractor_contribution_amount
float
Default dollar amount to be contributed by the contractor for deductions

contractor_contribution_percentage
float
Default percentage of contractor's pay to be contributed by the contractor for deductions

agency_name
string
Address of the agency for a court order (Garnishment only)

agency_address
string
Name of the agency for a court order (Garnishment only)

case_id
string
Case ID of a court order (Garnishment only)

order_number
string
Order number of a court order (Garnishment only)

Request Example

xxxxxxxxxx

curl --request POST \  
     --url https://api.zeal.com/contractor-deduction-templates \  
     --header 'accept: application/json' \  
     --header 'content-type: application/json' \  
     --data '  
{  
  "deduction_type": "garnishment"  
}  
'  

Response Codes

200 - New Example  
400 - Bad Request