v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Contractor Deduction Template

post/contractor-deduction-templates

Request body

companyIDstring required

ID of company

contractorIDstring required

ID of contractor

custom_namestring required

Human-readable name for the deduction template

deduction_type'garnishment' | 'miscellaneous' required
effective_start_datestring required

Date the template should start become effective

effective_end_datestring

Date the template should become ineffective

external_idstring
contractor_contribution_amountnumber float

Default dollar amount to be contributed by the contractor for deductions

contractor_contribution_percentagenumber float

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

agency_namestring

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

agency_addressstring

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

case_idstring

Case ID of a court order (Garnishment only)

order_numberstring

Order number of a court order (Garnishment only)

Response

200

successboolean
dataobject

Contains Contractor Deduction Template object

testModeboolean