Skip to main content
PATCH
Update Contractor Deduction Template

Authorizations

Authorization
string
header
required

Body

application/json
deductionTemplateID
string
required

ID of contractor

companyID
string
required

ID of company

custom_name
string

Human-readable name for the deduction template

contractor_contribution_amount
number<float>

Default dollar amount to be contributed by the contractor for deductions

contractor_contribution_percentage
number<float>

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

effective_start_date
string

Date the template should start become effective

effective_end_date
string

Date the template should become ineffective

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)

external_id
string

Response

200

success
boolean
data
object

Contains Contractor Deduction Template object

testMode
boolean